Suppliers

The companies you buy from, with their approval status.

purchasing:readpurchasing:writehttps://public-api.nutrasoft.ca/v1

Linked fromPurchase orderssupplier_id Billssupplier_id Productsmaterial.supplier_ids

The Supplier object

idinteger
activeboolean
addressobject
ShowHide 5 fields of address
- citystringnullable
- line1stringnullable
- line2stringnullable
- postal_codestringnullable
- statestringnullable
approval_expirystringnullable
- UTC timestamp
approval_statusstringnullable
Computed when read: an approval whose expiry has passed reads as PENDING.
- one ofPENDINGAPPROVEDREJECTEDSUSPENDED
certification_expires_onstringnullable
- date YYYY-MM-DD
certification_schemestringnullable
NONE means the supplier holds none; null means not recorded.
- one ofSQFBRCGSFSSC22000IFSGLOBALGAPPRIMUSGFSCANADAGAPOTHERNONE
companystringnullable
contact_namestringnullable
created_atstringnullable
- UTC timestamp

Show 5 more attributes

emailstringnullable
phonestringnullable
supplier_codestringnullable
updated_atstringnullable
- UTC timestamp
websitestringnullable

Operations

List suppliers

get/supplierspurchasing:read

approval_status is computed when read, so an expired approval never reads as APPROVED. Use search or the named filters, not both.

Query parameters

supplier_codestringnullable
Partial match.
companystringnullable
Partial match.
emailstringnullable
Partial match.
activebooleannullable
searchstringnullable
Free-text match.
sortstringnullable
Comma-separated field:direction pairs, e.g. id:desc. Sortable: company, created_at, id, supplier_code, updated_at. id is always added last, so paging is stable.
limitinteger
Rows to return. Maximum 200.
- >= 1
- <= 200
- default 50
offsetinteger
Rows to skip. Maximum 10000: to read further, narrow the filters or page with updated_since.
- >= 0
- <= 10000
- default 0
updated_sincestringnullable
Only rows changed after this instant, as an ISO 8601 timestamp; without an offset it is read as UTC. Tracks the record itself, not its child rows, and deletions are not reported, so reconcile by re-listing from time to time.
- UTC timestamp

Returns

200 A page of Supplier objects in data, with pagination.

Errors

400 401 403 429 500 503

GET /suppliers

curl "https://public-api.nutrasoft.ca/v1/suppliers?limit=50" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"

Response200

{
  "data": [
    {
      "id": 123,
      "active": true,
      "address": {
        "city": "Montreal",
        "line1": "123 Example Street",
        "line2": "Suite 200",
        "postal_code": "H4S 2C1",
        "state": "QC"
      },
      "approval_expiry": "2026-09-10T14:30:00Z",
      "approval_status": "PENDING",
      "certification_expires_on": "2026-09-10",
      "certification_scheme": "SQF",
      "company": "Example Foods Inc.",
      "contact_name": "Alex Martin",
      "created_at": "2026-09-10T14:30:00Z",
      "email": "orders@example.com",
      "phone": "+1-514-555-0100",
      "supplier_code": "SAMPLE-01",
      "updated_at": "2026-09-10T14:30:00Z",
      "website": "https://example.com"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "has_more": false
  },
  "order": "id:asc"
}

Retrieve a supplier

get/suppliers/{supplier_id}purchasing:read

Path parameters

supplier_idintegerrequired
The supplier's id.
- > 0

Returns

200 One Supplier object in data.

Errors

400 401 403 404 429 500 503

GET /suppliers/{supplier_id}

curl "https://public-api.nutrasoft.ca/v1/suppliers/123" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"

Response200

{
  "data": {
    "id": 123,
    "active": true,
    "address": {
      "city": "Montreal",
      "line1": "123 Example Street",
      "line2": "Suite 200",
      "postal_code": "H4S 2C1",
      "state": "QC"
    },
    "approval_expiry": "2026-09-10T14:30:00Z",
    "approval_status": "PENDING",
    "certification_expires_on": "2026-09-10",
    "certification_scheme": "SQF",
    "company": "Example Foods Inc.",
    "contact_name": "Alex Martin",
    "created_at": "2026-09-10T14:30:00Z",
    "email": "orders@example.com",
    "phone": "+1-514-555-0100",
    "supplier_code": "SAMPLE-01",
    "updated_at": "2026-09-10T14:30:00Z",
    "website": "https://example.com"
  }
}

Create a supplier

post/supplierspurchasing:write

supplier_code is unique within your account; a duplicate is a 409. A new supplier starts PENDING approval, which is decided in NutraSoft. Not idempotent.

Request body

companystringrequired
Trading name.
- min 1 chars
- max 100 chars
supplier_codestringrequired
Your code for this supplier, unique within your account.
- min 1 chars
- max 40 chars
activeboolean
An inactive supplier is kept but not offered on new documents.
- default true
addressobjectnullable
ShowHide 5 fields of address
- citystringnullable
  - max 100 chars
- line1stringnullable
  - max 100 chars
- line2stringnullable
  - max 100 chars
- postal_codestringnullable
  Postal or ZIP code.
  - max 20 chars
- statestringnullable
  Province or state. Free text.
  - max 100 chars
contact_namestringnullable
- max 100 chars
emailstringnullable
- max 254 chars
phonestringnullable
- max 50 chars
websitestringnullable
- max 255 chars

Returns

201 One Supplier object in data.

Errors

400 401 403 409 429 500 503

POST /suppliers

curl -X POST "https://public-api.nutrasoft.ca/v1/suppliers" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "company": "Example Foods Inc.",
  "supplier_code": "SAMPLE-01"
}'

