API reference

Suppliers. 5 operations.

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

Operations

POST/api/v1/suppliers/{key}/archivesuppliers.archivesuppliers.writeContract only

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

Parameters

`key`path	string
`key`path	string
`Idempotency-Key`header	stringSee common parameters

Request body

ArchiveSupplierRequest

Answer

Supplier

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

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/suppliers/{key}/archive

POST/api/v1/suppliers/{key}/deletesuppliers.deletesuppliers.writeContract only

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

Parameters

`key`path	string
`key`path	string
`Idempotency-Key`header	stringSee common parameters

Answer

Deletion

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

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/suppliers/{key}/delete

GET/api/v1/suppliers/{key}suppliers.getsuppliers.readContract only

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

Parameters

`key`path	string
`key`path	string

Answer

SupplierDetail

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

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

GET/api/v1/supplierssuppliers.listsuppliers.readContract only

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

Parameters

`archived`query	booleanOnly the archived suppliers; the live ones when left out.
`q`query	stringThe words to search the suppliers for: a name, a key, an email.
`limit`query	integerThe most suppliers in the page: 1 to 200; 50 when left out.
`after`query	stringThe cursor of the page: the next of the page before; the first page when left out. The suppliers follow it.

Answer

SupplierList

Errors: 401, 403, 405, 422, 429

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

POST/api/v1/supplierssuppliers.savesuppliers.writeContract only

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

Parameters

Idempotency-Keyheader stringSee common parameters

Request body

SupplierRequest

Answer

Supplier

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

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/suppliers

Schemas 8

ArchiveSupplierRequest

ArchiveSupplierRequest archives a supplier, or brings it back.

archivedrequired boolean

Deletion

Deletion is what a delete deleted: the slug of the category, the collection or the content page that is gone, or the name of the image.

deletedrequired string

Supplier

Supplier is a business that makes or sends goods for the store. It is not the store's own supplier details on the tax invoice.

`archived`required	boolean
`contact`required	string
`emails`required	array of string
`key`required	string
`name`required	string
`note`required	string
`open_orders`required	integer
`phone`required	string
`revision`required	integer
`send_by`required	string
`ships_to`required	string

SupplierChange

SupplierChange is a line of a supplier's history: who changed what, and when.

`at`required	string (date-time)
`by`required	string
`by_name`	string
`summary`required	string

SupplierDetail

SupplierDetail is a supplier with its history and its supplier orders counted by state (suppliers.get).

`history`required	array of SupplierChange
`orders`required	array of SupplierOrderCount
`supplier`required	Supplier

SupplierList

SupplierList is a page of suppliers, with how many the filter holds in all.

`count`required	integer
`next`required	string
`suppliers`required	array of Supplier

SupplierOrderCount

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

`count`required	integer
`state`required	string

SupplierRequest

SupplierRequest makes a supplier, or changes the one with the same Key, at Revision (0 to make; a stale revision is Refused). It sets every part given here.

`contact`required	string
`emails`required	array of string
`key`required	string
`name`required	string
`note`required	string
`phone`required	string
`revision`required	integer
`send_by`required	string
`ships_to`required	string

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