| Name | Description | Type | Additional information |
|---|---|---|---|
| WS_Key |
(Required) Webservice Key provided by 2ship support |
string |
None. |
| AddressPoint |
(Required) From this address are calculated the distances to the returning lockers |
WS_Repository.Models.Requests.Lockers.AddressPoint |
None. |
| GetLockers |
(Required) Flag - specify to include lockers |
boolean |
None. |
| GetCarrierLocations |
(Required) Flag - specify to include Carrier Locations |
boolean |
None. |
| GetRetailLocations |
(Required) Flag - specify to include Retail Locations |
boolean |
None. |
| LocationsType |
(Required) Specify the type of the returning Lockers/Locations |
WS_Repository.Models.Requests.Lockers.LocationsType |
None. |
| MaxDistanceToLockerInKM |
(Optional) Specify the max distance to lockers/location in KM - default value is 10 - max value is 100 |
decimal number |
None. |
| MaxNumberOfPlacesReturned |
(Optional) Spcify the max number of places returned - default value is 20 - max value is 100 |
integer |
None. |
| CarrierId |
(Optional) if is not 0 then it only return locations/lockers for that paticular carrier |
integer |
None. |