Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Get the Buyers collection.
Create a new Buyer object for the client account.
Update the Buyer object. You can only update the logo and contact fields only.
Delete the Buyer object.
Enable a previously disabled Buyer object.
When enabled, the buyer status will change to Active
if the buyer has ExternalId
assigned or Enabled otherwise.
Validate a Buyer object.
Disable the Buyer object. Disabled buyers cannot be used in transactions.
Get a single Buyer object by ID.
No Content
Success
Success
Success
Success
Success
Json representation of the buyer
Created
Json representation of the buyer
Success
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:
address
object
Address of the buyer.
Example:
taxId
string
Buyer's tax ID.
Example: "12-34567890"
account
Buyer’s account object.
sellers
contact
object
Contact person details.
Example:
audit
object
Possible audit events: Created, Updated, Disabled, Enabled, Activated.
Example: