Distributor - Get

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

GET /distributor/get

Distributor - Get

cURL

curl --request GET \
  --url https://api.skulabs.com/distributor/get \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "name": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "active": true,
    "address": {
      "street": "<string>",
      "street_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "country": "<string>"
    },
    "terms": "<string>",
    "shipping": "<string>",
    "memo": "<string>",
    "items": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "item_id": "507f1f77bcf86cd799439011",
        "cost": 123,
        "quantity": 123,
        "minimum_quantity": 123,
        "lot_quantity": 123,
        "part_number": "<string>",
        "reorder_point": 123,
        "reorder_rule": "<string>",
        "notes": "<string>"
      }
    ],
    "location_id": "507f1f77bcf86cd799439011",
    "default_billing_profile_id": "507f1f77bcf86cd799439011"
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

selector · object · required

Query selector object for filtering results

limit · number

Max results to return

Example:

50

skip · number

Number of results to skip

Example:

0

sort · object

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

fields · object

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

Response

200

application/json

Array of suppliers matching the query

_id · string · required

Unique supplier identifier

Example:

"507f1f77bcf86cd799439011"

name · string · required

Supplier name

phone · string | null

Supplier phone number

email · string | null

Supplier email address

active · boolean

Whether the supplier is active

address · object

Supplier address

Show child attributes

terms · string | null

Default payment terms

shipping · string | null

Default shipping method

memo · string | null

Default memo for purchase orders

items · object[]

Items supplied by this supplier

Show child attributes

location_id · string

Default location ID for this supplier

Example:

"507f1f77bcf86cd799439011"

default_billing_profile_id · string | null

Billing profile purchase orders for this supplier are issued under

Example:

"507f1f77bcf86cd799439011"