Preview a whole pack or selected cards for redemption
Optional declaredUnitValues accept one {productId, amount} entry per distinct selected product, in USD per unit. Repeated copies share that unit value. The returned lines include declaredUnitValue, and the returned pack retains the overrides. Duplicate or unselected product entries are refused. Values do not change the frozen source digest or catalog defaults. Preview a whole published pack or selected one-based cardOrdinals within the current organization and verified deployment. Omit cardOrdinals for the whole pack; each selected ordinal may appear once. The response includes the frozen source revision and digest, exact catalog products and recorded conditions, and quantity lines that combine repeated exact variants. Pass the returned lines into createRedemptionOrder for the whole pack or the previewed subset. To select cards after fetching the whole pack, use their productId and condition from cards and combine repeated products into quantities. A Live caller using the pack input can pass the returned pack object unchanged instead of lines. Preview and quote the resolved lines with the same recipient and physical source before submitting a priced redemption. A stale revision or digest requires another preview; an exact submission-key replay preserves the selected source identities. This convenience does not grant protocol authority, allocate a serialized physical copy, restore a token or escrow, or authorize unrevealed content. Test can preview explicitly copied published packs in its active generation. The copy preserves recorded raw conditions and resolves separate Test catalog products with sufficient synthetic stock. Use the returned explicit lines for Test redemption; frozen pack creation remains Live-only. Missing or revoked Test copies never fall back to Live.
/v1/organizations/{orgId}/orders/redemptions/pack-previewAuthorizationBasic auth · headerrequiredRegistered confidential integration credentials. Keep the secret server-side.
CookieAPI key · headerrequiredConsole-managed Vault session cookie; secure cookie naming may vary by environment.
AuthorizationBearer token (Vault organization API key) · headerrequiredOrganization-owned credential with immutable mode and Read-only or Read/write permissions. Only explicitly declared ordinary customer operations accept it. Test business access refuses until shared Test composition is available; no staff, team, key-management or protocol authority is granted.
orgIdstringrequiredapplication/jsoncardOrdinalsinteger[]declaredUnitValuesobject[]Show propertiesHide properties
objectamountstringrequiredproductIdstringrequireddeploymentRefstringrequiredpackReferencestringrequiredSuccess
dataobjectrequiredShow propertiesHide properties
cardsobject[]requiredShow propertiesHide properties
objectconditionstring | nullrequiredShow propertiesHide properties
stringnullordinalintegerrequiredproductIdstringrequiredlinesobject[]requiredShow propertiesHide properties
objectdeclaredUnitValueobjectShow propertiesHide properties
amountstringrequiredconditionstring | nullrequiredShow propertiesHide properties
stringnullproductIdstringrequiredquantityintegerrequiredpackobjectrequiredShow propertiesHide properties
cardOrdinalsinteger[]declaredUnitValuesobject[]Show propertiesHide properties
objectamountstringrequiredproductIdstringrequireddeploymentRefstringrequiredpackReferencestringrequiredsourceContentRevisionintegerrequiredsourceDigeststringrequiredmetaobjectrequiredShow propertiesHide properties
requestIdstringrequiredError
errorobjectrequiredShow propertiesHide properties
codestringrequiredforbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_readyfieldsobject[]Show propertiesHide properties
objectcodestringrequiredmessagestringrequiredpathstringrequiredmessagestringrequiredoperationIdstringmetaobjectrequiredShow propertiesHide properties
requestIdstringrequired