Export Mappings (CSV)
GET/api/starshipit/integration-instances/:integration_instance/shipping-methods/export
Downloads the current carrier/service-to-SKU-shipping-method mappings as a CSV file (Content-Type text/csv, Content-Disposition attachment). Filename: starshipit-shipping-methods-{instanceId}-{YYYY-MM-DD}.csv.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Columns: code, carrier, carrier_name, carrier_service_code, order_count, shipping_method_id, shipping_method_name. Rows for unmapped pairs leave shipping_method_id / shipping_method_name blank.
This is the template for the Import endpoint: export, edit the shipping method columns, then re-import. Response is a file download, not JSON.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.