Sign in

v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB
Locations

Retrieve a Location

View a location within the specified account.

get/public/v3/Locations/{locationId}

Path parameters

locationIdinteger required

ID of the location.

Headers

x-tive-account-idinteger required

ID of the account the request will be made in.

Response

The requested location

namestring nullable
formattedAddressstring nullable
locationMethodstring nullable
locationOrigin1 | 2 | 3 | 4
nodeType'Warehouse' | 'ConsumerPickupPoint' | 'DistributionCenter' | 'RiskZone' | 'Airport' | 'Seaport' | 'ProductionFacility' | 'Terminal' | 'BorderCrossing' | 'ServiceStop'
shareLocationboolean
shareLocationExternallyboolean
includeCollaboratorsWhenSharingboolean
idinteger
numberOfShipmentsUsinginteger
accountIdinteger