LogoLogo
  • About
  • Authentication
  • API Reference
    • Schedules
    • Merchandise
    • Manifests
    • Pickups
      • Load Summary
  • Webhooks
    • Setup
    • Pickups
    • Dropoffs
Powered by GitBook
On this page
  1. API Reference

Manifests

PreviousMerchandiseNextPickups

Last updated 1 month ago

  • POSTCreate a manifest
  • GETGet Manifests

Get Manifests

get

Get manifests by manifest number or lt number

Authorizations
Query parameters
lt_numberstringrequired

The load transit number to filter on.

Only one of lt_number or manifest_number is required.

Example: BBB12345
manifest_numberstringrequired

The manifest number to filter on.

Only one of lt_number or manifest_number is required.

Example: 123456
fluid_typestring ยท enumoptional

The type of fluid to filter on, either raw milk or processed fluids.

By default, it will query on raw milk.

Available options:
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.prod.milkmoovement.io/v1/manifests?lt_number=BBB12345&manifest_number=123456' \
  --header 'x-api-key: YOUR_API_KEY'
201
400
{
  "route_session": {
    "_id": "text",
    "status": "text",
    "manifest_number": "text",
    "total_distance": 1,
    "total_time": 1,
    "total_time_in_milliseconds": 1,
    "route_points": [],
    "arrival_at_processor_event": "text",
    "type_of_fluid": "milk",
    "is_locked": true,
    "is_diverted": true,
    "created_at": "text",
    "pre_delivery_report_processor_recipients": [
      "text"
    ],
    "kosher": true,
    "adjustments_id": "text",
    "BOL": "text",
    "route_number": "text",
    "hopped_fences": [],
    "seals": [],
    "deleted_at": "text",
    "updated_at": "text",
    "updated_by": "text"
  },
  "pickups": [
    {
      "_id": "text",
      "is_rejected": true,
      "temperature": "text",
      "compartment": "text",
      "volume": 1,
      "volume_a": 1,
      "volume_b": 1,
      "volume_c": 1,
      "route_session_id": "text",
      "producer_id": "text",
      "driver_id": "text",
      "outside": "text",
      "is_outside_geofence": true,
      "sample_barcodes": [
        {}
      ],
      "measurement_method": "text",
      "sample_type": "text",
      "type_of_fluid": "milk",
      "lab_report_ids": [],
      "is_locked": "text",
      "manual_pooling_adjustment": true,
      "created_at": "2025-04-03T02:45:44.372Z",
      "outside_milk": true,
      "time_in_geofence_ms": 1,
      "lt_number": "text",
      "manifest_number": "text",
      "is_organic": true,
      "kosher": true,
      "deleted_at": "text",
      "updated_at": "2025-04-03T02:45:44.372Z",
      "updated_by": "text"
    }
  ],
  "dropoffs": [
    {
      "_id": "text",
      "comment": "text",
      "is_rejected": true,
      "compartment": "text",
      "metered": 1,
      "volume": 1,
      "volume_a": 1,
      "volume_b": 1,
      "volume_c": 1,
      "dropoff_type": "text",
      "net_weight": 1,
      "route_session_id": "text",
      "processor_id": "text",
      "split_details": [
        {}
      ],
      "driver_id": "text",
      "latitude": "text",
      "longitude": "text",
      "outside": "text",
      "is_outside_geofence": true,
      "time_on_plant": 1,
      "time_on_plant_in_milliseconds": 1,
      "type_of_fluid": "milk",
      "sample_barcodes": [
        {}
      ],
      "is_locked": "text",
      "created_at": "2025-04-03T02:45:44.372Z",
      "milk_category": "text",
      "geofence_id": "text",
      "time_in_geofence_ms": 1,
      "lt_number": "text",
      "manifest_number": "text",
      "silo_invoice_id": [
        {}
      ],
      "is_organic": true,
      "kosher": true,
      "deleted_at": "text",
      "updated_at": "2025-04-03T02:45:44.372Z",
      "updated_by": "text"
    }
  ]
}

Manifest Found

Create a manifest

post

Creates a manifest and (associated route session, pickup(s) and dropoff) and returns a manifest object

