List Suppliers

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.

Query ParametersExpand Collapse

page_size: optional number

Number of suppliers per page. Defaults to 10.

formatint32

page_start: optional number

Page number, starting at 1. Defaults to 1.

formatint32

search_text: optional string

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

ReturnsExpand Collapse

page_size: number

Maximum number of items returned per page.

formatint32

page_start: number

Current page number (1-based).

formatint32

total_count: number

Total number of records matching the query across all pages.

formatint64

list: optional array of object { allow_create_receipt, is_direct_vendor, city, 4 more }

Collection of items for the current page.

allow_create_receipt: boolean

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

is_direct_vendor: boolean

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

city: optional string

City the supplier is registered in.

country_region_id: optional string

Country or region the supplier is registered in.

name: optional string

Display name of the supplier.

reason_code: optional number

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 string

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_body: optional map[unknown]

Additional body-level metadata for the list.

list_filters: optional map[array of string]

Active filter criteria applied to the result set, keyed by field name.

next_page: optional number

Next page number, or null when on the last page.

formatint32

previous_page: optional number

Previous page number, or null when on the first page.

formatint64

project_last_modified_date: optional string

Last modified date/time of the project.

scroll_id: optional string

Opaque scroll identifier for deep-pagination scenarios.

server_time: optional string

Server UTC date/time when the response was generated.

sort_column: optional string

Column name the results are sorted by.

sort_order: optional string

Sort direction (asc or desc).

task_last_modified_date: optional string

Last modified date/time of the task.

List Suppliers

curl https://api.colleqtive.net/api/v2/public/suppliers \
    -H "Authorization: $COLLEQTIVE_BEARER_TOKEN"

{
  "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."
}