GET Service/ServicePoint?ZoneId={ZoneId}&City={City}&State={State}&Zip={Zip}&PartialZip={PartialZip}&Country={Country}&ServiceType={ServiceType}
Retrieve service point definitions
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ZoneId |
Filter by unique identifier, usually the zip or postal code (optional) |
string |
None. |
| City |
Filter by city name (optional) |
string |
None. |
| State |
Filter by state or province code (optional) |
string |
None. |
| Zip |
Filter by zip or postal code (optional) |
string |
None. |
| PartialZip |
Filter by partial zip or postal code (optional) |
string |
None. |
| Country |
Filter by country code (optional) |
string |
None. |
| ServiceType |
Filter by service type code (optional, see Service/ServiceType) |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of ServicePoint| Name | Description | Type | Additional information |
|---|---|---|---|
| ZoneId |
Unique identifier, usually the zip or postal code |
string |
None. |
| City |
City name |
string |
None. |
| State |
State or province code |
string |
None. |
| Zip |
Zip or postal code |
string |
None. |
| BaseZip |
Zip or postal code used for rating |
string |
None. |
| Country |
Country code |
string |
None. |
| Terminal |
Terminal code (see /Service/Terminal) |
string |
None. |
| ServiceType |
Service type code (see /Service/ServiceType) |
string |
None. |
| ServiceDays |
Days of the week when this point is serviced |
string |
None. |
| CutoffTime |
Pickup requests must be received before this time in order to pickup on the same day |
string |
None. |
| ServiceTime |
Approximate service time |
string |
None. |
| HighCostCharge |
High cost charge for this service point, if applicable |
decimal number |
None. |
| HighCostMinimum |
Minimum high cost charge per pound for this service point, if applicable |
decimal number |
None. |
| HighCostPerLb |
High cost charge per pound for this service point, if applicable |
decimal number |
None. |
Response Formats
application/json, text/json
[
{
"ZoneId": "sample string 1",
"City": "sample string 2",
"State": "sample string 3",
"Zip": "sample string 4",
"BaseZip": "sample string 5",
"Country": "sample string 6",
"Terminal": "sample string 7",
"ServiceType": "sample string 9",
"ServiceDays": "sample string 10",
"CutoffTime": "sample string 11",
"ServiceTime": "sample string 12",
"HighCostCharge": 14.1,
"HighCostMinimum": 15.1,
"HighCostPerLb": 16.1
},
{
"ZoneId": "sample string 1",
"City": "sample string 2",
"State": "sample string 3",
"Zip": "sample string 4",
"BaseZip": "sample string 5",
"Country": "sample string 6",
"Terminal": "sample string 7",
"ServiceType": "sample string 9",
"ServiceDays": "sample string 10",
"CutoffTime": "sample string 11",
"ServiceTime": "sample string 12",
"HighCostCharge": 14.1,
"HighCostMinimum": 15.1,
"HighCostPerLb": 16.1
}
]
application/xml, text/xml
<ArrayOfServicePoint xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<ServicePoint>
<ZoneId>sample string 1</ZoneId>
<City>sample string 2</City>
<State>sample string 3</State>
<Zip>sample string 4</Zip>
<BaseZip>sample string 5</BaseZip>
<Country>sample string 6</Country>
<Terminal>sample string 7</Terminal>
<ServiceType>sample string 9</ServiceType>
<ServiceDays>sample string 10</ServiceDays>
<CutoffTime>sample string 11</CutoffTime>
<ServiceTime>sample string 12</ServiceTime>
<HighCostCharge>14.1</HighCostCharge>
<HighCostMinimum>15.1</HighCostMinimum>
<HighCostPerLb>16.1</HighCostPerLb>
</ServicePoint>
<ServicePoint>
<ZoneId>sample string 1</ZoneId>
<City>sample string 2</City>
<State>sample string 3</State>
<Zip>sample string 4</Zip>
<BaseZip>sample string 5</BaseZip>
<Country>sample string 6</Country>
<Terminal>sample string 7</Terminal>
<ServiceType>sample string 9</ServiceType>
<ServiceDays>sample string 10</ServiceDays>
<CutoffTime>sample string 11</CutoffTime>
<ServiceTime>sample string 12</ServiceTime>
<HighCostCharge>14.1</HighCostCharge>
<HighCostMinimum>15.1</HighCostMinimum>
<HighCostPerLb>16.1</HighCostPerLb>
</ServicePoint>
</ArrayOfServicePoint>