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

List partner events

Poll durable version 1 events for the current organization and immutable mode with after and a limit from 1 to 100. The HTTP result is data.items plus data.checkpoint; meta.requestId is a request identifier, not a checkpoint. Process events in sequence order, deduplicate stable event IDs and store the checkpoint only after durable ingestion. Repeat the prior after value after a failed ingestion and continue with returned checkpoints until an empty page. Polling and current scope remain independent of outbound signing configuration. Assessment and acceptance are distinct; stable unitRefs identify cards across count revisions. This read acknowledges no delivery and repeats no business effect.

GET/v1/organizations/{orgId}/partner-events
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_-]+$
Query parameters
afterinteger
min 0 · max 9007199254740991 · default: 0
limitinteger
min 1 · max 100 · default: 50
Responses
200

Success

dataobjectrequired
Show properties
checkpointintegerrequired
min 0 · max 9007199254740991
itemsobject[]required
Show properties
Array of object
One of:
object
entityobjectrequired
Show properties
idstringrequired
min length 1 · max length 128
kindstringrequired
Allowed:depositorder
revisionstringrequired
min length 1 · max length 128
idstring<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)$
occurredAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
scopeobjectrequired
Show properties
modestringrequired
Allowed:livetest
organizationIdstringrequired
min length 1 · max length 128
sequenceintegerrequired
max 9007199254740991
versionnumberrequired
dataobjectrequired
Show properties
assessmentobject[]required
Show properties
Array of object
assessedConditionstringrequired
Allowed:nmlpmphpdmgno_damage_found
productIdstringrequired
min length 1 · max length 128
quantityintegerrequired
min 0 · max 9007199254740991
receiptLineIdstringrequired
min length 1 · max length 128
revisionintegerrequired
max 9007199254740991
unitRefsstring[]required
variantSkuobjectrequired
Show properties
One of:
object
kindstringrequired
valuestringrequired
min length 1 · max length 256
object
kindstringrequired
object
kindstringrequired
declarationRevisionintegerrequired
max 9007199254740991
depositRefstring | nullrequired
Show properties
Any of:
string
string
null
null
purchaseOrderIdstringrequired
min length 1 · max length 128
acceptanceobjectrequired
Show properties
One of:
object
kindstringrequired
object
kindstringrequired
revisionintegerrequired
max 9007199254740991
object
itemsobject[]required
Show properties
Array of object
assessedConditionstringrequired
Allowed:nmlpmphpdmgno_damage_found
productIdstringrequired
min length 1 · max length 128
quantityintegerrequired
max 9007199254740991
receiptLineIdstringrequired
min length 1 · max length 128
revisionintegerrequired
max 9007199254740991
unitRefsstring[]required
min items 1
variantSkuobjectrequired
Show properties
One of:
object
kindstringrequired
valuestringrequired
min length 1 · max length 256
object
kindstringrequired
object
kindstringrequired
kindstringrequired
revisionintegerrequired
max 9007199254740991
typestringrequired
object
entityobjectrequired
Show properties
idstringrequired
min length 1 · max length 128
kindstringrequired
Allowed:depositorder
revisionstringrequired
min length 1 · max length 128
idstring<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)$
occurredAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
scopeobjectrequired
Show properties
modestringrequired
Allowed:livetest
organizationIdstringrequired
min length 1 · max length 128
sequenceintegerrequired
max 9007199254740991
versionnumberrequired
dataobjectrequired
Show properties
assessmentobject[]required
Show properties
Array of object
assessedConditionstringrequired
Allowed:nmlpmphpdmgno_damage_found
productIdstringrequired
min length 1 · max length 128
quantityintegerrequired
min 0 · max 9007199254740991
receiptLineIdstringrequired
min length 1 · max length 128
revisionintegerrequired
max 9007199254740991
unitRefsstring[]required
variantSkuobjectrequired
Show properties
One of:
object
kindstringrequired
valuestringrequired
min length 1 · max length 256
object
kindstringrequired
object
kindstringrequired
declarationRevisionintegerrequired
max 9007199254740991
depositRefstring | nullrequired
Show properties
Any of:
string
string
null
null
purchaseOrderIdstringrequired
min length 1 · max length 128
acceptanceobjectrequired
Show properties
itemsobject[]required
min items 1
Show properties
Array of object
assessedConditionstringrequired
Allowed:nmlpmphpdmgno_damage_found
productIdstringrequired
min length 1 · max length 128
quantityintegerrequired
max 9007199254740991
receiptLineIdstringrequired
min length 1 · max length 128
revisionintegerrequired
max 9007199254740991
unitRefsstring[]required
min items 1
variantSkuobjectrequired
Show properties
One of:
object
kindstringrequired
valuestringrequired
min length 1 · max length 256
object
kindstringrequired
object
kindstringrequired
kindstringrequired
revisionintegerrequired
max 9007199254740991
typestringrequired
object
entityobjectrequired
Show properties
idstringrequired
min length 1 · max length 128
kindstringrequired
Allowed:depositorder
revisionstringrequired
min length 1 · max length 128
idstring<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)$
occurredAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
scopeobjectrequired
Show properties
modestringrequired
Allowed:livetest
organizationIdstringrequired
min length 1 · max length 128
sequenceintegerrequired
max 9007199254740991
versionnumberrequired
dataobjectrequired
Show properties
providerOrderNumberstring | nullrequired
Show properties
Any of:
string
string
null
null
shipmentsobject[]required
min items 1 · max items 2000
Show properties
Array of object
carrierstring | nullrequired
Show properties
Any of:
string
string
null
null
numberstringrequired
min length 1 · max length 256
shipDatestring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
shipmentIdstringrequired
min length 1 · max length 128
typestringrequired
object
entityobjectrequired
Show properties
idstringrequired
min length 1 · max length 128
kindstringrequired
Allowed:depositorder
revisionstringrequired
min length 1 · max length 128
idstring<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)$
occurredAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
scopeobjectrequired
Show properties
modestringrequired
Allowed:livetest
organizationIdstringrequired
min length 1 · max length 128
sequenceintegerrequired
max 9007199254740991
versionnumberrequired
dataobjectrequired
Show properties
cancelledAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
statusstringrequired
typestringrequired
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/partner-events' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "checkpoint": 1,
    "items": [
      {
        "entity": {
          "id": "00000000-0000-4000-8000-000000000001",
          "kind": "deposit",
          "revision": "assessment-1"
        },
        "id": "00000000-0000-4000-8000-000000000001",
        "occurredAt": "2026-11-05T15:00:00.000Z",
        "scope": {
          "mode": "live",
          "organizationId": "org_example"
        },
        "sequence": 1,
        "version": 1,
        "data": {
          "assessment": [],
          "declarationRevision": 1,
          "depositRef": "deposit_example",
          "purchaseOrderId": "00000000-0000-4000-8000-000000000001",
          "acceptance": {
            "kind": "not_accepted"
          }
        },
        "type": "deposit.assessed"
      }
    ]
  },
  "meta": {
    "requestId": "example-listPartnerEvents"
  }
}

Was this page helpful?