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

Preview an order and validate its address

Reviews a proposed order without creating it. For a redemption in Test or Live, set orderKind to redemption to check the exact destination. A rejected, unavailable or unconfirmed address cannot advance. Recheck any corrections before placing the order; a quote or autoAdvance alone does not authorize creation. Set rateContext.physicalSource to {} and copy physicalSource.selected unchanged as fulfillmentSource. Pass the same deliveryConfirmation to preview and quote; an omitted value means none. For priced shipping, quote the same recipient, products and source, then preview the exact named service and pass the quote selection as shippingQuote. Preview again when any input changes. Existing unquoted callers can pass preview’s requestedService.selected and requestedService.review as requestedShippingService and requestedShippingServiceReview.

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

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_-]+$
Request body
requiredapplication/json
deliveryConfirmationstring
Allowed:nonedeliverysignatureadult_signaturedirect_signature
linesobject[]required
min items 1 · max items 100
Show properties
Array of object
declaredUnitValueobject
Show properties
amountstringrequired
matches ^(0|[1-9]\d{0,8})(\.\d{1,4})?$
productIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
quantityintegerrequired
min 1 · max 100000
orderKindstring
rateContextobjectrequired
Show properties
Any of:
object
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
object
carrierIdsstring[]required
min items 1 · max items 25
requestedShippingServicestring
max length 200
physicalSourceobjectrequired
Show properties
selectedobject
Show properties
Any of:
object
configurationRevisionstringrequired
matches ^[1-9][0-9]*$
sourceSignaturestringrequired
matches ^[0-9a-f]{64}$
physicalOriginEquivalenceRefstringrequired
min length 1 · max length 200
v1WarehouseIdintegerrequired
max 9007199254740991
object
modestringrequired
configurationRevisionstringrequired
matches ^[1-9][0-9]*$
sourceSignaturestringrequired
matches ^[0-9a-f]{64}$
physicalOriginEquivalenceRefstringrequired
min length 1 · max length 200
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
selectedAddressstringrequired
Allowed:editedoriginal
Responses
200

Success

dataobjectrequired
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}$
requestedServiceobject
Show properties
statestringrequired
Allowed:readyunavailable
selectedstring | nullrequired
Show properties
Any of:
string
string
null
null
choicesstring[]required
max items 1000
reviewstring | nullrequired
Show properties
Any of:
string
string
null
null
reasonstring | nullrequired
physicalSourceobject
Show properties
statestringrequired
Allowed:unavailablechoiceready
selectedobject | nullrequired
Show properties
Any of:
object
Any of:
object
configurationRevisionstringrequired
matches ^[1-9][0-9]*$
sourceSignaturestringrequired
matches ^[0-9a-f]{64}$
physicalOriginEquivalenceRefstringrequired
min length 1 · max length 200
v1WarehouseIdintegerrequired
max 9007199254740991
object
modestringrequired
configurationRevisionstringrequired
matches ^[1-9][0-9]*$
sourceSignaturestringrequired
matches ^[0-9a-f]{64}$
physicalOriginEquivalenceRefstringrequired
min length 1 · max length 200
null
null
choicesobject[]required
max items 100
Show properties
Array of object
selectionobjectrequired
Show properties
Any of:
object
configurationRevisionstringrequired
matches ^[1-9][0-9]*$
sourceSignaturestringrequired
matches ^[0-9a-f]{64}$
physicalOriginEquivalenceRefstringrequired
min length 1 · max length 200
v1WarehouseIdintegerrequired
max 9007199254740991
object
modestringrequired
configurationRevisionstringrequired
matches ^[1-9][0-9]*$
sourceSignaturestringrequired
matches ^[0-9a-f]{64}$
physicalOriginEquivalenceRefstringrequired
min length 1 · max length 200
addressobjectrequired
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
reasonstring | nullrequired
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/string/orders/preview' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "deliveryConfirmation": "none",
  "lines": [
    {
      "declaredUnitValue": {
        "amount": "string"
      },
      "productId": "string",
      "quantity": 1
    }
  ],
  "orderKind": "redemption",
  "rateContext": {
    "carrierIds": [
      "string"
    ],
    "shipFrom": {
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "company": "string",
      "country": "string",
      "email": "string",
      "name": "string",
      "phone": "string",
      "postalCode": "string",
      "region": "string"
    }
  },
  "recipient": {
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "company": "string",
    "country": "string",
    "email": "string",
    "name": "string",
    "phone": "string",
    "postalCode": "string",
    "region": "string"
  },
  "selectedAddress": "edited"
}'
Response
{
  "data": {
    "address": {
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "company": "string",
      "country": "string",
      "email": "string",
      "name": "string",
      "phone": "string",
      "postalCode": "string",
      "region": "string",
      "candidate": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "company": "string",
        "country": "string",
        "email": "string",
        "name": "string",
        "phone": "string",
        "postalCode": "string",
        "region": "string"
      },
      "provider": {
        "code": "string",
        "field": "string",
        "outcome": "accepted",
        "rateCount": 0,
        "requestId": "string"
      },
      "reason": "string",
      "selected": "edited",
      "state": "invalid-required-field"
    },
    "autoAdvance": true,
    "eligibility": "ineligible",
    "issues": [
      "string"
    ],
    "products": [
      {
        "productId": "string",
        "revision": "string",
        "sku": "string",
        "weight": {
          "unit": "string",
          "value": 0
        }
      }
    ],
    "reviewId": "string",
    "requestedService": {
      "state": "ready",
      "selected": "string",
      "choices": [
        "string"
      ],
      "review": "string",
      "reason": "string"
    },
    "physicalSource": {
      "state": "unavailable",
      "selected": {
        "configurationRevision": "string",
        "sourceSignature": "string",
        "physicalOriginEquivalenceRef": "string",
        "v1WarehouseId": 1
      },
      "choices": [
        {
          "selection": {
            "configurationRevision": "string",
            "sourceSignature": "string",
            "physicalOriginEquivalenceRef": "string",
            "v1WarehouseId": 1
          },
          "address": {
            "addressLine1": "string",
            "addressLine2": "string",
            "city": "string",
            "company": "string",
            "country": "string",
            "email": "string",
            "name": "string",
            "phone": "string",
            "postalCode": "string",
            "region": "string"
          }
        }
      ],
      "reason": "string"
    }
  },
  "meta": {
    "requestId": "string"
  }
}

Was this page helpful?