List Delivery Type Mappings
GET/api/pinnacle/instances/:instance/delivery-types
Returns every SKU.io shipping method with the Pinnacle delivery type it maps to. Each row's status is mapped (explicit mapping), unmapped (falls back to the instance default delivery type — uses_default=true — or is rejected before dispatch when there is no default), pickup (a pickup method; never sent to Pinnacle) or other_provider (EVERY warehouse that dispatches to this instance sends the method to a different provider or Manual through a routing rule that is currently honoured — active, mapped target; routed_to describes the first such rule and there is no mapping to edit). Routing is evaluated per warehouse: when only some warehouses route the method elsewhere, the row keeps its mapped / unmapped status (Pinnacle still receives it from the others) and routed_elsewhere_at lists each warehouse whose rule sends it elsewhere (warehouse_id, warehouse_name, target name / integration_name / is_manual, routing_rule_id) for display only. Rules whose target cannot be used (inactive, unmapped, no dispatcher) fall through to the warehouse default and are ignored. Archived shipping methods are not listed. will_send is what dispatch puts on the wire for an order with that method, in the same order dispatch decides it: pickup (never sent) → other_provider (sent to the routing-rule target instead) → mapped (the mapped code) → default (the instance default delivery type) → rejected (no mapping and no valid default; the order is rejected before it reaches Pinnacle). will_send.text is the display string. Several shipping methods may map to the same delivery type. Also returns all delivery types (forward and reverse), the default delivery type (default_delivery_type_valid=false when the saved default is not a valid code), counts per status plus rejected (rows dispatch would reject), and the warehouses whose routing rules were considered.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: requires a Bearer token (Personal Access Token).
Request
Responses
- 200
- 401
- 403
- 404
- 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
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.