---
title: "Customer"
url: "https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/210b509a-613e-44ac-a87b-ef6c22c23a2c/schemas/Customer"
---

> Full API specification: https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/210b509a-613e-44ac-a87b-ef6c22c23a2c.md

# Customer

Customer model

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Retail Express API
  version: v2.1
servers:
  - url: https://api.retailexpress.com.au/v2.1
components:
  schemas:
    AccountCustomer:
      title: ""
      type: object
      properties:
        credit_blocked:
          type: boolean
          description: Is credit blocked
        credit_limit:
          type: number
          description: Credit limit
          format: double
        credit_remaining:
          type: number
          description: Credit remaining
          format: double
          nullable: true
        enabled:
          type: boolean
          description: Is enabled
        payment_terms:
          type: integer
          description: Payment terms
          format: int32
          nullable: true
      additionalProperties: false
      description: Account customer view model
    CustomerBillingAddress:
      title: ""
      type: object
      properties:
        country:
          type: string
          description: Country
          nullable: true
        country_code:
          type: string
          description: Country Code
          nullable: true
        state:
          type: string
          description: State
          nullable: true
        suburb:
          type: string
          description: Suburb
          nullable: true
        address_line1:
          type: string
          description: Address line 1
          nullable: true
        address_line2:
          type: string
          description: Address line 2
          nullable: true
        postcode:
          type: string
          description: Post code
          nullable: true
        first_name:
          type: string
          description: First name
          nullable: true
        last_name:
          type: string
          description: Last Name
          nullable: true
      additionalProperties: false
      description: Billing address model
    CustomerType:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Customer type identifier
          format: int32
        name:
          type: string
          description: Customer type name
          nullable: true
      additionalProperties: false
      description: Customer type model
    DeliveryAddress:
      title: ""
      type: object
      properties:
        country:
          type: string
          description: Country
          nullable: true
        country_code:
          type: string
          description: Country Code
          nullable: true
        state:
          type: string
          description: State
          nullable: true
        suburb:
          type: string
          description: Suburb
          nullable: true
        address_line1:
          type: string
          description: Address line 1
          nullable: true
        address_line2:
          type: string
          description: Address line 2
          nullable: true
        postcode:
          type: string
          description: Post code
          nullable: true
        company:
          type: string
          description: Company
          nullable: true
        mobile:
          type: string
          description: Mobile phone
          nullable: true
        phone:
          type: string
          description: Phone
          nullable: true
        first_name:
          type: string
          description: First name
          nullable: true
        last_name:
          type: string
          description: Last Name
          nullable: true
        id:
          type: integer
          description: Identifier
          format: int32
        default:
          type: boolean
          description: Is Default
          nullable: true
        modified_on:
          type: string
          description: Modified on
          format: date-time
      additionalProperties: false
      description: Delivery Address model
    LoyaltyProgram:
      title: ""
      type: object
      properties:
        enabled:
          type: boolean
          description: Is enabled
        points_available:
          type: number
          description: Points available
          format: double
        points_redeemed:
          type: number
          description: Points redeemed
          format: double
        points_to_date:
          type: number
          description: Points to date
          format: double
        auto_price_group:
          type: boolean
          description: Auto price group
        points_available_value:
          type: number
          description: Points available value
          format: double
          nullable: true
      additionalProperties: false
      description: Loyalty program model
    Marketing:
      title: ""
      type: object
      properties:
        receive_email:
          type: boolean
          description: Receive email
        receive_post:
          type: boolean
          description: Receive post
        receive_sms:
          type: boolean
          description: Receive sms
      additionalProperties: false
      description: Marketing view model
    PriceGroup:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Identifier
          format: int32
        name:
          type: string
          description: Name
          nullable: true
        type:
          type: string
          description: Type
          nullable: true
      additionalProperties: false
      description: Price group model
    SurveyResponse:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Survey response id
          format: int32
        question:
          type: string
          description: Survey response question
          nullable: true
        answer:
          type: string
          description: Survey response answer
          nullable: true
      additionalProperties: false
      description: Survey Response model
    OutletExtended:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Outlet id
          format: int32
          nullable: true
        name:
          maxLength: 255
          minLength: 0
          type: string
          description: Outlet name
          nullable: true
        modified_on:
          type: string
          description: Modified on
          format: date-time
      additionalProperties: false
    CustomerSalesChannel:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Identifier
          format: int32
        name:
          type: string
          description: Channel name
          nullable: true
        shopify_channel:
          type: boolean
          description: Is shopify channel
        enabled:
          type: boolean
          description: Is enabled
      additionalProperties: false
      description: CustomerSalesChannel Model
    Customer:
      title: ""
      type: object
      properties:
        account_customer:
          $ref: "#/components/schemas/AccountCustomer"
        acn:
          type: string
          description: Acn
          nullable: true
        billing_address:
          $ref: "#/components/schemas/CustomerBillingAddress"
        company:
          type: string
          description: Company
          nullable: true
        customer_number:
          type: string
          description: Customer number
          nullable: true
        customer_type:
          $ref: "#/components/schemas/CustomerType"
        date_of_birth:
          type: string
          description: Date of birth
          nullable: true
        date_of_birth_withheld:
          type: boolean
          description: Date of birth with held
        delivery_addresses:
          type: array
          items:
            $ref: "#/components/schemas/DeliveryAddress"
          description: Delivery address
          nullable: true
        email:
          type: string
          description: Email
          nullable: true
        fax:
          type: string
          description: Fax
          nullable: true
        first_name:
          type: string
          description: First name
          nullable: true
        id:
          type: integer
          description: Identifier
          format: int32
        last_name:
          type: string
          description: Last name
          nullable: true
        loyalty_program:
          $ref: "#/components/schemas/LoyaltyProgram"
        marketing:
          $ref: "#/components/schemas/Marketing"
        mobile:
          type: string
          description: Mobile
          nullable: true
        phone:
          type: string
          description: Phone
          nullable: true
        price_groups:
          type: array
          items:
            $ref: "#/components/schemas/PriceGroup"
          description: Price group
          nullable: true
        survey_responses:
          type: array
          items:
            $ref: "#/components/schemas/SurveyResponse"
          description: Survey responses
          nullable: true
        website:
          type: string
          description: Website
          nullable: true
        home_outlet:
          $ref: "#/components/schemas/OutletExtended"
        custom_reference:
          type: string
          description: Custom reference
          nullable: true
        export_to_web:
          type: boolean
          description: Export to web
        total_payments:
          type: number
          description: Total Payments
          format: double
          nullable: true
        total_transactions:
          type: integer
          description: Total Transactions
          format: int32
          nullable: true
        sales_channels:
          type: array
          items:
            $ref: "#/components/schemas/CustomerSalesChannel"
          description: Sales Channels
          nullable: true
        created_on:
          type: string
          description: Created on
          format: date-time
        modified_on:
          type: string
          description: Modified on
          format: date-time
      additionalProperties: false
      description: Customer model
```