Get Vendor Claim Defaults
GET/api/return-receipts/quick-damage-capture/vendor-claim-defaults
What the damage capture's "Claim from vendor" option prefills for a product: its suppliers (default first) with each one's vendor SKU and cost, plus the product's book cost as a fallback.
returns:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token. Permission: returns.receive. Token scope: returns:read.
Query:
- product_id (required): the damaged product
Response: default_supplier_id, suppliers[] {supplier_id, supplier_name, is_default, supplier_sku, unit_cost, currency_code}, book_unit_cost.
Request
Responses
- 200
- 401
- 403
- 422
- 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.
Unprocessable Entity
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.