1 of 72

Accounts API

Account

Account Object

The account object represents an individual account on the Marketplace platform. This object contains the following properties:

Field

Type

Description

id

string

Primary account identifier.

Example: "ACC-1671-0642"

href

string

Relative reference to object on API.

Example: "/v1/accounts/accounts/ACC-1671-0642"

type

string

Type of the account (Client, Vendor, Operations)

Example: "Client"

status

string

Status of the account (Enabled, Active, Disabled)

Example: "Enabled"

name

string

Account name.

Example: "Stark Industries"

description

string

Account description.

Example: "Our company account"

externalId

string

External identifier - Customer Discount Group number.

Example: "WW-1001111"

externalName

string

External identifier - Customer Discount Group name.

Example: "Stark Industries"

serviceLevel

string

Service level offered to the account (Essential, Elite, DSC)

Example: "Elite"

address

object

Address of the company.

Example:

icon

string

Relative path to account logo.

Example: "/static/accounts/ACC-1671-0642/logo.png"

website

string

Path to company’s website.

Example: "https://www.example.com"

technicalSupportEmail

string

Technical support email for some corner cases.

Example: "user@example.com"

audit

object

Possible audit events: Created, Updated, Disabled, Enabled, or Activated.

Example:

groups

Example

{
  "id": "ACC-1671-0642",
  "href": "/accounts/accounts/ACC-1671-0642",
  "type": "Client",
  "status": "Enabled",
  "name": "You Are a Test Account",
  "description": "This is a test account.",
  "externalId": "WW-1001111",
  "serviceLevel": "Express",
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt 4B",
    "postCode": "12345",
    "city": "Cityville",
    "state": "S",
    "country": "ST"
  },
  "logo": null,
  "technicalSupportEmail": "user@example.com",
  "website": "https://example.com"  
}

{
  "id": "ACC-1671-0642",
  "href": "/accounts/accounts/ACC-1671-0642",
  "type": "Client",
  "status": "Enabled",
  "name": "You Are a Test Account",
  "description": "This is a test account.",
  "externalId": "WW-1001111",
  "serviceLevel": "Express",
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt 4B",
    "postCode": "12345",
    "city": "Cityville",
    "state": "S",
    "country": "ST"
  },
  "logo": null,
  "technicalSupportEmail": "user@example.com",
  "website": "https://example.com",
  "groups": [
		{
			"id": "UGR-9354-3382",
			"href": "/user-groups/UGR-9354-3382",
			"name": "Administrators",
			"description": "Manages administrative tasks and resources within an organization.",
			"logo": null,
			"isDefault": true
		}
  ],
  {
    "created": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "updated": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "disabled": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "enabled": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "activated": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } }
  }
}

List Accounts

Create Account

Create a new Client or Vendor Account object.

Enable Account

Enable the previously disabled Account object.

When enabled, the account status will change to Active if the account has ExternalId assigned or Enabled otherwise.

Disable Account

Disable the Account object. Disabling prevents users from signing in

Activate Account

Activate the previously enabled Account object.

Get Account

Get a single Account object by ID.

Update Account

Update the Account object.

Validate Account

Validate the Account object.

Get List of External Buyers

Gets a list of external Buyer objects that can be added to Account

Get Account Icon

Buyer

Buyer Object

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

Field

Type

Description

Example

List Buyers

Get the Buyers collection.

Create Buyer

Create a new Buyer object for the client account.

Enable Buyer

Enable a previously disabled Buyer object.

When enabled, the buyer status will change to Active if the buyer has ExternalId assigned or Enabled otherwise.

Disable Buyer

Disable the Buyer object. Disabled buyers cannot be used in transactions.

Get Buyer

Get a single Buyer object by ID.

Update Buyer

Update the Buyer object. You can only update the logo and contact fields only.

Delete Buyer

Delete the Buyer object.

Validate Buyer

Validate a Buyer object.

Seller

Seller Object

The seller object represents a seller in the Marketplace platform. This object contains the following properties:

Field

Type

Description

Example

List Sellers

Get the Sellers collection.

Get Seller

Get a single Seller object by ID.

Create Seller

Create a new Seller object.

Activate Seller

Activate a previously deactivated or disabled seller.

When activated, the status changes from Offline or Disabled to Active.

Deactivate Seller

Deactivate a seller.

When a seller is deactivated, the status changes from Active to Offline.

List Modules

Get a list of modules in the platform.

Account

Account Object

The account object represents an individual account on the Marketplace platform. This object contains the following properties:

Field

Type

Description

id

string

Primary account identifier.

Example: "ACC-1671-0642"

href

string

Relative reference to object on API.

Example: "/v1/accounts/accounts/ACC-1671-0642"

type

string

Type of the account (Client, Vendor, Operations)

Example: "Client"

status

string

Status of the account (Enabled, Active, Disabled)

Example: "Enabled"

name

string

Account name.

Example: "Stark Industries"

description

string

Account description.

Example: "Our company account"

externalId

string

External identifier - Customer Discount Group number.

Example: "WW-1001111"

externalName

string

External identifier - Customer Discount Group name.

Example: "Stark Industries"

serviceLevel

string

Service level offered to the account (Essential, Elite, DSC)

Example: "Elite"

address

object

Address of the company.

Example:

{
  "addressLine1": "123 Main Street",
  "addressLine2": "Apt 4B",
  "postCode": "12345",
  "city": "Cityville",
  "state": "S",
  "country": "ST"
}

icon

string

Relative path to account logo.

Example: "/static/accounts/ACC-1671-0642/logo.png"

website

string

Path to company’s website.

Example: "https://www.example.com"

technicalSupportEmail

string

Technical support email for some corner cases.

Example: "user@example.com"

audit

object

Possible audit events: Created, Updated, Disabled, Enabled, or Activated.

Example:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } },
  "disabled": { "at": "...", "by": { } },
  "enabled": { "at": "...", "by": { } },
  "activated": { "at": "...", "by": { } }
}

groups

Example

{
  "id": "ACC-1671-0642",
  "href": "/accounts/accounts/ACC-1671-0642",
  "type": "Client",
  "status": "Enabled",
  "name": "You Are a Test Account",
  "description": "This is a test account.",
  "externalId": "WW-1001111",
  "serviceLevel": "Express",
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt 4B",
    "postCode": "12345",
    "city": "Cityville",
    "state": "S",
    "country": "ST"
  },
  "logo": null,
  "technicalSupportEmail": "user@example.com",
  "website": "https://example.com"  
}

{
  "id": "ACC-1671-0642",
  "href": "/accounts/accounts/ACC-1671-0642",
  "type": "Client",
  "status": "Enabled",
  "name": "You Are a Test Account",
  "description": "This is a test account.",
  "externalId": "WW-1001111",
  "serviceLevel": "Express",
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt 4B",
    "postCode": "12345",
    "city": "Cityville",
    "state": "S",
    "country": "ST"
  },
  "logo": null,
  "technicalSupportEmail": "user@example.com",
  "website": "https://example.com",
  "groups": [
		{
			"id": "UGR-9354-3382",
			"href": "/user-groups/UGR-9354-3382",
			"name": "Administrators",
			"description": "Manages administrative tasks and resources within an organization.",
			"logo": null,
			"isDefault": true
		}
  ],
  {
    "created": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "updated": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "disabled": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "enabled": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "activated": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } }
  }
}