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

Get a Warehouse reconciliation run

GET/v1/organizations/{orgId}/reconciliation/{runRef}
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 TEST service token) · headerrequired

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

Path parameters
orgIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
runRefstringrequired
min length 1 · max length 256
Responses
200

Success

dataobjectrequired
Show properties
adapterobjectrequired
Show properties
idstringrequired
min length 1
labelstringrequired
min length 1
providerVerifiedbooleanrequired
asOfstring<date-time> | stringrequired
Show properties
Any of:
string<date-time>
string<date-time>
string
string
countsobject[]required
min items 1
Show properties
Array of object
differenceinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
physicalCountinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
reasonstring | nullrequired
Show properties
Any of:
string
string
null
null
scopeRefstringrequired
min length 1
statusstringrequired
Allowed:cleanincompletematerial_discrepancy
tokenizedCountinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
unitstringrequired
min length 1
notificationStatusstringrequired
Allowed:not_requiredpendingsentunknown
resultstringrequired
Allowed:completematerial_discrepancyincompleteunknown
runRefstringrequired
min length 1
sourceRefstringrequired
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 GET '/v1/organizations/string/reconciliation/string' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "adapter": {
      "id": "string",
      "label": "string",
      "providerVerified": false
    },
    "asOf": "2019-08-24T14:15:22Z",
    "counts": [
      {
        "difference": -9007199254740991,
        "physicalCount": 0,
        "reason": "string",
        "scopeRef": "string",
        "status": "clean",
        "tokenizedCount": 0,
        "unit": "string"
      }
    ],
    "notificationStatus": "not_required",
    "result": "complete",
    "runRef": "string",
    "sourceRef": "string"
  },
  "meta": {
    "requestId": "string"
  }
}

Was this page helpful?