Buyer
The Buyer object represents an individual buyer within the Marketplace platform. This object contains the following properties:
Field
Type
Description
id
string
The primary identifier for the buyer.
Example: BUY-1234-1234
href
string
A relative reference to the object in the API.
Example: /v1/accounts/buyers/BUY-1234-1234
status
string
The status of the buyer.
Possible values: Enabled
, Active
, Disabled
, or Deleted
name
string
The buyer's name.
Example: Stark Industries
icon
string
The relative path to the buyer’s logo.
Example: /static/accounts/BUY-1234-1234/logo.png
externalIds
The external identifier.
Example:
{
"erpCompanyContact": "WW-CON-123456",
"erpCustomer": "WW-SCU-123456"
}
address
The address of the buyer.
Example:
{
"addressLine1": "123 Main Street",
"addressLine2": "Apt 4B",
"postCode": "12345",
"city": "Cityville",
"state": "S",
"country": "ST"
}
taxId
string
The buyer's tax ID.
Example: 12-34567890
contact
object
The details of the contact person.
Example:
{
"name": "Will Smith",
"firstName": "Will",
"lastName": "Smith",
"email": "[email protected]",
"phone": null,
"user": {
"id": "USR-0000-0001",
"icon": null,
"name": "Will Smith"
}
}
Example
{
"id": "BUY-3911-2313",
"contact": {
"name": "Will Smith",
"firstName": "Will",
"lastName": "Smith",
"email": "[email protected]",
"phone": null
},
"externalIds": {
"erpCompanyContact": "WW-CON-123456",
"erpCustomer": "WW-SCU-123456"
},
"status": "Active",
"icon": null,
"address": {
"addressLine1": "PO Box 31",
"addressLine2": "Victory Road",
"postCode": "DE24 8BJ",
"city": "Derby",
"state": "Derbs",
"country": "UK"
},
"taxId": "VAT1",
"name": "Stark Industries"
}
Last updated
Was this helpful?