v1

latestOpenAPI 3.0.32026-07-13149852.3 MB

distributor

Distributor - Get

Retrieve a paginated list of distributors (suppliers/vendors).

get/distributor/get

Query parameters

selectorobject required

Query selector object for filtering results

limitnumber

Max results to return

Example:50

skipnumber

Number of results to skip

sortobject

Sort fields object, e.g. { "name": 1 }

fieldsobject

Projection fields object, e.g. { "name": 1 }

Response

Array of suppliers matching the query

_idstring required

Unique supplier identifier

namestring required

Supplier name

phonestring nullable

Supplier phone number

emailstring nullable

Supplier email address

activeboolean

Whether the supplier is active

termsstring nullable

Default payment terms

shippingstring nullable

Default shipping method

memostring nullable

Default memo for purchase orders

location_idstring

Default location ID for this supplier

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "items": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "item_id": "507f1f77bcf86cd799439011"
      }
    ],
    "location_id": "507f1f77bcf86cd799439011"
  }
]