Sku

get

Authorizations

Query parameters

skucodesany ofOptional

stringOptional

or

string[]Optional

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

HTTPcURLJavaScriptPython

GET /api/sku HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Accept: */*

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

post

Authorizations

Body

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

namestring · min: 1 · max: 128Required

cycleTimenumber | nullableOptional

specificationsany of | nullableOptional

or

instructionsUrlstring · uri | nullableOptional

lineSpeedTargetnumber | nullableOptional

downtimeDurationThresholdMultipliernumber | nullableOptional

allowUseInQuickSchedulebooleanOptionalDefault: true

unitsPerMinuteinteger | nullableOptional

unitsPerHourinteger | nullableOptional

batchSizenumber | nullableOptional

valuenumber | nullableOptional

minimumCycleTimeinteger | nullableOptional

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

HTTPcURLJavaScriptPython

POST /api/sku HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 309

{
  "code": "text",
  "name": "text",
  "cycleTime": 1,
  "specifications": [
    {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  ],
  "instructionsUrl": "https://example.com",
  "lineSpeedTarget": 1,
  "downtimeDurationThresholdMultiplier": 1,
  "allowUseInQuickSchedule": true,
  "unitsPerMinute": 1,
  "unitsPerHour": 1,
  "batchSize": 1,
  "value": 1,
  "minimumCycleTime": 1
}

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

post

Authorizations

Body

codestringRequired

namestringRequired

specificationsstring | nullableOptional

instructionsUrlstring | nullableOptional

accountIdstringRequired

downtimeDurationThresholdMultipliernumber | nullableOptional

allowUseInQuickScheduleboolean | nullableOptional

cycleTimenumber | nullableOptional

lineSpeedTargetnumber | nullableOptional

unitsPerMinutenumber | nullableOptional

unitsPerHournumber | nullableOptional

batchSizenumber | nullableOptional

valuenumber | nullableOptional

minimumCycleTimenumber | nullableOptional

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

HTTPcURLJavaScriptPython

POST /api/sku/bulk HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 285

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

{
  "isSuccess": true,
  "result": {
    "updatedSkus": [
      {
        "errors": [
          {
            "message": "text",
            "field": "text"
          }
        ],
        "index": 1,
        "sku": {
          "code": "text",
          "name": "text",
          "specifications": "text",
          "instructionsUrl": "text",
          "accountId": "text",
          "downtimeDurationThresholdMultiplier": 1,
          "allowUseInQuickSchedule": true,
          "cycleTime": 1,
          "lineSpeedTarget": 1,
          "unitsPerMinute": 1,
          "unitsPerHour": 1,
          "batchSize": 1,
          "createdAt": "text",
          "updatedAt": "text",
          "value": 1,
          "minimumCycleTime": 1
        }
      }
    ],
    "errorSkus": [
      {
        "errors": [
          {
            "message": "text",
            "field": "text"
          }
        ],
        "index": 1,
        "sku": {
          "code": "text",
          "name": "text",
          "specifications": "text",
          "instructionsUrl": "text",
          "accountId": "text",
          "downtimeDurationThresholdMultiplier": 1,
          "allowUseInQuickSchedule": true,
          "cycleTime": 1,
          "lineSpeedTarget": 1,
          "unitsPerMinute": 1,
          "unitsPerHour": 1,
          "batchSize": 1,
          "createdAt": "text",
          "updatedAt": "text",
          "value": 1,
          "minimumCycleTime": 1
        }
      }
    ]
  }
}

delete

Authorizations

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

HTTPcURLJavaScriptPython

DELETE /api/sku/{code} HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

get

Authorizations

Responses

200

200 OK

text/csv

Responsestring

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

HTTPcURLJavaScriptPython

GET /api/sku/csv HTTP/1.1
Host: qa.eu-west-2-2.busroot.opind.co
X-API-KEY: YOUR_API_KEY
Accept: */*

text