Create Shipment for Locker
Creating a shipment, requires the sender's address, recipient's address, and a parcel (one or more items and their related information). Find below more details on how you can create a shipment
Create Shipment
POST
https://api-sandbox.shiplemon.com/v1/shipments
Request Body
Name | Type | Description |
---|---|---|
related_order_id | string | You can use this to store your internal reference id. For example the related order to be matched for this shipment from the ecommerce platform |
cash_on_delivery | number | Cash on Delivery (Αντικαταβολή) will be allowed only if you have provided your own credentials when using the rated carrier The amount for cash on delivery. If shipment does not use cash on delivery, set null |
rate_id* | string | This is the selected rate (the id of the rate selected in the /rates request) This string is not a string that you have to create. It will be provided and you have to include it in the shipment request in order for us to know the selected option of the user |
items* | array | This is an array that describes more details about the items that will be sent in the shipment and that you want to get rates for.
Each item in this array is an object in the following format (all the dimensions are in cm and the weight in grams)
The value and currency fields are optional
|
address_from* | object | This object describes where the pickup of the item will happen. This is the starting point (point A) of the shipment.
|
address_to* | object | The same format as the address_from in order to define the destination of the shipment (point B) |
incoming_order_id | string | Use this parameter to link this shipment as a child of an incoming order |
extras | object | See request example for object properties |
Example data for request (eg. Boxnow)
extras:
insurance_amount: the declared amount for the package to be insured
is_saturday_delivery: if the delivery is about to happen on Saturday (if the carrier support it)
is_customs_invoice_document: boolean flag that indicates if the upload PDF is invoice document to be used for customs
Scheduling a pickup
You can also add the following if you want to schedule courier to PICKUP from address_from, otherwise set it to null
or don't provide this property in the JSON completely.
Important! you can set pickup only for rates that support it "has_pickup": true
Request
Example request body
Response
Returns the created shipment
Last updated