Get a specific shipment

curl --request GET \
  --url 'https://app.smartsend.io/api/v1/website/{team}/shipments/{shipment}?api_token=' \
  --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",
      "receiver": {
        "internal_id": "U3778",
        "internal_reference": "U-00001675",
        "address_line1": "Esplanaden 50",
        "postal_code": "1098",
        "city": "Copenhagen",
        "country": "DK",
        "email": "[email protected]",
        "company": "Maersk",
        "name_line1": "John Doe",
        "name_line2": "Att. Finance",
        "address_line2": "2nd floor",
        "state": "<string>",
        "region": "Capital",
        "sms": "30274735"
      },
      "parcels": [
        {
          "internal_id": "1226",
          "internal_reference": "AB-00001445",
          "id": "c5540f2b-3eea-45c4-957a-9d7b53f899e7",
          "type": "parcel",
          "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": [
            {
              "internal_id": "1226",
              "internal_reference": "PRODUCT-1231456",
              "sku": "12345678",
              "name": "Product A",
              "id": "c5540f2b-3eea-45c4-957a-9d7b53f899e7",
              "type": "item",
              "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
            }
          ]
        }
      ],
      "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",
      "sender": {
        "internal_id": "U3778",
        "internal_reference": "U-00001675",
        "company": "Maersk",
        "address_line1": "Esplanaden 50",
        "postal_code": "1098",
        "city": "Copenhagen",
        "country": "DK",
        "email": "[email protected]",
        "name_line1": "John Doe",
        "name_line2": "Att. Finance",
        "address_line2": "2nd floor",
        "state": "<string>",
        "region": "Capital",
        "sms": "30274735"
      },
      "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": "[email protected]"
      },
      "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"
  }
}

GET

website

{team}

shipments

{shipment}

Get a specific shipment

curl --request GET \
  --url 'https://app.smartsend.io/api/v1/website/{team}/shipments/{shipment}?api_token=' \
  --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",
      "receiver": {
        "internal_id": "U3778",
        "internal_reference": "U-00001675",
        "address_line1": "Esplanaden 50",
        "postal_code": "1098",
        "city": "Copenhagen",
        "country": "DK",
        "email": "[email protected]",
        "company": "Maersk",
        "name_line1": "John Doe",
        "name_line2": "Att. Finance",
        "address_line2": "2nd floor",
        "state": "<string>",
        "region": "Capital",
        "sms": "30274735"
      },
      "parcels": [
        {
          "internal_id": "1226",
          "internal_reference": "AB-00001445",
          "id": "c5540f2b-3eea-45c4-957a-9d7b53f899e7",
          "type": "parcel",
          "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": [
            {
              "internal_id": "1226",
              "internal_reference": "PRODUCT-1231456",
              "sku": "12345678",
              "name": "Product A",
              "id": "c5540f2b-3eea-45c4-957a-9d7b53f899e7",
              "type": "item",
              "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
            }
          ]
        }
      ],
      "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",
      "sender": {
        "internal_id": "U3778",
        "internal_reference": "U-00001675",
        "company": "Maersk",
        "address_line1": "Esplanaden 50",
        "postal_code": "1098",
        "city": "Copenhagen",
        "country": "DK",
        "email": "[email protected]",
        "name_line1": "John Doe",
        "name_line2": "Att. Finance",
        "address_line2": "2nd floor",
        "state": "<string>",
        "region": "Capital",
        "sms": "30274735"
      },
      "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": "[email protected]"
      },
      "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

shipment

string<uuid>

required

Shipment ID

Response

Successful operation

data

object[]

Data container

Show child attributes

data.id

string<uuid>

required

Unique ID

Example:

"c5540f2b-3eea-45c4-957a-9d7b53f899e7"

data.type

string

required

Description of the resource type

Example:

"shipment"

data.internal_id

string

required

The database id used by the website for the resource

Example:

"1226"

data.internal_reference

string

required

The id that is used to reference the resource externally

Example:

"AB-00001445"

data.shipping_carrier

enum<string>

required

The carrier code

Available options:

postnord,

gls,

dao,

bifrost,

bring

Example:

"postnord"

data.shipping_method

string

required

The code for the shipping method

