Account

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

Field	Type	Description
id	string	The primary identifier for the account. Example: ACC-1671-0642
href	string	A relative reference to the object. Example: /v1/accounts/accounts/ACC-1671-0642
type	string	The type of the account. Possible values: Client, Vendor, or Operations
status	string	The status of the account in the platform. Possible values: Enabled, Active, or Disabled
name	string	The name of the account. Example: Stark Industries
description	string	The account's 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	The service level offered to the account. Possible values: Essential, Elite, or DSC Example: Elite
address	address	The address of the company. Example: { "addressLine1": "123 Main Street", "addressLine2": "Apt 4B", "postCode": "12345", "city": "Cityville", "state": "S", "country": "ST" }
icon	string	The relative path to the account's logo. Example: /static/accounts/ACC-1671-0642/logo.png
website	string	The path to the company’s website. Example: https://www.example.com
technicalSupportEmail	string	The email address for technical support. Example: [email protected]
audit	object	A reference to the Audit object. Possible values: Created, Updated, Disabled, Enabled, or Activated. Example: { "created": { "at": "...", "by": { } }, "updated": { "at": "...", "by": { } }, "disabled": { "at": "...", "by": { } }, "enabled": { "at": "...", "by": { } }, "activated": { "at": "...", "by": { } } }
groups	userGroup	A reference to the User Group object.

Example

SHORT FORM

{
  "id": "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": "[email protected]",
  "website": "https://example.com"  
}

FULL EXAMPLE

{
  "id": "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": "[email protected]",
  "website": "https://example.com",
  "groups": [
		{
			"id": "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" } }
  }
}