comecerodocs
Orders

List an order's shipments

GET
/orders/{order_id}/shipments

Lists the shipments made for an order. Offset-based (offset, limit). sort_by takes date_created (default) or date_modified.

A limited token may call this for an order of its own customer.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Path Parameters

order_id*string

The order id.

Query Parameters

offset?integer

For offset-based lists, how many items to skip before the page starts. Use next_page_offset or previous_page_offset from the page you have. A value that is not a whole number is a 400.

Range0 <= value
Default0
limit?integer

How many items to return on one page, from 1 to 100. The default is 100. A value outside 1 to 100, or one that is not a whole number, is a 400.

Range1 <= value <= 100
Default100
desc?boolean

Sort in descending order (newest, largest or last first) when true. The default is false. A value other than true or false is a 400.

Defaultfalse
sort_by?string

The field to sort by.

Default"date_created"
Value in"date_created""date_modified"
expand?string

Comma-separated child objects to return in full instead of as a URL, for example customer,payments. Use dot notation for nested objects (items.product), up to four levels deep. A single object takes up to 12 paths; a list takes up to 2, applied to every item. Extra paths are dropped without an error. See Expanding objects.

show?string

Comma-separated fields to return; all others are left out. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

hide?string

Comma-separated fields to leave out of the response. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

formatted?boolean

When true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.

Defaultfalse

Response Body

An offset-based page of shipments.

application/json
  1. response

An offset-based page of shipments.

total_items*integer

How many items match, across all pages.

total_pages*integer

How many pages there are at this limit. 0 when nothing matches.

current_page*integer

The number of this page, starting at 1. 0 when nothing matches.

next_page_url*|

The URL of the next page, or null on the last page.

Formaturi
next_page_offset*|

The offset of the next page, or null on the last page.

previous_page_url*|

The URL of the previous page, or null on the first page.

Formaturi
previous_page_offset*|

The offset of the previous page, or null on the first page.

current_page_url*string

The URL of this page.

Formaturi
data*array<>

The shipments on this page.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/orders/string/shipments'
Example Response
{  "total_items": 1,  "total_pages": 1,  "current_page": 1,  "next_page_url": null,  "next_page_offset": null,  "previous_page_url": null,  "previous_page_offset": null,  "current_page_url": "https://api.comecero.com/api/v1/orders/2979-KXVST-674/shipments",  "data": [    {      "object": "shipment",      "url": "https://api.comecero.com/api/v1/shipments/0093718200417ShQ2xN8kL",      "shipment_id": "0093718200417ShQ2xN8kL",      "date_created": "2026-11-04T09:30:00Z",      "date_modified": "2026-11-04T09:30:00Z",      "date_shipped": "2026-11-04T09:30:00Z",      "test": true,      "account_id": "AB1234",      "items": [        {          "object": "shipment_item",          "item_id": "1",          "product_id": "lens-cloth.test",          "name": "Lens cleaning cloth",          "quantity": 2,          "product": "https://api.comecero.com/api/v1/products/lens-cloth.test"        }      ],      "order": "https://api.comecero.com/api/v1/orders/2979-KXVST-674",      "courier": "UPS",      "tracking_number": "1Z999AA10123456784",      "tracking_url": "http://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1Z999AA10123456784",      "notifications": "https://api.comecero.com/api/v1/shipments/0093718200417ShQ2xN8kL/notifications",      "meta": null    }  ]}

List an order's refunds GET

Lists the refunds on an order, including failed and pending ones and chargebacks. Offset-based (`offset`, `limit`). `sort_by` takes `date_created` (default), `date_modified` or `date_completed`. A limited token may call this for an order of its own customer.

Void an order POST

Cancels the authorization on every pending payment of the order, so the customer is never charged. The order's `payment_status` becomes `cancelled`. Only works while at least one payment is still pending (not captured); to give money back after capture, refund the order. No body is read. Returns `201` with a `payment_list` holding each payment and its result. When every void fails, the API answers with an error instead and puts the `payment_list` in the error's `meta.payment_list`. Needs a secret or trusted token that may create or update payments. A token without that permission gets `401`, not `403`.