Create or update price list

POST/api/prices/lists

Creates a new price list or updates an existing one for the current workspace.

Request Body

application/json

Request payload for Create or update price list.

id?|

Existing price list identifier when updating a saved list.

name*string

Price list name shown to users.

Example"Distributor Pricing"

customers?array<>|

Customer identifiers explicitly assigned to the price list.

enabled?|

Whether the price list should be active after save.

description?|

Optional internal description for the price list.

status*string

Lifecycle status to persist for the price list.

Value in"enabled" | "disabled" | "archived"

Example"enabled"

fallbackToPriceListId?|

Fallback price list identifier used when a product is missing a direct row.

isForAll?|

Whether the price list should apply to all customers.

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/prices/lists" \  -H "Content-Type: application/json" \  -d '{    "name": "Distributor Pricing",    "status": "enabled"  }'

{
  "success": true
}

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

{
  "_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 price 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`