Skip to main content
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": "[email protected]",
      "address": {
        "line1": "<string>",
        "city": "<string>",
        "postCode": "<string>",
        "line2": "<string>",
        "line3": "<string>"
      },
      "phoneNumber": "<string>"
    },
    "parcel": {
      "dimensions": {
        "width": 1,
        "height": 1,
        "length": 1,
        "unit": "CM"
      },
      "items": [
        {
          "quantity": 2,
          "value": {
            "value": 1,
            "currency": "<string>"
          },
          "weight": {
            "value": 1,
            "unit": "GRAMS"
          },
          "description": "<string>"
        }
      ]
    },
    "reference": "<string>",
    "reference2": "<string>",
    "to": {
      "name": "<string>",
      "email": "[email protected]",
      "address": {
        "line1": "<string>",
        "city": "<string>",
        "postCode": "<string>",
        "line2": "<string>",
        "line3": "<string>"
      },
      "phoneNumber": "<string>"
    }
  },
  "ignore": [
    "SIZE"
  ]
}
'
{
  "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,
      "unit": "GRAMS"
    },
    "items": [
      {
        "quantity": 2,
        "description": "<string>",
        "value": {
          "value": 1,
          "currency": "<string>"
        },
        "weight": {
          "value": 1,
          "unit": "GRAMS"
        }
      }
    ]
  },
  "from": {
    "name": "<string>",
    "email": "[email protected]",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postCode": "<string>",
      "line2": "<string>",
      "line3": "<string>"
    },
    "phoneNumber": "<string>"
  },
  "to": {
    "name": "<string>",
    "email": "[email protected]",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postCode": "<string>",
      "line2": "<string>",
      "line3": "<string>"
    },
    "phoneNumber": "<string>"
  },
  "state": "AWAITING_BOOKING",
  "metadata": {
    "externalId": "<string>",
    "merchant": {
      "id": "<string>"
    },
    "user": {
      "email": "[email protected]"
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "hasDelivery": true,
  "hasCollection": true,
  "reference": "<string>",
  "reference2": "<string>",
  "labels": [
    {
      "url": "<string>",
      "type": "PAPERLESS"
    }
  ],
  "trackingNumber": "<string>",
  "trackingUrl": "<string>",
  "statusDescription": "<string>",
  "failureReason": "<string>",
  "latestDeliveryEvent": "BOOKED",
  "deliveryState": "AWAITING_BOOKING",
  "collectionRequestedTimeSlot": {
    "date": "<string>",
    "time": "<string>"
  },
  "collection": {
    "bookedTimeSlot": {
      "date": "<string>",
      "time": "<string>"
    },
    "rebooked": true
  }
}
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

​
id
string
required
​
carrier
object
required
​
shipment
object
required

Create return shipment request

​
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

​
id
string<uuid>
required

At last shipment id

​
carrier
object
required
​
parcel
object
required
​
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.

​
to
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.

​
state
enum<string>
required
Available options:
AWAITING_BOOKING,
READY,
ONGOING,
COMPLETE,
CANCELED,
FAIL
​
metadata
object
required
​
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[]
​
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

​
collection
object