Skip to main content
POST
/
shipments
/
estimate
Create shipment
curl --request POST \
  --url https://api.quivo.co/shipments/estimate \
  --header 'Content-Type: application/json' \
  --data '
{
  "estimateRequests": [
    {
      "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,
      "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>"
    }
  ]
}
'
{
  "estimateResults": [
    {
      "requestUUID": "<string>",
      "success": true,
      "currency": {
        "currencyCode": "<string>",
        "defaultFractionDigits": 123,
        "numericCode": 123,
        "displayName": "<string>",
        "symbol": "<string>",
        "numericCodeAsString": "<string>"
      },
      "amountLabel": 123,
      "amountInsurance": 123
    }
  ]
}

Body

application/json

Data to create a new resource at /shipments/estimate

Request payload for obtaining shipping cost and service estimates. Contains shipment details (dimensions, weight, addresses) to calculate shipping options and prices.

estimateRequests
object[]
required

Required list of estimate requests.
The value of requestUUID will be returned in the response, so it can be used to match the results to the requests.

Response

Returns shipping cost and service estimates for the requested shipment configuration.

Shipping cost and service estimates. Contains available shipping options with prices, delivery times, and service characteristics.

estimateResults
object[]

Array of estimate result