Authorizations
Body
route_sessionobjectrequired

pickupsobject[]required

dropoffobjectrequired

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.prod.milkmoovement.io/v1/manifests' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "route_session": {
      "manifest_number": "text",
      "load_transit_number": "text",
      "route_name": "text",
      "trailer_number": "text",
      "po_number": "text",
      "status": "active",
      "type_of_fluid": "milk"
    },
    "pickups": [
      {
        "driver_number": "text",
        "producer_number": "text",
        "tank": "1",
        "compartment": "Front",
        "volume": 1,
        "temperature": 1,
        "type_of_fluid": "milk",
        "is_rejected": null,
        "date": "2024-03-03 06:00:00",
        "sample_barcodes": [
          "text"
        ]
      }
    ],
    "dropoff": {
      "driver_number": "text",
      "processor_number": "text",
      "net_weight": 1,
      "scale_weight": 1,
      "tare_weight": 1,
      "latitude": "text",
      "longitude": "text",
      "volume": 1,
      "dropoff_type": "metered",
      "compartment": "Front",
      "date": "2024-03-03 06:00:00",
      "comment": "text",
      "sample_barcodes": [
        "text"
      ]
    }
  }'
201
400
{
  "route_session": {
    "_id": "text",
    "status": "text",
    "manifest_number": "text",
    "total_distance": 1,
    "total_time": 1,
    "total_time_in_milliseconds": 1,
    "route_points": [],
    "arrival_at_processor_event": "text",
    "type_of_fluid": "milk",
    "is_locked": true,
    "is_diverted": true,
    "created_at": "text",
    "pre_delivery_report_processor_recipients": [
      "text"
    ],
    "kosher": true,
    "adjustments_id": "text",
    "BOL": "text",
    "route_number": "text",
    "hopped_fences": [],
    "seals": [],
    "deleted_at": "text",
    "updated_at": "text",
    "updated_by": "text"
  },
  "pickups": [
    {
      "_id": "text",
      "is_rejected": true,
      "temperature": "text",
      "compartment": "text",
      "volume": 1,
      "volume_a": 1,
      "volume_b": 1,
      "volume_c": 1,
      "route_session_id": "text",
      "producer_id": "text",
      "driver_id": "text",
      "outside": "text",
      "is_outside_geofence": true,
      "sample_barcodes": [
        {}
      ],
      "measurement_method": "text",
      "sample_type": "text",
      "type_of_fluid": "milk",
      "lab_report_ids": [],
      "is_locked": "text",
      "manual_pooling_adjustment": true,
      "created_at": "2025-04-03T02:45:44.372Z",
      "outside_milk": true,
      "time_in_geofence_ms": 1,
      "lt_number": "text",
      "manifest_number": "text",
      "is_organic": true,
      "kosher": true,
      "deleted_at": "text",
      "updated_at": "2025-04-03T02:45:44.372Z",
      "updated_by": "text"
    }
  ],
  "dropoffs": [
    {
      "_id": "text",
      "comment": "text",
      "is_rejected": true,
      "compartment": "text",
      "metered": 1,
      "volume": 1,
      "volume_a": 1,
      "volume_b": 1,
      "volume_c": 1,
      "dropoff_type": "text",
      "net_weight": 1,
      "route_session_id": "text",
      "processor_id": "text",
      "split_details": [
        {}
      ],
      "driver_id": "text",
      "latitude": "text",
      "longitude": "text",
      "outside": "text",
      "is_outside_geofence": true,
      "time_on_plant": 1,
      "time_on_plant_in_milliseconds": 1,
      "type_of_fluid": "milk",
      "sample_barcodes": [
        {}
      ],
      "is_locked": "text",
      "created_at": "2025-04-03T02:45:44.372Z",
      "milk_category": "text",
      "geofence_id": "text",
      "time_in_geofence_ms": 1,
      "lt_number": "text",
      "manifest_number": "text",
      "silo_invoice_id": [
        {}
      ],
      "is_organic": true,
      "kosher": true,
      "deleted_at": "text",
      "updated_at": "2025-04-03T02:45:44.372Z",
      "updated_by": "text"
    }
  ]
}

Manifest Created Successfully