Skip to main content
POST
/
api
/
rest
/
shipments
/
search
Search Shipments
curl --request POST \
  --url https://api.upwell.com/api/rest/shipments/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 10,
  "offset": 0,
  "orderBy": {},
  "where": {}
}
'
{
  "shipments": [
    {
      "billOfLadingNumber": "<string>",
      "billedDate": "2023-12-25",
      "carrierId": "<string>",
      "carrierProNumber": "<string>",
      "carrierTotalRate": 123,
      "company": {
        "dunsNumber": "<string>",
        "id": "<string>",
        "logoUrl": "<string>",
        "mcNumber": "<string>",
        "name": "<string>",
        "primaryEmailAddress": "<string>",
        "primaryPhone": "<string>",
        "sourceSystem": "<string>",
        "sourceSystemId": "<string>",
        "termsOfService": "<string>",
        "website": "<string>"
      },
      "companyId": "<string>",
      "consigneeAddress": {
        "city": "<string>",
        "companyName": "<string>",
        "country": "AD",
        "id": "<string>",
        "name": "<string>",
        "phoneNumber": "<string>",
        "stateOrProvince": "<string>",
        "streetLine1": "<string>",
        "streetLine2": "<string>",
        "type": "ADDRESS_BOOK",
        "zipOrPostalCode": "<string>"
      },
      "coveredDate": "2023-12-25",
      "createdAt": "2023-11-07T05:31:56Z",
      "currency": "AED",
      "customerId": "<string>",
      "customerPoNumber": "<string>",
      "customerReferenceNumber": "<string>",
      "customerTotalRate": 123,
      "deliveredAt": "<unknown>",
      "dispatchedDate": "2023-12-25",
      "id": "<string>",
      "invoiceId": "<string>",
      "loadDescription": "<string>",
      "loadedDate": "2023-12-25",
      "pickupAddress": {
        "city": "<string>",
        "companyName": "<string>",
        "country": "AD",
        "id": "<string>",
        "name": "<string>",
        "phoneNumber": "<string>",
        "stateOrProvince": "<string>",
        "streetLine1": "<string>",
        "streetLine2": "<string>",
        "type": "ADDRESS_BOOK",
        "zipOrPostalCode": "<string>"
      },
      "pickupAt": "<unknown>",
      "releaseDate": "2023-12-25",
      "shipmentId": "<string>",
      "shipmentInvoices": [
        {
          "invoiceId": "<string>",
          "shipmentId": "<string>"
        }
      ],
      "sourceSystem": "<string>",
      "sourceSystemId": "<string>",
      "status": "<string>",
      "stops": [
        {
          "address": {
            "city": "<string>",
            "companyName": "<string>",
            "country": "AD",
            "id": "<string>",
            "name": "<string>",
            "phoneNumber": "<string>",
            "stateOrProvince": "<string>",
            "streetLine1": "<string>",
            "streetLine2": "<string>",
            "type": "ADDRESS_BOOK",
            "zipOrPostalCode": "<string>"
          },
          "id": "<string>",
          "metadata": "<string>",
          "pieceCount": 123,
          "sequenceNumber": 123,
          "stopType": "<string>",
          "weightAmount": "<unknown>",
          "weightUnit": "<string>"
        }
      ],
      "terminal": "<string>",
      "trailerNumber": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "volume": "<unknown>",
      "volumeUnit": "<string>",
      "weight": "<unknown>",
      "weightUnit": "<string>"
    }
  ]
}

Headers

authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Query Parameters

limit
integer
default:10
offset
integer
default:0

Body

application/json

Query parameters can also be provided in the request body as a JSON object

limit
integer | null
default:10
offset
integer | null
default:0
orderBy
object[] | null
where
ShipmentsBoolExp Ā· object

Boolean expression to filter rows from the table "shipments". All fields are combined with a logical 'AND'.

Response

200 - application/json

Responses for POST /api/rest/shipments/search

shipments
Shipments Ā· object[]