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

Production lines

The lines a production run is scheduled on.

manufacturing:readmanufacturing:writehttps://public-api.nutrasoft.ca/v1
Links toWarehouseswarehouse_id
Linked fromProductionsproduction_line_id

The Production line object

  • idinteger
  • descriptionstringnullable
  • namestring
  • warehouse_idintegernullable

Operations

List production lines

get/production-linesmanufacturing:read

Deleted lines are not returned.

Query parameters

  • searchstringnullable

    Free-text match.

  • namestringnullable

    Partial match on the name.

  • sortstringnullable

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

Retrieve a production line

get/production-lines/{production_line_id}manufacturing:read

Path parameters

  • production_line_idintegerrequired

    The line's id.

    • > 0
Returns
200 One ProductionLine object in data.
Errors
400 401 403 404 429 500 503
GET /production-lines/{production_line_id}
curl "https://public-api.nutrasoft.ca/v1/production-lines/123" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"
Response200
{
  "data": {
    "id": 123,
    "description": "string",
    "name": "Sample name",
    "warehouse_id": 123
  }
}

Create a production line

post/production-linesmanufacturing:write

The name is unique within your account; a duplicate is a 409. Equipment and employees are assigned in NutraSoft.

Request body

  • namestringrequired

    Unique within your account.

    • min 1 chars
    • max 100 chars
  • descriptionstringnullable
    • max 500 chars
  • warehouse_idintegernullable

    One of your warehouses.

    • > 0
Returns
201 One ProductionLine object in data.
Errors
400 401 403 409 429 500 503
POST /production-lines
curl -X POST "https://public-api.nutrasoft.ca/v1/production-lines" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sample name"
}'
Response201
{
  "data": {
    "id": 123,
    "description": "string",
    "name": "Sample name",
    "warehouse_id": 123
  }
}

Update a production line

patch/production-lines/{production_line_id}manufacturing:write

Omitted fields are left unchanged. A null description or warehouse_id clears it.

Path parameters

  • production_line_idintegerrequired

    The line's id.

    • > 0

Request body

  • descriptionstringnullable
    • max 500 chars
  • namestringnullable
    • min 1 chars
    • max 100 chars
  • warehouse_idintegernullable
    • > 0
Returns
200 One ProductionLine object in data.
Errors
400 401 403 404 409 429 500 503
PATCH /production-lines/{production_line_id}
curl -X PATCH "https://public-api.nutrasoft.ca/v1/production-lines/123" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "string"
}'
Response200
{
  "data": {
    "id": 123,
    "description": "string",
    "name": "Sample name",
    "warehouse_id": 123
  }
}

Delete a production line

delete/production-lines/{production_line_id}manufacturing:write

The line is soft-deleted: runs that reference it keep it, and it leaves the list. Its per-product capacities are removed.

Path parameters

  • production_line_idintegerrequired

    The line's id.

    • > 0
Returns
200 One ProductionLine object in data.
Errors
400 401 403 404 409 429 500 503
DELETE /production-lines/{production_line_id}
curl -X DELETE "https://public-api.nutrasoft.ca/v1/production-lines/123" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"
Response200
{
  "data": {
    "id": 123,
    "description": "string",
    "name": "Sample name",
    "warehouse_id": 123
  }
}