ServicePoints
Returns service point locations for the specified carrier and address filters.
View-Specific Information
Select
The add-in will use the ShipStation API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the add-in.
- ServicePointId, CarrierCode, CountryCode, ServiceCodes, AddressLine1, CityLocality, StateProvince, PostalCode, Latitude, Longitude, CarrierId, AddressLine2, AddressLine3, Radius, ShipmentWeightValue, ShipmentWeightUnit and ShipmentPackages support the following operator: =.
Note: To retrieve a single service point, specify CarrierCode, CountryCode, and ServicePointId. To list service points, CarrierId, ServiceCodes, and ShipmentPackages are required. For example, the following queries are processed server side:
SELECT * FROM ServicePoints WHERE CarrierCode = 'se-123456' AND CountryCode = 'US' AND ServicePointId = 'chronoclassic'
SELECT * FROM ServicePoints WHERE CarrierId = 'se-123456' AND ServiceCodes = 'chronoclassic' AND ShipmentPackages = '{"dimensions":{"unit":"inch","length":2,"width":2,"height":1}}'
SELECT * FROM ServicePoints WHERE CarrierId = 'se-123456' AND ServiceCodes = 'chronoclassic' AND ShipmentPackages = '{"dimensions":{"unit":"inch","length":2,"width":2,"height":1}}' AND CountryCode = 'US'
SELECT * FROM ServicePoints WHERE CarrierId = 'se-123456' AND ServiceCodes = 'chronoclassic' AND ShipmentPackages = '{"dimensions":{"unit":"inch","length":2,"width":2,"height":1}}' AND AddressLine1 = '123 Main St'
SELECT * FROM ServicePoints WHERE CarrierId = 'se-123456' AND ServiceCodes = 'chronoclassic' AND ShipmentPackages = '{"dimensions":{"unit":"inch","length":2,"width":2,"height":1}}' AND AddressLine2 = 'Suite 100'
SELECT * FROM ServicePoints WHERE CarrierId = 'se-123456' AND ServiceCodes = 'chronoclassic' AND ShipmentPackages = '{"dimensions":{"unit":"inch","length":2,"width":2,"height":1}}' AND AddressLine3 = 'Floor 2'
SELECT * FROM ServicePoints WHERE CarrierId = 'se-123456' AND ServiceCodes = 'chronoclassic' AND ShipmentPackages = '{"dimensions":{"unit":"inch","length":2,"width":2,"height":1}}' AND CityLocality = 'Austin'
SELECT * FROM ServicePoints WHERE CarrierId = 'se-123456' AND ServiceCodes = 'chronoclassic' AND ShipmentPackages = '{"dimensions":{"unit":"inch","length":2,"width":2,"height":1}}' AND StateProvince = 'TX'
SELECT * FROM ServicePoints WHERE CarrierId = 'se-123456' AND ServiceCodes = 'chronoclassic' AND ShipmentPackages = '{"dimensions":{"unit":"inch","length":2,"width":2,"height":1}}' AND PostalCode = '78701'
SELECT * FROM ServicePoints WHERE CarrierId = 'se-123456' AND ServiceCodes = 'chronoclassic' AND ShipmentPackages = '{"dimensions":{"unit":"inch","length":2,"width":2,"height":1}}' AND Latitude = '30.2672'
SELECT * FROM ServicePoints WHERE CarrierId = 'se-123456' AND ServiceCodes = 'chronoclassic' AND ShipmentPackages = '{"dimensions":{"unit":"inch","length":2,"width":2,"height":1}}' AND Longitude = '-97.7431'
SELECT * FROM ServicePoints WHERE CarrierId = 'se-123456' AND ServiceCodes = 'chronoclassic' AND ShipmentPackages = '{"dimensions":{"unit":"inch","length":2,"width":2,"height":1}}' AND Radius = '5000'
SELECT * FROM ServicePoints WHERE CarrierId = 'se-123456' AND ServiceCodes = 'chronoclassic' AND ShipmentPackages = '{"dimensions":{"unit":"inch","length":2,"width":2,"height":1}}' AND ShipmentWeightValue = '2.5'
SELECT * FROM ServicePoints WHERE CarrierId = 'se-123456' AND ServiceCodes = 'chronoclassic' AND ShipmentPackages = '{"dimensions":{"unit":"inch","length":2,"width":2,"height":1}}' AND ShipmentWeightUnit = 'pound'
Columns
| Name | Type | References | Description |
| ServicePointId [KEY] | String | A unique identifier for the service point. | |
| CarrierCode | String | A shipping carrier, such as fedex, dhl_express, stamps_com, etc. | |
| CountryCode | String | A two-letter ISO 3166-1 country code. | |
| ServiceCodes | String | The service codes available at this service point. | |
| CompanyName | String | The company name at the service point. | |
| AddressLine1 | String | The first line of the service point address. | |
| CityLocality | String | The city or locality of the service point. | |
| StateProvince | String | The state or province of the service point. | |
| PostalCode | String | The postal code of the service point. | |
| PhoneNumber | String | The phone number associated with the service point. | |
| Latitude | Double | The latitude of the service point. | |
| Longitude | Double | The longitude of the service point. | |
| HoursOfOperationMonday | String | Monday opening hours. | |
| HoursOfOperationTuesday | String | Tuesday opening hours. | |
| HoursOfOperationWednesday | String | Wednesday opening hours. | |
| HoursOfOperationThursday | String | Thursday opening hours. | |
| HoursOfOperationFriday | String | Friday opening hours. | |
| HoursOfOperationSaturday | String | Saturday opening hours. | |
| HoursOfOperationSunday | String | Sunday opening hours. | |
| Features | String | The features available at the service point, such as drop_off_point. | |
| Type | String | The type of service point, such as pudo. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| CarrierId | String | The carrier Id to search service points for. Required when listing service points. | |
| AddressLine2 | String | The second line of the address to search near. | |
| AddressLine3 | String | The third line of the address to search near. | |
| Radius | Integer | The search radius in meters. | |
| ShipmentWeightValue | Double | The total weight value of the shipment. | |
| ShipmentWeightUnit | String | The unit of the shipment weight, such as pound or ounce. | |
| ShipmentPackages | String | The package dimensions as a JSON object. |