Create Amazon Integration Instance
POST/api/amazon
Create a new Amazon integration instance. Validated by StoreAmazonIntegrationData. After creation the controller also ensures a PaymentType for Amazon exists, then returns the redirect URL the user must follow to authorize the SP-API connection.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Fields
name(string, required) — display name for this instanceintegration_id(int, required, must exist inintegrationstable) — id of the Amazon integration rowcountry(string, optional) — ISO country code (e.g.US,CA,UK)is_automatic_sync_enabled(bool, default false)connection_settings(object, optional) — typically populated by OAuth callbackintegration_settings(object, required) — AmazonIntegrationSettingsData fields (see show response for available keys)
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.