Preview a purchase order
Review a customer purchase-order declaration without saving it. Player deposits require explicit eligibility for the selected immutable mode and a returnAddress. Test eligibility uses the current configured Test catalog. Live deposits keep their separate customer and deployment controls; Test setup does not activate Live intake or background deposit runs. The preview preserves each exact raw condition, or returns condition null when conditionDeferred leaves its declared grade unset. Sealed lines must specify sealedUnit. Graded-card deposits, cert lookups and exact-slab workflows are deferred from the current integration scope. Preview reserves no PO number or stock and creates no provider PO, real label purchase, charge or shipment.
/v1/organizations/{orgId}/purchase-orders/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/jsonexpectedDatestring<date> | nullShow propertiesHide properties
string<date>nulllinesobject[]requiredShow propertiesHide properties
objectproductIdstringrequiredquantityintegerrequiredconditionDeferredbooleanslabsobject[]Legacy compatibility field. Graded-card deposits and cert lookups are deferred from the current integration scope; use supported raw-card and sealed-item declarations.
Show propertiesHide properties
objectgraderstringrequiredpsabgscgccertstringrequiredLegacy graded-card certificate identifier retained for compatibility. Graded-card deposits, cert lookups and exact-slab workflows are deferred from the current integration scope.
sealedUnitstringpackboxcasemagneticSlabstringbrandedbranded_tamper_sealprofessionalGradingbooleannotestring | nullShow propertiesHide properties
stringnullorderDatestring<date> | nullShow propertiesHide properties
string<date>nullpoNumberstringregistrationKindstringstandardplayer_depositdepositRefstring | nullShow propertiesHide properties
stringnulllabelOriginstring | nullShow propertiesHide properties
stringnulllabelServicestring | nullShow propertiesHide properties
stringnullreturnAddressobject | nullShow propertiesHide properties
namestringrequiredcompanyNamestring | nullShow propertiesHide properties
stringnulladdressLine1stringrequiredaddressLine2string | nullShow propertiesHide properties
stringnullcitystringrequiredregionstring | nullShow propertiesHide properties
stringnullpostalCodestringrequiredcountryCodestringrequiredphonestring | nullShow propertiesHide properties
stringnullemailstring<email> | nullShow propertiesHide properties
string<email>nullnulltrackingstring | nullShow propertiesHide properties
stringnullSuccess
dataobjectrequiredShow propertiesHide properties
previewobjectrequiredShow propertiesHide properties
linesobject[]requiredShow propertiesHide properties
objectbaseSkustringrequiredconditionstring | nullrequiredproductIdstringrequiredquantityintegerrequiredskustring | nullrequiredsubmittedNamestringrequiredoriginstringrequiredcustomerstaff_unexpectedpoNumberstring | nullrequiredShow propertiesHide properties
stringnullregistrationKindstringrequiredstandardplayer_depositsupplierIdstring | nullrequiredwarehouseRefstringrequiredmetaobjectrequiredShow 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