Create Integration Instance
POST/api/shiprush/instances
Creates and connects a new ShipRush integration instance for the current account, then returns it together with a live dashboard summary and the ONE-TIME plaintext store credentials (username, password, feed URL) the merchant pastes into ShipRush. The credentials block is shown only once — it is never returned again on Get.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body fields:
- name (string, required): a label for this connection. Max 255 characters.
- environment (string, optional): "production" or "sandbox". Defaults to "production".
- shipping_api_token (string, optional, nullable): a ShipRush Shipping API token that enables the token-gated tracking/service-name sync. Max 255 characters.
- record_shipping_costs (boolean, optional): capture ShipRush shipping costs against orders. Defaults to true.
Returns 201 with the created instance, its dashboard summary, and the one-time credentials block. Returns 422 with field errors when validation fails.
ShipRush is single-instance: a tenant can connect one ShipRush account. Creating a second instance returns 422.
Authentication: Requires a Bearer token.
Request
Responses
- 201
- 401
- 403
- 422
- 429
Created
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.
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.