Example:

"collect"

data.receiver

object

required

Receiver Resource

Show child attributes

data.receiver.internal_id

string

required

The database id used by the website for the resource

Example:

"U3778"

data.receiver.internal_reference

string

required

The id that is used to reference the resource externally

Example:

"U-00001675"

data.receiver.address_line1

string

required

First line used to store the address

Example:

"Esplanaden 50"

data.receiver.postal_code

string

required

Postal code

Example:

"1098"

data.receiver.city

string

required

City

Example:

"Copenhagen"

data.receiver.country

string

required

ISO3166 alpha 2 country code

Example:

"DK"

data.receiver.email

string<email>

required

Email address

Example:

"[email protected]"

data.receiver.company

string

Company name

Example:

"Maersk"

data.receiver.name_line1

string

First line used to store the name of the receiver

Example:

"John Doe"

data.receiver.name_line2

string

Second line used to store the name of the receiver

Example:

"Att. Finance"

data.receiver.address_line2

string

Second line used to store the address

Example:

"2nd floor"

data.receiver.state

string

State

data.receiver.region

string

Region

Example:

"Capital"

data.receiver.sms

string

Mobile phone number

Example:

"30274735"

data.parcels

object[]

required

List of parcels

Show child attributes

data.parcels.internal_id

string

required

The database id used by the website for the resource

Example:

"1226"

data.parcels.internal_reference

string

required

The id that is used to reference the resource externally

Example:

"AB-00001445"

data.parcels.id

string<uuid>

Unique ID

Example:

"c5540f2b-3eea-45c4-957a-9d7b53f899e7"

data.parcels.type

string

Description of the resource type

Example:

"parcel"

data.parcels.weight

number

Parcel weight in kilograms [kg]

Required range: x >= 0

Example:

2.35

data.parcels.height

number

Parcel height in centimeters [cm]

Required range: x >= 0

Example:

12.2

data.parcels.width

number

Parcel width in centimeters [cm]

Required range: x >= 0

Example:

15.8

data.parcels.length

number

Parcel length in centimeters [cm]

Required range: x >= 0

Example:

30.5

data.parcels.freetext

string

A freetext field which is intended to be printed on the label.

Example:

"Leave at doorstep"

data.parcels.total_price_excluding_tax

number

Total price excluding tax

Required range: x >= 0

Example:

79.2

data.parcels.total_price_including_tax

number

Total price including tax

Required range: x >= 0

Example:

99

data.parcels.total_tax_amount

number

Total tax amount

Required range: x >= 0

Example:

19.8

data.parcels.items

object[]

List of items

Show child attributes

data.parcels.items.internal_id

string

required

The database id used by the website for the resource

Example:

"1226"

data.parcels.items.internal_reference

string

required

The id that is used to reference the resource externally

Example:

"PRODUCT-1231456"

data.parcels.items.sku

string

required

Item SKU number

Example:

"12345678"

data.parcels.items.name

string

required

Item name

Example:

"Product A"

data.parcels.items.id

string<uuid>

Unique ID

Example:

"c5540f2b-3eea-45c4-957a-9d7b53f899e7"

data.parcels.items.type

string

Description of the resource type

Example:

"item"

data.parcels.items.description

string

Item description

Example:

"Small Blue Product A"

data.parcels.items.hs_code

string

The items HS customs number

Example:

"10203040"

data.parcels.items.country_of_origin

string

ISO3166 Alpha2 country code

Example:

"CN"

data.parcels.items.image_url

string<url>

The url of an item image

Example:

"https://example.com/catalog/product-a.jpg"

data.parcels.items.unit_weight

number

The item unit weight in kilograms [kg]

Example:

1.2

data.parcels.items.unit_price_excluding_tax

number

The item unit price excluding tax

Example:

40.6

data.parcels.items.unit_price_including_tax

number

The item unit price including tax

Example:

50.75

data.parcels.items.quantity

number

The item quantity

Example:

2

data.parcels.items.total_price_excluding_tax

number

The item total price excluding tax

Example:

81.2

data.parcels.items.total_price_including_tax

number

The item total price including tax

Example:

101.5

data.parcels.items.total_tax_amount

number

The item total tax amount

