1 of 11

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

List Accounts

Create Account

Create a new Client or Vendor Account object.

Enable Account

Enable the previously disabled 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

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

post

/v1/accounts/accounts

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

typeobjectrequired

statusobject

serviceLevelobjectrequired

addressobject

iconnullable string

technicalSupportEmailnullable string email

websitenullable string

descriptionnullable string

namestringrequired

groupsnullable object[]

buyersnullable object[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.platform.softwareone.com/public/v1/accounts/accounts' \
  --header 'Content-Type: application/json' \
  --data '{"audit":{},"$meta":{},"type":{},"status":{},"serviceLevel":{},"address":{},"name":"text","groups":[{"audit":{},"$meta":{},"account":{},"modules":[{"id":"text","audit":{},"$meta":{},"href":"text","description":"text","isConfigurable":true,"isEnabledByDefault":true,"paid":true,"name":"text","accountTypes":["text"]}],"users":[{"audit":{},"$meta":{},"phone":{},"settings":{},"currentAccount":{},"accounts":["[Circular Reference]"]}]}],"buyers":[{"audit":{},"$meta":{},"contact":{},"externalIds":{},"status":{},"address":{},"account":{},"name":"text","sellers":[{"id":"text","audit":{},"$meta":{},"href":"text","externalId":"text","status":{},"icon":"text","address":{},"name":"text","currencies":["text"]}]}]}'

201

400

{
  "id": "text",
  "audit": {},
  "$meta": {},
  "href": "text",
  "externalId": "text",
  "externalName": "text",
  "type": {},
  "status": {},
  "serviceLevel": {},
  "address": {},
  "icon": "text",
  "technicalSupportEmail": "hello@example.com",
  "website": "text",
  "description": "text",
  "name": "text",
  "groups": [
    {
      "id": "text",
      "audit": {},
      "$meta": {},
      "href": "text",
      "name": "text",
      "description": "text",
      "account": {},
      "logo": "text",
      "isDefault": true,
      "modules": [
        {
          "id": "text",
          "audit": {},
          "$meta": {},
          "href": "text",
          "description": "text",
          "isConfigurable": true,
          "isEnabledByDefault": true,
          "paid": true,
          "name": "text",
          "accountTypes": [
            "text"
          ]
        }
      ],
      "users": [
        "[Circular Reference]"
      ]
    }
  ],
  "buyers": [
    {
      "id": "text",
      "audit": {},
      "$meta": {},
      "href": "text",
      "contact": {},
      "externalIds": {},
      "status": {},
      "icon": "text",
      "address": {},
      "taxId": "text",
      "account": {},
      "name": "text",
      "sellers": [
        {
          "id": "text",
          "audit": {},
          "$meta": {},
          "href": "text",
          "externalId": "text",
          "status": {},
          "icon": "text",
          "address": {},
          "name": "text",
          "currencies": [
            "text"
          ]
        }
      ]
    }
  ]
}

Created

post

/v1/accounts/accounts/{id}/activate

Path parameters

idstringrequired

Body

idstring

auditobject

$metaobject

hrefstring

externalIdstringrequired

externalNamenullable string

typeobject

statusobject

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string email

websitenullable string

descriptionnullable string

namestringrequired

groupsnullable object[]

buyersnullable object[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.platform.softwareone.com/public/v1/accounts/accounts/{id}/activate' \
  --header 'Content-Type: application/json' \
  --data '{"audit":{},"$meta":{},"externalId":"text","type":{},"status":{},"serviceLevel":{},"address":{},"name":"text","groups":[{"audit":{},"$meta":{},"account":{},"modules":[{"id":"text","audit":{},"$meta":{},"href":"text","description":"text","isConfigurable":true,"isEnabledByDefault":true,"paid":true,"name":"text","accountTypes":["text"]}],"users":[{"audit":{},"$meta":{},"phone":{},"settings":{},"currentAccount":{},"accounts":["[Circular Reference]"]}]}],"buyers":[{"audit":{},"$meta":{},"contact":{},"externalIds":{},"status":{},"address":{},"account":{},"name":"text","sellers":[{"id":"text","audit":{},"$meta":{},"href":"text","externalId":"text","status":{},"icon":"text","address":{},"name":"text","currencies":["text"]}]}]}'

200

400

404

{
  "id": "text",
  "audit": {},
  "$meta": {},
  "href": "text",
  "externalId": "text",
  "externalName": "text",
  "type": {},
  "status": {},
  "serviceLevel": {},
  "address": {},
  "icon": "text",
  "technicalSupportEmail": "hello@example.com",
  "website": "text",
  "description": "text",
  "name": "text",
  "groups": [
    {
      "id": "text",
      "audit": {},
      "$meta": {},
      "href": "text",
      "name": "text",
      "description": "text",
      "account": {},
      "logo": "text",
      "isDefault": true,
      "modules": [
        {
          "id": "text",
          "audit": {},
          "$meta": {},
          "href": "text",
          "description": "text",
          "isConfigurable": true,
          "isEnabledByDefault": true,
          "paid": true,
          "name": "text",
          "accountTypes": [
            "text"
          ]
        }
      ],
      "users": [
        "[Circular Reference]"
      ]
    }
  ],
  "buyers": [
    {
      "id": "text",
      "audit": {},
      "$meta": {},
      "href": "text",
      "contact": {},
      "externalIds": {},
      "status": {},
      "icon": "text",
      "address": {},
      "taxId": "text",
      "account": {},
      "name": "text",
      "sellers": [
        {
          "id": "text",
          "audit": {},
          "$meta": {},
          "href": "text",
          "externalId": "text",
          "status": {},
          "icon": "text",
          "address": {},
          "name": "text",
          "currencies": [
            "text"
          ]
        }
      ]
    }
  ]
}

Success

put

/v1/accounts/accounts/{id}

Path parameters

idstringrequired

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

typeobject

statusobject

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string email

websitenullable string

descriptionnullable string

namestringrequired

groupsnullable object[]

buyersnullable object[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.platform.softwareone.com/public/v1/accounts/accounts/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"audit":{},"$meta":{},"type":{},"status":{},"serviceLevel":{},"address":{},"name":"text","groups":[{"audit":{},"$meta":{},"account":{},"modules":[{"id":"text","audit":{},"$meta":{},"href":"text","description":"text","isConfigurable":true,"isEnabledByDefault":true,"paid":true,"name":"text","accountTypes":["text"]}],"users":[{"audit":{},"$meta":{},"phone":{},"settings":{},"currentAccount":{},"accounts":["[Circular Reference]"]}]}],"buyers":[{"audit":{},"$meta":{},"contact":{},"externalIds":{},"status":{},"address":{},"account":{},"name":"text","sellers":[{"id":"text","audit":{},"$meta":{},"href":"text","externalId":"text","status":{},"icon":"text","address":{},"name":"text","currencies":["text"]}]}]}'

200

400

404

{
  "id": "text",
  "audit": {},
  "$meta": {},
  "href": "text",
  "externalId": "text",
  "externalName": "text",
  "type": {},
  "status": {},
  "serviceLevel": {},
  "address": {},
  "icon": "text",
  "technicalSupportEmail": "hello@example.com",
  "website": "text",
  "description": "text",
  "name": "text",
  "groups": [
    {
      "id": "text",
      "audit": {},
      "$meta": {},
      "href": "text",
      "name": "text",
      "description": "text",
      "account": {},
      "logo": "text",
      "isDefault": true,
      "modules": [
        {
          "id": "text",
          "audit": {},
          "$meta": {},
          "href": "text",
          "description": "text",
          "isConfigurable": true,
          "isEnabledByDefault": true,
          "paid": true,
          "name": "text",
          "accountTypes": [
            "text"
          ]
        }
      ],
      "users": [
        "[Circular Reference]"
      ]
    }
  ],
  "buyers": [
    {
      "id": "text",
      "audit": {},
      "$meta": {},
      "href": "text",
      "contact": {},
      "externalIds": {},
      "status": {},
      "icon": "text",
      "address": {},
      "taxId": "text",
      "account": {},
      "name": "text",
      "sellers": [
        {
          "id": "text",
          "audit": {},
          "$meta": {},
          "href": "text",
          "externalId": "text",
          "status": {},
          "icon": "text",
          "address": {},
          "name": "text",
          "currencies": [
            "text"
          ]
        }
      ]
    }
  ]
}

Success

post

/v1/accounts/accounts/{id}/validate

Path parameters

idstringrequired

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

typeobject

statusobject

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string

websitenullable string

descriptionnullable string

namenullable string

groupsnullable object[]

buyersnullable object[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.platform.softwareone.com/public/v1/accounts/accounts/{id}/validate' \
  --header 'Content-Type: application/json' \
  --data '{"audit":{},"$meta":{},"type":{},"status":{},"serviceLevel":{},"address":{},"groups":[{"audit":{},"$meta":{},"account":{},"modules":[{"id":"text","audit":{},"$meta":{},"href":"text","description":"text","isConfigurable":true,"isEnabledByDefault":true,"paid":true,"name":"text","accountTypes":["text"]}],"users":[{"audit":{},"$meta":{},"phone":{},"settings":{},"currentAccount":{},"accounts":["[Circular Reference]"]}]}],"buyers":[{"audit":{},"$meta":{},"contact":{},"externalIds":{},"status":{},"address":{},"account":{},"name":"text","sellers":[{"id":"text","audit":{},"$meta":{},"href":"text","externalId":"text","status":{},"icon":"text","address":{},"name":"text","currencies":["text"]}]}]}'

200

400

{
  "id": "text",
  "audit": {},
  "$meta": {},
  "href": "text",
  "externalId": "text",
  "externalName": "text",
  "type": {},
  "status": {},
  "serviceLevel": {},
  "address": {},
  "icon": "text",
  "technicalSupportEmail": "hello@example.com",
  "website": "text",
  "description": "text",
  "name": "text",
  "groups": [
    {
      "id": "text",
      "audit": {},
      "$meta": {},
      "href": "text",
      "name": "text",
      "description": "text",
      "account": {},
      "logo": "text",
      "isDefault": true,
      "modules": [
        {
          "id": "text",
          "audit": {},
          "$meta": {},
          "href": "text",
          "description": "text",
          "isConfigurable": true,
          "isEnabledByDefault": true,
          "paid": true,
          "name": "text",
          "accountTypes": [
            "text"
          ]
        }
      ],
      "users": [
        "[Circular Reference]"
      ]
    }
  ],
  "buyers": [
    {
      "id": "text",
      "audit": {},
      "$meta": {},
      "href": "text",
      "contact": {},
      "externalIds": {},
      "status": {},
      "icon": "text",
      "address": {},
      "taxId": "text",
      "account": {},
      "name": "text",
      "sellers": [
        {
          "id": "text",
          "audit": {},
          "$meta": {},
          "href": "text",
          "externalId": "text",
          "status": {},
          "icon": "text",
          "address": {},
          "name": "text",
          "currencies": [
            "text"
          ]
        }
      ]
    }
  ]
}

Success