/products/update

Update one catalogue product. Put the SKU in code on the JSON body, not in the URL, so values like BLUE+RED5 are not mangled.

Send only the fields you want to change. At least one writable field is required, otherwise you get 400 validation_error. Fields you leave out keep their current values.

This writes a product change log row per changed field, linked to the API key that made the call.

Prefer this over PUT /products/{code} whenever the SKU contains +, spaces, or other reserved characters.

Catalogue scoping

Every API key is granted one or more catalogues. A product is identified by code within a catalogue.

API key reaches	What to send	If you omit it
One catalogue	Nothing, it is inferred	Fine
More than one catalogue	`catalogue_uid`	`400 catalogue_required`

catalogue_id still works as a fallback. A uid the key cannot reach returns 404 catalogue_not_found.

What cannot change

code identifies the product and cannot be renamed here. A product cannot be moved between catalogues. id, created_at and updated_at are ignored. Unknown field names are ignored.

Stock and price example:

{
  "catalogue_uid": "demo-catalogue",
  "code": "BLUE+RED5",
  "soh": 12,
  "retail_price": 199.99
}

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Body Params application/jsonRequired

Example

{
    "catalogue_uid": "demo-catalogue",
    "code": "BLUE+RED5",
    "soh": 12,
    "retail_price": 199.99,
    "title": "Blue/red widget"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Catalogue scoping#

What cannot change#

Request

Request Code Samples

Responses

Catalogue scoping

What cannot change