Quote available shipping services

POST/v1/rates/quoteQuote available shipping services

Request body

required

application/json

objectRateQuoteRequest

parcelsarray of objectrequired

minItems 1

Show child attributes

minItems 1

Show array items

contentsarray of object

maxItems 50

Show child attributes

maxItems 50

Show array items

customs_codenull | string

descriptionstringrequired

quantityintegerrequired

minimum 1

unit_valueobjectrequired

Show child attributes

amountstringrequired

pattern ^[0-9]+(\.[0-9]{2})$

currencystringrequired

pattern ^[A-Z]{3}$

height_cmnumberrequired

exclusiveMinimum 0

length_cmnumberrequired

exclusiveMinimum 0

weight_gramsintegerrequired

minimum 1

width_cmnumberrequired

exclusiveMinimum 0

recipientobjectrequired

Show child attributes

citystringrequired

companynull | string

countrystringrequired

pattern ^[A-Z]{2}$

line1stringrequired

line2null | string

namestringrequired

minLength 1

phonenull | string

postal_codestringrequired

regionnull | string

senderobjectrequiredAddress ↑

Example request

{
  "parcels": [
    {
      "contents": [
        {
          "customs_code": "610910",
          "description": "Synthetic cotton shirt",
          "quantity": 2,
          "unit_value": {
            "amount": "12.50",
            "currency": "XTS"
          }
        }
      ],
      "height_cm": 12,
      "length_cm": 30.5,
      "weight_grams": 1750,
      "width_cm": 20
    }
  ],
  "recipient": {
    "city": "Exampleton",
    "company": "Northstar Supplies",
    "country": "ZZ",
    "line1": "14 Fictional Quay",
    "line2": "Unit 7",
    "name": "Rowan Example",
    "phone": "+00000000000",
    "postal_code": "EX4 2PL",
    "region": "Test Province"
  },
  "sender": {
    "city": "Exampleton",
    "company": "Northstar Supplies",
    "country": "ZZ",
    "line1": "14 Fictional Quay",
    "line2": "Unit 7",
    "name": "Rowan Example",
    "phone": "+00000000000",
    "postal_code": "EX4 2PL",
    "region": "Test Province"
  }
}

Responses

object

dataarray of objectrequired

Show child attributes

Show array items

amountobjectrequiredMoney ↑

carrierstringrequired

estimated_delivery_datestring · daterequired

expires_atstring · date-timerequired

idstringrequired

servicestringrequired

Example response

{
  "data": [
    {
      "amount": {
        "amount": "12.50",
        "currency": "XTS"
      },
      "carrier": "Example Parcel Network",
      "estimated_delivery_date": "2026-09-07",
      "expires_at": "2026-06-09T00:00:00Z",
      "id": "rate_00000000000000000001",
      "service": "synthetic_express"
    }
  ]
}

objectProblem

detailstring

errorsarray of object

Show child attributes

Show array items

messagestringrequired

pathstringrequired

request_idstringrequired

statusintegerrequired

maximum 599 · minimum 400

titlestringrequired

typestring · urirequired

Example response

{
  "errors": [
    {
      "message": "must be a synthetic postal code",
      "path": "recipient.postal_code"
    }
  ],
  "request_id": "req_00000000000000000006",
  "status": 422,
  "title": "Synthetic request validation failed",
  "type": "https://parcel-events.example/problems/validation"
}

Examples

curl -X POST 'https://api.parcel-events.example/v1/rates/quote' \
  -H 'Content-Type: application/json' \
  -d '{"parcels":[{"contents":[{"customs_code":"610910","description":"Synthetic cotton shirt","quantity":2,"unit_value":{"amount":"12.50","currency":"XTS"}}],"height_cm":12,"length_cm":30.5,"weight_grams":1750,"width_cm":20}],"recipient":{"city":"Exampleton","company":"Northstar Supplies","country":"ZZ","line1":"14 Fictional Quay","line2":"Unit 7","name":"Rowan Example","phone":"+00000000000","postal_code":"EX4 2PL","region":"Test Province"},"sender":{"city":"Exampleton","company":"Northstar Supplies","country":"ZZ","line1":"14 Fictional Quay","line2":"Unit 7","name":"Rowan Example","phone":"+00000000000","postal_code":"EX4 2PL","region":"Test Province"}}'

const response = await fetch('https://api.parcel-events.example/v1/rates/quote', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"parcels":[{"contents":[{"customs_code":"610910","description":"Synthetic cotton shirt","quantity":2,"unit_value":{"amount":"12.50","currency":"XTS"}}],"height_cm":12,"length_cm":30.5,"weight_grams":1750,"width_cm":20}],"recipient":{"city":"Exampleton","company":"Northstar Supplies","country":"ZZ","line1":"14 Fictional Quay","line2":"Unit 7","name":"Rowan Example","phone":"+00000000000","postal_code":"EX4 2PL","region":"Test Province"},"sender":{"city":"Exampleton","company":"Northstar Supplies","country":"ZZ","line1":"14 Fictional Quay","line2":"Unit 7","name":"Rowan Example","phone":"+00000000000","postal_code":"EX4 2PL","region":"Test Province"}}),
});
const data = await response.json();

