Customer API
  1. response
Customer API
  • common
    • customers
      • customer
        • account
          • transactions
            • transaction
              • Get Transaction
            • List Transactions
          • Get Account
          • Update Account
          • Get account by id
        • Get Customer
        • Get Customer w/Account
        • Update Customer
  • host
    • customers
      • Add Customer
      • Add Customers
      • Search Customers
    • customer-account-defaults
      • Get Account Defaults
      • Set Account Defaults
    • default-customer
      • Get Default Customer
    • frequent-customers
      • List Frequent Customers
  • store
    • customers
      • customer
        • account
          • transactions
            • Add Transaction
        • visibility
          • Get Customer Visibility
          • Set Customer Visibility
        • Get Provisioning
        • Provision For Store
        • Publish State Events
        • get customer by account number
      • Add Customer
      • Add & Provision Customer
      • Add Customers
      • Bulk List Customers
      • Search Customers
    • default-customer
      • Get Default Customer
      • Set Default Customer
    • frequent-customers
      • Add Frequent Customer
      • List Frequent Customers
      • Remove Frequent Customer
  • Schemas
    • request
      • AddCustomerRequest
      • AddCustomerAndProvisionForStoreRequest
      • AddCustomerAccountTxRequest
      • AddFranchiseCustomerRequest
      • BulkCustomerRequest
      • LinkCustomerRequest
      • ProvisionCustomerForStoreRequest
      • SetCustomerAccountDefaultsRequest
      • UpdateCustomerRequest
      • UpdateCustomerAccountRequest
    • response
      • FailureResponse
      • AddFrequentCustomerResponse
      • BulkCustomersResponse
      • GetCustomerResponse
      • GetCustomerAndAccountResponse
      • GetCustomerVisibilityResponse
      • GetStoreAccountResponse
      • ListCustomersResponse
      • ListCustomerAccountsResponse
      • StoreAccountListResponse
      • AddTransactionResponse
      • GetCustomerAccountResponse
    • Address
    • Contact
    • Customer
    • CustomerAccount
    • CustomerAccountDefaults
    • CustomerAccountTx
    • CustomerAndAccount
    • StoreCustomerProvisioning
    • Metadata
    • PayType
    • StoreCustomerWithAccount
  1. response

GetCustomerResponse

{
    "data": {
        "id": 1,
        "franchiseId": 1,
        "name": "string",
        "address": {
            "street1": "string",
            "street2": "string",
            "city": "string",
            "state": "string",
            "countryCode": "string",
            "zipCode": "/regex/"
        },
        "phone": "string",
        "email": "string",
        "billToAccount": {
            "id": 0,
            "status": "ACTIVE",
            "billToAddress": {
                "street1": "string",
                "street2": "string",
                "city": "string",
                "state": "string",
                "countryCode": "string",
                "zipCode": "/regex/"
            },
            "balance": 0,
            "creditLimit": 0,
            "cashOverLimit": false,
            "cashOverDays": false,
            "ageInDays": 0,
            "defaultPayType": "CASH",
            "payTypes": [
                "CASH"
            ],
            "priceCode": 0,
            "taxCode": "string",
            "maxDays": 0,
            "signatureRequired": false,
            "version": 0
        },
        "shipTo": {
            "name": "string",
            "address": {
                "street1": "string",
                "street2": "string",
                "city": "string",
                "state": "string",
                "countryCode": "string",
                "zipCode": "/regex/"
            },
            "phone": "string",
            "email": "string"
        },
        "version": 0
    }
}
Built with