Skip to main content

Import Shipping Method Mappings

POST 

/api/shipbob/:instance/shipping-methods/import

Import shipping method mappings from a CSV file. Good rows apply; each rejected row is reported in data.errors as "Line N: …" (the header is line 1). Blank lines are skipped and a UTF-8 BOM (Excel "CSV UTF-8") is tolerated.

Required scope: integrations:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Content-Type: multipart/form-data.

Form Data:

  • file (file, required) — CSV file (.csv or .txt, max 2 MB).

Columns (use Export first for a template):

  • id — the ShipBob shipping method row id (from the export). Matched first.
  • shipbob_shipping_method — the ShipBob method name; used when id is blank or unknown.
  • service_level — informational, ignored on import.
  • shipping_method_id — SKU shipping method id (authoritative when present).
  • shipping_method_name — SKU shipping method name or full name (case-insensitive), used when shipping_method_id is blank. Leave both SKU columns blank to remove that mapping.

Response counts: created (newly mapped), updated (re-mapped), deleted (mapping cleared), errors (per-row messages).

Errors:

  • 422 — file missing / wrong type / over 2 MB (validation), or the CSV has no header row or lacks the key columns (an id or shipbob_shipping_method column, and a shipping_method_id or shipping_method_name column).

Request​

Responses​

OK

Response Headers
    Content-Type