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"  
}

SoftwareOne is a trademark of SoftwareOne, Inc. "The Software Licensing Experts" is a service mark of SoftwareOne, Inc. VAR assist is a trademark of SoftwareOne, Inc. "It pays to partner" is a service mark of SoftwareOne, Incorporated.