Get Customer

Get Customer by External ID and Source

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

source

string

required

For API users should be Always 9

Example:

Match pattern:

[1-9]

externalId

string

required

Example:

Responses

🟢200Successful operation

application/json

Body

complytId

string <uuid>

optional

The unique identifier in Complyt of the customer

externalId

string

required

the attribute designed to receive a unique identifier provided by API consumers themselves (e.g. pass your own ID)

>= 1 characters<= 256 characters

source

string

required

a single digit which identifies your different stores, checkout solutions, marketplaces, etc. defined by the API consumers (to avoid external id duplications)

Match pattern:

^(10|[1-9])$

name

string

optional

The customer's name

>= 1 characters<= 256 characters

address

object

optional

city

string

optional

>= 0 characters<= 100 characters

country

string

optional

>= 0 characters<= 50 characters

county

string

optional

>= 0 characters<= 100 characters

state

string

optional

>= 0 characters<= 100 characters

street

string

optional

>= 0 characters<= 200 characters

region

string

optional

>= 0 characters<= 20 characters

zip

string

optional

>= 0 characters<= 20 characters

string

optional

An (Optional) Email address associated with the customer

customerType

enum<string>

optional

Indicates whether the customer is 'retail'/'reseller'/'marketplace'. Defaults to 'retail' if no customer type is provided

Allowed values:

RETAILMARKETPLACERESELLERRETAIL_EXEMPT

internalTimestamps

object (internalTimestamps)

optional

read-only. The APIs internal timestamps for this resource

createdDate

string

required

valid ISO8601 format. Supported formats are 'YYYY-MM-DD'/ 'YYYY-MM-DDTHH:mm:ssZ'/ and 'YYYY-MM-DDTHH:mm:ss±hh:mm' (with a valid time zone offset).

updatedDate

string

required

valid ISO8601 format. Supported formats are 'YYYY-MM-DD'/ 'YYYY-MM-DDTHH:mm:ssZ'/ and 'YYYY-MM-DDTHH:mm:ss±hh:mm' (with a valid time zone offset).

externalTimestamps

object (externalTimestamps)

required

External timestamps, which should reference the dates in your originating system since these are the timestamps used for sales tax calculation

createdDate

string

required

The creation time of the transaction

updatedDate

string

required

The last update time of the transaction

comment

string

optional

>= 0 characters<= 200 characters

Example

{
    "complytId": "9f8ee193-1a71-42b4-801d-ee1d8a161fbe",
    "externalId": "externalIdExample",
    "source": "sourceExample",
    "name": "Complyt",
    "address": {
        "city": "Sacramento",
        "country": "US",
        "county": null,
        "state": "CA",
        "street": "944 W. Wintergreen St.",
        "zip": "95823"
    },
    "email": "example@some.mail.com",
    "customerType": "RETAIL",
    "internalTimestamps": {
        "createdDate": "2023-01-10T17:40:44.357",
        "updatedDate": "2023-01-11T17:10:21.275"
    },
    "externalTimestamps": {
        "createdDate": "2022-10-19T07:00:00",
        "updatedDate": "2022-10-19T09:07:54.585"
    },
    "comment": "this is a customer"
}

🟠400Something is wrong with your request

🟠401Unauthorized

🟠403Forbidden

🟠404Customer Not Found

🔴500Internal Error

Get Customer

Request

Request samples

Responses