vendors
Vendors module · 6 operations
List vendor rows
GET/vendors
An organization in the vendor relationship with this org, with its counterparty type. Returns a cursor page of vendor rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
Create a vendor
POST/vendors
An organization in the vendor relationship with this org, with its counterparty type. Creates a vendor. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
Get a vendor
GET/vendors/{id}
An organization in the vendor relationship with this org, with its counterparty type. Returns one vendor with its `ETag`. A vendor the caller may not see returns 404.
Update a vendor
PATCH/vendors/{id}
An organization in the vendor relationship with this org, with its counterparty type. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
Delete a vendor
DELETE/vendors/{id}
An organization in the vendor relationship with this org, with its counterparty type. Soft-deletes the vendor: it moves to Trash and can be restored for its table's retention period.
Transition the vendor state
POST/vendors/{id}/transitions
Moves the vendor lifecycle to another state through its transition RPC, which writes the transition ledger. Uses compare-and-set on `expected_state`; a disallowed transition returns a 422 refusal. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.