Create Item Mapping
POST/api/spscommerce/:integrationInstance/item-mappings
Match a trading partner item number to a product. Every failed purchase order waiting on that item number is retried straight away; retried_purchase_orders says how many.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token and the integrations.update permission.
Body fields:
- partner_sku (string, required, max 255): the trading partner's item number (buyer part number); unique per connection
- product_id (integer, required): the product it becomes
- partner_description (string, optional, max 255)
- upc (string, optional, max 255)
- is_active (boolean, optional, default true): an inactive mapping is ignored
Request
Responses
- 201
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
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.