Skip to main content
PATCH
Update a vendor relationship

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

Idempotency-Key
string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Path Parameters

id
string<uuid>
required
pvid
string<uuid>
required

Body

application/json

Allowlist PATCH: supply only the fields to change. Only the fields whose meaning is easy to get wrong are named here.

order_multiple
integer | null

REORDER-BUYER-TRUTH decision D-7 (2026-09-22). The vendor purchase INCREMENT (case / pack qty) for this product from this vendor. Null means not configured, which is every row that existed before the field. DISTINCT FROM min_order_qty, which is a FLOOR you may exceed by any amount: the multiple is a STEP you must land on. A vendor minimum of 300 lets you buy 301; a multiple of 300 does not. Applied as the LAST round-up on the FINAL suggested quantity, ROUNDING UP ONLY. 1 is legal and is a no-op, so ordering in 1s stays distinguishable from not set. A value below 1, or a non-integer, returns 400 invalid_field with param: order_multiple; the same rule is enforced by the database CHECK product_vendors_order_multiple_positive.

Required range: x >= 1

Response

Updated vendor relationship

The stored product-vendor row, every column of it. Only the fields whose meaning is easy to get wrong are named here.

order_multiple
integer | null

REORDER-BUYER-TRUTH decision D-7 (2026-09-22). The vendor purchase INCREMENT (case / pack qty) for this product from this vendor. Null means not configured, which is every row that existed before the field. DISTINCT FROM min_order_qty, which is a FLOOR you may exceed by any amount: the multiple is a STEP you must land on. A vendor minimum of 300 lets you buy 301; a multiple of 300 does not. Applied as the LAST round-up on the FINAL suggested quantity, ROUNDING UP ONLY. 1 is legal and is a no-op, so ordering in 1s stays distinguishable from not set. A value below 1, or a non-integer, returns 400 invalid_field with param: order_multiple; the same rule is enforced by the database CHECK product_vendors_order_multiple_positive.

Required range: x >= 1