Get Order Details | UPS API Documentation

curl -G https://www.onlinetools.ups.com/api/forwarding/v1/orders \
     -H "transactionSrc: GlobalAdvisor" \
     -H "X-BusinessGUID: 12345678-34CD-1233-A678-B00000000000" \
     -H "X-ClientId: 12345678-12AB-1234-A789-00000000000A" \
     -H "Authorization: Bearer <token>" \
     -d "criteria[shipperAccountNumber]=123456789" \
     -d "criteria[criteriaList][criteriaField]=SHIP_DATE" \
     -d "criteria[criteriaList][criteriaOperator]=BTWN" \
     -d "criteria[criteriaList][criteriaValue]=8"

{
  "response": {
    "orders": [
      {
        "shipmentNumber": "906694886",
        "orderNumber": "9066948860001",
        "consignee": {
          "account": "123456789",
          "serviceCenterCode": "BOS",
          "contactName": "Sheldon",
          "contactPhone": "8888888778",
          "contactEmail": "test2@ups.com",
          "company": "DHL INTERNATIONAL (UK) LTD.",
          "address1": "99 Hereford Street",
          "city": "Cranston",
          "state": "RI",
          "postalCode": "02920",
          "countryCode": "US"
        },
        "shipDate": "2025-07-24",
        "statusCode": 8,
        "status": "Posted",
        "description": "LOTS OF STUFF",
        "manifestNumber": "M934567890",
        "shipperReference": "SHIPPER REF",
        "consigneeReference": "CONSIGNEE REF",
        "isMetric": true,
        "items": {
          "totalWeight": 14,
          "weightUnit": "LB",
          "totalPieceCount": 2,
          "item": [
            {
              "count": 1,
              "length": 10,
              "width": 10,
              "height": 10,
              "weight": 10
            },
            {
              "count": 1,
              "length": 10,
              "width": 10,
              "height": 10,
              "weight": 10
            }
          ]
        }
      }
    ],
    "message": "Order search completed successfully."
  }
}

Search for orders based on criteria

Authentication

AuthorizationBearer

Find your Client ID and Secret on your app info page. 1. Select "Try It" 2. In the Security section enter your Client ID and Secret 3. Select "Request Token" 4. Enter any additional information in the Body and Parameters sections 5. Select "Send" to execute your API request"

Query parameters

criteriaobjectRequired

The criteria used to search for Orders

Response headers

BkndTransIdstringOptional

The backend transaction id.

transIdstringOptional

An identifier unique to the request.

transactionSrcstringOptional

Identifies the client/source application that is calling.

Content-TypestringOptional

The Content-Type header provides the client with the actual content/media type of the returned content.

X-BusinessGUIDstringOptional

Unique business GUID.

X-ClientIdstringOptional

Unique client Id.

Response

responseobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

Authentication

Headers

Query parameters

Response headers

Response

Errors