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

Get player-deposit results

Poll the current factual assessment and accepted units of one player-deposit purchase order. Assessment reports current recorded condition, exact product, quantity, stable unitRefs and count revision. Acceptance is current only when the committed acceptance matches all current count revisions; stale or not_accepted carries no accepted units. Current accepted items exclude open disputes and ship-backs. Each variantSku is a stored verified SKU, an explicit unavailable mapping or not_applicable for goods without a condition variant. Acceptance revision tracks commercial acceptance, so reconcile the full current accepted unitRefs on every successful poll, including after each dispute event, rather than skipping an unchanged revision. A stable unitRef remains the card identity; use its count revision as reconciliation evidence and never authorize another mint merely because that revision changed. A count or assessment alone never authorizes tokenization. This read creates no acceptance, shipment or receiver delivery and uses the current organization and mode authority.

GET/v1/organizations/{orgId}/purchase-orders/{purchaseOrderId}/deposit-results
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_-]+$
purchaseOrderIdstring<uuid>required
matches ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Responses
200

Success

dataobjectrequired
Show properties
acceptanceobjectrequired
Show properties
One of:
object
kindstringrequired
object
kindstringrequired
revisionintegerrequired
min 1 · max 9007199254740991
object
itemsobject[]required
Show properties
Array of object
assessedConditionstringrequired
Allowed:nmlpmphpdmgno_damage_found
productIdstringrequired
quantityintegerrequired
min 1 · max 9007199254740991
receiptLineIdstringrequired
revisionintegerrequired
min 1 · max 9007199254740991
unitRefsstring[]required
min items 1
variantSkuobjectrequired
Show properties
One of:
object
kindstringrequired
valuestringrequired
min length 1
object
kindstringrequired
object
kindstringrequired
kindstringrequired
revisionintegerrequired
min 1 · max 9007199254740991
assessmentobject[]required
Show properties
Array of object
assessedConditionstringrequired
Allowed:nmlpmphpdmgno_damage_found
productIdstringrequired
quantityintegerrequired
min 0 · max 9007199254740991
receiptLineIdstringrequired
revisionintegerrequired
min 1 · max 9007199254740991
unitRefsstring[]required
variantSkuobjectrequired
Show properties
One of:
object
kindstringrequired
valuestringrequired
min length 1
object
kindstringrequired
object
kindstringrequired
declarationRevisionintegerrequired
min 1 · max 9007199254740991
depositRefstring | nullrequired
purchaseOrderIdstringrequired
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 GET '/v1/organizations/org_example/purchase-orders/00000000-0000-4000-8000-000000000001/deposit-results' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "acceptance": {
      "items": [
        {
          "assessedCondition": "lp",
          "productId": "product_variant_lp_demo",
          "quantity": 1,
          "receiptLineId": "receipt_line_demo",
          "revision": 2,
          "unitRefs": [
            "receipt_line_demo:1"
          ],
          "variantSku": {
            "kind": "available",
            "value": "CARD-DEMO-LP"
          }
        }
      ],
      "kind": "current",
      "revision": 3
    },
    "assessment": [
      {
        "assessedCondition": "lp",
        "productId": "product_variant_lp_demo",
        "quantity": 2,
        "receiptLineId": "receipt_line_demo",
        "revision": 2,
        "unitRefs": [
          "receipt_line_demo:0",
          "receipt_line_demo:1"
        ],
        "variantSku": {
          "kind": "available",
          "value": "CARD-DEMO-LP"
        }
      }
    ],
    "declarationRevision": 2,
    "depositRef": "deposit_demo_1",
    "purchaseOrderId": "00000000-0000-4000-8000-000000000001"
  },
  "meta": {
    "requestId": "example-getDepositResults"
  }
}

Was this page helpful?