Skip to content
Stashtab Docs
Esc
↑↓navigate↵open⌘Jpreview

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.

POST/v1/organizations/{orgId}/purchase-orders/preview
Authorization
AuthorizationBasic auth · headerrequired

Registered confidential integration credentials. Keep the secret server-side.

or
CookieAPI key · headerrequired

Console-managed Vault session cookie; secure cookie naming may vary by environment.

or
AuthorizationBearer token (Vault organization API key) · headerrequired

Organization-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.

Path parameters
orgIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Request body
requiredapplication/json
expectedDatestring<date> | null
Show properties
Any of:
string<date>
string<date>
null
null
linesobject[]required
min items 1 · max items 500
Show properties
Array of object
productIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
quantityintegerrequired
min 1 · max 100000
conditionDeferredboolean
slabsobject[]

Legacy compatibility field. Graded-card deposits and cert lookups are deferred from the current integration scope; use supported raw-card and sealed-item declarations.

min items 1 · max items 100
Show properties
Array of object
graderstringrequired
Allowed:psabgscgc
certstringrequired

Legacy graded-card certificate identifier retained for compatibility. Graded-card deposits, cert lookups and exact-slab workflows are deferred from the current integration scope.

max length 40
sealedUnitstring
Allowed:packboxcase
magneticSlabstring
Allowed:brandedbranded_tamper_seal
professionalGradingboolean
notestring | null
Show properties
Any of:
string
string
null
null
orderDatestring<date> | null
Show properties
Any of:
string<date>
string<date>
null
null
poNumberstring
min length 1 · max length 200
registrationKindstring
default: "standard"
Allowed:standardplayer_deposit
depositRefstring | null
Show properties
Any of:
string
string
null
null
labelOriginstring | null
Show properties
Any of:
string
string
null
null
labelServicestring | null
Show properties
Any of:
string
string
null
null
returnAddressobject | null
Show properties
Any of:
object
namestringrequired
min length 1 · max length 200
companyNamestring | null
Show properties
Any of:
string
string
null
null
addressLine1stringrequired
min length 1 · max length 200
addressLine2string | null
Show properties
Any of:
string
string
null
null
citystringrequired
min length 1 · max length 200
regionstring | null
Show properties
Any of:
string
string
null
null
postalCodestringrequired
min length 1 · max length 20
countryCodestringrequired
matches ^[A-Za-z]{2}$
phonestring | null
Show properties
Any of:
string
string
null
null
emailstring<email> | null
Show properties
Any of:
string<email>
string<email>
null
null
null
null
trackingstring | null
Show properties
Any of:
string
string
null
null
Responses
200

Success

dataobjectrequired
Show properties
previewobjectrequired
Show properties
linesobject[]required
Show properties
Array of object
baseSkustringrequired
min length 1
conditionstring | nullrequired
productIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
quantityintegerrequired
min 0 · max 9007199254740991
skustring | nullrequired
submittedNamestringrequired
min length 1
originstringrequired
Allowed:customerstaff_unexpected
poNumberstring | nullrequired
Show properties
Any of:
string
string
null
null
registrationKindstringrequired
Allowed:standardplayer_deposit
supplierIdstring | nullrequired
warehouseRefstringrequired
min length 1
metaobjectrequired
Show properties
requestIdstringrequired
default

Error

errorobjectrequired
Show properties
codestringrequired
Allowed:forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_ready
fieldsobject[]
Show properties
Array of object
codestringrequired
messagestringrequired
pathstringrequired
messagestringrequired
operationIdstring
metaobjectrequired
Show properties
requestIdstringrequired
Request
curl -X POST '/v1/organizations/string/purchase-orders/preview' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "expectedDate": "2019-08-24",
  "lines": [
    {
      "productId": "string",
      "quantity": 1,
      "conditionDeferred": true,
      "slabs": [
        {
          "grader": "psa",
          "cert": "string"
        }
      ],
      "sealedUnit": "pack",
      "magneticSlab": "branded",
      "professionalGrading": true
    }
  ],
  "note": "string",
  "orderDate": "2019-08-24",
  "poNumber": "string",
  "registrationKind": "standard",
  "depositRef": "string",
  "labelOrigin": "string",
  "labelService": "string",
  "returnAddress": {
    "name": "string",
    "companyName": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "countryCode": "string",
    "phone": "string",
    "email": "user@example.com"
  },
  "tracking": "string"
}'
Response
{
  "data": {
    "preview": {
      "lines": [
        {
          "baseSku": "string",
          "condition": "string",
          "productId": "string",
          "quantity": 0,
          "sku": "string",
          "submittedName": "string"
        }
      ],
      "origin": "customer",
      "poNumber": "string",
      "registrationKind": "standard",
      "supplierId": "string",
      "warehouseRef": "string"
    }
  },
  "meta": {
    "requestId": "string"
  }
}

Was this page helpful?