Skip to main content
GET
/
team
/
{team}
/
shipments
List shipments
curl --request GET \
  --url https://app.smartsend.io/api/v2/team/{team}/shipments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "state": "open",
      "currency": "<string>",
      "weight_unit": "g",
      "dimension_unit": "cm",
      "invoice_number": "<string>",
      "reference": "<string>",
      "identifier": "<string>",
      "uri": "<string>",
      "delivery": {
        "carrier_code": "<string>",
        "carrier_name": "<string>",
        "carrier_logo_url": "<string>",
        "carrier_icon_url": "<string>",
        "service_code": "<string>",
        "service_name": "<string>",
        "is_pickup": true,
        "is_return": true,
        "addons": [
          {
            "code": "<string>",
            "name": "<string>"
          }
        ],
        "incoterm": "EXW"
      },
      "parties": {
        "receiver": {
          "reference": "<string>",
          "identifier": "<string>",
          "uri": "<string>",
          "address": {
            "address_lines": [
              "<string>"
            ],
            "postal_code": "<string>",
            "city": "<string>",
            "country": "<string>",
            "administrative_area": "<string>"
          },
          "contact": {
            "name_lines": [
              "<string>"
            ],
            "company": "<string>",
            "email": "jsmith@example.com",
            "phone": "<string>"
          },
          "identifiers": {
            "vat": "<string>",
            "eori": "<string>",
            "gb_eori": "<string>",
            "tax_id": "<string>",
            "voec": "<string>"
          }
        },
        "pickup": {
          "service_point_code": "<string>",
          "company": "<string>",
          "address": {
            "address_lines": [
              "<string>"
            ],
            "postal_code": "<string>",
            "city": "<string>",
            "country": "<string>",
            "administrative_area": "<string>"
          },
          "reference": "<string>",
          "identifier": "<string>",
          "uri": "<string>"
        }
      },
      "parcels": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "reference": "<string>",
          "identifier": "<string>",
          "tracking_code": "<string>",
          "tracking_url": "<string>",
          "freetext": "<string>",
          "gross_weight": 1,
          "length": 1,
          "width": 1,
          "height": 1,
          "total_net_amount": 123,
          "tax_amount": 123,
          "duty_amount": 123,
          "items": [
            {
              "reference": "<string>",
              "identifier": "<string>",
              "uri": "<string>",
              "image_url": "<string>",
              "sku": "<string>",
              "location": "<string>",
              "name": "<string>",
              "description": "<string>",
              "tariff_code": "<string>",
              "country_of_origin": "<string>",
              "quantity": 1,
              "total_net_amount": 123,
              "tax_amount": 123,
              "duty_amount": 123,
              "net_weight": 1,
              "cost_amount": 123
            }
          ],
          "documents": [
            {
              "type": "label",
              "format": "pdf",
              "url": "<string>"
            }
          ]
        }
      ],
      "total_net_amount": 123,
      "tax_amount": 123,
      "duty_amount": 123,
      "shipping_net_amount": 123,
      "shipping_tax_amount": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "booked_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "current_page": 123,
    "per_page": 123,
    "total": 123,
    "last_page": 123,
    "from": 123,
    "to": 123
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Accept-Language
string
default:en

Preferred language(s) for translatable content using BCP 47 language tags. Supports quality values (q-factors) for priority ordering. The API negotiates the best available language based on this header, the team's configured language, and available translations. If omitted, the team's default language is used.

Example:

"da-DK, da;q=0.9, en;q=0.8"

​
Request-ID
string

Any value passed in this request will be returned in the same header. This can be used to correlate requests between client and server.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9._-]{1,128}$

Path Parameters

​
team
string
required

Team identifier. All resources are scoped to this team.

Minimum string length: 1
Example:

"ad9546c1-393e-49a5-9a72-5cc146c9bec5"

Query Parameters

​
carrier
string

Filter by carrier code

Example:

"postnord"

​
service
string

Filter by service code

Example:

"postnord_agent"

​
tracking_number
string

Filter by parcel tracking number

​
state
enum<string>

Filter by shipment state Current state of the shipment in the booking lifecycle

Available options:
open,
queued,
booked,
cancelled,
failed
​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
per_page
integer
default:100

Number of shipments per page

Required range: 1 <= x <= 1000

Response

Shipments retrieved successfully

​
data
object[]
required
​
meta
object
required