Create a simple shipment

cURL

curl --request POST \
  --url https://api.atlast.co/v1/shipments/simple \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "carrier": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serviceId": "<string>"
  },
  "shipment": {
    "from": {
      "name": "<string>",
      "email": "jsmith@example.com",
      "address": {
        "line1": "<string>",
        "city": "<string>",
        "postCode": "<string>",
        "line2": "<string>",
        "line3": "<string>",
        "country": "<string>",
        "province": "<string>"
      },
      "phoneNumber": "<string>"
    },
    "parcel": {
      "dimensions": {
        "width": 1,
        "height": 1,
        "length": 1,
        "unit": "CM"
      },
      "items": [
        {
          "quantity": 2,
          "value": {
            "value": 1,
            "currency": "<string>"
          },
          "weight": {
            "value": 1
          },
          "description": "<string>"
        }
      ]
    },
    "reference": "<string>",
    "reference2": "<string>"
  },
  "ignore": [
    "SIZE"
  ]
}
'

import requests

url = "https://api.atlast.co/v1/shipments/simple"

payload = {
    "id": "<string>",
    "carrier": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "serviceId": "<string>"
    },
    "shipment": {
        "from": {
            "name": "<string>",
            "email": "jsmith@example.com",
            "address": {
                "line1": "<string>",
                "city": "<string>",
                "postCode": "<string>",
                "line2": "<string>",
                "line3": "<string>",
                "country": "<string>",
                "province": "<string>"
            },
            "phoneNumber": "<string>"
        },
        "parcel": {
            "dimensions": {
                "width": 1,
                "height": 1,
                "length": 1,
                "unit": "CM"
            },
            "items": [
                {
                    "quantity": 2,
                    "value": {
                        "value": 1,
                        "currency": "<string>"
                    },
                    "weight": { "value": 1 },
                    "description": "<string>"
                }
            ]
        },
        "reference": "<string>",
        "reference2": "<string>"
    },
    "ignore": ["SIZE"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    carrier: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', serviceId: '<string>'},
    shipment: {
      from: {
        name: '<string>',
        email: 'jsmith@example.com',
        address: {
          line1: '<string>',
          city: '<string>',
          postCode: '<string>',
          line2: '<string>',
          line3: '<string>',
          country: '<string>',
          province: '<string>'
        },
        phoneNumber: '<string>'
      },
      parcel: {
        dimensions: {width: 1, height: 1, length: 1, unit: 'CM'},
        items: [
          {
            quantity: 2,
            value: {value: 1, currency: '<string>'},
            weight: {value: 1},
            description: '<string>'
          }
        ]
      },
      reference: '<string>',
      reference2: '<string>'
    },
    ignore: ['SIZE']
  })
};

