Skip to content
Get started

Suppliers

List Suppliers
suppliers.list_suppliers(SupplierListSuppliersParams**kwargs) -> SyncCursorPage[SupplierListSuppliersResponse]
GET/api/v2/public/suppliers
ModelsExpand Collapse
class SupplierListSuppliersResponse: …

A supplier as returned by the public v2 suppliers list.

allow_create_receipt: bool

true when store staff can raise a receipt against this supplier without an order.

is_direct_vendor: bool

true when the supplier delivers straight to the store instead of through a distribution centre.

city: Optional[str]

City the supplier is registered in.

country_region_id: Optional[str]

Country or region the supplier is registered in.

name: Optional[str]

Display name of the supplier.

reason_code: Optional[int]

Default reason code for movements booked against this supplier, or null when there is none. Look the code up through the reason codes endpoint.

formatint32
supplier_code: Optional[str]

The supplier’s code in the source system. The order, delivery and receipt endpoints expect this value, and suppliers are matched on it when created or updated.