Get Portal Access Hash
GET/api/amazon/:integrationInstance/draft-inbound-plans/:draft_inbound_plan/portal-access-hash
Returns the encrypted plan identifier (hashed_id) used to build the shareable, unauthenticated verification portal URL for this draft inbound plan. The portal lets a supplier verify item quantities without logging in.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
The hash is an encrypted payload of the plan id; append it to the verification portal path (/v2/integrations/amazon/fba/draft-inbound-plans/verification-portal/{hashed_id}?integration={integrationInstance}) and share the resulting link. The same hash is embedded in the inventory inquiry email and the QR code on the inventory inquiry PDF. No request body or query parameters.
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.