Skip to main content
POST
/
api
/
shipments
/
batch
{
  "shipments": [
    {
      "shipment_date": "2023-11-08T10:00:00Z",
      "shipment_type": "delivery",
      "complete_at_start": "2023-11-08T14:00:00-05:00",
      "complete_at_end": "2023-11-08T18:00:00-05:00",
      "carrier_service_level_id": "550e8400-e29b-41d4-a716-446655440000",
      "shipper": {
        "name": "John Doe",
        "street": "123 Main St",
        "city": "Brooklyn",
        "state": "NY",
        "zip": "11201",
        "country": "US",
        "phone": "7185551234",
        "email": "[email protected]"
      },
      "receiver": {
        "name": "Jane Smith",
        "street": "456 Oak Ave",
        "city": "Brooklyn",
        "state": "NY",
        "zip": "11215",
        "country": "US",
        "phone": "7185559876",
        "email": "[email protected]"
      },
      "receiver_is_residential": true,
      "order_number": "ORD-001",
      "timezone": "America/New_York",
      "items": [
        {
          "title": "Laptop",
          "length": 10.0,
          "width": 8.0,
          "height": 6.0,
          "distance_unit": "in",
          "weight": 2.5,
          "mass_unit": "lb",
          "value": 99.99,
          "currency": "USD"
        }
      ]
    }
  ]
}
{
  "pickup_id": "123e4567-e89b-12d3-a456-426614174000",
  "shipments": [
    {
      "id": "456e7890-e89b-12d3-a456-426614174001",
      "order_number": "ORD-001",
      "shipment_type": "delivery",
      "shipment_date": "2023-11-08T10:00:00Z",
      "complete_at_start": "2023-11-08T19:00:00Z",
      "complete_at_end": "2023-11-08T23:00:00Z",
      "carrier_id": "660e8400-e29b-41d4-a716-446655440000",
      "carrier_service_level_id": "550e8400-e29b-41d4-a716-446655440000",
      "pickup_id": "123e4567-e89b-12d3-a456-426614174000",
      "timezone": "America/New_York",
      "inserted_at": "2023-11-07T10:00:00Z",
      "updated_at": "2023-11-07T10:00:00Z"
    }
  ]
}

Request Body

shipments
array
required
List of shipments to create (1-100 shipments)
{
  "shipments": [
    {
      "shipment_date": "2023-11-08T10:00:00Z",
      "shipment_type": "delivery",
      "complete_at_start": "2023-11-08T14:00:00-05:00",
      "complete_at_end": "2023-11-08T18:00:00-05:00",
      "carrier_service_level_id": "550e8400-e29b-41d4-a716-446655440000",
      "shipper": {
        "name": "John Doe",
        "street": "123 Main St",
        "city": "Brooklyn",
        "state": "NY",
        "zip": "11201",
        "country": "US",
        "phone": "7185551234",
        "email": "[email protected]"
      },
      "receiver": {
        "name": "Jane Smith",
        "street": "456 Oak Ave",
        "city": "Brooklyn",
        "state": "NY",
        "zip": "11215",
        "country": "US",
        "phone": "7185559876",
        "email": "[email protected]"
      },
      "receiver_is_residential": true,
      "order_number": "ORD-001",
      "timezone": "America/New_York",
      "items": [
        {
          "title": "Laptop",
          "length": 10.0,
          "width": 8.0,
          "height": 6.0,
          "distance_unit": "in",
          "weight": 2.5,
          "mass_unit": "lb",
          "value": 99.99,
          "currency": "USD"
        }
      ]
    }
  ]
}
{
  "pickup_id": "123e4567-e89b-12d3-a456-426614174000",
  "shipments": [
    {
      "id": "456e7890-e89b-12d3-a456-426614174001",
      "order_number": "ORD-001",
      "shipment_type": "delivery",
      "shipment_date": "2023-11-08T10:00:00Z",
      "complete_at_start": "2023-11-08T19:00:00Z",
      "complete_at_end": "2023-11-08T23:00:00Z",
      "carrier_id": "660e8400-e29b-41d4-a716-446655440000",
      "carrier_service_level_id": "550e8400-e29b-41d4-a716-446655440000",
      "pickup_id": "123e4567-e89b-12d3-a456-426614174000",
      "timezone": "America/New_York",
      "inserted_at": "2023-11-07T10:00:00Z",
      "updated_at": "2023-11-07T10:00:00Z"
    }
  ]
}
All shipments in a batch share the same pickup. The pickup window times should be coordinated to ensure all shipments can be collected together.

Response Fields

pickup_id
string
Unique identifier for the shared pickup (UUID format)
shipments
array
List of created shipments with the same structure as individual shipment responses