Tillwire Read the guide
API reference

Supplier orders. 6 operations.

0 of them work. 6 are in the contract and not built yet. Each needs a bearer token with its scope. All operations.

Operations

GET/api/v1/supplier-orders/{id}supplier-orders.getsuppliers.readContract only

This operation is in the contract, and the engine refuses every call of it until it is built.

Parameters

idpathstring
idpathstring

Errors: 401, 403, 404, 405, 422, 429

curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/supplier-orders/{id}

GET/api/v1/supplier-orderssupplier-orders.listsuppliers.readContract only

This operation is in the contract, and the engine refuses every call of it until it is built.

Parameters

statequerystringOnly the supplier orders in this state: made, sent, accepted, shipped or cancelled.
supplierquerystringOnly the supplier orders of the supplier with this key.
orderqueryintegerOnly the supplier orders of the order with this number.
not_sentquerybooleanOnly the ones made whose send failed.
fromquerystringA day, yyyy-mm-dd: made on or after it.
toquerystringA day, yyyy-mm-dd: made before it.
limitqueryintegerThe most supplier orders in the page: 1 to 200; 50 when left out.
afterquerystringThe cursor of the page: the next of the page before; the first page when left out. The supplier orders follow it.

Errors: 401, 403, 405, 422, 429

curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/supplier-orders

POST/api/v1/orders/{number}/supplier-orderssupplier-orders.makesuppliers.writeContract only

This operation is in the contract, and the engine refuses every call of it until it is built.

Parameters

numberpathstring
numberpathstring
Idempotency-KeyheaderstringSee common parameters

Answer

array of SupplierOrder

Errors: 401, 403, 404, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/orders/{number}/supplier-orders

POST/api/v1/supplier-orders/{id}/sendsupplier-orders.sendsuppliers.writeContract only

This operation is in the contract, and the engine refuses every call of it until it is built.

Parameters

idpathstring
idpathstring
Idempotency-KeyheaderstringSee common parameters

Errors: 401, 403, 404, 405, 409, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/supplier-orders/{id}/send

POST/api/v1/supplier-orders/{id}/statesupplier-orders.set-statesuppliers.writeContract only

This operation is in the contract, and the engine refuses every call of it until it is built.

Parameters

idpathstring
idpathstring
Idempotency-KeyheaderstringSee common parameters

Errors: 401, 403, 404, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/supplier-orders/{id}/state

GET/api/v1/supplier-orders/to-sendsupplier-orders.to-sendsuppliers.readContract only

This operation is in the contract, and the engine refuses every call of it until it is built.

Errors: 401, 403, 405, 422, 429

curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/supplier-orders/to-send

Schemas 11

LineChoice

LineChoice is a buyer's answer on a cart line or an order line: the label the field had at the confirm, and the value. An order never changes it, and a privacy erasure of the buyer replaces a text value with the catalogue's word "erased".

keyrequiredstring
labelrequiredstring
valuerequiredstring
MakeSupplierOrdersRequest

MakeSupplierOrdersRequest makes and sends the supplier orders of one order, with a note for them (the button of ). It is Refused for an order that has them, is cancelled, or has no made-to-order line with a supplier.

noterequiredstring
SupplierDelivery

SupplierDelivery is where a supplier whose ShipsTo is buyer sends the goods: the buyer's delivery name, address and phone and nothing more. Absent for a supplier that ships to the store.

addressrequiredarray of string
namerequiredstring
phonerequiredstring
SupplierOrder

SupplierOrder is what the store sends one supplier for one order. Supplier and Emails are the copy made then.

deliverySupplierDelivery
dispatch_byrequiredstring
emailsrequiredarray of string
historyrequiredarray of SupplierOrderEvent
idrequiredinteger
linesrequiredarray of SupplierOrderLine
made_atrequiredstring (date-time)
not_sentrequiredboolean
noterequiredstring
numberrequiredstring
orderrequiredinteger
order_closedrequiredboolean
staterequiredstring
supplierrequiredstring
supplier_archivedrequiredboolean
supplier_namerequiredstring
updated_atrequiredstring (date-time)
updated_byrequiredstring
updated_by_namestring
SupplierOrderCount

SupplierOrderCount is how many supplier orders a supplier has in a state.

countrequiredinteger
staterequiredstring
SupplierOrderEvent

SupplierOrderEvent is a line of a supplier order's history: a state change or a send, with who, when, the note and the reference or the reason.

atrequiredstring (date-time)
byrequiredstring
by_namestring
fromrequiredstring
noterequiredstring
reasonrequiredstring
refrequiredstring
sentrequiredboolean
torequiredstring
SupplierOrderLine

SupplierOrderLine is a line of a supplier order: what the supplier makes. It holds no price.

choicesrequiredarray of LineChoice
optionsrequiredarray of string
quantityrequiredinteger
skurequiredstring
titlerequiredstring
SupplierOrderList

SupplierOrderList is a page of supplier orders, newest first, with the totals of all the filter holds.

nextrequiredstring
ordersrequiredarray of SupplierOrder
totalsrequiredSupplierOrderTotals
SupplierOrderStateRequest

SupplierOrderStateRequest changes a supplier order's state: From is the state the screen read, and a change at another state is Refused. State is accepted, shipped (Ref is optional, 0 to 120 characters) or cancelled (Reason is needed, 1 to 200 characters; SharedReason is what the supplier is told, 0 to 200, and "" tells none).

fromrequiredstring
reasonrequiredstring
refrequiredstring
shared_reasonrequiredstring
staterequiredstring
SupplierOrderTotals

SupplierOrderTotals count all the supplier orders a filter holds by state, not only the page.

by_staterequiredarray of SupplierOrderCount
countrequiredinteger
not_sentrequiredinteger
SupplierOrdersToSend

SupplierOrdersToSend is how many orders need their supplier orders sent: paid, or placed on cash on delivery or account terms, not cancelled or refunded in full, with a made-to-order line that has a supplier and no supplier order. Home shows the line when Orders is above 0.

ordersrequiredinteger

Made from engine/internal/openapi/openapi.json at commit 6c4cbd921. The contract-only operations come from the engine’s stub file, engine/internal/ops.