Create a customer purchase order
Create a customer purchase-order declaration in the selected immutable mode. Player deposits require explicit eligibility for that mode and a returnAddress for ship-back. Test eligibility admits configured raw-condition and sealed pack/box/case declarations using isolated inventory and a synthetic prepaid-label association. Live deposits keep their separate customer and deployment controls; Test setup does not activate Live intake or background deposit runs. A raw line may set conditionDeferred to leave its declared grade unset; a sealed line must specify sealedUnit. Use the returned local PO ID to read deposit-results after assessment and acceptance. An exact submission-key replay returns its original receipt; changed intent conflicts. Graded-card deposits, cert lookups and exact-slab workflows are deferred from the current integration scope. Test creates no provider PO, real label purchase, charge or shipment.
/v1/organizations/{orgId}/purchase-ordersAuthorizationBasic 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 TEST service token) · headerrequiredCustomer- and resource-bound service grant, rechecked on every call. Existing Live opening-feed authority remains narrow; ordinary Test business requests refuse until shared Test composition is available.
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>nullnullsubmissionKeystringrequiredtrackingstring | nullShow propertiesHide properties
stringnullSuccess
dataobjectrequiredShow propertiesHide properties
effectsstring[]requiredoperationIdstringrequiredoutcomestringrequiredpurchaseOrderobjectrequiredShow propertiesHide properties
declarationRevisionintegerrequiredidstring<uuid>requiredpoNumberstringrequiredproviderPoRefstring | nullrequiredShow propertiesHide properties
stringnulldepositobjectShow propertiesHide properties
adapterobjectrequiredShow propertiesHide properties
idstringrequiredlabelstringrequiredproviderVerifiedbooleanrequireddepositRefstringrequiredlabelobjectrequiredShow propertiesHide properties
documentIdstring<uuid>requiredlabelRefstringrequiredproviderRefstringrequiredtrackingstringrequiredsourcestringrequiredplayer_depositslabsobject[]Historical graded-card metadata retained for compatibility. Graded-card deposits and cert lookups are deferred from the current integration scope.
Show propertiesHide properties
objectcertstringrequiredgraderstringrequiredpsabgscgclookupstringrequiredverifiedpendingmetaobjectrequiredShow 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