List all shipments

GET/shipping/{connection_id}/shipment

Parameters

Returns

ShippingShipmentarray

idstring

Unique identifier for this shipment object

created_atdate-time

The date that this shipment object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate-time

The last date that this shipment object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

order_idstring

Reference to commerce_order or accounting_order

organization_idstring

ref -> accounting Organization this shipment belongs to (multi-company ERPs)

from_addressobject

Origin address

to_addressobject

Destination address

packages array

Array of packages in this shipment

carrier_idstring

Reference to the carrier

service_codestring

Code for the shipping service used

status enum

Valid values:

"PENDING"

"PROCESSING"

"IN_TRANSIT"

"DELIVERED"

"EXCEPTION"

"CANCELLED"

"LABEL_CREATED"

"PICKED_UP"

"OUT_FOR_DELIVERY"

"DELIVERY_ATTEMPTED"

"RETURNED_TO_SENDER"

"HELD_AT_LOCATION"

"CUSTOMS_CLEARANCE"

"EXCEPTION_RESOLVED"

Current status of the shipment

rate_idstring

Optional reference to the selected rate (for traceability)

label_idstring

Optional reference to the shipping label

tracking_idstring

Optional reference to the tracking information

shipped_atdate-time

When shipment was createddispatched (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rate_amountnumber

The rate amount used (may differ from shipping_cost due to adjustments)

rate_currencystring

Currency for rate_amount

rate_service_namestring

Service name from the rate (e.g., "Priority Mail")

rate_estimated_daysnumber

Estimated delivery days from the rate

rate_estimated_delivery_atdate-time

Estimated delivery date from the rate (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

is_rate_guaranteedboolean

Whether delivery is guaranteed (from rate)

return_addressobject

Return address (may differ from from_address)

return_authorization_numberstring

RMA number if return shipment

warehouse_location_idstring

Origin warehouselocation ID; points to CommerceLocation

warehouse_location_namestring

Origin warehouse location name

customsobject

Customs information

is_internationalboolean

Whether shipment is international

insuranceobject

Insurance details

special_instructionsstring array

Array of special instructions

is_signature_requiredboolean

Signature required on delivery

is_adult_signature_requiredboolean

Adult signature required

reference_numberstring

Customer reference number

is_returnboolean

Whether this is a return shipment

original_shipment_idstring

Reference to original shipment if return; points to ShippingShipment

return_reasonstring

Reason for return

return_type enum

Valid values:

"CUSTOMER"

"VENDOR"

"WARRANTY"

"DEFECTIVE"

"OTHER"

Type of return

carrier_namestring

Human-readable carrier/provider name when there is no carrier record to reference (e.g. commerce-platform fulfillments)

tracking_urlstring

Carrier tracking URL for this shipment

lineitems array

Item-level fulfillment lines (what shipped); used by commerce-platform fulfillments

raw

The raw data returned by the integration for this shipment

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'GET',
  url: 'https://api.unified.to/shipping/5de520f96e439b002043d8dc/shipment',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    limit: 50,
    offset: 0,
    updated_gte: '2026-10-13T20:43:30.320Z',
    sort: 'updated_at',
    order: 'asc',
    query: '',
    order_id: '',
    carrier_id: '',
    org_id: '',
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const results = await sdk.shipping.listShippingShipments({ connectionId, 
    limit: 50,
    offset: 0,
    updated_gte: '2026-10-13T20:43:30.320Z',
    sort: 'updated_at',
    order: 'asc',
    query: '',
    order_id: '',
    carrier_id: '',
    org_id: '',
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'GET',
  url: 'https://api.unified.to/shipping/5de520f96e439b002043d8dc/shipment',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    limit: 50,
    offset: 0,
    updated_gte: '2026-10-13T20:43:30.320Z',
    sort: 'updated_at',
    order: 'asc',
    query: '',
    order_id: '',
    carrier_id: '',
    org_id: '',
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/shipping/5de520f96e439b002043d8dc/shipment?limit=50&offset=0&updated_gte=2026-10-13T20:43:30.320Z&sort=updated_at&order=asc&query=&order_id=&carrier_id=&org_id=&fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/shipping/5de520f96e439b002043d8dc/shipment?limit=50&offset=0&updated_gte=2026-10-13T20:43:30.320Z&sort=updated_at&order=asc&query=&order_id=&carrier_id=&org_id=&fields=&raw=

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/shipping/5de520f96e439b002043d8dc/shipment?limit=50&offset=0&updated_gte=2026-10-13T20:43:30.320Z&sort=updated_at&order=asc&query=&order_id=&carrier_id=&org_id=&fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.get(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/shipping/5de520f96e439b002043d8dc/shipment?limit=50&offset=0&updated_gte=2026-10-13T20:43:30.320Z&sort=updated_at&order=asc&query=&order_id=&carrier_id=&org_id=&fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/shipping/5de520f96e439b002043d8dc/shipment?limit=50&offset=0&updated_gte=2026-10-13T20:43:30.320Z&sort=updated_at&order=asc&query=&order_id=&carrier_id=&org_id=&fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request GET \
  --url 'https://api.unified.to/shipping/5de520f96e439b002043d8dc/shipment?limit=50&offset=0&updated_gte=2026-10-13T20:43:30.320Z&sort=updated_at&order=asc&query=&order_id=&carrier_id=&org_id=&fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?