Shipments - Get

Retrieve shipments for a specific order.

GET /shipments/get

Shipments - Get

cURL

curl --request GET \
  --url https://api.skulabs.com/shipments/get \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "user_id": "507f1f77bcf86cd799439011",
    "time": "2025-01-15T12:00:00.000Z",
    "voided": true,
    "return_label": true,
    "deducted": true,
    "response": {
      "provider": "<string>",
      "service": "<string>",
      "label_url": "<string>",
      "tracking_number": "<string>",
      "tracking_url": "<string>",
      "amount": 123,
      "currency": "<string>",
      "shipment_id": "<string>",
      "signature": true
    },
    "request": {
      "order_items": [
        {
          "item_id": "<string>",
          "variant_id": "<string>",
          "quantity": 123,
          "sku": "<string>"
        }
      ],
      "parcel": {
        "length": 123,
        "width": 123,
        "height": 123,
        "weight": 123,
        "weight_unit": "<string>",
        "dimensions_unit": "<string>"
      },
      "address": {},
      "carrier_account_ids": [
        "<string>"
      ],
      "provider": "<string>",
      "service": "<unknown>"
    }
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

selector · object · required

Query selector object for filtering results

limit · number

Max results to return

Example:

50

skip · number

Number of results to skip

Example:

0

sort · object

Sort fields object, e.g. { "name": 1 }

Response

200

application/json

Array of shipments matching the query (flattened from orders)

_id · string

Shipment ID

Example:

"507f1f77bcf86cd799439011"

user_id · string

User who created the shipment

Example:

"507f1f77bcf86cd799439011"

time · string

Shipment creation time

Example:

"2025-01-15T12:00:00.000Z"

voided · boolean

Whether the shipment is voided

return_label · boolean

Whether this is a return label

deducted · boolean

Whether inventory was deducted

response · object

Shipment response details

Show child attributes

request · object

Shipment request parameters

Show child attributes