Create Integration Instance
POST/api/shippit/instances
Creates and connects a new Shippit integration instance for the current account, then returns it together with a live dashboard summary (merchant profile, order-state counts, courier and warehouse-mapping counts, and the webhook URL to paste into your Shippit account).
Body fields:
- name (string, required): a label for this connection. Max 255 characters.
- api_key (string, required): the Shippit API key. Minimum 8 characters.
- environment (string, optional): "production" or "sandbox". Defaults to "production".
- auto_book (boolean, optional): automatically book shipments with Shippit. Defaults to true.
- record_shipping_costs (boolean, optional): capture Shippit shipping costs against orders. Defaults to true.
- default_courier_type (string, optional, nullable): default Shippit courier type to request, e.g. "standard" or "express". Max 100 characters.
Returns 201 with the created instance and its dashboard summary. Returns 422 with field errors when validation fails.
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.