v1API ReferenceSKUs

Create SKUs

Required scope: skus.create.

Create one or many SKUs. The body is a JSON array, even for a single record.

Only sku (the product code) is required; unit defaults to units and archived to false.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A JSON array. Each item has these fields:

Response Body

application/json

application/json

application/json

application/json

application/json

Try it live
POST
/v1/skus

This endpoint requires authentication — paste a token in the Authorization section below.

curl -X POST "https://example.com/v1/skus" \  -H "Content-Type: application/json" \  -d '[    {      "sku": "string"    }  ]'
[  {    "id": "36f7b519-d93e-4ec8-8245-7f4b8c123456",    "company": {      "id": 1,      "name": "Company 1"    },    "sku": "sku 1",    "name": "sku 1",    "description": "sku 1",    "unit": "pcs",    "archived": false,    "createdAt": "2024-01-01T00:00:00.000Z",    "updatedAt": "2024-01-01T00:00:00.000Z",    "deletedAt": "2024-01-02T00:00:00.000Z"  }]

Delete a work order DELETE

Delete a work order. The delete is soft: production logs that reference the work order keep their history, and creating a work order with the same name later restores it.

Search SKUs POST

Search the product catalog, or page through it with {}. The filters are separate rather than one combined search: skus matches the SKU code and also accepts include / exclude by id, while names, description and unit are each their own fuzzy filter. Archived SKUs are part of the catalog and are not excluded automatically.