Import Shipment
Importing 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 import a shipment
Last updated
Importing 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 import a shipment
Last updated
POST
https://api-sandbox.shiplemon.com/v1/shipments/import
Name | Type | Description |
---|---|---|
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
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
Example request body
Returns the created shipment
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
driver
string
This string is an optional string that you have to provide and indicates the carrier of the shipment
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
{
"weight":1000,
"height":20,
"width":20,
"length":20,
"notes":"nike air max",
"value":20,
"currency": "EUR",
"compartment_size": 1
}
address_from*
object
This object describes where the pickup of the item will happen. This is the starting point (point A) of the shipment.
company
, address2
, notes
and zip
are optional and can accept null
This object looks like this:
{
"loacation_id": "123",
"country":"GR",
"zip":"14451",
"name": "Kostas Papadopoulos",
"company": "Papadopoulou IKE",
"address": "Papadopoulou 23",
"address2": "Floor 2",
"city": "Athens",
"phone": "+306900000000",
"email":"example@email.com",
"country": "GR",
"notes": "call me"
}
In the country parameter we accept the ALPHA-2 code format. You can find more here:
https://www.iban.com/country-codes)
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
tracking_ref
string
This is the tracking reference provided from the carrier
tracking_url
string
The tracking URL for the shipment
label_url
string
The URL for the shipment label
extras
object
See request example for object properties