Skip to main content
POST
/
v1
/
website
/
{team}
/
shipments
Store a new shipment
curl --request POST \
  --url 'https://app.smartsend.io/api/v1/website/{team}/shipments?api_token=' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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",
    "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"
  },
  "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]"
  },
  "parcels": [
    {
      "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": [
        {
          "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"
    }
  ]
}
'
{
  "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"
      }
    ]
  }
}

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

Body

application/json

Input data format

Base shipment

​
internal_id
string
required

The database id used by the website for the resource

Example:

"1226"

​
internal_reference
string
required

The id that is used to reference the resource externally

Example:

"AB-00001445"

​
shipping_carrier
enum<string>
required

The carrier code

Available options:
postnord,
gls,
dao,
bifrost,
bring
Example:

"postnord"

​
shipping_method
string
required

The code for the shipping method

Example:

"collect"

​
subtotal_price_excluding_tax
number

The subtotal price excluding tax

Example:

159.2

​
subtotal_price_including_tax
number

The subtotal price including tax

Example:

199

​
shipping_price_excluding_tax
number

The shipping price excluding tax

Example:

20

​
shipping_price_including_tax
number

The shipping price including tax

Example:

25

​
total_price_excluding_tax
number

The total price excluding tax

Example:

179.2

​
total_price_including_tax
number

The total price including tax

Example:

224

​
total_tax_amount
number

The total tax amount

Example:

44.8

​
currency
string

The three letter ISO4217 currency code

Example:

"EUR"

​
receiver
object

Base Receiver

​
sender
object

Base Sender

​
agent
object

Base Pickup

​
parcels
object[]

List of parcels

​
addons
object[]

List of addons

Response

Successful operation

​
data
object

Shipment Resource