Skip to main content
POST
/
returnApp
/
book
Book shipment
curl --request POST \
  --url https://api.quivo.co/returnApp/book \
  --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,
      "originCountryIso2": "AF",
      "currency": "<string>",
      "tariffNumber": "<string>",
      "orderedSku": "<string>",
      "unNumber": "<string>"
    }
  ],
  "invoiceNumber": "<string>",
  "invoiceDate": "<string>"
}
'
{
  "status": "OK",
  "message": "<string>",
  "bookedShipmentId": 123,
  "trackingNumber": "<string>",
  "trackingLink": "<string>",
  "labelUrls": [
    "<string>"
  ],
  "documentUrls": [
    "<string>"
  ]
}

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.

requestUUID
string
required

A unique identifier for the request.
Used for tracing and to prevent duplicate shipment bookings.

hash
string
required

The hash that is used for booking return label.

Required string length: 1 - 2147483647
reference
string
required

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

shipFrom
object
required

The

grossWeightKG
number
required

Weight of the return shipment.

heightM
number

Height of the return shipment in meters.

lengthM
number

Length of the return shipment in meters.

widthM
number

Width of the return shipment in meters.

customsPositions
object[]

Optional customs positions for the shipment. Only required if shipping to countries for which export documents are required.

invoiceNumber
string

Optional invoice number for the shipment. Only required for royal mail.

invoiceDate
string

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.

status
enum<string>

Indicates whether the operation was successful or not.

Available options:
OK,
ERROR
message
string

Optional additional information about the operation's result.
When the operation failed, this field includes more information about the error.

bookedShipmentId
integer<int64>

ID of booked shipment

trackingNumber
string

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

labelUrls
string[]

List of URLs where the labels can be downloaded.

documentUrls
string[]

List of URLs where additional documents, such as export documents, can be downloaded.