Freight

get shipments

get/freights/shipments

Request

  • Base URL: https://stg.wearewarp.com/api/v1
  • URL: https://stg.wearewarp.com/api/v1/freights/shipments
  • Auth: API key in header apikey

Query parameters

pagenumber

(Optional) Page number, starting from 1. Default 1.

pageSizenumber

(Optional) Page size (minimum 1). Default 10. Values below 1 are rejected with 400 invalid_field_data.

orderNumberstring
Example:123456

(Optional) Order number - accepts the numeric Warp Id or the order code (e.g. P-01723-2449).

orderIdstring
Example:01H3W439G5J5Y282KQFQTAQGTD

(Optional) Id of the order. The order code (e.g. P-01723-2449) is accepted as well.

shipmentNumberstring
Example:123457

(Optional) Shipment number - accepts the numeric Warp Id or the shipment code (e.g. S-00524-2635).

shipmentIdstring
Example:01H3W51F7FEC42MFZAXJQTG4CY

(Optional) Id of the shipment. The shipment code (e.g. S-00524-2635) is accepted as well.

refNumberstring
Example:PO-123456

(Optional) Reference number of a stop (matches the refNums of the pickup/delivery stops).

createDateStartstring
Example:2023-06-28T20:47:33.892Z

(Optional) Returns shipments created on or after the specified ISO 8601 date-time (inclusive).

createDateEndstring
Example:2023-06-28T20:47:33.892Z

(Optional) Returns shipments created on or before the specified ISO 8601 date-time (inclusive).

Response

successful operation

totalnumber
pagenumber
pageSizenumber

Example response

{
  "data": [
    {
      "shipmentId": "01H3W51F7FEC42MFZAXJQTG4CY",
      "shipmentNumber": "S-00524-2635",
      "orderId": "01H3W439G5J5Y282KQFQTAQGTD",
      "orderNumber": "P-01723-2449",
      "createDate": "2023-06-26T15:10:32.393Z",
      "shipmentType": "LTL",
      "trackingNumber": "S-00524-2635",
      "listItems": [
        {
          "id": "01H3W439P2X0CSSVG171KT44Q6",
          "itemNumber": "29357",
          "name": "Item Name",
          "itemId": "Id customer defined",
          "qty": 1,
          "qtyUnit": "Pallet",
          "weightUnit": "lbs",
          "weightPerUnit": 1,
          "sizeUnit": "IN",
          "length": 1,
          "width": 1,
          "height": 1,
          "temperature_limit": {
            "min": 50,
            "max": 100
          },
          "barcode": [
            "barcode1"
          ]
        }
      ],
      "pickupInfo": {
        "contacts": [
          {
            "type": "primary",
            "fullName": "Kevin Phung",
            "phone": "0123456789"
          }
        ],
        "address": {
          "street": "1220 Satterwhite Rd",
          "city": "Buda",
          "state": "TX",
          "zipcode": "12345"
        },
        "locationName": "Location Name",
        "instructions": "instructions",
        "refNums": [
          "PO-123456"
        ],
        "windows": [
          {
            "from": "2023-07-21T23:00:00.000Z",
            "to": "2023-07-21T23:00:00.000Z"
          }
        ],
        "appointmentInfo": {
          "from": "2023-07-21T23:00:00.000Z",
          "to": "2023-07-21T23:00:00.000Z"
        },
        "accessCode": "accessCode",
        "requiresAppointment": true
      },
      "deliveryInfo": {
        "contacts": [
          {
            "type": "primary",
            "fullName": "Kevin Phung",
            "phone": "0123456789"
          }
        ],
        "address": {
          "street": "1220 Satterwhite Rd",
          "city": "Buda",
          "state": "TX",
          "zipcode": "12345"
        },
        "locationName": "Location Name",
        "instructions": "instructions",
        "refNums": [
          "PO-123456"
        ],
        "windows": [
          {
            "from": "2023-07-21T23:00:00.000Z",
            "to": "2023-07-21T23:00:00.000Z"
          }
        ],
        "appointmentInfo": {
          "from": "2023-07-21T23:00:00.000Z",
          "to": "2023-07-21T23:00:00.000Z"
        },
        "accessCode": "accessCode",
        "requiresAppointment": true
      }
    }
  ],
  "total": 100,
  "page": 1,
  "pageSize": 10
}

Changes

No recorded changes to this operation across all 1 revision of this API.