SKU

get

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Query parameters

skucodesstringOptional

Comma-separated list of SKU Codes.

limitintegerOptional

skipintegerOptional

searchtextstringOptional

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

get

/sku

HTTPcURLJavaScriptPython

GET /api/sku HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "results": [
    {
      "code": "text",
      "name": "text",
      "cycleTime": null,
      "specifications": [
        {
          "name": "text",
          "value": "text"
        }
      ],
      "instructionsUrl": null,
      "lineSpeedTarget": null,
      "downtimeDurationThresholdMultiplier": null,
      "allowUseInQuickSchedule": null,
      "unitsPerMinute": null,
      "unitsPerHour": null,
      "batchSize": null,
      "value": null,
      "minimumCycleTime": null
    }
  ],
  "paging": {
    "totalElements": 1
  }
}

post

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Body

application/json

codestring · min: 1 · max: 32RequiredPattern: ^([a-zA-Z0-9.\\/-]+)$

namestring · min: 1 · max: 128Required

cycleTimenumber | nullOptional

specificationsany ofOptional

or

or

nullOptional

instructionsUrlstring | nullOptional

lineSpeedTargetnumber | null · min: 1 · max: 99999Optional

downtimeDurationThresholdMultipliernumber | null · min: 1 · max: 999Optional

allowUseInQuickSchedulebooleanOptionalDefault: true

unitsPerMinutenumber | nullOptional

unitsPerHournumber | nullOptional

batchSizenumber | nullOptional

valuenumber | nullOptional

minimumCycleTimeinteger | null · max: 43200000Optional

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

post

/sku

HTTPcURLJavaScriptPython

POST /api/sku HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 316

{
  "code": "text",
  "name": "text",
  "cycleTime": null,
  "specifications": [
    {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  ],
  "instructionsUrl": null,
  "lineSpeedTarget": null,
  "downtimeDurationThresholdMultiplier": null,
  "allowUseInQuickSchedule": true,
  "unitsPerMinute": null,
  "unitsPerHour": null,
  "batchSize": null,
  "value": null,
  "minimumCycleTime": null
}

{
  "isSuccess": true,
  "results": [
    {
      "code": "text",
      "name": "text",
      "specifications": null,
      "instructionsUrl": null,
      "accountId": "text",
      "downtimeDurationThresholdMultiplier": null,
      "allowUseInQuickSchedule": null,
      "cycleTime": null,
      "lineSpeedTarget": null,
      "unitsPerMinute": null,
      "unitsPerHour": null,
      "batchSize": null,
      "createdAt": null,
      "updatedAt": null,
      "value": null,
      "minimumCycleTime": null
    }
  ]
}

delete

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Path parameters

codestring · min: 1 · max: 32RequiredPattern: ^([a-zA-Z0-9.\\/-]+)$

Responses

204

204 No Content

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

delete

/sku/{code}

HTTPcURLJavaScriptPython

DELETE /api/sku/{code} HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

No content