fetch('https://api.atlast.co/v1/shipments/simple', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.atlast.co/v1/shipments/simple",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'carrier' => [
        'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'serviceId' => '<string>'
    ],
    'shipment' => [
        'from' => [
                'name' => '<string>',
                'email' => 'jsmith@example.com',
                'address' => [
                                'line1' => '<string>',
                                'city' => '<string>',
                                'postCode' => '<string>',
                                'line2' => '<string>',
                                'line3' => '<string>',
                                'country' => '<string>',
                                'province' => '<string>'
                ],
                'phoneNumber' => '<string>'
        ],
        'parcel' => [
                'dimensions' => [
                                'width' => 1,
                                'height' => 1,
                                'length' => 1,
                                'unit' => 'CM'
                ],
                'items' => [
                                [
                                                                'quantity' => 2,
                                                                'value' => [
                                                                                                                                'value' => 1,
                                                                                                                                'currency' => '<string>'
                                                                ],
                                                                'weight' => [
                                                                                                                                'value' => 1
                                                                ],
                                                                'description' => '<string>'
                                ]
                ]
        ],
        'reference' => '<string>',
        'reference2' => '<string>'
    ],
    'ignore' => [
        'SIZE'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.atlast.co/v1/shipments/simple"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"carrier\": {\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"serviceId\": \"<string>\"\n  },\n  \"shipment\": {\n    \"from\": {\n      \"name\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"address\": {\n        \"line1\": \"<string>\",\n        \"city\": \"<string>\",\n        \"postCode\": \"<string>\",\n        \"line2\": \"<string>\",\n        \"line3\": \"<string>\",\n        \"country\": \"<string>\",\n        \"province\": \"<string>\"\n      },\n      \"phoneNumber\": \"<string>\"\n    },\n    \"parcel\": {\n      \"dimensions\": {\n        \"width\": 1,\n        \"height\": 1,\n        \"length\": 1,\n        \"unit\": \"CM\"\n      },\n      \"items\": [\n        {\n          \"quantity\": 2,\n          \"value\": {\n            \"value\": 1,\n            \"currency\": \"<string>\"\n          },\n          \"weight\": {\n            \"value\": 1\n          },\n          \"description\": \"<string>\"\n        }\n      ]\n    },\n    \"reference\": \"<string>\",\n    \"reference2\": \"<string>\"\n  },\n  \"ignore\": [\n    \"SIZE\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.atlast.co/v1/shipments/simple")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"carrier\": {\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"serviceId\": \"<string>\"\n  },\n  \"shipment\": {\n    \"from\": {\n      \"name\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"address\": {\n        \"line1\": \"<string>\",\n        \"city\": \"<string>\",\n        \"postCode\": \"<string>\",\n        \"line2\": \"<string>\",\n        \"line3\": \"<string>\",\n        \"country\": \"<string>\",\n        \"province\": \"<string>\"\n      },\n      \"phoneNumber\": \"<string>\"\n    },\n    \"parcel\": {\n      \"dimensions\": {\n        \"width\": 1,\n        \"height\": 1,\n        \"length\": 1,\n        \"unit\": \"CM\"\n      },\n      \"items\": [\n        {\n          \"quantity\": 2,\n          \"value\": {\n            \"value\": 1,\n            \"currency\": \"<string>\"\n          },\n          \"weight\": {\n            \"value\": 1\n          },\n          \"description\": \"<string>\"\n        }\n      ]\n    },\n    \"reference\": \"<string>\",\n    \"reference2\": \"<string>\"\n  },\n  \"ignore\": [\n    \"SIZE\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.atlast.co/v1/shipments/simple")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"carrier\": {\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"serviceId\": \"<string>\"\n  },\n  \"shipment\": {\n    \"from\": {\n      \"name\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"address\": {\n        \"line1\": \"<string>\",\n        \"city\": \"<string>\",\n        \"postCode\": \"<string>\",\n        \"line2\": \"<string>\",\n        \"line3\": \"<string>\",\n        \"country\": \"<string>\",\n        \"province\": \"<string>\"\n      },\n      \"phoneNumber\": \"<string>\"\n    },\n    \"parcel\": {\n      \"dimensions\": {\n        \"width\": 1,\n        \"height\": 1,\n        \"length\": 1,\n        \"unit\": \"CM\"\n      },\n      \"items\": [\n        {\n          \"quantity\": 2,\n          \"value\": {\n            \"value\": 1,\n            \"currency\": \"<string>\"\n          },\n          \"weight\": {\n            \"value\": 1\n          },\n          \"description\": \"<string>\"\n        }\n      ]\n    },\n    \"reference\": \"<string>\",\n    \"reference2\": \"<string>\"\n  },\n  \"ignore\": [\n    \"SIZE\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "carrier": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serviceId": "<string>"
  },
  "parcel": {
    "dimensions": {
      "width": 1,
      "height": 1,
      "length": 1,
      "unit": "CM"
    },
    "weight": {
      "value": 1
    },
    "items": [
      {
        "quantity": 2,
        "description": "<string>",
        "value": {
          "value": 1,
          "currency": "<string>"
        },
        "weight": {
          "value": 1
        }
      }
    ]
  },
  "from": {
    "name": "<string>",
    "email": "jsmith@example.com",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postCode": "<string>",
      "line2": "<string>",
      "line3": "<string>",
      "country": "<string>",
      "province": "<string>"
    },
    "phoneNumber": "<string>"
  },
  "to": {
    "name": "<string>",
    "email": "jsmith@example.com",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postCode": "<string>",
      "line2": "<string>",
      "line3": "<string>",
      "country": "<string>",
      "province": "<string>"
    },
    "phoneNumber": "<string>"
  },
  "metadata": {
    "externalId": "<string>",
    "merchant": {
      "id": "<string>"
    },
    "user": {
      "email": "jsmith@example.com"
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "hasDelivery": true,
  "hasCollection": true,
  "reference": "<string>",
  "reference2": "<string>",
  "labels": [
    {
      "url": "<string>"
    }
  ],
  "trackingNumber": "<string>",
  "trackingUrl": "<string>",
  "statusDescription": "<string>",
  "failureReason": "<string>",
  "collectionRequestedTimeSlot": {
    "date": "<string>",
    "time": "<string>"
  },
  "collection": {
    "bookedTimeSlot": {
      "date": "<string>",
      "time": "<string>"
    },
    "rebooked": true
  }
}

{
  "message": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "details": {}
}

POST

shipments

simple

cURL

curl --request POST \
  --url https://api.atlast.co/v1/shipments/simple \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "carrier": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serviceId": "<string>"
  },
  "shipment": {
    "from": {
      "name": "<string>",
      "email": "jsmith@example.com",
      "address": {
        "line1": "<string>",
        "city": "<string>",
        "postCode": "<string>",
        "line2": "<string>",
        "line3": "<string>",
        "country": "<string>",
        "province": "<string>"
      },
      "phoneNumber": "<string>"
    },
    "parcel": {
      "dimensions": {
        "width": 1,
        "height": 1,
        "length": 1,
        "unit": "CM"
      },
      "items": [
        {
          "quantity": 2,
          "value": {
            "value": 1,
            "currency": "<string>"
          },
          "weight": {
            "value": 1
          },
          "description": "<string>"
        }
      ]
    },
    "reference": "<string>",
    "reference2": "<string>"
  },
  "ignore": [
    "SIZE"
  ]
}
'

