Retrieve Buyer Details
GET/buyers/{buyerId}
Retrieves the Buyer Details.
Request
Path Parameters
Possible values: <= 255 characters
Unique identifier of the customer in your system.
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
Schema
buyer
object
Possible values: <= 255 characters
buyerDetails
object
required
Possible values: <= 30 characters
Possible values: <= 40 characters
Possible values: <= 100 characters
Possible values: <= 5 characters
Possible values: <= 100 characters
Possible values: <= 18 characters
Possible values: <= 18 characters
Possible values: <= 18 characters
Possible values: <= 25 characters
The user’s national ID number.
billingAddress
object
required
Possible values: <= 60 characters
Possible values: <= 60 characters
Possible values: <= 60 characters
Possible values: <= 10 characters
Possible values: <= 30 characters
Possible values: <= 6 characters
Possible values: >= 2 characters
and <= 2 characters
Possible values: <= 18 characters
shippingAddress
object
Possible values: <= 60 characters
Possible values: <= 60 characters
Possible values: <= 60 characters
Possible values: <= 10 characters
Possible values: <= 30 characters
Possible values: <= 6 characters
Possible values: >= 2 characters
and <= 2 characters
Possible values: <= 30 characters
Possible values: <= 40 characters
Possible values: <= 18 characters
Possible values: <= 18 characters
result
object
required
Possible values: [success
, error
]
errors
object
Possible values: <= 11 characters
Possible values: <= 400 characters
{
"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"
}
}
}