Get freight
GET
/v1/organizations/{orgId}/freight/{freightId}Authorization
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
freightIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
orgIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Responses
200
Success
dataobjectrequiredShow propertiesHide properties
carrierstring | nullrequiredcustomerReferencestring | nullrequireddestinationstring | nullrequireddocumentsobject[]requiredShow propertiesHide properties
Array of
objectidstringrequiredkindstringrequiredAllowed:
bolpacking-slipstatestringrequiredAllowed:
availableunavailableidstringrequiredlatestUpdateobject | nullrequiredShow propertiesHide properties
Any of:
object
atstringrequireddescriptionstringrequirednull
nullproNumberstring | nullrequiredquoteobject | nullrequiredShow propertiesHide properties
Any of:
object
amountstringrequiredcurrencystringrequirednull
nullrecipientNamestring | nullrequiredreferencestringrequiredstatusstringrequiredAllowed:
pending-pickupin-transitdeliveredexceptionunknowntrackingNumberstring | nullrequireddeliveryLabelstring | nullrequiredexceptionMessagestring | nullrequiredoriginstring | nullrequiredpickupLabelstring | nullrequiredrecipientAddressstring[]requiredmetaobjectrequiredShow 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