import requests

url = "https://api.atlast.co/v1/shipments/simple"

payload = {
    "id": "<string>",
    "carrier": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "serviceId": "<string>"
    },
    "shipment": {
        "from": {
            "name": "<string>",
            "email": "jsmith@example.com",
            "address": {
                "line1": "<string>",
                "city": "<string>",
                "postCode": "<string>",
                "line2": "<string>",
                "line3": "<string>",
                "country": "<string>",
                "province": "<string>"
            },
            "phoneNumber": "<string>"
        },
        "parcel": {
            "dimensions": {
                "width": 1,
                "height": 1,
                "length": 1,
                "unit": "CM"
            },
            "items": [
                {
                    "quantity": 2,
                    "value": {
                        "value": 1,
                        "currency": "<string>"
                    },
                    "weight": { "value": 1 },
                    "description": "<string>"
                }
            ]
        },
        "reference": "<string>",
        "reference2": "<string>"
    },
    "ignore": ["SIZE"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    carrier: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', serviceId: '<string>'},
    shipment: {
      from: {
        name: '<string>',
        email: 'jsmith@example.com',
        address: {
          line1: '<string>',
          city: '<string>',
          postCode: '<string>',
          line2: '<string>',
          line3: '<string>',
          country: '<string>',
          province: '<string>'
        },
        phoneNumber: '<string>'
      },
      parcel: {
        dimensions: {width: 1, height: 1, length: 1, unit: 'CM'},
        items: [
          {
            quantity: 2,
            value: {value: 1, currency: '<string>'},
            weight: {value: 1},
            description: '<string>'
          }
        ]
      },
      reference: '<string>',
      reference2: '<string>'
    },
    ignore: ['SIZE']
  })
};

