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

Preview a CSV or JSON order import

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

Path parameters
orgIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Request body
requiredapplication/json
limitinteger
min 1 · max 2500 · default: 25
offsetinteger
min 0 · max 9007199254740991 · default: 0
rateContextobjectrequired
Show properties
carrierIdsstring[]required
min items 1 · max items 25
shipFromobjectrequired
Show properties
addressLine1stringrequired
min length 1 · max length 500
addressLine2stringrequired
max length 500
citystringrequired
min length 1 · max length 200
companystringrequired
max length 200
countrystringrequired
min length 1 · max length 200
emailstringrequired
max length 200
namestringrequired
max length 200
phonestringrequired
max length 200
postalCodestringrequired
max length 200
regionstringrequired
max length 200
sourceobjectrequired
Show properties
One of:
object
contentBase64stringrequired
min length 1 · max length 666668
encodingstringrequired
Allowed:utf-8windows-1252
formatstringrequired
object
contentBase64stringrequired
min length 1 · max length 666668
encodingstringrequired
Allowed:utf-8windows-1252
formatstringrequired
Allowed:original_47_column_csv
object
formatstringrequired
ordersobject[]required
min items 1 · max items 5000
Show properties
Array of object
itemsobject[]required
min items 1 · max items 100
Show properties
Array of object
namestringrequired
max length 500
quantityintegerrequired
min 1 · max 100000
skustringrequired
max length 500
recipientobjectrequired
Show properties
addressLine1stringrequired
max length 500
addressLine2stringrequired
max length 500
citystringrequired
max length 200
companystringrequired
max length 200
countrystringrequired
max length 200
emailstringrequired
max length 200
namestringrequired
max length 200
phonestringrequired
max length 200
postalCodestringrequired
max length 200
regionstringrequired
max length 200
sourceOrderIdstring | nullrequired
Show properties
Any of:
string
string
null
null
Responses
200

Success

dataobjectrequired
Show properties
nextOffsetinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
rowsobject[]required
Show properties
Array of object
groupIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
groupRevisionintegerrequired
max 9007199254740991
itemsobject[]required
Show properties
Array of object
mappingstringrequired
Allowed:ambiguousmissingmatched
namestringrequired
productIdstring | nullrequired
Show properties
Any of:
string
string
null
null
quantityinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
quantityTextstring
skustringrequired
sourceGroupintegerrequired
max 9007199254740991
reviewobjectrequired
Show properties
addressobjectrequired
Show properties
addressLine1stringrequired
addressLine2stringrequired
citystringrequired
companystringrequired
countrystringrequired
emailstringrequired
namestringrequired
phonestringrequired
postalCodestringrequired
regionstringrequired
candidateobject | nullrequired
Show properties
Any of:
object
addressLine1stringrequired
addressLine2stringrequired
citystringrequired
companystringrequired
countrystringrequired
emailstringrequired
namestringrequired
phonestringrequired
postalCodestringrequired
regionstringrequired
null
null
providerobjectrequired
Show properties
codestring | nullrequired
fieldstring | nullrequired
outcomestringrequired
Allowed:acceptednot_runrejectedunavailable
rateCountintegerrequired
min 0 · max 9007199254740991
requestIdstring | nullrequired
reasonstring | nullrequired
selectedstringrequired
Allowed:editedoriginal
statestringrequired
Allowed:invalid-required-fieldneeds-reviewpassed-unchangedprovider-unavailable
autoAdvancebooleanrequired
eligibilitystringrequired
Allowed:ineligiblereadyunavailable
issuesstring[]required
productsobject[]required
Show properties
Array of object
productIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
revisionstring | nullrequired
skustring | nullrequired
weightobject | nullrequired
Show properties
Any of:
object
unitstringrequired
valuenumberrequired
null
null
reviewIdstringrequired
matches ^[0-9a-f]{64}$
reviewRevisionintegerrequired
max 9007199254740991
sourceOrderIdstring | nullrequired
sourceRowintegerrequired
max 9007199254740991
submittedobject | nullrequired
Show properties
Any of:
object
outcomestringrequired
Allowed:confirmedunknown
visibleOrderNumberstring | nullrequired
null
null
unmappedobject[]required
Show properties
Array of object
columnstringrequired
valuestringrequired
sourceobjectrequired
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.

idstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
revisionintegerrequired
max 9007199254740991
sourceHashstringrequired
matches ^[0-9a-f]{64}$
totalRowsintegerrequired
min 0 · 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 POST '/v1/organizations/org_example/order-imports/preview' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "limit": 25,
  "offset": 0,
  "rateContext": {
    "carrierIds": [
      "carrier_example"
    ],
    "shipFrom": {
      "addressLine1": "1 Warehouse Way",
      "addressLine2": "",
      "city": "Toronto",
      "company": "Warehouse Demo",
      "country": "CA",
      "email": "warehouse@example.test",
      "name": "Warehouse Demo",
      "phone": "",
      "postalCode": "M5V 1E3",
      "region": "ON"
    }
  },
  "source": {
    "format": "json",
    "orders": [
      {
        "items": [
          {
            "name": "Demo card sleeve",
            "quantity": 2,
            "sku": "IMPORT-DEMO-SLEEVE"
          }
        ],
        "recipient": {
          "addressLine1": "1 Example Street",
          "addressLine2": "",
          "city": "Toronto",
          "company": "",
          "country": "CA",
          "email": "taylor@example.test",
          "name": "Taylor Example",
          "phone": "",
          "postalCode": "M5V 1E3",
          "region": "ON"
        },
        "sourceOrderId": "IMPORT-DEMO-1"
      }
    ]
  }
}'
Response
{
  "data": {
    "nextOffset": null,
    "rows": [
      {
        "groupId": "order_import_group_demo",
        "groupRevision": 1,
        "items": [
          {
            "mapping": "matched",
            "name": "Demo card sleeve",
            "productId": "product_import_demo",
            "quantity": 2,
            "sku": "IMPORT-DEMO-SLEEVE",
            "sourceGroup": 1
          }
        ],
        "review": {
          "address": {
            "addressLine1": "1 Example Street",
            "addressLine2": "",
            "city": "Toronto",
            "company": "",
            "country": "CA",
            "email": "taylor@example.test",
            "name": "Taylor Example",
            "phone": "",
            "postalCode": "M5V 1E3",
            "region": "ON",
            "candidate": null,
            "provider": {
              "code": null,
              "field": null,
              "outcome": "accepted",
              "rateCount": 1,
              "requestId": "rate_import_demo"
            },
            "reason": null,
            "selected": "original",
            "state": "passed-unchanged"
          },
          "autoAdvance": true,
          "eligibility": "ready",
          "issues": [],
          "products": [
            {
              "productId": "product_import_demo",
              "revision": "product-import-demo-revision",
              "sku": "IMPORT-DEMO-SLEEVE",
              "weight": {
                "unit": "ounces",
                "value": 1
              }
            }
          ],
          "reviewId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        },
        "reviewRevision": 1,
        "sourceOrderId": "IMPORT-DEMO-1",
        "sourceRow": 1,
        "submitted": null,
        "unmapped": []
      }
    ],
    "source": {
      "columns": [
        "sourceOrderId",
        "recipient",
        "items"
      ],
      "encoding": null,
      "format": "json",
      "id": "order_import_demo",
      "revision": 1,
      "sourceHash": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
      "totalRows": 1
    }
  },
  "meta": {
    "requestId": "example-previewOrderImport"
  }
}