Create or update product list

POST/api/product-lists

Creates a new product list or updates an existing one in the current workspace.

Request Body

application/json

Request payload for Create or update product list.

TypeScript Definitions

Use the request body type in TypeScript.

id?|

Existing product list id when updating.

name*string

Human-readable product list name.

Length1 <= length

data*

visibility?|

Visibility scope for the product list.

Response Body

`application/json`

curl -X POST "https://example.com/api/product-lists" \  -H "Content-Type: application/json" \  -d '{    "name": "Fertilizers",    "data": {      "items": [        {          "productId": "product_123",          "quantity": 0        }      ]    }  }'

{  "id": "list_123",  "name": "Fertilizers",  "data": {    "items": [      {        "productId": "product_123",        "quantity": 0,        "unitCode": "unit"      }    ],    "note": "Summer bundle",    "imageFileId": "file_123"  },  "visibility": "organisation",  "createdBy": "workspace_user_123",  "workspaceId": "ws_123",  "createdAt": "2026-03-20T12:00:00.000Z",  "updatedAt": "2026-03-20T12:05:00.000Z",  "imageUrl": "https://files.recerc.test/file_123"}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Create or update product list

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`