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

Get order import review and results

GET/v1/organizations/{orgId}/order-imports/{importId}
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.

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

Success

dataobjectrequired
Show properties
columnsstring[]required
encodingstring | nullrequired
Show properties
Any of:
string
string
null
null
formatstringrequired

Stored import format. The returned identifier may differ from the format sent in the request.

groupsobject[]required
Show properties
Array of object
groupRevisionintegerrequired
max 9007199254740991
idstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
outcomestringrequired
Allowed:pendingconfirmedrejectedunknown
resultRefsobject | nullrequired
Show properties
Any of:
object
orderIdstring | nullrequired
Show properties
Any of:
string
string
null
null
providerOrderRefstring | nullrequired
visibleOrderNumberstring | nullrequired
null
null
reviewobjectrequired
reviewIdstringrequired
matches ^[0-9a-f]{64}$
reviewRevisionintegerrequired
max 9007199254740991
sourceIdentitystringrequired
sourceOrderIdstring | nullrequired
sourceRevisionintegerrequired
max 9007199254740991
sourceRowintegerrequired
max 9007199254740991
idstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
organizationIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
sourceHashstringrequired
matches ^[0-9a-f]{64}$
sourceRevisionintegerrequired
max 9007199254740991
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/order-imports/string' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "columns": [
      "string"
    ],
    "encoding": "utf-8",
    "format": "string",
    "groups": [
      {
        "groupRevision": 1,
        "id": "string",
        "outcome": "pending",
        "resultRefs": {
          "orderId": "string",
          "providerOrderRef": "string",
          "visibleOrderNumber": "string"
        },
        "review": {
          "property1": null,
          "property2": null
        },
        "reviewId": "string",
        "reviewRevision": 1,
        "sourceIdentity": "string",
        "sourceOrderId": "string",
        "sourceRevision": 1,
        "sourceRow": 1
      }
    ],
    "id": "string",
    "organizationId": "string",
    "sourceHash": "string",
    "sourceRevision": 1
  },
  "meta": {
    "requestId": "string"
  }
}