PRproject44
Stop Location Management

Submit a new shipment location.

<h4><b>Required Fields</h4></b> To create a valid stop location, you must supply a <b>name</b> plus one of <ul><li>A valid <b>STREET ADDRESS</b>. This is an address that includes all of:<ul><li><b>addressLines</b></li><li><b>city</b></li><li><b>state</b> and/or <b>postalCode</b></li><li><b>country</b></li></ul></li><li>A pair of valid <b>COORDINATES</b> along with an address that includes <b>COUNTRY</b></li><ul>
post/api/v4/stoplocations

Request

Request body

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.

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.