Products

Get Products

get

Returns a list of all products in your organization.

Authorizations

Bearer

AuthorizationstringRequired

Query parameters

cursorstringOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get/v2/products

HTTPcURLJavaScriptPython

GET /api/v2/products HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "external_id": "6009400032",
      "name": "text"
    }
  ],
  "metadata": {
    "next_cursor": "text"
  }
}

Get Product

get

Returns details for a specific product.

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

uuidstring · uuidRequired

Responses

200

Successful Response

application/json

uuidstring · uuidRequired

The UUID of the product.

external_idstringRequired

The identifier of the product in the ERP/MES.

Example: 6009400032

namestring · nullableRequired

An optional, more verbose name or description of the product.

422

Validation Error

application/json

get/v2/products/{uuid}

HTTPcURLJavaScriptPython

GET /api/v2/products/{uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "external_id": "6009400032",
  "name": "text"
}