NutraSoft food manufacturing ERP software
Esc
  • GuideGetting startedThree steps to your first call and your first order, then the two shapes every response takes.
  • GuideAuthentication and keysBearer keys, test and live environments, rotation without an outage, and what each scope grants.
  • GuideTest modeA second NutraSoft account of your own, seeded with realistic data, that you can safely break.
  • PageErrorsEvery error code the API returns, what it means, what to do about it and whether to retry.
  • PageConventionsThe rules every operation follows: money, time, paging, sorting, nulls, PATCH and identifiers.
Menu

Customer types

The categories you group customers into.

sales:readhttps://public-api.nutrasoft.ca/v1
Linked fromCustomerscustomer_type_id

The Customer type object

  • idinteger
  • codestring
  • descriptionstringnullable
  • namestringnullable

Operations

List customer types

get/customer-typessales:read

The types a customer can be classified under.

Query parameters

  • searchstringnullable

    Free-text match on code, name or description.

  • namestringnullable

    Partial match on the name.

  • sortstringnullable

    Comma-separated field:direction pairs, e.g. id:desc. Sortable: code, id, name. 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
Returns
200 A page of CustomerType objects in data, with pagination.
Errors
400 401 403 429 500 503
GET /customer-types
curl "https://public-api.nutrasoft.ca/v1/customer-types?limit=50" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"
Response200
{
  "data": [
    {
      "id": 123,
      "code": "SAMPLE-01",
      "description": "string",
      "name": "Sample name"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "has_more": false
  },
  "order": "id:asc"
}

Retrieve a customer type

get/customer-types/{customer_type_id}sales:read

Path parameters

  • customer_type_idintegerrequired

    The customer type's id.

    • > 0
Returns
200 One CustomerType object in data.
Errors
400 401 403 404 429 500 503
GET /customer-types/{customer_type_id}
curl "https://public-api.nutrasoft.ca/v1/customer-types/123" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"
Response200
{
  "data": {
    "id": 123,
    "code": "SAMPLE-01",
    "description": "string",
    "name": "Sample name"
  }
}