Skip to main content

Retrieve Buyer Details

GET 
/buyers/{buyer-id}

Retrieves the Buyer details.

Request​

Path Parameters

    buyer-id BuyerIdrequired

    Possible values: <= 255 characters

    Unique identifier of the customer in your system.

Responses​

OK

Schema

    buyer

    object

    buyerId BuyerId (string)required

    Possible values: <= 255 characters

    buyerDetails

    object

    required

    firstName First Name (string)

    Possible values: <= 30 characters

    Example: Sarah
    lastName Last Name (string)

    Possible values: <= 40 characters

    Example: Fon Schwartz
    companyName Organization Name (string)

    Possible values: <= 100 characters

    Example: LLC Bean
    locale Locale (string)

    Possible values: <= 5 characters

    Example: en-US
    dateOfBirth date
    email Email (string)

    Possible values: <= 100 characters

    phone Phone Number (string)

    Possible values: <= 18 characters

    Example: 972528882468
    phone2 Phone Number (string)

    Possible values: <= 18 characters

    Example: 972528882468
    workPhone Phone Number (string)

    Possible values: <= 18 characters

    Example: 972528882468
    nationalIdentificationNumber password

    The user’s national ID number.

    Possible values: <= 25 characters

    Example: 221685479

    billingAddress

    object

    required

    address Address Line (string)

    Possible values: <= 60 characters

    addressLine2 Address Line (string)

    Possible values: <= 60 characters

    addressLine3 Address Line (string)

    Possible values: <= 60 characters

    zip Postal Code (string)

    Possible values: <= 10 characters

    city City (string)

    Possible values: <= 30 characters

    state State (string)

    Possible values: <= 6 characters

    Example: AZ
    countryCode Country Code (string)required

    Possible values: >= 2 characters and <= 2 characters

    Example: DE
    phone Phone Number (string)

    Possible values: <= 18 characters

    Example: 972528882468
    addressMatch boolean
    Default value: false

    shippingAddress

    object

    sameAsBilling boolean
    Default value: false
    address Address Line (string)

    Possible values: <= 60 characters

    addressLine2 Address Line (string)

    Possible values: <= 60 characters

    addressLine3 Address Line (string)

    Possible values: <= 60 characters

    zip Postal Code (string)

    Possible values: <= 10 characters

    city City (string)

    Possible values: <= 30 characters

    state State (string)

    Possible values: <= 6 characters

    Example: AZ
    countryCode Country Code (string)

    Possible values: >= 2 characters and <= 2 characters

    Example: DE
    firstName First Name (string)

    Possible values: <= 30 characters

    Example: Sarah
    lastName Last Name (string)

    Possible values: <= 40 characters

    Example: Fon Schwartz
    phone Phone Number (string)

    Possible values: <= 18 characters

    Example: 972528882468
    phone2 Phone Number (string)

    Possible values: <= 18 characters

    Example: 972528882468

    result

    object

    required

    status stringrequired

    Possible values: [success, error]

    errors

    object

    code string

    If an error occurred on the request side, an error code is returned in this parameter.

    Possible values: <= 11 characters

    Example: 7000.1000
    reason string

    If an error occurred on the request side, then an error reason is returned in this parameter.

    Possible values: <= 400 characters

    Example: Unexpected error
Loading...