Map Courier To Shipping Method
POST/api/shippit/instances/:integration_instance/couriers/:courier/link
Map a courier (its courier type / service level) to an internal shipping method so the dispatcher knows which courier to request when submitting an order. Send shipping_method_id as null (or omit it) to remove an existing mapping. Returns the updated courier.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body parameters:
- shipping_method_id (integer, nullable) — the internal shipping method id to map to. Must reference an existing shipping method. Null or omitted unlinks the courier.
Returns 404 when the courier cannot be found, and 422 when shipping_method_id does not reference an existing shipping method.
Authenticate with 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
Unprocessable Entity
Response Headers
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.