Response201

{
  "data": {
    "id": 123,
    "active": true,
    "address": {
      "city": "Montreal",
      "line1": "123 Example Street",
      "line2": "Suite 200",
      "postal_code": "H4S 2C1",
      "state": "QC"
    },
    "approval_expiry": "2026-09-10T14:30:00Z",
    "approval_status": "PENDING",
    "certification_expires_on": "2026-09-10",
    "certification_scheme": "SQF",
    "company": "Example Foods Inc.",
    "contact_name": "Alex Martin",
    "created_at": "2026-09-10T14:30:00Z",
    "email": "orders@example.com",
    "phone": "+1-514-555-0100",
    "supplier_code": "SAMPLE-01",
    "updated_at": "2026-09-10T14:30:00Z",
    "website": "https://example.com"
  }
}

Update a supplier

patch/suppliers/{supplier_id}purchasing:write

Omitted fields are left unchanged. address is replaced as a whole. Approval and certification are not writable.

Path parameters

supplier_idintegerrequired
The supplier's id.
- > 0

Request body

activebooleannullable
addressobjectnullable
ShowHide 5 fields of address
- citystringnullable
  - max 100 chars
- line1stringnullable
  - max 100 chars
- line2stringnullable
  - max 100 chars
- postal_codestringnullable
  Postal or ZIP code.
  - max 20 chars
- statestringnullable
  Province or state. Free text.
  - max 100 chars
companystringnullable
- min 1 chars
- max 100 chars
contact_namestringnullable
- max 100 chars
emailstringnullable
- max 254 chars
phonestringnullable
- max 50 chars
supplier_codestringnullable
- min 1 chars
- max 40 chars
websitestringnullable
- max 255 chars

Returns

200 One Supplier object in data.

Errors

400 401 403 404 409 429 500 503

PATCH /suppliers/{supplier_id}

curl -X PATCH "https://public-api.nutrasoft.ca/v1/suppliers/123" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "active": true
}'

Response200

{
  "data": {
    "id": 123,
    "active": true,
    "address": {
      "city": "Montreal",
      "line1": "123 Example Street",
      "line2": "Suite 200",
      "postal_code": "H4S 2C1",
      "state": "QC"
    },
    "approval_expiry": "2026-09-10T14:30:00Z",
    "approval_status": "PENDING",
    "certification_expires_on": "2026-09-10",
    "certification_scheme": "SQF",
    "company": "Example Foods Inc.",
    "contact_name": "Alex Martin",
    "created_at": "2026-09-10T14:30:00Z",
    "email": "orders@example.com",
    "phone": "+1-514-555-0100",
    "supplier_code": "SAMPLE-01",
    "updated_at": "2026-09-10T14:30:00Z",
    "website": "https://example.com"
  }
}

Delete a supplier

delete/suppliers/{supplier_id}purchasing:write

A supplier that was ever ordered from or billed is deactivated, not deleted: active becomes false and its documents and stock are kept. Only a supplier with no purchasing history is removed. Check active on the response to see which happened.

Path parameters

supplier_idintegerrequired
The supplier's id.
- > 0

Returns

200 One Supplier object in data.

Errors

400 401 403 404 409 429 500 503

DELETE /suppliers/{supplier_id}

curl -X DELETE "https://public-api.nutrasoft.ca/v1/suppliers/123" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"

Response200

{
  "data": {
    "id": 123,
    "active": true,
    "address": {
      "city": "Montreal",
      "line1": "123 Example Street",
      "line2": "Suite 200",
      "postal_code": "H4S 2C1",
      "state": "QC"
    },
    "approval_expiry": "2026-09-10T14:30:00Z",
    "approval_status": "PENDING",
    "certification_expires_on": "2026-09-10",
    "certification_scheme": "SQF",
    "company": "Example Foods Inc.",
    "contact_name": "Alex Martin",
    "created_at": "2026-09-10T14:30:00Z",
    "email": "orders@example.com",
    "phone": "+1-514-555-0100",
    "supplier_code": "SAMPLE-01",
    "updated_at": "2026-09-10T14:30:00Z",
    "website": "https://example.com"
  }
}