Get Product Mapping Candidates
GET/api/shipbob/:instance/products/:product/mapping-candidates
The SKU.io products the auto-matcher considers for one ShipBob product: every product whose SKU or barcode equals the ShipBob product's barcode, UPC, GTIN or SKU, with the identifiers it shares (matched_on). A product with more than one candidate is flagged Needs Review instead of being mapped; the mapping dialog lists these for a one-click pick. 404 for a product of another connection.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
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.
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.