API Reference

Update a purchase order (only the fields sent; optimistic version); 200 unchanged when nothing differs

patch
https://apis.kentro.live/channel/v1/purchase-orders/

Scope: purchase-orders:write, channel:write or admin.

Idempotency: send Idempotency-Key; a retry with the same key replays the first answer.

Rate limit: write class, 1,200 requests per minute per tenant by default (read class 6,000). Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; a refusal is 429 rate_limited with Retry-After.

Path Params
string
required
length between 1 and 300

The uuid, a legacy 24-hex id, or ext:: (URL-encoded).

Body Params
string
length between 1 and 64

The version this change was based on; stale is 409 version_conflict.

length between 1 and 100
Schema_aee7e11aee | null
Schema_d20f0a8786 | null
length between 1 and 100
length between 1 and 100
length between 1 and 255
length between 1 and 100
length between 1 and 255
Schema_9a7a6f6798 | null
Schema_9a7a6f6798 | null
items
array of objects
length between 1 and 1000
items
string
length between 1 and 100
product
object
string
length between 1 and 100

The retailer's item code, kept when the product does not resolve.

string
length between 1 and 255

Kept when the product does not resolve; a product line takes the product name.

integer
required
0 to 1000000
required
length ≤ 24
^[0-9]{1,14}(\.[0-9]{1,8})?$

A non-negative decimal amount in currency units ("12.50"); numbers are accepted.

length ≤ 24
^[0-9]{1,14}(\.[0-9]{1,8})?$

A non-negative decimal amount in currency units ("12.50"); numbers are accepted.

discounts
array of objects
length ≤ 50
discounts
boolean
string
length ≤ 10000
metadata
object

Keys 1 to 100 characters, values up to 1000.

totals
object

Recomputed by the server: subtotal from the lines, total from subtotal + shipping + salesTax + dutyTax + vat - discount. A mismatch is 422 totals_mismatch with the computed values.

discounts
array of objects
length ≤ 50
discounts
Schema_aee7e11aee | null
Schema_aee7e11aee | null
Schema_aee7e11aee | null
length between 1 and 100
integer
0 to 3650
length between 1 and 255
length between 1 and 255
Schema_512cb94789 | null
metadata
object

Merged by key; a null value removes the key.

length ≤ 10000
Headers
string
length between 7 and 50

Any string of 7 to 50 characters that identifies this request (an order number, a webhook id). A retry with the same key and the same body answers the first result with Idempotent-Replayed: true; the same key with a different body is 422 idempotency_key_reused; a concurrent request with the same key is 409 in_progress with Retry-After. Recommended on every write.

Responses

Updated about 2 hours ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 hours ago

Did this page help you?