Load Summary

Get Load Summary via Date Range

get

Get report of load summary pickup data for provided date range

Authorizations

api_key

x-api-keystringRequired

Query parameters

start_datestring · dateRequired

The start date of the pickups to filter on.

Supports the following formats:

• YYYY-MM-DD

Example: 2024-03-01

end_datestring · dateRequired

The end date of the pickups to filter on.

Supports the following formats:

• YYYY-MM-DD

Example: 2024-03-07

include_updated_loadsbooleanOptional

Include loads updated within the provided date range.

Responses

200

Successful response

application/json

_idstringOptionalExample: 67180705d2a2311f2801b992

pickup_temperaturestringOptionalExample: 36

pickup_amountnumberOptionalExample: 3200

pickup_tarenumberOptionalExample: 100

pickup_grossnumberOptionalExample: 3300

invoice_numberstringOptionalExample: ABC12345

milk_categorystringOptionalExample: member_producer

compartmentstringOptionalExample: front

route_numberstringOptionalExample: A100

pickup_datestringOptionalExample: 2024-03-03T06:00:00.000Z

dropoff_datestringOptionalExample: 2024-03-03T09:00:00.000Z

producer_namestringOptionalExample: Producer Name

producer_businessstringOptionalExample: A001234

producer_numberstringOptionalExample: 1234

producer_tankstringOptionalExample: 1

producer_locationstringOptional

dip_levelstringOptionalExample: 10.5

rejectedstringOptionalExample: false

degradedstringOptionalExample: false

gradestringOptionalExample: A

time_on_farmnumberOptionalExample: 5

pickup_commentstringOptionalExample: Comment

processor_namestringOptionalExample: Processor Name

processor_numberstringOptionalExample: 123

dropoff_amountnumberOptionalExample: 3200

dropoff_tarenumberOptionalExample: 100

dropoff_grossnumberOptionalExample: 3300

scale_amountnumberOptionalExample: 3200

time_at_processornumberOptionalExample: 5

dropoff_commentstring[]OptionalExample: ["Comment"]

pooledstringOptionalExample: false

sample_barcodestring[]OptionalExample: ["123456","2345678"]

other_solidsstringOptional

butterfat_amountstringOptional

protein_amountstringOptional

lactose_amountstringOptional

other_solids_amountstringOptional

solids_not_fat_amountstringOptional

hauler_namestringOptionalExample: Hauler Name

hauler_numberstringOptionalExample: 123

driverstringOptionalExample: Driver Name

geofence_enter_timestringOptionalExample: 2024-03-03T06:00:00.000Z

geofence_exit_timestringOptionalExample: 2024-03-03T06:30:00.000Z

exit_enter_geofencestring[]Optional

truck_numberstringOptional

The number of the truck (for regions that use truck numbers)

Example: 123

truck_typestringOptionalExample: Regular

trailer_numberstringOptionalExample: 123

beginning_odometernumberOptionalExample: 10

ending_odometernumberOptionalExample: 20

total_distancenumberOptionalExample: 10

route_totalnumberOptionalExample: 3000000

route_startstringOptionalExample: 2024-03-03T06:00:00.000Z

route_endstringOptionalExample: 2024-03-03T06:30:00.000Z

seals_infostring[]OptionalExample: ["123456","2345678"]

lab_lengthnumberOptionalExample: 10

producer_idstringOptionalExample: 67180a73b7fe039229250b1a

processor_idstringOptionalExample: 67180a80a32a59cb37b77842

dropoff_meterednumberOptionalExample: 3200

manifest_numberstringOptionalExample: 00123456

is_lockedstringOptionalExample: false

jump_truckstring[]OptionalExample: ["false"]

400

Bad Request

application/json

get

/pickups/load-summary

HTTPcURLJavaScriptPython

GET /v1/pickups/load-summary?start_date=2024-03-01&end_date=2024-03-07 HTTP/1.1
Host: api.prod.milkmoovement.io
x-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "_id": "67180705d2a2311f2801b992",
    "pickup_temperature": "36",
    "pickup_amount": 3200,
    "pickup_tare": 100,
    "pickup_gross": 3300,
    "invoice_number": "ABC12345",
    "milk_category": "member_producer",
    "compartment": "front",
    "route_number": "A100",
    "pickup_date": "2024-03-03T06:00:00.000Z",
    "dropoff_date": "2024-03-03T09:00:00.000Z",
    "producer_name": "Producer Name",
    "producer_business": "A001234",
    "producer_number": "1234",
    "producer_tank": "1",
    "producer_location": "text",
    "dip_level": "10.5",
    "rejected": "false",
    "degraded": "false",
    "grade": "A",
    "time_on_farm": 5,
    "pickup_comment": "Comment",
    "processor_name": "Processor Name",
    "processor_number": "123",
    "dropoff_amount": 3200,
    "dropoff_tare": 100,
    "dropoff_gross": 3300,
    "scale_amount": 3200,
    "time_at_processor": 5,
    "dropoff_comment": [
      "Comment"
    ],
    "pooled": "false",
    "sample_barcode": [
      "123456",
      "2345678"
    ],
    "other_solids": "text",
    "butterfat_amount": "text",
    "protein_amount": "text",
    "lactose_amount": "text",
    "other_solids_amount": "text",
    "solids_not_fat_amount": "text",
    "hauler_name": "Hauler Name",
    "hauler_number": "123",
    "driver": "Driver Name",
    "geofence_enter_time": "2024-03-03T06:00:00.000Z",
    "geofence_exit_time": "2024-03-03T06:30:00.000Z",
    "exit_enter_geofence": [
      "text"
    ],
    "truck_number": "123",
    "truck_type": "Regular",
    "trailer_number": "123",
    "beginning_odometer": 10,
    "ending_odometer": 20,
    "total_distance": 10,
    "route_total": 3000000,
    "route_start": "2024-03-03T06:00:00.000Z",
    "route_end": "2024-03-03T06:30:00.000Z",
    "seals_info": [
      "123456",
      "2345678"
    ],
    "lab_length": 10,
    "producer_id": "67180a73b7fe039229250b1a",
    "processor_id": "67180a80a32a59cb37b77842",
    "dropoff_metered": 3200,
    "manifest_number": "00123456",
    "is_locked": "false",
    "jump_truck": [
      "false"
    ]
  }
]