Book shipment
curl --request POST \
--url https://api.quivo.co/v2/shipments/bookBatchAsync \
--header 'Authorization: Bearer <token>' \
--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,
"currency": "<string>",
"tariffNumber": "<string>",
"orderedSku": "<string>",
"unNumber": "<string>"
}
],
"invoiceNumber": "<string>",
"invoiceDate": "2023-12-25",
"transportInsuranceAmount": 1,
"includeReturnLabel": true,
"trackingEnabled": true,
"shipmentDate": "2023-12-25",
"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>"
}
'import requests
url = "https://api.quivo.co/v2/shipments/bookBatchAsync"
payload = {
"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,
"currency": "<string>",
"tariffNumber": "<string>",
"orderedSku": "<string>",
"unNumber": "<string>"
}
],
"invoiceNumber": "<string>",
"invoiceDate": "2023-12-25",
"transportInsuranceAmount": 1,
"includeReturnLabel": True,
"trackingEnabled": True,
"shipmentDate": "2023-12-25",
"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>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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,
currency: '<string>',
tariffNumber: '<string>',
orderedSku: '<string>',
unNumber: '<string>'
}
],
invoiceNumber: '<string>',
invoiceDate: '2023-12-25',
transportInsuranceAmount: 1,
includeReturnLabel: true,
trackingEnabled: true,
shipmentDate: '2023-12-25',
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>'
})
};
fetch('https://api.quivo.co/v2/shipments/bookBatchAsync', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.quivo.co/v2/shipments/bookBatchAsync",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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,
'currency' => '<string>',
'tariffNumber' => '<string>',
'orderedSku' => '<string>',
'unNumber' => '<string>'
]
],
'invoiceNumber' => '<string>',
'invoiceDate' => '2023-12-25',
'transportInsuranceAmount' => 1,
'includeReturnLabel' => true,
'trackingEnabled' => true,
'shipmentDate' => '2023-12-25',
'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>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.quivo.co/v2/shipments/bookBatchAsync"
payload := strings.NewReader("{\n \"reference\": \"<string>\",\n \"bookRequests\": [\n {\n \"shippingServiceGroupId\": 123,\n \"grossWeightKg\": 1,\n \"shipTo\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"sellerId\": 123,\n \"lineNumber\": 123,\n \"requestUUID\": \"<string>\",\n \"reference\": \"<string>\",\n \"shipFrom\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"lengthM\": 1,\n \"widthM\": 1,\n \"heightM\": 1,\n \"customsPositions\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 1,\n \"pieceNetWeightKg\": 1,\n \"pieceNetCustomsValue\": 1,\n \"currency\": \"<string>\",\n \"tariffNumber\": \"<string>\",\n \"orderedSku\": \"<string>\",\n \"unNumber\": \"<string>\"\n }\n ],\n \"invoiceNumber\": \"<string>\",\n \"invoiceDate\": \"2023-12-25\",\n \"transportInsuranceAmount\": 1,\n \"includeReturnLabel\": true,\n \"trackingEnabled\": true,\n \"shipmentDate\": \"2023-12-25\",\n \"additionalParcels\": [\n {\n \"weight\": 1,\n \"length\": 123,\n \"width\": 123,\n \"height\": 123,\n \"reference\": \"<string>\"\n }\n ],\n \"userIdentifier\": \"<string>\",\n \"shopOrderIdentifier\": \"<string>\",\n \"contentDescription\": \"<string>\",\n \"systemReference\": \"<string>\",\n \"shipmentAttachments\": [\n {\n \"fileName\": \"<string>\",\n \"fileKey\": \"<string>\",\n \"mimeType\": \"<string>\"\n }\n ],\n \"cashOnDeliveryAmount\": 123,\n \"cashOnDeliveryCurrency\": \"<string>\"\n }\n ],\n \"email\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.quivo.co/v2/shipments/bookBatchAsync")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reference\": \"<string>\",\n \"bookRequests\": [\n {\n \"shippingServiceGroupId\": 123,\n \"grossWeightKg\": 1,\n \"shipTo\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"sellerId\": 123,\n \"lineNumber\": 123,\n \"requestUUID\": \"<string>\",\n \"reference\": \"<string>\",\n \"shipFrom\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"lengthM\": 1,\n \"widthM\": 1,\n \"heightM\": 1,\n \"customsPositions\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 1,\n \"pieceNetWeightKg\": 1,\n \"pieceNetCustomsValue\": 1,\n \"currency\": \"<string>\",\n \"tariffNumber\": \"<string>\",\n \"orderedSku\": \"<string>\",\n \"unNumber\": \"<string>\"\n }\n ],\n \"invoiceNumber\": \"<string>\",\n \"invoiceDate\": \"2023-12-25\",\n \"transportInsuranceAmount\": 1,\n \"includeReturnLabel\": true,\n \"trackingEnabled\": true,\n \"shipmentDate\": \"2023-12-25\",\n \"additionalParcels\": [\n {\n \"weight\": 1,\n \"length\": 123,\n \"width\": 123,\n \"height\": 123,\n \"reference\": \"<string>\"\n }\n ],\n \"userIdentifier\": \"<string>\",\n \"shopOrderIdentifier\": \"<string>\",\n \"contentDescription\": \"<string>\",\n \"systemReference\": \"<string>\",\n \"shipmentAttachments\": [\n {\n \"fileName\": \"<string>\",\n \"fileKey\": \"<string>\",\n \"mimeType\": \"<string>\"\n }\n ],\n \"cashOnDeliveryAmount\": 123,\n \"cashOnDeliveryCurrency\": \"<string>\"\n }\n ],\n \"email\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quivo.co/v2/shipments/bookBatchAsync")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reference\": \"<string>\",\n \"bookRequests\": [\n {\n \"shippingServiceGroupId\": 123,\n \"grossWeightKg\": 1,\n \"shipTo\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"sellerId\": 123,\n \"lineNumber\": 123,\n \"requestUUID\": \"<string>\",\n \"reference\": \"<string>\",\n \"shipFrom\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"lengthM\": 1,\n \"widthM\": 1,\n \"heightM\": 1,\n \"customsPositions\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 1,\n \"pieceNetWeightKg\": 1,\n \"pieceNetCustomsValue\": 1,\n \"currency\": \"<string>\",\n \"tariffNumber\": \"<string>\",\n \"orderedSku\": \"<string>\",\n \"unNumber\": \"<string>\"\n }\n ],\n \"invoiceNumber\": \"<string>\",\n \"invoiceDate\": \"2023-12-25\",\n \"transportInsuranceAmount\": 1,\n \"includeReturnLabel\": true,\n \"trackingEnabled\": true,\n \"shipmentDate\": \"2023-12-25\",\n \"additionalParcels\": [\n {\n \"weight\": 1,\n \"length\": 123,\n \"width\": 123,\n \"height\": 123,\n \"reference\": \"<string>\"\n }\n ],\n \"userIdentifier\": \"<string>\",\n \"shopOrderIdentifier\": \"<string>\",\n \"contentDescription\": \"<string>\",\n \"systemReference\": \"<string>\",\n \"shipmentAttachments\": [\n {\n \"fileName\": \"<string>\",\n \"fileKey\": \"<string>\",\n \"mimeType\": \"<string>\"\n }\n ],\n \"cashOnDeliveryAmount\": 123,\n \"cashOnDeliveryCurrency\": \"<string>\"\n }\n ],\n \"email\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"warnings": [
{
"shippingLabelReference": "<string>",
"exportDeclarationDocumentRequired": true
}
]
}shipments
Book shipment
Start booking multiple shipments asynchronously.
POST
/
shipments
/
bookBatchAsync
Book shipment
curl --request POST \
--url https://api.quivo.co/v2/shipments/bookBatchAsync \
--header 'Authorization: Bearer <token>' \
--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,
"currency": "<string>",
"tariffNumber": "<string>",
"orderedSku": "<string>",
"unNumber": "<string>"
}
],
"invoiceNumber": "<string>",
"invoiceDate": "2023-12-25",
"transportInsuranceAmount": 1,
"includeReturnLabel": true,
"trackingEnabled": true,
"shipmentDate": "2023-12-25",
"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>"
}
'import requests
url = "https://api.quivo.co/v2/shipments/bookBatchAsync"
payload = {
"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,
"currency": "<string>",
"tariffNumber": "<string>",
"orderedSku": "<string>",
"unNumber": "<string>"
}
],
"invoiceNumber": "<string>",
"invoiceDate": "2023-12-25",
"transportInsuranceAmount": 1,
"includeReturnLabel": True,
"trackingEnabled": True,
"shipmentDate": "2023-12-25",
"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>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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,
currency: '<string>',
tariffNumber: '<string>',
orderedSku: '<string>',
unNumber: '<string>'
}
],
invoiceNumber: '<string>',
invoiceDate: '2023-12-25',
transportInsuranceAmount: 1,
includeReturnLabel: true,
trackingEnabled: true,
shipmentDate: '2023-12-25',
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>'
})
};
fetch('https://api.quivo.co/v2/shipments/bookBatchAsync', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.quivo.co/v2/shipments/bookBatchAsync",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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,
'currency' => '<string>',
'tariffNumber' => '<string>',
'orderedSku' => '<string>',
'unNumber' => '<string>'
]
],
'invoiceNumber' => '<string>',
'invoiceDate' => '2023-12-25',
'transportInsuranceAmount' => 1,
'includeReturnLabel' => true,
'trackingEnabled' => true,
'shipmentDate' => '2023-12-25',
'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>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.quivo.co/v2/shipments/bookBatchAsync"
payload := strings.NewReader("{\n \"reference\": \"<string>\",\n \"bookRequests\": [\n {\n \"shippingServiceGroupId\": 123,\n \"grossWeightKg\": 1,\n \"shipTo\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"sellerId\": 123,\n \"lineNumber\": 123,\n \"requestUUID\": \"<string>\",\n \"reference\": \"<string>\",\n \"shipFrom\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"lengthM\": 1,\n \"widthM\": 1,\n \"heightM\": 1,\n \"customsPositions\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 1,\n \"pieceNetWeightKg\": 1,\n \"pieceNetCustomsValue\": 1,\n \"currency\": \"<string>\",\n \"tariffNumber\": \"<string>\",\n \"orderedSku\": \"<string>\",\n \"unNumber\": \"<string>\"\n }\n ],\n \"invoiceNumber\": \"<string>\",\n \"invoiceDate\": \"2023-12-25\",\n \"transportInsuranceAmount\": 1,\n \"includeReturnLabel\": true,\n \"trackingEnabled\": true,\n \"shipmentDate\": \"2023-12-25\",\n \"additionalParcels\": [\n {\n \"weight\": 1,\n \"length\": 123,\n \"width\": 123,\n \"height\": 123,\n \"reference\": \"<string>\"\n }\n ],\n \"userIdentifier\": \"<string>\",\n \"shopOrderIdentifier\": \"<string>\",\n \"contentDescription\": \"<string>\",\n \"systemReference\": \"<string>\",\n \"shipmentAttachments\": [\n {\n \"fileName\": \"<string>\",\n \"fileKey\": \"<string>\",\n \"mimeType\": \"<string>\"\n }\n ],\n \"cashOnDeliveryAmount\": 123,\n \"cashOnDeliveryCurrency\": \"<string>\"\n }\n ],\n \"email\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.quivo.co/v2/shipments/bookBatchAsync")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reference\": \"<string>\",\n \"bookRequests\": [\n {\n \"shippingServiceGroupId\": 123,\n \"grossWeightKg\": 1,\n \"shipTo\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"sellerId\": 123,\n \"lineNumber\": 123,\n \"requestUUID\": \"<string>\",\n \"reference\": \"<string>\",\n \"shipFrom\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"lengthM\": 1,\n \"widthM\": 1,\n \"heightM\": 1,\n \"customsPositions\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 1,\n \"pieceNetWeightKg\": 1,\n \"pieceNetCustomsValue\": 1,\n \"currency\": \"<string>\",\n \"tariffNumber\": \"<string>\",\n \"orderedSku\": \"<string>\",\n \"unNumber\": \"<string>\"\n }\n ],\n \"invoiceNumber\": \"<string>\",\n \"invoiceDate\": \"2023-12-25\",\n \"transportInsuranceAmount\": 1,\n \"includeReturnLabel\": true,\n \"trackingEnabled\": true,\n \"shipmentDate\": \"2023-12-25\",\n \"additionalParcels\": [\n {\n \"weight\": 1,\n \"length\": 123,\n \"width\": 123,\n \"height\": 123,\n \"reference\": \"<string>\"\n }\n ],\n \"userIdentifier\": \"<string>\",\n \"shopOrderIdentifier\": \"<string>\",\n \"contentDescription\": \"<string>\",\n \"systemReference\": \"<string>\",\n \"shipmentAttachments\": [\n {\n \"fileName\": \"<string>\",\n \"fileKey\": \"<string>\",\n \"mimeType\": \"<string>\"\n }\n ],\n \"cashOnDeliveryAmount\": 123,\n \"cashOnDeliveryCurrency\": \"<string>\"\n }\n ],\n \"email\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quivo.co/v2/shipments/bookBatchAsync")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reference\": \"<string>\",\n \"bookRequests\": [\n {\n \"shippingServiceGroupId\": 123,\n \"grossWeightKg\": 1,\n \"shipTo\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"sellerId\": 123,\n \"lineNumber\": 123,\n \"requestUUID\": \"<string>\",\n \"reference\": \"<string>\",\n \"shipFrom\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"countryIso2\": \"<string>\",\n \"street\": \"<string>\",\n \"street2\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"lengthM\": 1,\n \"widthM\": 1,\n \"heightM\": 1,\n \"customsPositions\": [\n {\n \"description\": \"<string>\",\n \"quantity\": 1,\n \"pieceNetWeightKg\": 1,\n \"pieceNetCustomsValue\": 1,\n \"currency\": \"<string>\",\n \"tariffNumber\": \"<string>\",\n \"orderedSku\": \"<string>\",\n \"unNumber\": \"<string>\"\n }\n ],\n \"invoiceNumber\": \"<string>\",\n \"invoiceDate\": \"2023-12-25\",\n \"transportInsuranceAmount\": 1,\n \"includeReturnLabel\": true,\n \"trackingEnabled\": true,\n \"shipmentDate\": \"2023-12-25\",\n \"additionalParcels\": [\n {\n \"weight\": 1,\n \"length\": 123,\n \"width\": 123,\n \"height\": 123,\n \"reference\": \"<string>\"\n }\n ],\n \"userIdentifier\": \"<string>\",\n \"shopOrderIdentifier\": \"<string>\",\n \"contentDescription\": \"<string>\",\n \"systemReference\": \"<string>\",\n \"shipmentAttachments\": [\n {\n \"fileName\": \"<string>\",\n \"fileKey\": \"<string>\",\n \"mimeType\": \"<string>\"\n }\n ],\n \"cashOnDeliveryAmount\": 123,\n \"cashOnDeliveryCurrency\": \"<string>\"\n }\n ],\n \"email\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"warnings": [
{
"shippingLabelReference": "<string>",
"exportDeclarationDocumentRequired": true
}
]
}Authorizations
Access token from POST /v2/oauth2/token, requested with an API credential. See https://api-docs.quivo.co/api-reference/authentication.
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.
A human readable reference for the whole batch request.
This will be included in the mail that is sent once the operation completes.
List of book requests for the labels that need to be created.
Show child attributes
Show child attributes
The E-Mail address to which the ZIP File with the labels and export documents is sent.
Response
successful operation
List of warnings for the booked shipments, such as export declaration document required.
Show child attributes
Show child attributes