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.
integrations:writeGrant 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 —
filemissing / 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
- 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 — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
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.