6.Get Fixed Locations Request (GET Method)


Info
  • Web service URL: BASE_URL/api/Location/FixedLocations
  • Web service URL: BASE_URL/api/Location/FixedLocationsWithErrors


 * only difference between webservices is endpoint name and response model ( FixedLocationsWithErrors contains errors object)


Parameter
Description
Courier
courierId or name from Couriers table
LocalityName
provide all three elements (LocalityName, CountyName, CountryCode) or none
CountyName
provide all three elements (LocalityName, CountyName, CountryCode) or none
CountryCode
provide all three elements (LocalityName, CountyName, CountryCode) or none
FixedLocationType
can be Locker(1) or PickupPoint(2)
ShowInactive
true or false (if not sent default value is FALSE)
RestrictionParcelsCount
restriction of parcels count
RestrictionSizeHeight
restriction of parcel size - height
RestrictionSizeWidth
restriction of parcel size - width
RestrictionSizeLength
restriction of parcel size - Length
ExternalLocationId
LocationId which is configured in Locations in Innoship portal
Latitude
Latitude - used together with Radius
Longitude
Longitude - used together with Radius
Radius
Radius - cannot be higher than 20 km (Lat & Long needs to be provided)

6.1 Get Fixed Locations Response

[
{
    "id": 78152,
    "fixedLocationId": "78152",
    "name": "easybox Express Caffe Plantelor",
    "fixedLocationTypeId": 1,
    "serviceId": 3,
    "courierId": 6,
    "localityId": 7903,
    "localityName": "Iasi",
    "localityNameLocalized": null,
    "countyCode": "IS",
    "countyName": "Iasi",
    "countyNameLocalized": null,
    "countryCode": "RO",
    "addressText": "Str. Plantelor, Nr. 48",
    "postalCode": "700680",
    "lat": 47.135987,
    "long": 27.583339,
    "distance": 1.419110775957534,
    "isActive": true,
    "email": null,
    "phone": null,
    "supportedPaymentType": "Card",
    "allowsDropOff": true,
    "schedule": [
        {
            "day": 1,
            "openingHour": "00:00",
            "closingHour": "23:59"
        },
        {
            "day": 2,
            "openingHour": "00:00",
            "closingHour": "23:59"
        },
        {
            "day": 3,
            "openingHour": "00:00",
            "closingHour": "23:59"
        },
        {
            "day": 4,
            "openingHour": "00:00",
            "closingHour": "23:59"
        },
        {
            "day": 5,
            "openingHour": "00:00",
            "closingHour": "23:59"
        },
        {
            "day": 6,
            "openingHour": "00:00",
            "closingHour": "23:59"
        },
        {
            "day": 7,
            "openingHour": "00:00",
            "closingHour": "23:59"
        }
    ],
    "restrictions": null,
    "brandId": "Sameday"
},
    {
        "id": 62161,
        "fixedLocationId": "62161",
        "name": "easybox Platoul Insorit",
        "fixedLocationTypeId": 1,
        "serviceId": 3,
        "courierId": 6,
        "localityId": 7903,
        "localityName": "Iasi",
        "localityNameLocalized": null,
        "countyCode": "IS",
        "countyName": "Iasi",
        "countyNameLocalized": null,
        "countryCode": "RO",
        "addressText": "Str. Podisului, Nr 14",
        "postalCode": "700620",
        "lat": 47.149459,
        "long": 27.556013,
        "distance": 1.8328655195884203,
        "isActive": true,
        "email": null,
        "phone": null,
        "supportedPaymentType": "Card",
        "allowsDropOff": true,
        "schedule": [
            {
                "day": 1,
                "openingHour": "00:00",
                "closingHour": "23:59"
            },
            {
                "day": 2,
                "openingHour": "00:00",
                "closingHour": "23:59"
            },
            {
                "day": 3,
                "openingHour": "00:00",
                "closingHour": "23:59"
            },
            {
                "day": 4,
                "openingHour": "00:00",
                "closingHour": "23:59"
            },
            {
                "day": 5,
                "openingHour": "00:00",
                "closingHour": "23:59"
            },
            {
                "day": 6,
                "openingHour": "00:00",
                "closingHour": "23:59"
            },
            {
                "day": 7,
                "openingHour": "00:00",
                "closingHour": "23:59"
            }
        ],
        "restrictions": null,
        "brandId": "Sameday"
    },
]

---------------------------------------------------------------------------
// same list from /api/location/fixedLocations endpoint
{
    "value": [  
        {
           // ... fixed location info ...
        },
        {
           // ... fixed location info ...
        },
        
    ],
    "correlationId": "434e3d93-394d-4923-8e64-1c73fdf9c374",
    "isSuccess": false,
    "errors": [
        "GLS_DE => GLS_DE doesn't have a method to get filtered fixed locations (PickupPoint).",
        "Hermes => Courier response is empty."
    ]
}


6.1 Get information about a specific fixed location (GET Method)

Info
  • Web service URL: BASE_URL/api/Location/FixedLocation/{id}


Parameter
Description
idinnoship fixed location id