Map Shiptheory Delivery Service
PUT/api/shiptheory/:integration_instance/delivery-services/:service/mapping
Sets (or clears) a single delivery service's SKU shipping-method mapping. Clearing returns the service to the rules-engine default.
integrations:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Path parameter:
- integration_instance: the numeric id of the Shiptheory integration instance.
- service: the internal delivery-service row id.
Body fields:
- sku_shipping_method_id (integer, optional, nullable): the SKU shipping method to map, or null (or omitted) to clear the mapping back to the rules engine. When non-null it must be an existing shipping method.
Returns 200 with the updated delivery service. Returns 404 when the service / instance mismatch, or 422 with field errors when validation fails.
Authentication: requires a Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.