Preview a CSV or JSON order import
POST
/v1/organizations/{orgId}/order-imports/previewAuthorization
AuthorizationBasic auth · headerrequiredRegistered confidential integration credentials. Keep the secret server-side.
or
CookieAPI key · headerrequiredConsole-managed Vault session cookie; secure cookie naming may vary by environment.
Path parameters
orgIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Request body
requiredapplication/jsonlimitintegermin 1 · max 2500 · default: 25
offsetintegermin 0 · max 9007199254740991 · default: 0
rateContextobjectrequiredShow propertiesHide properties
carrierIdsstring[]requiredmin items 1 · max items 25
shipFromobjectrequiredShow propertiesHide properties
addressLine1stringrequiredmin length 1 · max length 500
addressLine2stringrequiredmax length 500
citystringrequiredmin length 1 · max length 200
companystringrequiredmax length 200
countrystringrequiredmin length 1 · max length 200
emailstringrequiredmax length 200
namestringrequiredmax length 200
phonestringrequiredmax length 200
postalCodestringrequiredmax length 200
regionstringrequiredmax length 200
sourceobjectrequiredShow propertiesHide properties
One of:
object
contentBase64stringrequiredmin length 1 · max length 666668
encodingstringrequiredAllowed:
utf-8windows-1252formatstringrequiredobject
contentBase64stringrequiredmin length 1 · max length 666668
encodingstringrequiredAllowed:
utf-8windows-1252formatstringrequiredAllowed:
original_47_column_csvobject
formatstringrequiredordersobject[]requiredmin items 1 · max items 5000
Show propertiesHide properties
Array of
objectitemsobject[]requiredmin items 1 · max items 100
Show propertiesHide properties
Array of
objectnamestringrequiredmax length 500
quantityintegerrequiredmin 1 · max 100000
skustringrequiredmax length 500
recipientobjectrequiredShow propertiesHide properties
addressLine1stringrequiredmax length 500
addressLine2stringrequiredmax length 500
citystringrequiredmax length 200
companystringrequiredmax length 200
countrystringrequiredmax length 200
emailstringrequiredmax length 200
namestringrequiredmax length 200
phonestringrequiredmax length 200
postalCodestringrequiredmax length 200
regionstringrequiredmax length 200
sourceOrderIdstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullResponses
200
Success
dataobjectrequiredShow propertiesHide properties
nextOffsetinteger | nullrequiredShow propertiesHide properties
Any of:
integer
integernull
nullrowsobject[]requiredShow propertiesHide properties
Array of
objectgroupIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
groupRevisionintegerrequiredmax 9007199254740991
itemsobject[]requiredShow propertiesHide properties
Array of
objectmappingstringrequiredAllowed:
ambiguousmissingmatchednamestringrequiredproductIdstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullquantityinteger | nullrequiredShow propertiesHide properties
Any of:
integer
integernull
nullquantityTextstringskustringrequiredsourceGroupintegerrequiredmax 9007199254740991
reviewobjectrequiredShow propertiesHide properties
addressobjectrequiredShow propertiesHide properties
addressLine1stringrequiredaddressLine2stringrequiredcitystringrequiredcompanystringrequiredcountrystringrequiredemailstringrequirednamestringrequiredphonestringrequiredpostalCodestringrequiredregionstringrequiredcandidateobject | nullrequiredShow propertiesHide properties
Any of:
object
addressLine1stringrequiredaddressLine2stringrequiredcitystringrequiredcompanystringrequiredcountrystringrequiredemailstringrequirednamestringrequiredphonestringrequiredpostalCodestringrequiredregionstringrequirednull
nullproviderobjectrequiredShow propertiesHide properties
codestring | nullrequiredfieldstring | nullrequiredoutcomestringrequiredAllowed:
acceptednot_runrejectedunavailablerateCountintegerrequiredmin 0 · max 9007199254740991
requestIdstring | nullrequiredreasonstring | nullrequiredselectedstringrequiredAllowed:
editedoriginalstatestringrequiredAllowed:
invalid-required-fieldneeds-reviewpassed-unchangedprovider-unavailableautoAdvancebooleanrequiredeligibilitystringrequiredAllowed:
ineligiblereadyunavailableissuesstring[]requiredproductsobject[]requiredShow propertiesHide properties
Array of
objectproductIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
revisionstring | nullrequiredskustring | nullrequiredweightobject | nullrequiredShow propertiesHide properties
Any of:
object
unitstringrequiredvaluenumberrequirednull
nullreviewIdstringrequiredmatches ^[0-9a-f]{64}$
reviewRevisionintegerrequiredmax 9007199254740991
sourceOrderIdstring | nullrequiredsourceRowintegerrequiredmax 9007199254740991
submittedobject | nullrequiredShow propertiesHide properties
Any of:
object
outcomestringrequiredAllowed:
confirmedunknownvisibleOrderNumberstring | nullrequirednull
nullunmappedobject[]requiredShow propertiesHide properties
Array of
objectcolumnstringrequiredvaluestringrequiredsourceobjectrequiredShow propertiesHide properties
columnsstring[]requiredencodingstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullformatstringrequiredStored import format. The returned identifier may differ from the format sent in the request.
idstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
revisionintegerrequiredmax 9007199254740991
sourceHashstringrequiredmatches ^[0-9a-f]{64}$
totalRowsintegerrequiredmin 0 · max 9007199254740991
metaobjectrequiredShow propertiesHide properties
requestIdstringrequireddefault
Error
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_readyfieldsobject[]Show propertiesHide properties
Array of
objectcodestringrequiredmessagestringrequiredpathstringrequiredmessagestringrequiredoperationIdstringmetaobjectrequiredShow propertiesHide properties
requestIdstringrequired