Freight

get invoice

Returns the cost breakdown of an order. For LTL/PARCEL orders (and orders priced at shipment level) the amounts are the sum over all shipments of the order. The cost fields (transitCost, volumeDiscount, fuelCost, serviceOptions, grandTotal) are absent while the order has not been priced yet. status is final once the invoice has been sent, pending before that.

get/freights/invoices/{orderId}

Request

Base URL: https://stg.wearewarp.com/api/v1
URL: https://stg.wearewarp.com/api/v1/freights/invoices/{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.

Response

successful operation

orderIdstring

orderNumberstring

The display number (code) of the order.

status'pending' | 'final'

final once the invoice has been sent, pending before that.

transitCostnumber

Base freight charge (USD). Absent while the order has not been priced.

volumeDiscountnumber

Volume discount (USD).

fuelCostnumber

Fuel surcharge (USD).

grandTotalnumber

Total amount of the order (USD).

Example response

{
  "orderId": "01H3W439G5J5Y282KQFQTAQGTD",
  "orderNumber": "P-01723-2449",
  "status": "final",
  "transitCost": 750,
  "volumeDiscount": 75,
  "fuelCost": 75,
  "serviceOptions": [
    {
      "name": "Extra Miles",
      "total": 15
    },
    {
      "name": "Photo Required",
      "total": 15
    }
  ],
  "grandTotal": 780
}

Changes

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