fetch('https://api.atlast.co/v1/shipments/simple', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.atlast.co/v1/shipments/simple",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'carrier' => [
        'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'serviceId' => '<string>'
    ],
    'shipment' => [
        'from' => [
                'name' => '<string>',
                'email' => 'jsmith@example.com',
                'address' => [
                                'line1' => '<string>',
                                'city' => '<string>',
                                'postCode' => '<string>',
                                'line2' => '<string>',
                                'line3' => '<string>',
                                'country' => '<string>',
                                'province' => '<string>'
                ],
                'phoneNumber' => '<string>'
        ],
        'parcel' => [
                'dimensions' => [
                                'width' => 1,
                                'height' => 1,
                                'length' => 1,
                                'unit' => 'CM'
                ],
                'items' => [
                                [
                                                                'quantity' => 2,
                                                                'value' => [
                                                                                                                                'value' => 1,
                                                                                                                                'currency' => '<string>'
                                                                ],
                                                                'weight' => [
                                                                                                                                'value' => 1
                                                                ],
                                                                'description' => '<string>'
                                ]
                ]
        ],
        'reference' => '<string>',
        'reference2' => '<string>'
    ],
    'ignore' => [
        'SIZE'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.atlast.co/v1/shipments/simple"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"carrier\": {\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"serviceId\": \"<string>\"\n  },\n  \"shipment\": {\n    \"from\": {\n      \"name\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"address\": {\n        \"line1\": \"<string>\",\n        \"city\": \"<string>\",\n        \"postCode\": \"<string>\",\n        \"line2\": \"<string>\",\n        \"line3\": \"<string>\",\n        \"country\": \"<string>\",\n        \"province\": \"<string>\"\n      },\n      \"phoneNumber\": \"<string>\"\n    },\n    \"parcel\": {\n      \"dimensions\": {\n        \"width\": 1,\n        \"height\": 1,\n        \"length\": 1,\n        \"unit\": \"CM\"\n      },\n      \"items\": [\n        {\n          \"quantity\": 2,\n          \"value\": {\n            \"value\": 1,\n            \"currency\": \"<string>\"\n          },\n          \"weight\": {\n            \"value\": 1\n          },\n          \"description\": \"<string>\"\n        }\n      ]\n    },\n    \"reference\": \"<string>\",\n    \"reference2\": \"<string>\"\n  },\n  \"ignore\": [\n    \"SIZE\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.atlast.co/v1/shipments/simple")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"carrier\": {\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"serviceId\": \"<string>\"\n  },\n  \"shipment\": {\n    \"from\": {\n      \"name\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"address\": {\n        \"line1\": \"<string>\",\n        \"city\": \"<string>\",\n        \"postCode\": \"<string>\",\n        \"line2\": \"<string>\",\n        \"line3\": \"<string>\",\n        \"country\": \"<string>\",\n        \"province\": \"<string>\"\n      },\n      \"phoneNumber\": \"<string>\"\n    },\n    \"parcel\": {\n      \"dimensions\": {\n        \"width\": 1,\n        \"height\": 1,\n        \"length\": 1,\n        \"unit\": \"CM\"\n      },\n      \"items\": [\n        {\n          \"quantity\": 2,\n          \"value\": {\n            \"value\": 1,\n            \"currency\": \"<string>\"\n          },\n          \"weight\": {\n            \"value\": 1\n          },\n          \"description\": \"<string>\"\n        }\n      ]\n    },\n    \"reference\": \"<string>\",\n    \"reference2\": \"<string>\"\n  },\n  \"ignore\": [\n    \"SIZE\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.atlast.co/v1/shipments/simple")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"carrier\": {\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"serviceId\": \"<string>\"\n  },\n  \"shipment\": {\n    \"from\": {\n      \"name\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"address\": {\n        \"line1\": \"<string>\",\n        \"city\": \"<string>\",\n        \"postCode\": \"<string>\",\n        \"line2\": \"<string>\",\n        \"line3\": \"<string>\",\n        \"country\": \"<string>\",\n        \"province\": \"<string>\"\n      },\n      \"phoneNumber\": \"<string>\"\n    },\n    \"parcel\": {\n      \"dimensions\": {\n        \"width\": 1,\n        \"height\": 1,\n        \"length\": 1,\n        \"unit\": \"CM\"\n      },\n      \"items\": [\n        {\n          \"quantity\": 2,\n          \"value\": {\n            \"value\": 1,\n            \"currency\": \"<string>\"\n          },\n          \"weight\": {\n            \"value\": 1\n          },\n          \"description\": \"<string>\"\n        }\n      ]\n    },\n    \"reference\": \"<string>\",\n    \"reference2\": \"<string>\"\n  },\n  \"ignore\": [\n    \"SIZE\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "carrier": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serviceId": "<string>"
  },
  "parcel": {
    "dimensions": {
      "width": 1,
      "height": 1,
      "length": 1,
      "unit": "CM"
    },
    "weight": {
      "value": 1
    },
    "items": [
      {
        "quantity": 2,
        "description": "<string>",
        "value": {
          "value": 1,
          "currency": "<string>"
        },
        "weight": {
          "value": 1
        }
      }
    ]
  },
  "from": {
    "name": "<string>",
    "email": "jsmith@example.com",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postCode": "<string>",
      "line2": "<string>",
      "line3": "<string>",
      "country": "<string>",
      "province": "<string>"
    },
    "phoneNumber": "<string>"
  },
  "to": {
    "name": "<string>",
    "email": "jsmith@example.com",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postCode": "<string>",
      "line2": "<string>",
      "line3": "<string>",
      "country": "<string>",
      "province": "<string>"
    },
    "phoneNumber": "<string>"
  },
  "metadata": {
    "externalId": "<string>",
    "merchant": {
      "id": "<string>"
    },
    "user": {
      "email": "jsmith@example.com"
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "hasDelivery": true,
  "hasCollection": true,
  "reference": "<string>",
  "reference2": "<string>",
  "labels": [
    {
      "url": "<string>"
    }
  ],
  "trackingNumber": "<string>",
  "trackingUrl": "<string>",
  "statusDescription": "<string>",
  "failureReason": "<string>",
  "collectionRequestedTimeSlot": {
    "date": "<string>",
    "time": "<string>"
  },
  "collection": {
    "bookedTimeSlot": {
      "date": "<string>",
      "time": "<string>"
    },
    "rebooked": true
  }
}

{
  "message": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "details": {}
}

{
  "message": "<string>",
  "details": {}
}

Shipments are composed of a delivery and optionally a collection.

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Create simple shipment request

string

required

carrier

object

required

Show child attributes

shipment

object

required

Create return shipment request

Show child attributes

ignore

enum<string>[]

Carrier constraints to ignore when creating a shipment. If not specified, all constraints will be checked. While our service constraints are based on carrier specifications, like size, these specifications are often vague and difficult to enforce. To allow for this, we provide a way to ignore specific constraints when creating a shipment. ** Note that this is not a replacement for the service constraints, it is only a way to ignore specific constraints when creating a shipment. And the API consumer is still responsible for ensuring that the shipment is valid. **

Available options:

SIZE

Response

The request has succeeded.

Shipment resource

string<uuid>

required

At last shipment id

carrier

object

required

Show child attributes

parcel

object

required

Show child attributes

from

object

required

Data used to specify address and receiver/sender details to create a shipment and collection. The data send in these address details are NOT verified. It's the responsibility of the caller to ensure the address data is correct or shipment/collection requests can fail.

Show child attributes

object

required

Show child attributes

state

enum<string>

required

Available options:

AWAITING_BOOKING,

READY,

ONGOING,

COMPLETE,

CANCELED,

FAIL

metadata

object

required

Show child attributes

createdAt

string<date-time>

required

hasDelivery

boolean

required

hasCollection

boolean

required

reference

string

Shipment Reference.

Required string length: 1 - 20

reference2

string

Optional shipping reference (might not be suported by all carriers)

Required string length: 1 - 20

labels

object[]

Show child attributes

trackingNumber

string

trackingUrl

string<uri>

statusDescription

string

failureReason

string

latestDeliveryEvent

enum<string>

Available options:

BOOKED,

COLLECTED,

AT_HUB,

IN_TRANSIT,

OUT_FOR_DELIVERY,

FAILED_ATTEMPT,

DELIVERED,

ON_HOLD,

ADDRESS_ISSUE,

RETURNED_TO_SENDER,

TRACKING_EXPIRED,

CANCELLED,

AWAITING_CUSTOMER_COLLECTION,

PACKING,

MISSING,

DAMAGED

deliveryState

enum<string>

Available options:

AWAITING_BOOKING,

READY,

ONGOING,

COMPLETE,

CANCELED,

FAIL

collectionRequestedTimeSlot

object

Resovled collection time slot

Show child attributes

collection

object

Show child attributes

API Documentation

Endpoints

Webhooks

Create a simple shipment

Authorizations

Body

Response