Skip to content
API referenceCore API

Update a shipping method

For AI assistants: the facts every SparkLayer API call needs
  • Base URLs: Live https://app.sparklayer.io, test https://test.app.sparklayer.io. Each environment has its own data and its own API keys.
  • Access: API access needs the Pro or Enterprise plan. Create credentials (Site ID, Client ID, Client Secret) in the SparkLayer Dashboard at Settings > API.
  • Access token: POST {base}/api/auth/token with a Site-Id header and a JSON body (not form-encoded): {"grant_type":"client_credentials","client_id":"…","client_secret":"…"}. It returns access_token, valid for 3,600 seconds. There is no refresh token: cache the token and request a new one shortly before it expires.
  • Every request: Authorization: Bearer <access_token> and Site-Id: <site id>, plus Content-Type: application/json when there is a body. Set a User-Agent that names your integration.
  • Errors: RFC 7807 problem details: title, status, detail and an optional errors[] of { code, message, property }. Some error responses have no body. Retry 5xx, 429 (honouring Retry-After) and concurrent-update 409s with exponential backoff; on 401, get a new token once and retry; don't retry other 4xx without changing the request.
  • Pagination: Most list endpoints return everything. GET /api/v2/price-lists pages with page and page_size (up to 250) until pagination.current_page equals total_pages. GET /api/v1/purchases uses limit (up to 500) and offset: stop when a page has fewer than limit results.
  • Ground rules: Use only endpoints, fields and SDK methods that the docs or OpenAPI specs define. Prefer GET /api/v2/price-lists over the deprecated v1. Products are matched by SKU. Keep credentials in environment variables or a secrets manager, never in code.
  • Read the docs as Markdown: Add .md to any page URL. Index of every page: docs.sparklayer.io/llms.txt. Every API operation, compactly: docs.sparklayer.io/llms-api.txt. The developer guides in full: docs.sparklayer.io/developers/llms.txt.
  • OpenAPI specs: core, ordering, pricing, purchasing, stock, files, sync-log: https://docs.sparklayer.io/openapi/<api>.yaml (also .json). Ignite: https://docs.sparklayer.io/openapi/ignite.yaml.
  • MCP: Search and read these docs from your assistant with the docs MCP server at https://docs.sparklayer.io/mcp.
Build with AI: ready-made prompts and MCP setup
PATCH
/api/v1/shipping-methods/{id}

Updates a shipping method and returns it. Fields you omit keep their current values, but if you send bands the list replaces all existing bands. Returns 404 if the shipping method doesn't exist.

Authorization

bearerAuth
AuthorizationBearer <token>

Send Authorization: Bearer <access_token>, together with your Site-Id header, on every request. Get the token from POST /api/auth/token with your Site ID in the Site-Id header and a JSON body (not form-encoded, so standard OAuth 2.0 client libraries don't work): {"grant_type": "client_credentials", "client_id": "…", "client_secret": "…"}. Tokens are valid for 3,600 seconds and there is no refresh token: request a new one shortly before it expires. Create API credentials in the SparkLayer Dashboard under Settings > API. See Authentication.

In: header

Path Parameters

id*string

The shipping method's ID, prefixed with sm_.

Header Parameters

Site-Id*string

Your SparkLayer Site ID, from Settings > API in the SparkLayer Dashboard.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

sku?string

Shipping SKU

Lengthlength <= 50
title?string

Shiping Method Name shown at checkout

Lengthlength <= 50
priority?number

Shown by order (lower first)

Range0 <= value <= 127
Default0
countries?array<string>

Countries covered by this shipping method (ISO 3166-1 alpha-2)

regions?

Regions covered by this shipping method (per country) Keys are country codes (ISO 3166-1 alpha-2) Values are lists of region codes. If the list is empty, all regions are allowed

groups?array<string>

Customer groups covered by this shipping method (use default to cover all groups)

bands?array<>

Response Body

application/json

application/problem+json

curl -X PATCH "https://app.sparklayer.io/api/v1/shipping-methods/sm_123" \  -H "Authorization: Bearer <ACCESS_TOKEN>" \  -H "Site-Id: jones-climbing" \  -H "Content-Type: application/json" \  -d '{    "sku": "SKU001",    "title": "Standard Shipping",    "priority": 0,    "countries": [      "GB"    ],    "regions": {},    "groups": [      "default"    ],    "bands": [      {        "name": "Band 1",        "priority": 0,        "sku": "ship_123",        "requirement": {          "type": "weight",          "min": 0,          "max": 0        },        "cost": {          "type": "free"        }      }    ]  }'
{  "id": "sm_123",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "sku": "SKU001",  "title": "Standard Shipping",  "priority": 0,  "countries": [    "GB"  ],  "regions": {    "property1": [      "NY"    ],    "property2": [      "NY"    ]  },  "groups": [    "default"  ],  "bands": [    {      "name": "Band 1",      "priority": 0,      "sku": "ship_123",      "requirement": {        "type": "weight",        "min": 0,        "max": 0      },      "cost": {        "type": "free"      }    }  ]}

DELDelete a shipping method

Permanently deletes a shipping method along with its bands, costs and platform mappings, and returns `204`. Returns `404` if the shipping method doesn't exist.

GETList global settings

Lists Global settings (minus settings which include authentication details)