Freight

get documents

Returns the documents (BOL, POD, other files) of every shipment of the order. Without type all document types are returned. podType only applies to POD documents: with type=pod (or no type) it filters the PODs; combined with type=bol or type=other the result is empty. PODs are taken from the delivery task of the last active leg of each shipment, and a POD is only returned once it has been confirmed/approved by WARP.

get/freights/documents/{orderId}

Request

Base URL: https://stg.wearewarp.com/api/v1
URL: https://stg.wearewarp.com/api/v1/freights/documents/{orderId}
Auth: API key in header apikey

Path parameters

orderIdstring required

Example:01H3W439G5J5Y282KQFQTAQGTD

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

Query parameters

type'bol' | 'pod' | 'other'

Example:bol

(Optional) Document type to return: bol, pod or other. Omit to return all types.

podType'Photo' | 'BOL' | 'Signature'

Example:Photo

(Optional) POD sub-type filter: Photo, BOL or Signature. Only meaningful for POD documents (type=pod or type omitted).

Response

successful operation

orderIdstring

orderNumberstring

The display number (code) of the order.

Example response

{
  "orderId": "01H3W439G5J5Y282KQFQTAQGTD",
  "orderNumber": "P-01723-2449",
  "data": [
    {
      "type": "pod",
      "podType": "Photo",
      "shipmentId": "01H3W51F7FEC42MFZAXJQTG4CY",
      "shipmentNumber": "S-00524-2635",
      "url": "file url",
      "stop": {
        "type": "DROPOFF",
        "name": "WATCH-LAX-9",
        "street": "1305 Wholesale Street",
        "city": "Los Angeles",
        "state": "CA",
        "zipcode": "90021"
      }
    }
  ]
}

Changes

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