Preview grouped purchase-order CSV or JSON
POST
/v1/organizations/{orgId}/purchase-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/jsonsourceobjectrequiredShow propertiesHide properties
One of:
object
contentBase64stringrequiredmin length 1 · max length 10000000
encodingstringrequiredAllowed:
utf-8windows-1252formatstringrequiredobject
formatstringrequiredgroupsobject[]requiredmin items 1 · max items 5000
Show propertiesHide properties
Array of
objectexpectedDatestring<date> | nullShow propertiesHide properties
Any of:
string<date>
string<date>null
nulllinesobject[]requiredmax items 500
Show propertiesHide properties
Array of
objectconditionstring | nullShow propertiesHide properties
Any of:
string
stringnull
nullnamestringrequiredmax length 500
quantityintegerrequiredmin 0 · max 9007199254740991
skustringrequiredmax length 500
sourceRowintegermax 9007199254740991
notestring | nullShow propertiesHide properties
Any of:
string
stringnull
nullorderDatestring<date> | nullShow propertiesHide properties
Any of:
string<date>
string<date>null
nullpoNumberstring | nullShow propertiesHide properties
Any of:
string
stringnull
nullResponses
200
Success
dataobjectrequiredShow propertiesHide properties
groupsobject[]requiredShow propertiesHide properties
Array of
objecteligiblebooleanrequiredexpectedDatestring | nullrequiredgroupIdstringrequiredmatches ^[0-9a-f]{64}$
issuesstring[]requiredlinesobject[]requiredShow propertiesHide properties
Array of
objectconditionstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullmappingstringrequiredAllowed:
ambiguousmatchedmissinginvalidnamestringrequiredproductIdstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullquantityinteger | nullrequiredShow propertiesHide properties
Any of:
integer
integernull
nullskustringrequiredsourceRowintegerrequiredmax 9007199254740991
notestring | nullrequiredorderDatestring | nullrequiredpoNumberstring | nullrequiredrevisionstringrequiredmatches ^[0-9a-f]{64}$
sourceRowsinteger[]requiredimportIdstringrequiredmatches ^[0-9a-f]{64}$
sourceHashstringrequiredmatches ^[0-9a-f]{64}$
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