Example:

20.3

data.subtotal_price_excluding_tax

number

The subtotal price excluding tax

Example:

159.2

data.subtotal_price_including_tax

number

The subtotal price including tax

Example:

199

data.shipping_price_excluding_tax

number

The shipping price excluding tax

Example:

20

data.shipping_price_including_tax

number

The shipping price including tax

Example:

25

data.total_price_excluding_tax

number

The total price excluding tax

Example:

179.2

data.total_price_including_tax

number

The total price including tax

Example:

224

data.total_tax_amount

number

The total tax amount

Example:

44.8

data.currency

string

The three letter ISO4217 currency code

Example:

"EUR"

data.sender

object

Sender Resource

Show child attributes

data.sender.internal_id

string

required

The database id used by the website for the resource

Example:

"U3778"

data.sender.internal_reference

string

required

The id that is used to reference the resource externally

Example:

"U-00001675"

data.sender.company

string

required

Company name

Example:

"Maersk"

data.sender.address_line1

string

required

First line used to store the address

Example:

"Esplanaden 50"

data.sender.postal_code

string

required

Postal code

Example:

"1098"

data.sender.city

string

required

City

Example:

"Copenhagen"

data.sender.country

string

required

ISO3166 alpha 2 country code

Example:

"DK"

data.sender.email

string<email>

required

Email address

Example:

"[email protected]"

data.sender.name_line1

string

First line used to store the name of the receiver

Example:

"John Doe"

data.sender.name_line2

string

Second line used to store the name of the receiver

Example:

"Att. Finance"

data.sender.address_line2

string

Second line used to store the address

Example:

"2nd floor"

data.sender.state

string

State

data.sender.region

string

Region

Example:

"Capital"

data.sender.sms

string

Mobile phone number

Example:

"30274735"

data.agent

object

Pickup Resource

Show child attributes

data.agent.internal_id

string

required

The database id used by the website for the resource

Example:

"U3778"

data.agent.internal_reference

string

required

The id that is used to reference the resource externally

Example:

"U-00001675"

data.agent.agent_no

string

required

The carriers own number for the agent

Example:

"2134"

data.agent.company

string

Company name

Example:

"Maersk"

data.agent.name_line1

string

First line used to store the name of the receiver

Example:

"John Doe"

data.agent.name_line2

string

Second line used to store the name of the receiver

Example:

"Att. Finance"

data.agent.address_line1

string

First line used to store the address

Example:

"Esplanaden 50"

data.agent.address_line2

string

Second line used to store the address

Example:

"2nd floor"

data.agent.postal_code

string

Postal code

Example:

"1098"

data.agent.city

string

City

Example:

"Copenhagen"

data.agent.state

string

State

data.agent.region

string

Region

Example:

"Capital"

data.agent.country

string

ISO3166 alpha 2 country code

Example:

"DK"

data.agent.sms

string

Mobile phone number

Example:

"30274735"

data.agent.email

string<email>

Email address

Example:

"[email protected]"

data.addons

object[]

List of addons

Show child attributes

data.addons.code

enum<string>

required

A code describing the addon

Available options:

ADHOC_PICKUP,

AGE_CHECK,

ALCOHOL,

BAGONDOOR,

CARRYIN,

CARRYINHEAVY,

CHRISTMASFUND,

CLIMATE_COMPENSATION,

DANGEROUS_GOODS,

DANGEROUS_GOODS_LIMITED_QUANTITY,

DELIVERYCONFIRMATION,

ECONOMY,

EXPRESS,

EXTEND_DELIVERY,

FLEXCHANGE,

FLEXDELIVERY,

HEAVY20KG,

IDCHECK,

INSURANCE,

LABELESS,

LEAVENOPOD,

NOFLEX,

NOTIFICATION,

NOTIFICATION_EMAIL,

NOTIFICATION_SMS,

PNCREDITNOINVOICE,

PRIVATERECEIVER,

QR,

SECONDDELIVERYATTEMPT,

SIGNATURE,

TYRES,

VALUABLES

data.addons.value

string

Misc value required for certain addons

Example:

"+4530274735"

API Reference

Endpoints

Get a specific shipment

Authorizations

Path Parameters

Response