comecerodocs
Settings

List shipping methods in settings

GET
/settings/shipping/methods

Lists the shipping methods in the shipping settings. The list is offset-based and returns every method unless you set limit. Filter by country to get the methods that ship there. Settings are kept per mode: a test token works on the test settings, a live token on the live ones. Secret and trusted tokens may call it when their permissions include settings_shipping. Limited tokens may not.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Query Parameters

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
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
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 method_id.

Default"method_id"
Value in"method_id""date_created""date_modified"
country?string

Only methods that ship to this two-letter ISO country code.

Length2 <= length <= 2
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 list of shipping methods.

application/json
  1. response

An offset-based list of shipping methods.

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 items on this page.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/settings/shipping/methods'
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/settings/shipping/methods",  "data": [    {      "object": "settings_shipping.method",      "url": "https://api.comecero.com/api/v1/settings/shipping/methods/standard-shipping-us",      "method_id": "standard-shipping-us",      "description": "Standard Shipping",      "details": "Arrives in 3 to 5 business days.",      "countries": [        "US"      ],      "quantity_rules": null,      "subtotal_rules": [        {          "currency": "USD",          "ranges": [            {              "minimum": 0,              "maximum": 49.99,              "price": 5            },            {              "minimum": 50,              "maximum": 999999,              "price": 0            }          ]        }      ],      "weight_rules": null,      "adjustments": null    }  ]}

Update shipping settings POST

Replaces every shipping method at once. Each method gets a new `method_id`. To add, change or remove one method, use the shipping method endpoints. Settings are kept per mode: a test token works on the test settings, a live token on the live ones. Secret and trusted tokens may call it when their permissions include `settings_shipping`. Limited tokens may not.

Create a shipping method in settings POST

Adds a shipping method to the shipping settings. Comecero sets its `method_id` from the description and countries. Give exactly one set of rules: `quantity_rules`, `subtotal_rules` or `weight_rules`. Gaps between ranges are closed when saved. Carts and invoices are not priced from these settings: shoppers only see the methods made with `POST /shipping_methods`. Secret and trusted tokens may call it when their permissions allow updates to `settings_shipping`. Limited tokens may not.