PRproject44
Stop Location Management

Retrieve a specific version of a shipment location by id and version number.

This retrieves only the specified version of the location.

get/api/v4/stoplocations/{id}/versions/{version}

Request

Path parameters

idstring uuid required

Id of the stop location to retrieve (required)

versioninteger required

Version of the stop location to retrieve (required)

Response

OK

addressSpecificity'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'DISTRICT' | 'POSTAL_CODE' | 'STREET' | 'INTERSECTION' | 'LANDMARK' | 'HOUSE_NUMBER'

The specificity of this address. Return only. This represents how sepcifically we were able to geocode the address, i.e., the most specific known entity we were able to match with it.

idstring uuid

Stop location id. Should be null. Will be provided on return.

namestring

Name of the location. Nonblank value required.

suppliedIdstring

Customer-supplied identifier for this location.

versioninteger

Version number of this location. Every time the location is edited this number is incremented.

Changes

No recorded changes to this operation across all 1 revision of this API.