Shipper API

Get itemized invoice for a delivered shipment

Retrieves the itemized invoice for a delivered shipment. The invoice includes all charges (base freight, accessorials) and line items.

Note: This endpoint is only available for shipments in DELIVERED state. Invoices are finalized when a shipment is delivered.

get/v1/shipper/shipment/{orderNumber}/invoice

Request

Base URL
https://api.oway.io
URL
https://api.oway.io/v1/shipper/shipment/{orderNumber}/invoice
Auth
HTTP bearer and API key in header x-oway-api-key

Path parameters

orderNumberstring required

Order number (5-character alphanumeric code, commonly called PRO number)

Response

Invoice retrieved successfully

orderIdstring

Order ID

orderNumberstring

Human-readable order number (PRO number)

invoiceDatestring date-time

Invoice date (typically same as delivery date)

shipDatestring date-time

Ship date (when the shipment was picked up)

deliveryDatestring date-time

Delivery date (when the shipment was delivered)

poNumberstring

Purchase order number (if provided)

refNumberstring

Reference number (BOL number)

totalChargesInCentsinteger

Total of all charges in cents (USD)

totalWeightinteger

Total weight of the shipment in pounds

totalPiecesinteger

Total number of pieces/pallets

Example response

{
  "orderId": "67b6c5fcfbf1be6b24127646",
  "orderNumber": "ZKYQ5",
  "invoiceDate": "2024-12-20T15:30:00Z",
  "shipDate": "2024-12-18T09:00:00Z",
  "deliveryDate": "2024-12-20T15:30:00Z",
  "poNumber": "PO-12345",
  "refNumber": "BOL-67890",
  "lineItems": [
    {
      "description": "General Freight",
      "freightClass": "85",
      "nmfcCode": "90500-04",
      "weight": 500,
      "quantity": 2,
      "packageType": "PLT"
    }
  ],
  "charges": [
    {
      "chargeType": "BASE_FREIGHT",
      "description": "Base Freight",
      "amountInCents": 100000
    }
  ],
  "totalChargesInCents": 125000,
  "totalWeight": 1500,
  "totalPieces": 4,
  "shipper": {
    "name": "Fairgrounds Distribution Center",
    "address1": "1531 Junipero Avenue",
    "address2": "Dock 5",
    "city": "Long Beach",
    "state": "CA",
    "zipCode": "90804",
    "country": "US",
    "phoneNumber": "+18087857650",
    "contactPerson": "Mike Johnson",
    "phoneExtension": "204",
    "email": "dock@example.com",
    "openTime": "10:00",
    "closeTime": "16:00",
    "notes": "Dock 3, enter from back of building",
    "appointmentRequired": true,
    "callAheadRequired": true
  },
  "consignee": {
    "name": "Fairgrounds Distribution Center",
    "address1": "1531 Junipero Avenue",
    "address2": "Dock 5",
    "city": "Long Beach",
    "state": "CA",
    "zipCode": "90804",
    "country": "US",
    "phoneNumber": "+18087857650",
    "contactPerson": "Mike Johnson",
    "phoneExtension": "204",
    "email": "dock@example.com",
    "openTime": "10:00",
    "closeTime": "16:00",
    "notes": "Dock 3, enter from back of building",
    "appointmentRequired": true,
    "callAheadRequired": true
  },
  "billTo": {
    "name": "Fairgrounds Distribution Center",
    "address1": "1531 Junipero Avenue",
    "address2": "Dock 5",
    "city": "Long Beach",
    "state": "CA",
    "zipCode": "90804",
    "country": "US",
    "phoneNumber": "+18087857650",
    "contactPerson": "Mike Johnson",
    "phoneExtension": "204",
    "email": "dock@example.com",
    "openTime": "10:00",
    "closeTime": "16:00",
    "notes": "Dock 3, enter from back of building",
    "appointmentRequired": true,
    "callAheadRequired": true
  }
}

Changes

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