Skip to main content

Pinnacle

📄️Get Order

Returns one Pinnacle order by local id or tracking number. Includes everything in the list row plus the item lines that were sent (each SKU resolved to its product id), every labelled piece (16-digit barcode), the full tracking event timeline (newest first; closure_reason is set for cancellation/closure events), proof-of-delivery files with download URLs, the shipment, and the exact CreateOrder request and response payloads. external_url links to the order in the Pinnacle portal when one is configured for the environment, otherwise null. can_cancel / can_refresh indicate whether Cancel Order / Refresh Order Tracking apply.

📄️List Delivery Type Mappings

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.

📄️Import Delivery Type Mappings (CSV)

Uploads a mapping CSV (multipart/form-data, field file; .csv or .txt, max 2 MB) with a header row. The header must contain delivery_type and a shipping-method column (shipping_method_id, or shipping_method_name / shipping_method_full_name); header names are matched case-insensitively. A file missing either is refused with 422 (errors.file) before anything is written — a missing delivery_type column is never read as blank cells. Each row is matched on shipping_method_id, or by name when the id is blank: the full name (carrier + method, e.g. 'UPS Ground') first, then the bare method name only when exactly one active shipping method has it. An ambiguous name is skipped with the error 'Several shipping methods are named '<name>' — use shipping_method_id'. delivery_type takes a forward delivery-type code or its label; an explicitly blank delivery_type cell removes that method's mapping. Rows that cannot be applied are skipped and reported in errors with their line number: an unknown shipping method, an unknown or reverse delivery type, or a shipping method that already appeared on an earlier line (the first occurrence wins). Returns counts of mappings created, updated and deleted.

📄️List Origin Warehouses

Returns the candidate ships-from warehouses with their address, eligibility checks and which one is the Pinnacle origin. Pinnacle picks up in the US only: an eligible origin needs a US street address, a 5-digit ZIP, a 2-letter state and a 10-digit phone (is_eligible / issues). A missing email is reported in warnings because dispatch will be rejected without one. origin_mode is explicit when an origin warehouse is set, or fulfillment_order_warehouse when each order ships from its own fulfillment order's warehouse.