Auto-Match Delivery Types
POST/api/pinnacle/instances/:instance/delivery-types/auto-match
Maps every still-unmapped shipping method whose name matches a Pinnacle delivery type — its code, its label, or a common name such as "Threshold" (TRHD) or "White Glove" (WG-RESI) — ignoring case, spacing, punctuation and the words delivery / service / shipping. Never changes an existing mapping, and skips pickup methods and methods routed to another provider. Returns the full mapping list plus what was matched. No request body.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
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
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.