Skip to main content
POST
/
shipments
/
bookShopAsync
Book shipment
curl --request POST \
  --url https://api.quivo.co/shipments/bookShopAsync \
  --header 'Content-Type: application/json' \
  --data '
{
  "shippingServiceGroupId": 123,
  "mailTo": "<string>",
  "shopId": 123,
  "orderIdentifiers": [
    "<string>"
  ],
  "parcelWeight": 1,
  "requestUUID": "<string>",
  "reference": "<string>",
  "shipFrom": {
    "name": "<string>",
    "company": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "state": "<string>",
    "countryIso2": "<string>",
    "street": "<string>",
    "street2": "<string>",
    "latitude": 123,
    "longitude": 123
  },
  "lengthM": 1,
  "widthM": 1,
  "heightM": 1,
  "parcelHeight": 1,
  "parcelWidth": 1,
  "parcelLength": 1,
  "contentWeight": 1,
  "exportFulfillment": true,
  "hideEmailAddress": true
}
'
This response has no body data.

Body

application/json

Request body data for Book shipment

Request payload for booking shipments for shop orders asynchronously. Contains shop identifiers, order references, shipping configuration, and email notification settings.

​
shippingServiceGroupId
integer<int64>
required

shipping service group from which to load the shipping services to use.

​
mailTo
string
required

e-Mail address to which the results will be sent.
Muliple e-mail addresses can be specified by separating them with a comma.

​
shopId
integer<int64>
required

ID of the shop from which the order data can be retrieved.

​
orderIdentifiers
string[]
required

list of order identifiers for which the shipments need to get booked.
At least one order identifier needs to be specified.
Duplicate or empty order identifiers are not allowed.

Required array length: 1 - 2147483647 elements
​
parcelWeight
number
required

The weight of the packaging material used in kg.
Should not contain the weight of the shipment's content (eg: products).

Required range: x > 0
​
requestUUID
string

A unique identifier for the request.
Used for tracing and to prevent duplicate shipment bookings.
This value is optional, if not included, a random requestUUID is generated.

​
reference
string

A human readable reference for the request.
This will be included in the mail that is sent once the operation completes.
This value is optional, if not included, a random reference will be generated.

​
shipFrom
object

The

​
lengthM
number

Optional length (in meters) of the shipment.

Required range: x > 0
​
widthM
number

Optional width (in meters) of the shipment.

Required range: x > 0
​
heightM
number

Optional height (in meters) of the shipment.

Required range: x > 0
​
parcelHeight
number

The height of the packaging material used in m.
Value is rounded to three decimal places.

Required range: x > 0
​
parcelWidth
number

The width of the packaging material used in m.
Value is rounded to three decimal places.

Required range: x > 0
​
parcelLength
number

The length of the packaging material used in m.
Value is rounded to three decimal places.

Required range: x > 0
​
contentWeight
number

Optional weight of the shipment's content in kg.
Should not contain the weight of the packaging material.
Use this field with care and in rare cases only, as it overrides the default weight calculation, which is based on the ordered product's weight.
Using this field can cause inconsistencies with the customs declaration and could result in errors during shipment booking.

Required range: x > 0
​
exportFulfillment
boolean

If set to true, the fulfillment data (tracking number and provider) are transmitted to the shop system after the label was created.

​
hideEmailAddress
boolean

If set to true, the shipment recipient's e-mail address is not transmitted to the carrier.
This means that the carrier is not able to contact the recipient of the shipment by e-mail.

Response

Bad request - the request payload is invalid, missing required fields, or contains invalid data.