Skip to main content
POST
/
shipments
/
bookBatchAsync
Book shipment
curl --request POST \
  --url https://api.quivo.co/shipments/bookBatchAsync \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference": "<string>",
  "bookRequests": [
    {
      "shippingServiceGroupId": 123,
      "grossWeightKg": 1,
      "shipTo": {
        "name": "<string>",
        "company": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "zip": "<string>",
        "city": "<string>",
        "state": "<string>",
        "countryIso2": "<string>",
        "street": "<string>",
        "street2": "<string>",
        "latitude": 123,
        "longitude": 123
      },
      "sellerId": 123,
      "lineNumber": 123,
      "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,
      "customsPositions": [
        {
          "description": "<string>",
          "quantity": 1,
          "pieceNetWeightKg": 1,
          "pieceNetCustomsValue": 1,
          "originCountryIso2": "AF",
          "currency": "<string>",
          "tariffNumber": "<string>",
          "orderedSku": "<string>",
          "unNumber": "<string>"
        }
      ],
      "invoiceNumber": "<string>",
      "invoiceDate": "2023-12-25",
      "transportInsuranceAmount": 1,
      "includeReturnLabel": true,
      "trackingEnabled": true,
      "shipmentDate": "2023-12-25",
      "termsOfTrade": "DAP",
      "additionalParcels": [
        {
          "weight": 1,
          "length": 123,
          "width": 123,
          "height": 123,
          "reference": "<string>"
        }
      ],
      "userIdentifier": "<string>",
      "shopOrderIdentifier": "<string>",
      "contentDescription": "<string>",
      "systemReference": "<string>",
      "shipmentAttachments": [
        {
          "fileName": "<string>",
          "fileKey": "<string>",
          "mimeType": "<string>"
        }
      ],
      "cashOnDeliveryAmount": 123,
      "cashOnDeliveryCurrency": "<string>"
    }
  ],
  "email": "<string>"
}
'
This response has no body data.

Body

application/json

Request body data for Book shipment

Request payload for booking multiple shipments asynchronously in batch. Contains shipment details and configuration for processing multiple shipping labels at once.

​
reference
string
required

A human readable reference for the whole batch request.
This will be included in the mail that is sent once the operation completes.

​
bookRequests
object[]
required

List of book requests for the labels that need to be created.

​
email
string
required

The E-Mail address to which the ZIP File with the labels and export documents is sent.

Response

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