Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-211931021.7 MB
Suppliers

List all Suppliers

Filtering

This endpoint supports result filtering. For more information on how to filter this request, go here.

OAuth Scope

This endpoint requires the following OAuth scope read_suppliers.

get/supplier.json

Response

An array of Suppliers

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

namestring

The name of the supplier company

business_numberstring

Business registration number (e.g., ABN, EIN)

addressstring

Physical address of the supplier store

emailstring email

Primary contact email address

phonestring

Primary contact phone number

account_numberstring

Your account number with this supplier

lngnumber float

Longitude coordinate of the supplier's address (Read only)

latnumber float

Latitude coordinate of the supplier's address (Read only)

geo_is_valid0 | 1

Whether the geocoded coordinates are valid (Read only). Valid values are [0,1]

geo_countrystring

Country from geocoded address (Read only)

geo_postcodestring

Postcode from geocoded address (Read only)

geo_statestring

State from geocoded address (Read only)

geo_citystring

City from geocoded address (Read only)

geo_streetstring

Street name from geocoded address (Read only)

geo_numberstring

Street number from geocoded address (Read only)

Example response

[
  {
    "uuid": "123e4567-795b-4d35-b3f2-23f94676197b",
    "edit_date": "2026-03-01 12:00:00"
  }
]