Skip to main content

Import Mappings (CSV)

POST 

/api/starshipit/integration-instances/:integration_instance/shipping-methods/import

Bulk-applies carrier/service-to-SKU-shipping-method mappings from an uploaded CSV (multipart/form-data, field file).

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Per row the target SKU shipping method is resolved by shipping_method_id first (authoritative), then by shipping_method_name (case-insensitive, matches the method name or full name). A row with both shipping-method columns blank removes the mapping for that code. The code is taken from the code column, or derived from carrier + carrier_service_code as "{carrier}|{carrier_service_code}".

Returns a summary of created / updated / deleted counts plus a list of human-readable per-line errors (e.g. unknown shipping method, missing code). Rows with errors are skipped; valid rows still apply.

Validation: file is required, must be a file of type csv or txt, max 2048 KB.

Authentication: Requires Bearer token.

Request

Responses

OK

Response Headers
    Content-Type