const response = await fetch('https://api.parcel-events.example/v1/rates/quote', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"parcels\":[{\"contents\":[{\"customs_code\":\"610910\",\"description\":\"Synthetic cotton shirt\",\"quantity\":2,\"unit_value\":{\"amount\":\"12.50\",\"currency\":\"XTS\"}}],\"height_cm\":12,\"length_cm\":30.5,\"weight_grams\":1750,\"width_cm\":20}],\"recipient\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"sender\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"}}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.parcel-events.example/v1/rates/quote",
    headers={"Content-Type": "application/json"},
    data='{"parcels":[{"contents":[{"customs_code":"610910","description":"Synthetic cotton shirt","quantity":2,"unit_value":{"amount":"12.50","currency":"XTS"}}],"height_cm":12,"length_cm":30.5,"weight_grams":1750,"width_cm":20}],"recipient":{"city":"Exampleton","company":"Northstar Supplies","country":"ZZ","line1":"14 Fictional Quay","line2":"Unit 7","name":"Rowan Example","phone":"+00000000000","postal_code":"EX4 2PL","region":"Test Province"},"sender":{"city":"Exampleton","company":"Northstar Supplies","country":"ZZ","line1":"14 Fictional Quay","line2":"Unit 7","name":"Rowan Example","phone":"+00000000000","postal_code":"EX4 2PL","region":"Test Province"}}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"parcels":[{"contents":[{"customs_code":"610910","description":"Synthetic cotton shirt","quantity":2,"unit_value":{"amount":"12.50","currency":"XTS"}}],"height_cm":12,"length_cm":30.5,"weight_grams":1750,"width_cm":20}],"recipient":{"city":"Exampleton","company":"Northstar Supplies","country":"ZZ","line1":"14 Fictional Quay","line2":"Unit 7","name":"Rowan Example","phone":"+00000000000","postal_code":"EX4 2PL","region":"Test Province"},"sender":{"city":"Exampleton","company":"Northstar Supplies","country":"ZZ","line1":"14 Fictional Quay","line2":"Unit 7","name":"Rowan Example","phone":"+00000000000","postal_code":"EX4 2PL","region":"Test Province"}}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.parcel-events.example/v1/rates/quote", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.parcel-events.example/v1/rates/quote");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"parcels\":[{\"contents\":[{\"customs_code\":\"610910\",\"description\":\"Synthetic cotton shirt\",\"quantity\":2,\"unit_value\":{\"amount\":\"12.50\",\"currency\":\"XTS\"}}],\"height_cm\":12,\"length_cm\":30.5,\"weight_grams\":1750,\"width_cm\":20}],\"recipient\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"sender\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"}}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.parcel-events.example/v1/rates/quote"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"parcels\":[{\"contents\":[{\"customs_code\":\"610910\",\"description\":\"Synthetic cotton shirt\",\"quantity\":2,\"unit_value\":{\"amount\":\"12.50\",\"currency\":\"XTS\"}}],\"height_cm\":12,\"length_cm\":30.5,\"weight_grams\":1750,\"width_cm\":20}],\"recipient\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"sender\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"}}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.parcel-events.example/v1/rates/quote")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"parcels\":[{\"contents\":[{\"customs_code\":\"610910\",\"description\":\"Synthetic cotton shirt\",\"quantity\":2,\"unit_value\":{\"amount\":\"12.50\",\"currency\":\"XTS\"}}],\"height_cm\":12,\"length_cm\":30.5,\"weight_grams\":1750,\"width_cm\":20}],\"recipient\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"sender\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"}}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.parcel-events.example/v1/rates/quote");
request.Content = new StringContent("{\"parcels\":[{\"contents\":[{\"customs_code\":\"610910\",\"description\":\"Synthetic cotton shirt\",\"quantity\":2,\"unit_value\":{\"amount\":\"12.50\",\"currency\":\"XTS\"}}],\"height_cm\":12,\"length_cm\":30.5,\"weight_grams\":1750,\"width_cm\":20}],\"recipient\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"},\"sender\":{\"city\":\"Exampleton\",\"company\":\"Northstar Supplies\",\"country\":\"ZZ\",\"line1\":\"14 Fictional Quay\",\"line2\":\"Unit 7\",\"name\":\"Rowan Example\",\"phone\":\"+00000000000\",\"postal_code\":\"EX4 2PL\",\"region\":\"Test Province\"}}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "data": [
    {
      "amount": {
        "amount": "12.50",
        "currency": "XTS"
      },
      "carrier": "Example Parcel Network",
      "estimated_delivery_date": "2026-09-07",
      "expires_at": "2026-06-09T00:00:00Z",
      "id": "rate_00000000000000000001",
      "service": "synthetic_express"
    }
  ]
}

{
  "errors": [
    {
      "message": "must be a synthetic postal code",
      "path": "recipient.postal_code"
    }
  ],
  "request_id": "req_00000000000000000006",
  "status": 422,
  "title": "Synthetic request validation failed",
  "type": "https://parcel-events.example/problems/validation"
}

Search documentation

Request body

Responses

Documentation menu