Bulk Map Delivery Types
PUT/api/pinnacle/instances/:instance/delivery-types/bulk
Points many shipping methods at one Pinnacle delivery type in a single call, or clears their mappings when delivery_type is null. Existing mappings of the listed methods are replaced; other methods are untouched. Returns the full mapping list plus result counts.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body fields:
- shipping_method_ids (array of integers, required, 1–500, distinct): existing shipping method ids.
- 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 clear the mappings.
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.