/transportshapes/{transportShapeId}/products

Gate or ungate products on a TransportShape (sales or purchasing target). Body accepts { add?, remove?, target } and resolves the diff against the shape's current product list. Add-ids are validated against the tenant and capped at 100 unique ids per request; remove-ids are not validated (retry-safety). Concurrent modifications are detected via optimistic locking and retried automatically; a request that keeps conflicting returns 409 with internal code CONCURRENT_UPDATE and is safe to retry.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the transport shape to update

Body Params

Diff to apply to the shape's products list for the chosen target

Diff to apply to a TransportShape's products list. At least one of 'add' or 'remove' must be a non-empty array. Diff is applied add-then-remove, so an ID present in both is a no-op.

add
array of strings

Product IDs to gate onto the shape's product list for the chosen target. Validated against the tenant — unknown IDs return HTTP 400.

add
remove
array of strings

Product IDs to ungate from the shape's product list for the chosen target. Not validated — stale removes are idempotent no-ops, preserving retry-safety.

remove
string
enum
required

Which side of the shape's products map to mutate. 'sales' edits the outbound/sellable list; 'purchasing' edits the inbound/sourcing list.

Allowed:
Responses

400

Bad request — an add-id does not exist in the tenant, or the request references more than 100 unique add-ids

401

Unauthorized

404

Transport shape not found

409

Concurrent modification conflict — the shape kept changing while the update was retried. The error payload carries internal code CONCURRENT_UPDATE; the request had no effect and is safe to retry.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json