Sign in
latestOpenAPI 3.0.02026-08-08163663.9 KB

4aa7f4326443

Shipper

Creates an order

Creates an order based on the factors provided in the request body. This API endpoint can only be accessed by Shippers!

post/orders

Request body

estimated_arrivalstring
master_bill_of_ladingstring required
movement_typestring required

Valid entries for movement_type and service_type are pickup and delivery.

ocean_carrier_scacstring

The SCAC code for an Ocean Carrier. If the SCAC code is not a known Ocean Carrier SCAC, enter Custom.

custom_ocean_carrier_scacstring

This custom_ocean_carrier_scac is required when the value for ocean_carrier_scac is Custom.

order_typestring required

Valid entries for order_type are 'import', 'export', 'domestic', 'reposition'.

service_typestring required
shipperstring required

shipper is the shipper ID.

special_instructionsstring
steamship_or_railroadstring

If there is no ocean carrier associated with this shipment, steamship_or_railroad is required.

total_weightinteger
vessel_or_railstring

Example request

{
  "arriving": {
    "name": "APMT",
    "address": "2500 Navy Way San Pedro CA 90731"
  },
  "contacts": [
    {
      "name": "Dispatch",
      "phone": "555-555-5555"
    }
  ],
  "delivering": {
    "name": "APMT",
    "address": "2500 Navy Way San Pedro CA 90731"
  },
  "equipments": [
    {
      "equipment_id": "AAAU1231234",
      "_equipmentType": "container"
    }
  ],
  "estimated_arrival": "2022-09-08Z00:00.00Z",
  "master_bill_of_lading": "ABCU12345678",
  "movement_type": "delivery",
  "ocean_carrier_scac": "MAEU",
  "custom_ocean_carrier_scac": "AAAAAA",
  "order_type": "import",
  "originating": {
    "name": "Port of Tianjin",
    "address": "XPMV+74M Binhai Tianjin China 300456"
  },
  "reference_numbers": [
    {
      "name": "delivery_order",
      "value": "LGB0123456789"
    }
  ],
  "service_type": "live",
  "shipper": "63108dce37cc4180163047d9",
  "shipments_staging": [
    {
      "weight": 35000,
      "stops": [
        {
          "sequence": 1,
          "action": "pickup",
          "location": {
            "name": "APMT",
            "address": "2500 Navy Way San Pedro CA 90731"
          },
          "window_start": "2022-09-09T19:00:45.440Z",
          "window_end": "2022-09-09T22:00:50.317Z",
          "equipments": [
            {
              "equipment_id": "AAAU1231234",
              "_equipmentType": "container"
            }
          ]
        }
      ]
    }
  ],
  "special_instructions": "Please deliver this freight!",
  "steamship_or_railroad": "BNSF",
  "total_weight": 35000,
  "vessel_or_rail": "ELEONORA"
}

Response

Status Code 200: Successful Response - the request was successful!

Example response

{
  "order": {
    "order_id": "ORD-8246",
    "order_type": "import",
    "reference_numbers": [
      {
        "name": "delivery_order",
        "value": "LGB0123456789"
      }
    ],
    "service_type": "live",
    "movement_type": "delivery",
    "order_received_date": "2023-07-12T04:17:47.947Z",
    "created_at": "2023-07-12T04:17:47.947Z",
    "equipments": [
      {
        "equipment_id": "AAAU1231234",
        "equipment_type": "container",
        "type": "ISO High Cube",
        "size": "40 ft",
        "status": "N/A"
      }
    ],
    "arriving": {
      "name": "APMT",
      "address": "2500 Navy Way San Pedro CA 90731 USA"
    },
    "delivering": {
      "name": "Cargomatic Inc.",
      "address": "211 E Ocean Blvd Long Beach CA 90802"
    },
    "hazmat_class": "N/A",
    "hazmat_packaging_group": "N/A"
  }
}