Buyer

Buyer Object

The buyer object represents an individual buyer in the Marketplace platform. This object contains the following properties:

Field	Type	Description
id	string	Primary buyer identifier. Example: "BUY-1234-1234"
href	string	Relative reference to object on API. Example: "/v1/accounts/buyers/BUY-1234-1234"
status	string	Status: Enabled, Active, Disabled, Deleted
name	string	Buyer's name. Example: "Stark Industries"
icon	string	Relative path to buyer’s logo. Example: "/static/accounts/BUY-1234-1234/logo.png"
externalIds	BuyerExternalIdsObject	External identifier. Example: { "erpCompanyContact": "WW-CON-123456", "erpCustomer": "WW-SCU-123456" }
address	object	Address of the buyer. Example: { "addressLine1": "123 Main Street", "addressLine2": "Apt 4B", "postCode": "12345", "city": "Cityville", "state": "S", "country": "ST" }
taxId	string	Buyer's tax ID. Example: "12-34567890"
account	Account	Buyer’s account object.
sellers	Seller
contact	object	Contact person details. Example: { "name": "Will Smith", "firstName": "Will", "lastName": "Smith", "email": "[e-mail]", "phone": null, "user": { "id": "USR-0000-0001", "href": "/users/USR-0000-0001", "icon": null, "name": "Will Smith" } }
audit	object	Possible audit events: Created, Updated, Disabled, Enabled, Activated. Example: { "created": { "at": "...", "by": { } }, "updated": { "at": "...", "by": { } }, "disabled": { "at": "...", "by": { } }, "enabled": { "at": "...", "by": { } }, "activated": { "at": "...", "by": { } }, "deleted": { "at": "...", "by": { } } }

Example

SHORT FORM

{
	"id": "BUY-3911-2313",
	"href": "/accounts/buyers/BUY-3911-2313",
	"contact": {
		"name": "Will Smith",
		"firstName": "Will",
		"lastName": "Smith",
		"email": "[e-mail]",
		"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"
}

FULL EXAMPLE

{
	"id": "BUY-3911-2313",
	"href": "/accounts/buyers/BUY-3911-2313",
	"contact": {
		"name": "Will Smith",
		"firstName": "Will",
		"lastName": "Smith",
		"email": "[e-mail]",
		"phone": null,
		"user": {
			"id": "USR-0000-0001",
			"href": "/users/USR-0000-0001",
			"icon": null,
			"invited": "2024-02-03T11:34:15.381Z",
			"joined": "2024-02-04T12:34:15.381Z",
			"lastLogin": "2024-02-05T13:34:15.381Z",
			"name": "Will Smith"
		}
	},
    "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",
	"account": {
		"id": "ACC-5563-4382",
		"href": "/accounts/accounts/ACC-5563-4382",
		"type": "Client",
		"status": "Active",
		"icon": null,
		"name": "AdAstraflexx"
	},
	"name": "Stark Industries",
	"sellers": [
		{
			"id": "SEL-1299-2079",
			"href": "/accounts/sellers/SEL-1299-2079",
			"externalId": "SWO_CH",
			"name": "SoftwareOne AG"
		}
	],
	"audit": {
		"created": {
			"at": "2023-12-14T13:44:20.896Z",
			"by": {
				"id": "USR-0000-0001",
				"href": "/users/USR-0000-0001",
				"icon": null,
				"invited": "2024-02-03T11:34:15.383Z",
				"joined": "2024-02-04T12:34:15.383Z",
				"lastLogin": null,
				"name": "Will Smith"
			}
		},
		"updated": {
			"at": "2024-01-06T19:04:16.692Z",
			"by": {
				"id": "USR-0000-0001",
				"href": "/users/USR-0000-0001",
				"icon": null,
				"invited": "2024-02-03T11:34:15.383Z",
				"joined": "2024-02-04T12:34:15.383Z",
				"lastLogin": null,
				"name": "Will Smith"
			}
		}
	}
}