Skip to main content
GET
/
v1
/
website
/
{team}
/
shipments
Get a list of a websites shipments
curl --request GET \
  --url https://app.smartsend.io/api/v1/website/{team}/shipments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "c5540f2b-3eea-45c4-957a-9d7b53f899e7",
      "type": "shipment",
      "internal_id": "1226",
      "internal_reference": "AB-00001445",
      "shipping_carrier": "postnord",
      "shipping_method": "collect",
      "subtotal_price_excluding_tax": 159.2,
      "subtotal_price_including_tax": 199,
      "shipping_price_excluding_tax": 20,
      "shipping_price_including_tax": 25,
      "total_price_excluding_tax": 179.2,
      "total_price_including_tax": 224,
      "total_tax_amount": 44.8,
      "currency": "EUR",
      "receiver": {
        "internal_id": "U3778",
        "internal_reference": "U-00001675",
        "company": "Maersk",
        "name_line1": "John Doe",
        "name_line2": "Att. Finance",
        "address_line1": "Esplanaden 50",
        "address_line2": "2nd floor",
        "postal_code": "1098",
        "city": "Copenhagen",
        "state": "<string>",
        "region": "Capital",
        "country": "DK",
        "sms": "30274735",
        "email": "john@example.com"
      },
      "sender": {
        "internal_id": "U3778",
        "internal_reference": "U-00001675",
        "company": "Maersk",
        "name_line1": "John Doe",
        "name_line2": "Att. Finance",
        "address_line1": "Esplanaden 50",
        "address_line2": "2nd floor",
        "postal_code": "1098",
        "city": "Copenhagen",
        "state": "<string>",
        "region": "Capital",
        "country": "DK",
        "sms": "30274735",
        "email": "john@example.com"
      },
      "agent": {
        "internal_id": "U3778",
        "internal_reference": "U-00001675",
        "agent_no": "2134",
        "company": "Maersk",
        "name_line1": "John Doe",
        "name_line2": "Att. Finance",
        "address_line1": "Esplanaden 50",
        "address_line2": "2nd floor",
        "postal_code": "1098",
        "city": "Copenhagen",
        "state": "<string>",
        "region": "Capital",
        "country": "DK",
        "sms": "30274735",
        "email": "john@example.com"
      },
      "parcels": [
        {
          "id": "c5540f2b-3eea-45c4-957a-9d7b53f899e7",
          "type": "parcel",
          "internal_id": "1226",
          "internal_reference": "AB-00001445",
          "weight": 2.35,
          "height": 12.2,
          "width": 15.8,
          "length": 30.5,
          "freetext": "Leave at doorstep",
          "total_price_excluding_tax": 79.2,
          "total_price_including_tax": 99,
          "total_tax_amount": 19.8,
          "items": [
            {
              "id": "c5540f2b-3eea-45c4-957a-9d7b53f899e7",
              "type": "item",
              "internal_id": "1226",
              "internal_reference": "PRODUCT-1231456",
              "sku": "12345678",
              "name": "Product A",
              "description": "Small Blue Product A",
              "hs_code": "10203040",
              "country_of_origin": "CN",
              "image_url": "https://example.com/catalog/product-a.jpg",
              "unit_weight": 1.2,
              "unit_price_excluding_tax": 40.6,
              "unit_price_including_tax": 50.75,
              "quantity": 2,
              "total_price_excluding_tax": 81.2,
              "total_price_including_tax": 101.5,
              "total_tax_amount": 20.3
            }
          ]
        }
      ],
      "addons": [
        {
          "code": "ADHOC_PICKUP",
          "value": "+4530274735"
        }
      ]
    }
  ],
  "meta": {
    "current_page": "1",
    "from": "1",
    "path": "https://example.com/api/example",
    "per_page": "15",
    "to": "15",
    "last_page": "10",
    "total": "140"
  }
}

Authorizations

Authorization
string
header
required

Provide API Token as Bearer authentication

api_token
string
query
required

Query API Token

Path Parameters

team
string
required

The domain of the website making the agent lookup request

Response

Successful operation

data
object[]

Data container

meta
object

Legth Aware Pagination Resource Pagination resource

I