PAparcellab
Place Info

Lookup places

Changed on

Lookup drop-off/pick-up locations for a courier, by location & distance.

post/v4/track/place-info/lookup/

Request

  • The document declares no server URL.
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Query parameters

accountinteger[]
orderingstring

Order results by any response field. Prefix with - for descending (e.g. -id).

Request body

accountinteger required

ID of account for this lookup

external_referencestring nullable
country_iso3string required

ISO 3166-1 alpha-3 code of country

Response

raw_place_typestring
distancenumber double nullable required

Distance to the place

courierstring required
country_iso3string required

ISO 3166-1 alpha-3 code of the country

place_type'default' | 'self_service' | 'partner_location' | 'store' | 'other'
  • default - Default (first party)
  • self_service - Self-Service / Locker
  • partner_location - Partner Location
  • store - Store
  • other - Other (e.g. hub)
namestring required

Name of this place

phone_numberstring
criteriastring[]

Search Criteria that this place matches

servicesServicesEnum[]

Services provided at this place

raw_servicesstring[]

Raw (carrier-provided) services provided at this place

has_detailsboolean

Whether this place info includes place details

is_in_serviceboolean

Whether this place is in service (open)

external_referencestring

External (3rd party) reference of this place, e.g. unique location ID

external_idstring uuid

parcelLab generated unique ID for this place

additional_infoobject

Additional information about this place

Changes