TradlyTRADLY-API.

Parameters

shipping_method
dictionary
shipping_method_id
integer
Required
Description
Platform-level shipping method template ID.
name
string
Required
Description
Display name shown to customers.
note
string
Description
Optional customer-facing description.
default
boolean
Required
Description
Set as the pre-selected method at checkout. Setting to `true` unsets all other defaults.
active
boolean
Required
Description
Whether this method is visible and available to customers.
order_by
integer
Description
Sort rank. Lower values appear first.
metadata
dictionary
Description
Extra configuration — e.g. `{ "extension_id": 12 }` links this method to an extension for live rate fetching.
GET/v1/tenants/shipping_methods
curl https://api.tradly.app/v1/tenants/shipping_methods \
  -H "Authorization: Bearer YOUR_PUBLISHABLE_OR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "shipping_method": {
    "shipping_method_id": 3,
    "name": "Express Shipping",
    "note": "Next-day delivery",
    "default": false,
    "active": true,
    "order_by": 2,
    "metadata": {}
  }
}'
RESPONSE
{
  "status": true,
  "data": {
    "shipping_methods": [
      {
        "id": 1,
        "name": "Standard Delivery",
        "note": "Delivered within 3–5 business days",
        "logo_path": "https://cdn.example.com/shipping/standard.png",
        "type": "standard",
        "channel": "delivery",
        "default": true,
        "active": true,
        "order_by": 1,
        "metadata": {}
      },
      {
        "id": 2,
        "name": "Express Shipping",
        "note": "Next-day delivery available",
        "logo_path": "https://cdn.example.com/shipping/express.png",
        "type": "external",
        "channel": "delivery",
        "default": false,
        "active": true,
        "order_by": 2,
        "metadata": {
          "extension_id": 12
        }
      }
    ]
  }
}