comecerodocs
Settings

Update shipping settings

POST
/settings/shipping

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.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Query Parameters

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

Request Body

application/json
  1. body

Replace every shipping method at once. To change one method, use the shipping method endpoints instead.

methods?array<>

The full list of methods. It replaces every saved method, and each gets a new method_id. An empty list removes all methods.

Response Body

The shipping settings, after the change.

application/json
  1. response

The shipping settings of the account in the current mode, with every shipping method.

object?"settings_shipping"

The object type. Always settings_shipping.

Value in"settings_shipping"
url?string

The URL of this object.

Formaturi
account_id?string

The ID of the account the settings belong to.

test?boolean

True for the test mode settings, false for live.

date_created?string

When the settings were created.

Formatdate-time
date_modified?string

When the settings were last changed.

Formatdate-time
methods?array<>

The shipping methods, sorted by method_id.

formatted?

Display text for the dates. Returned only when formatted=true.

Example Request
curl -X POST 'https://api.comecero.com/api/v1/settings/shipping' \  -H 'Content-Type: application/json' \  -d '{  "methods": [    {      "description": "Standard Shipping",      "countries": [        "*"      ],      "quantity_rules": [        {          "minimum": 1,          "maximum": 999,          "prices": [            {              "price": 7.5,              "currency": "USD"            }          ]        }      ]    }  ]}'
Example Response
{  "object": "settings_shipping",  "url": "https://api.comecero.com/api/v1/settings/shipping",  "account_id": "AB1234",  "test": true,  "date_created": "2026-01-12T09:30:00Z",  "date_modified": "2026-10-02T14:21:07Z",  "methods": [    {      "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": null,      "countries": [        "US"      ],      "quantity_rules": null,      "subtotal_rules": [        {          "currency": "USD",          "ranges": [            {              "minimum": 0,              "maximum": 49.99,              "price": 5            },            {              "minimum": 50,              "maximum": 99.99,              "price": 10            },            {              "minimum": 100,              "maximum": 999999,              "price": 15            }          ]        }      ],      "weight_rules": null,      "adjustments": null    }  ]}

Get shipping settings GET

Returns the shipping settings with every shipping method. 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.

List shipping methods in settings GET

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.