Retrieve Buyer Details

GET 
/buyers/{buyerId}

Retrieves the Buyer Details.

Request

Path Parameters

buyerId BuyerIdrequired

Possible values: <= 255 characters

Unique identifier of the customer in your system.

Responses

200

OK

application/json

Schema

Schema

buyer

object

buyerId BuyerId (string)required

Possible values: <= 255 characters

buyerDetails

object

required

firstName First Name (string)

Possible values: <= 30 characters

lastName Last Name (string)

Possible values: <= 40 characters

companyName Organization Name (string)

Possible values: <= 100 characters

locale Locale (string)

Possible values: <= 5 characters

dateOfBirth date

email Email (string)

Possible values: <= 100 characters

phone Phone Number (string)

Possible values: <= 18 characters

phone2 Phone Number (string)

Possible values: <= 18 characters

workPhone Phone Number (string)

Possible values: <= 18 characters

nationalIdentificationNumber National ID Number (string)

Possible values: <= 25 characters

The user’s national ID number.

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

countryCode Country Code (string)required

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

The 2-letter ISO country code.

phone Phone Number (string)

Possible values: <= 18 characters

addressMatch boolean

shippingAddress

object

sameAsBilling boolean

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

countryCode Country Code (string)

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

The 2-letter ISO country code.

firstName First Name (string)

Possible values: <= 30 characters

lastName Last Name (string)

Possible values: <= 40 characters

phone Phone Number (string)

Possible values: <= 18 characters

phone2 Phone Number (string)

Possible values: <= 18 characters

result

object

required

status stringrequired

Possible values: [success, error]

errors

object

code string

Possible values: <= 11 characters

reason string

Possible values: <= 400 characters

Example (from schema)

{
  "buyer": {
    "buyerId": "[email protected]",
    "buyerDetails": {
      "firstName": "Sarah",
      "lastName": "Fon Schwartz",
      "companyName": "LLC Bean",
      "locale": "en-US",
      "dateOfBirth": "2024-04-09",
      "email": "[email protected]",
      "phone": "+972528882468",
      "phone2": "+972528882468",
      "workPhone": "+972528882468",
      "nationalIdentificationNumber": "221685479",
      "billingAddress": {
        "address": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "zip": "string",
        "city": "string",
        "state": "AZ",
        "countryCode": "DE",
        "phone": "+972528882468",
        "addressMatch": false
      },
      "shippingAddress": {
        "sameAsBilling": false,
        "address": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "zip": "string",
        "city": "string",
        "state": "AZ",
        "countryCode": "DE",
        "firstName": "Sarah",
        "lastName": "Fon Schwartz",
        "phone": "+972528882468",
        "phone2": "+972528882468"
      }
    }
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Unexpected error"
    }
  }
}

Loading...