List Suppliers

suppliers.list_suppliers() -> SyncCursorPage[SupplierListSuppliersResponse]

GET/api/v2/public/suppliers

Suppliers for the organisation, ordered by supplier code. Deleted suppliers are not returned. Use it to find the supplier_code values the order, delivery and receipt endpoints expect.

ParametersExpand Collapse

page_size: Optional[int]

Number of suppliers per page. Defaults to 10.

formatint32

page_start: Optional[int]

Page number, starting at 1. Defaults to 1.

formatint32

search_text: Optional[str]

Case-insensitive search in supplier code, name, country/region and city.

ReturnsExpand 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.

List Suppliers

import os
from colleqtive_sdk import Colleqtive

client = Colleqtive(
    bearer_token=os.environ.get("COLLEQTIVE_BEARER_TOKEN"),  # This is the default and can be omitted
)
page = client.suppliers.list_suppliers()
page = page.list[0]
print(page.country_region_id)

{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "allow_create_receipt": true,
      "is_direct_vendor": true,
      "city": "city",
      "country_region_id": "country_region_id",
      "name": "name",
      "reason_code": 0,
      "supplier_code": "supplier_code"
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 0,
  "previous_page": 0,
  "project_last_modified_date": "project_last_modified_date",
  "scroll_id": "scroll_id",
  "server_time": "server_time",
  "sort_column": "sort_column",
  "sort_order": "sort_order",
  "task_last_modified_date": "task_last_modified_date"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}

Returns Examples

{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "allow_create_receipt": true,
      "is_direct_vendor": true,
      "city": "city",
      "country_region_id": "country_region_id",
      "name": "name",
      "reason_code": 0,
      "supplier_code": "supplier_code"
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 0,
  "previous_page": 0,
  "project_last_modified_date": "project_last_modified_date",
  "scroll_id": "scroll_id",
  "server_time": "server_time",
  "sort_column": "sort_column",
  "sort_order": "sort_order",
  "task_last_modified_date": "task_last_modified_date"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}