Skip to main content

Import Delivery Type Mappings (CSV)

POST 
/api/pinnacle/instances/:instance/delivery-types/import

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.

Not yet available to API tokens

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​

OK

Response Headers
    Content-Type