Create Provider
POST/api/api-shipping-providers
Create a new API Shipping Provider integration instance.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Request Body Fields:
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Display name for the provider (max 255 chars) |
Post-Request Script:
Automatically sets the {{provider-id}} collection variable on success.
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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.