- Workflow
- Import an order
- Update an order's status
- Import a shipment
- Update the order to receive 'boarding is complete' state
- Access our API
Workflow
After this part in the workflow, everything is handled by Seven Senders, retrieving the shipment delivery information via the carriers, etc.
Import an order
The order is the fundamental entity that you need to import inside your account to track your shipments. The relation is one to many, which means one order can have a various number of shipments.
To import an order into your account, use the POST method of the /v2/orders endpoint.
Update an order's status
When you import an order in you Seven Senders account, its status will always be new.
You have the possibility to update its status towards different values. Those value are here to help you convey your process state to the consumers.
Order statuses
Status | Description |
| new | Status when the order is created inside your account |
| paid | Order was paid by the customer |
| in_production | This status is useful if you need to produce/made the item ordered by the customer |
| in_preparation | The order is processed inside your warehouse |
To update an order's status in your account, use the POST method of the /v2/order-states endpoint.
Import a shipment
When you import a shipment, you link it to an order (using you own order reference). This link when created will automatically change the order's status to shipped.
A shipment can only have 1 link toward an order.
To import a shipment into your account, use the POST method of the /v2/shipments endpoint. The link between an order and a shipment is made via the shop_order_id (your internal reference for the order).
After importing a shipment inside your account Seven Senders will take over the update of the shipment's status.
Shipment statuses
Seven Senders will update the shipment status based on the carrier information, a shipment can have the following status.
| Status | Description |
|---|---|
| New | The shipment has been created inside your Seven Senders account |
| Fist scan at LMC | The Last Mile Carrier has scanned the shipment for the first time Normally occur when the carrier retrieve the shipment at your warehouse |
| Info | The carrier has received the shipment information into his system |
| Pickup | The shipment has been picked up by the carrier at your warehouse |
| Hub scan at LMC | The Last Mile Carrier has scanned your shipment inside his hub |
| Out for delivery | The Last Mile Carrier went to deliver the shipment to the customer |
| Delivery attempt failed | The delivery attempt has failed |
| Delivered to pickup point | The shipment has been delivery to a third party |
| Delivered | The shipment was succesfully delivered to the customer |
| Lost | The shipment has been lost |
Update the order to receive 'boarding is complete' state
When all the items inside an order have been shipped from your warehouse, you need to tell us this information.
With this information we can put an order as Completed when all those shipments will be delivered. Completed status is the end of life status for an order:
- If boarding complete = true (or null) and all shipments are delivered → order completed
- If boarding complete = true (or null) and 1 shipment is delivered → order NOT completed
- If boarding complete = false and 1 shipment created in delivered → order NOT completed
- If boarding complete = false and all shipment created in delivered → order NOT completed
To do that you need to call our /v2/orders/:id endpoint with the PATCH method, use the boarding_complete parameter with the value 1.
Access our API
To access our API and manage your Seven Senders account, you will need an API-KEY. This credential is given to you when your account is created.
The tokens created with help of the API key are valid for one hour. We recommend to request new tokens every 30 to 45 minutes.