Commands for Products

GET

api

billing

products

commands

Commands for Products

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/products/commands \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/billing/products/commands"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/products/commands', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Key": "<string>",
  "Name": "<string>",
  "AppliesOnlyToMultipleEntities": true,
  "AppliesOnlyToOneEntity": true,
  "NeedsEntitiesToRun": true,
  "Order": 123,
  "RequiresParameters": [
    {}
  ]
}

Commands are actions that can be executed on one or more Product records. Use this endpoint to discover which commands are available, then execute them via the Run command endpoint.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the Product-List role.

Query Parameters

integer

If provided, only commands available for this specific Product will be returned.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/billing/products/commands" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/products/commands',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const commands = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/products/commands',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

commands = response.json()

Response

200

Returns an array of available commands.

string

Unique identifier for the command. Pass this to the Run command endpoint.

string

Human-readable name of the command.

boolean

Whether the command can only be run on multiple records at once.

boolean

Whether the command can only be run on a single record.

boolean

Whether the command requires record Ids to execute.

integer

Display order for the command.

object[]

List of parameters required by this command, each containing Name and Type.

Example Response

[
  {
    "Key": "COMMAND_KEY_1",
    "Name": "Command name",
    "AppliesOnlyToMultipleEntities": false,
    "DisplayInDropdown": false,
    "DisplayInDropdownV2": true,
    "AppliesOnlyToOneEntity": true,
    "AppliesOnlyToTwoEntities": false,
    "DisplayInGrid": false,
    "Icon": "/Content/Themes/Admin/Images/Icons/Fugue/gear.png",
    "NeedsEntitiesToRun": true,
    "Order": 8,
    "RequiresParameters": [
      {
        "Name": "Parameter name",
        "Type": "parameterType"
      }
    ]
  }
]

Run command for ProductsExecute a command on one or more Product records.

Commands for Products

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/products/commands \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/billing/products/commands"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/products/commands', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Key": "<string>",
  "Name": "<string>",
  "AppliesOnlyToMultipleEntities": true,
  "AppliesOnlyToOneEntity": true,
  "NeedsEntitiesToRun": true,
  "Order": 123,
  "RequiresParameters": [
    {}
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

Code Examples

Response

200

​Authentication

​Query Parameters

​Code Examples

​Response

​200

Authentication

Query Parameters

Code Examples

Response

200