WOwove
Shipments

List shipments

Retrieve a paginated list of shipments for your organization. Results are ordered by creation date (newest first).

get/api/v1/external/shipments

Request

Query parameters

pageinteger

Page number for pagination

limitinteger

Number of items per page

status'draft' | 'booked' | 'pending' | 'in_transit' | 'delivered' | 'cancelled'

Filter by shipment status

shipmentType'FCL' | 'LCL' | 'Air'

Filter by shipment type

searchstring

Search shipments by name or ID. When set, createdAfter/createdBefore are ignored.

createdAfterstring date-time

Only shipments created at or after this ISO 8601 time

createdBeforestring date-time

Only shipments created at or before this ISO 8601 time

updatedAfterstring date-time

Only shipments updated at or after this ISO 8601 time. Use it to pull what changed since your last refresh. Applies with a search too.

updatedBeforestring date-time

Only shipments updated at or before this ISO 8601 time

Response

Shipments retrieved successfully

successboolean

Example response

{
  "success": true,
  "data": {
    "data": [
      {
        "creation": {
          "source": "email"
        },
        "emailUpdates": {
          "threads": 2
        },
        "sync": {
          "method": "manual",
          "status": "success",
          "syncedBy": {
            "name": "Jane Smith",
            "email": "jane@example.com"
          },
          "tmsReference": "C00012345"
        },
        "id": "1014810279825727490",
        "status": "draft",
        "name": "External API Test Shipment",
        "shipmentType": "LCL",
        "commodity": "Electronics",
        "portOfLoading": {
          "portCode": "USLAX",
          "portName": "Los Angeles",
          "countryCode": "US"
        },
        "portOfDischarge": {
          "portCode": "USLAX",
          "portName": "Los Angeles",
          "countryCode": "US"
        },
        "placeOfReceiptPort": {
          "portCode": "USLAX",
          "portName": "Los Angeles",
          "countryCode": "US"
        },
        "placeOfReceiptAirport": {
          "airportCode": "LAX",
          "airportName": "Los Angeles International Airport",
          "countryCode": "US"
        },
        "placeOfReceiptAddress": {
          "address1": "123 Main St",
          "address2": "Suite 100",
          "city": "New York",
          "province": "NY",
          "postalCode": "10001",
          "country": "US"
        },
        "placeOfDeliveryPort": {
          "portCode": "USLAX",
          "portName": "Los Angeles",
          "countryCode": "US"
        },
        "placeOfDeliveryAirport": {
          "airportCode": "LAX",
          "airportName": "Los Angeles International Airport",
          "countryCode": "US"
        },
        "placeOfDeliveryAddress": {
          "address1": "123 Main St",
          "address2": "Suite 100",
          "city": "New York",
          "province": "NY",
          "postalCode": "10001",
          "country": "US"
        },
        "documentCount": 5
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 150,
      "totalPages": 8,
      "hasNext": true
    }
  }
}

Changes

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