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": "<unknown>",
      "state": "<unknown>",
      "currency": "<string>",
      "weight_unit": "<unknown>",
      "dimension_unit": "<unknown>",
      "invoice_number": "<unknown>",
      "reference": "<unknown>",
      "identifier": "<unknown>",
      "uri": "<unknown>",
      "delivery": {
        "carrier_code": "<unknown>",
        "carrier_name": "<unknown>",
        "carrier_logo_url": "<unknown>",
        "carrier_icon_url": "<unknown>",
        "service_code": "<unknown>",
        "service_name": "<unknown>",
        "is_pickup": "<unknown>",
        "is_return": "<unknown>",
        "addons": "<unknown>",
        "incoterm": "EXW"
      },
      "parties": {
        "receiver": {
          "reference": "<unknown>",
          "identifier": "<unknown>",
          "uri": "<unknown>",
          "address": {
            "address_lines": "<unknown>",
            "postal_code": "<unknown>",
            "city": "<string>",
            "country": "<string>",
            "administrative_area": "<unknown>"
          },
          "contact": {
            "name_lines": [
              "<string>"
            ],
            "company": "<unknown>",
            "email": "<unknown>",
            "phone": "<unknown>"
          },
          "identifiers": "<unknown>"
        },
        "pickup": "<unknown>"
      },
      "parcels": [
        {
          "uuid": "<unknown>",
          "reference": "<unknown>",
          "identifier": "<unknown>",
          "tracking_code": "<unknown>",
          "tracking_url": "<unknown>",
          "freetext": "<unknown>",
          "gross_weight": "<unknown>",
          "length": "<unknown>",
          "width": "<unknown>",
          "height": "<unknown>",
          "total_net_amount": "<unknown>",
          "tax_amount": "<unknown>",
          "duty_amount": "<unknown>",
          "items": "<unknown>",
          "documents": "<unknown>"
        }
      ],
      "total_net_amount": "<unknown>",
      "tax_amount": "<unknown>",
      "duty_amount": "<unknown>",
      "shipping_net_amount": "<unknown>",
      "shipping_tax_amount": "<unknown>",
      "created_at": "<unknown>",
      "booked_at": "<unknown>"
    }
  ],
  "meta": {
    "current_page": 123,
    "per_page": 123,
    "total": 123,
    "last_page": 123,
    "from": "<unknown>",
    "to": "<unknown>"
  }
}

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

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