Book shipment
curl --request POST \
--url https://api.quivo.co/v2/returnApp/book \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"requestUUID": "<string>",
"hash": "<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
},
"grossWeightKG": 123,
"heightM": 123,
"lengthM": 123,
"widthM": 123,
"customsPositions": [
{
"description": "<string>",
"quantity": 1,
"pieceNetWeightKg": 1,
"pieceNetCustomsValue": 1,
"currency": "<string>",
"tariffNumber": "<string>",
"orderedSku": "<string>",
"unNumber": "<string>"
}
],
"invoiceNumber": "<string>",
"invoiceDate": "<string>"
}
'import requests
url = "https://api.quivo.co/v2/returnApp/book"
payload = {
"requestUUID": "<string>",
"hash": "<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
},
"grossWeightKG": 123,
"heightM": 123,
"lengthM": 123,
"widthM": 123,
"customsPositions": [
{
"description": "<string>",
"quantity": 1,
"pieceNetWeightKg": 1,
"pieceNetCustomsValue": 1,
"currency": "<string>",
"tariffNumber": "<string>",
"orderedSku": "<string>",
"unNumber": "<string>"
}
],
"invoiceNumber": "<string>",
"invoiceDate": "<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({
requestUUID: '<string>',
hash: '<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
},
grossWeightKG: 123,
heightM: 123,
lengthM: 123,
widthM: 123,
customsPositions: [
{
description: '<string>',
quantity: 1,
pieceNetWeightKg: 1,
pieceNetCustomsValue: 1,
currency: '<string>',
tariffNumber: '<string>',
orderedSku: '<string>',
unNumber: '<string>'
}
],
invoiceNumber: '<string>',
invoiceDate: '<string>'
})
};
fetch('https://api.quivo.co/v2/returnApp/book', 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/returnApp/book",
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([
'requestUUID' => '<string>',
'hash' => '<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
],
'grossWeightKG' => 123,
'heightM' => 123,
'lengthM' => 123,
'widthM' => 123,
'customsPositions' => [
[
'description' => '<string>',
'quantity' => 1,
'pieceNetWeightKg' => 1,
'pieceNetCustomsValue' => 1,
'currency' => '<string>',
'tariffNumber' => '<string>',
'orderedSku' => '<string>',
'unNumber' => '<string>'
]
],
'invoiceNumber' => '<string>',
'invoiceDate' => '<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/returnApp/book"
payload := strings.NewReader("{\n \"requestUUID\": \"<string>\",\n \"hash\": \"<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 \"grossWeightKG\": 123,\n \"heightM\": 123,\n \"lengthM\": 123,\n \"widthM\": 123,\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\": \"<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/returnApp/book")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"requestUUID\": \"<string>\",\n \"hash\": \"<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 \"grossWeightKG\": 123,\n \"heightM\": 123,\n \"lengthM\": 123,\n \"widthM\": 123,\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\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quivo.co/v2/returnApp/book")
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 \"requestUUID\": \"<string>\",\n \"hash\": \"<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 \"grossWeightKG\": 123,\n \"heightM\": 123,\n \"lengthM\": 123,\n \"widthM\": 123,\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\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "OK",
"message": "<string>",
"bookedShipmentId": 123,
"trackingNumber": "<string>",
"trackingLink": "<string>",
"labelUrls": [
"<string>"
],
"documentUrls": [
"<string>"
]
}returnApp
Book shipment
Book a return shipment through the returns application flow.
POST
/
returnApp
/
book
Book shipment
curl --request POST \
--url https://api.quivo.co/v2/returnApp/book \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"requestUUID": "<string>",
"hash": "<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
},
"grossWeightKG": 123,
"heightM": 123,
"lengthM": 123,
"widthM": 123,
"customsPositions": [
{
"description": "<string>",
"quantity": 1,
"pieceNetWeightKg": 1,
"pieceNetCustomsValue": 1,
"currency": "<string>",
"tariffNumber": "<string>",
"orderedSku": "<string>",
"unNumber": "<string>"
}
],
"invoiceNumber": "<string>",
"invoiceDate": "<string>"
}
'import requests
url = "https://api.quivo.co/v2/returnApp/book"
payload = {
"requestUUID": "<string>",
"hash": "<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
},
"grossWeightKG": 123,
"heightM": 123,
"lengthM": 123,
"widthM": 123,
"customsPositions": [
{
"description": "<string>",
"quantity": 1,
"pieceNetWeightKg": 1,
"pieceNetCustomsValue": 1,
"currency": "<string>",
"tariffNumber": "<string>",
"orderedSku": "<string>",
"unNumber": "<string>"
}
],
"invoiceNumber": "<string>",
"invoiceDate": "<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({
requestUUID: '<string>',
hash: '<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
},
grossWeightKG: 123,
heightM: 123,
lengthM: 123,
widthM: 123,
customsPositions: [
{
description: '<string>',
quantity: 1,
pieceNetWeightKg: 1,
pieceNetCustomsValue: 1,
currency: '<string>',
tariffNumber: '<string>',
orderedSku: '<string>',
unNumber: '<string>'
}
],
invoiceNumber: '<string>',
invoiceDate: '<string>'
})
};
fetch('https://api.quivo.co/v2/returnApp/book', 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/returnApp/book",
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([
'requestUUID' => '<string>',
'hash' => '<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
],
'grossWeightKG' => 123,
'heightM' => 123,
'lengthM' => 123,
'widthM' => 123,
'customsPositions' => [
[
'description' => '<string>',
'quantity' => 1,
'pieceNetWeightKg' => 1,
'pieceNetCustomsValue' => 1,
'currency' => '<string>',
'tariffNumber' => '<string>',
'orderedSku' => '<string>',
'unNumber' => '<string>'
]
],
'invoiceNumber' => '<string>',
'invoiceDate' => '<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/returnApp/book"
payload := strings.NewReader("{\n \"requestUUID\": \"<string>\",\n \"hash\": \"<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 \"grossWeightKG\": 123,\n \"heightM\": 123,\n \"lengthM\": 123,\n \"widthM\": 123,\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\": \"<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/returnApp/book")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"requestUUID\": \"<string>\",\n \"hash\": \"<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 \"grossWeightKG\": 123,\n \"heightM\": 123,\n \"lengthM\": 123,\n \"widthM\": 123,\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\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quivo.co/v2/returnApp/book")
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 \"requestUUID\": \"<string>\",\n \"hash\": \"<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 \"grossWeightKG\": 123,\n \"heightM\": 123,\n \"lengthM\": 123,\n \"widthM\": 123,\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\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "OK",
"message": "<string>",
"bookedShipmentId": 123,
"trackingNumber": "<string>",
"trackingLink": "<string>",
"labelUrls": [
"<string>"
],
"documentUrls": [
"<string>"
]
}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 a return shipment through the returns application. Contains return shipping details and carrier selection for processing product returns.
A unique identifier for the request.
Used for tracing and to prevent duplicate shipment bookings.
The hash that is used for booking return label.
Required string length:
1 - 2147483647A human readable reference for the request.
This will be included in the mail that is sent once the operation completes.
The
Show child attributes
Show child attributes
Weight of the return shipment.
Height of the return shipment in meters.
Length of the return shipment in meters.
Width of the return shipment in meters.
Optional customs positions for the shipment. Only required if shipping to countries for which export documents are required.
Show child attributes
Show child attributes
Optional invoice number for the shipment. Only required for royal mail.
Optional invoice date for the shipment. Only required for royal mail.
Response
Returns the booking result for the return shipment with tracking and label information.
Response from booking a shipment operation. Contains booking status, shipment identifier, tracking information, and label/document references.
Indicates whether the operation was successful or not.
Available options:
OK, ERROR Optional additional information about the operation's result.
When the operation failed, this field includes more information about the error.
ID of booked shipment
The tracking number of the booked shipment.
The tracking link of the booked shipment. Note that some carriers do not immediately recognize shipments after they have been created
List of URLs where the labels can be downloaded.
List of URLs where additional documents, such as export documents, can be downloaded.