Schedules

Get Schedules via Date Range

get

Authorizations

api_key

x-api-keystringRequired

Query parameters

start_datestring · date-timeRequired

The start date of the schedules to filter on.

Supports the following formats:

• YYYY-MM-DD
• YYYY-MM-DDTHH:MM
• YYYY-MM-DDTHH:MM-HH:MM

Example: 2024-01-01T04:00

end_datestring · date-timeRequired

The end date of the schedules to filter on.

Supports the following formats:

• YYYY-MM-DD
• YYYY-MM-DDTHH:MM
• YYYY-MM-DDTHH:MM-HH:MM

Example: 2024-01-15

license_numberstringOptional

The license number of the processor to filter on.

By default, it will return all schedules.

Note: This field is only queryable with Admin API access.

Example: 1234

license_typestring · enumOptional

Whether to query for the destination processor, or the origin processor.

By default, it will query on the destination.

Example: originPossible values:

fluid_typestring · enumOptional

Whether to filter on raw milk or processed fluids.

By default, it will query both.

Example: rawPossible values:

commodity_typestringOptional

The commodity_type to filter further on processed fluids.

This field is only used if the fluid_type is processed.

Example: cream

Responses

200

Successful response

application/json

get

/schedules

HTTPcURLJavaScriptPython

GET /v1/schedules?start_date=2024-01-01T04%3A00&end_date=2024-01-15 HTTP/1.1
Host: api.prod.milkmoovement.io
x-api-key: YOUR_API_KEY
Accept: */*

200

Successful response

[
  {
    "_id": "234577",
    "route_session": {
      "_id": "5577667",
      "status": "closed",
      "manifest_number": "1111",
      "lt_number": "BBB12345",
      "processor_external_id": "1111"
    },
    "start_date": "2024-03-03T06:00:00.000Z",
    "end_date": "2024-03-03T09:00:00.000Z",
    "amount": 32000,
    "lt_number": "BBB12345",
    "processor_external_id": "1111",
    "destination_processor": {
      "_id": "2222",
      "name": "Processor Name",
      "license_number": "123"
    },
    "hauler": {
      "_id": "2222",
      "name": "Hauler Name",
      "hauler_number": "123"
    },
    "origin_producer_ids": [
      "78978879"
    ],
    "origin_processor_id": {
      "_id": "2222",
      "name": "Processor Name",
      "license_number": "123"
    },
    "commodity_type": "milk",
    "created_at": "2024-02-16T14:58:05.269Z",
    "updated_at": "2024-02-16T14:58:05.269Z"
  }
]