Update Delivery Type Mappings
PUT/api/pinnacle/instances/:instance/delivery-types
Creates, changes or removes shipping method → Pinnacle delivery type mappings. Methods not listed are left untouched. Any number of shipping methods can map to the same delivery type. Returns the full mapping list.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body fields:
- mappings (array, required, at least 1).
- mappings.*.shipping_method_id (integer, required, distinct): an existing shipping method id.
- mappings.*.delivery_type (string|null, required key): a forward delivery type (PWG-OFFICE, PWG-RESI, PWG-SHOWROOM, WG-OFFICE, WG-RESI, WG-SHOWROOM, WGN, ROC, TRHD, DS, B2B, WHSE, WC, CS), or null to remove the mapping.
Authentication: requires a Bearer token (Personal Access Token).
Requires the integrations.update permission; without it the request is refused with 403.
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.