Punti di servizio

Trova i punti dove un destinatario può ritirare, o un mittente lasciare, un pacco.

GET/service-points

Search service points (PUDO)

In arrivo Il contratto è pubblicato prima dell'implementazione. Questa operazione non è ancora disponibile e la sua forma può ancora cambiare.

Finds pick-up and drop-off points for the PDB and InPost networks, by postal code, province, city, free text or distance from a point. Results with a radius are sorted by distance. Use a point's code as service_point_code in POST /shipments. One endpoint replaces the two legacy PUDO APIs; opening hours always use the slot-list shape. The legacy locale and full options are gone (use the key-locale header and pagination).

Autenticazione: la tua chiave API nell'header X-API-Key.

Parametri

  • Name
    carrier
    Type
    string
    obbligatorio
    Description

    Network.

    Valori ammessi: PDB, INPOST.

  • Name
    postal_code
    Type
    string
    Description

    Postal code. With radius_km it is the centre of the search, otherwise an exact filter.

  • Name
    province
    Type
    string
    Description

    Province code.

  • Name
    city
    Type
    string
    Description

    City (partial match).

  • Name
    search
    Type
    string
    Description

    Free text on code, name and address.

  • Name
    radius_km
    Type
    number
    Description

    Radius in km, default 10. Needs postal_code or latitude/longitude.

    ≥ 0.1.

  • Name
    latitude
    Type
    number
    Description

    Latitude of the centre.

  • Name
    longitude
    Type
    number
    Description

    Longitude of the centre.

  • Name
    type
    Type
    string
    Description

    Point type, UPPER_SNAKE: PDB FMP, APT, RTZ; InPost PARCEL_LOCKER and the other InPost types upper-cased.

  • Name
    status
    Type
    string
    Description

    InPost only. Default OPERATING.

  • Name
    location_type
    Type
    string
    Description

    InPost only: INDOOR or OUTDOOR.

    Valori ammessi: INDOOR, OUTDOOR.

  • Name
    page
    Type
    integer
    Description

    Page number.

    Predefinito: 1. ≥ 1.

  • Name
    per_page
    Type
    integer
    Description

    Items per page, up to 500 for this catalogue.

    Predefinito: 100. ≥ 1, ≤ 500.

Risposte

  • 200A page of service points.ServicePointList
  • 400Malformed or invalid request. Codes: VALIDATION_ERROR (with details.errors), INVALID_JSON, IDEMPOTENCY_KEY_REQUIRED, UNSUPPORTED_VERSION.Error
  • 401Missing, invalid or expired API key. Codes: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED.Error
  • 403Authenticated but not allowed. Codes: FEATURE_NOT_ENABLED (reserved feature not enabled for the customer), IP_NOT_ALLOWED (the key is restricted to other addresses), ACCOUNT_INACTIVE, CUSTOMER_OUT_OF_SCOPE.Error
  • 410Version retired. Code VERSION_RETIRED.Error
  • 429Daily or burst limit exceeded. Code DAILY_LIMIT_EXCEEDED or RATE_LIMIT_EXCEEDED. Wait Retry-After seconds.Error
  • 500Unexpected error. Code SERVER_ERROR; details.correlation_id repeats the correlation id.Error
  • 502The carrier or an internal dependency failed. Code UPSTREAM_ERROR. Safe to retry reads; retry writes with the same Idempotency-Key.Error

Richiesta

GET
/service-points
Caricamento...

Risposta 200

{
  "data": [
    {
      "code": "00000",
      "carrier": "PDB",
      "type": "RTZ",
      "name": "EXAMPLE POINT",
      "address": "VIA ESEMPIO 1",
      "building_number": null,
      "description": null,
      "city": "Roma",
      "postal_code": "00162",
      "province": "RM",
      "latitude": 45,
      "longitude": 9,
      "status": null,
      "location_type": null,
      "open_24h": null,
      "opening_hours": {
        "monday": [
          {
            "from": "08:30",
            "to": "13:00"
          },
          {
            "from": "15:30",
            "to": "19:30"
          }
        ],
        "tuesday": [
          {
            "from": "08:30",
            "to": "13:00"
          }
        ],
        "wednesday": [],
        "thursday": [],
        "friday": [],
        "saturday": [],
        "sunday": []
      },
      "distance_km": 0.42
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "per_page": 100
  }
}

Modelli

Oggetti usati dalle richieste e dalle risposte di questa pagina.

ParceLabsVersion

CorrelationId

KeyLocale

ServicePointList

ServicePoint

  • Name
    code
    Type
    string
    obbligatorio
    Alias italiano: code
    Description

    Code to put in recipient.service_point_code or sender.service_point_code.

  • Name
    carrier
    Type
    string
    obbligatorio
    Alias italiano: vettore
    Description

    Carrier network.

    Valori ammessi: PDB, INPOST.

  • Name
    type
    Type
    string
    obbligatorio
    Alias italiano: type
    Description

    Point type, UPPER_SNAKE. PDB: FMP, APT, RTZ. InPost: PARCEL_LOCKER and the other InPost types upper-cased. NOTE: the legacy docs give contradictory meanings for APT/RTZ; confirm with Claudio before publishing.

  • Name
    name
    Type
    string · nullable
    Alias italiano: name
    Description

    Point name (PDB).

  • Name
    address
    Type
    string
    obbligatorio
    Alias italiano: address
    Description

    Street (InPost: street only, number in building_number).

  • Name
    building_number
    Type
    string · nullable
    Alias italiano: building_number
    Description

    House number (InPost), may be snc.

  • Name
    description
    Type
    string · nullable
    Alias italiano: description
    Description

    Where the point is (InPost).

  • Name
    city
    Type
    string
    obbligatorio
    Alias italiano: city
    Description

    City.

  • Name
    postal_code
    Type
    string
    obbligatorio
    Alias italiano: postal_code
    Description

    Postal code.

  • Name
    province
    Type
    string
    Alias italiano: province
    Description

    Province.

  • Name
    latitude
    Type
    number
    Alias italiano: latitude
    Description

    Latitude.

  • Name
    longitude
    Type
    number
    Alias italiano: longitude
    Description

    Longitude.

  • Name
    status
    Type
    string · nullable
    Alias italiano: status
    Description

    InPost only, UPPER_SNAKE: points other than OPERATING cannot be used.

  • Name
    location_type
    Type
    string · nullable
    Alias italiano: location_type
    Description

    InPost only.

    Valori ammessi: INDOOR, OUTDOOR, null.

  • Name
    open_24h
    Type
    boolean · nullable
    Alias italiano: open_24h
    Description

    InPost only: open 24/7.

  • Name
    opening_hours
    Type
    object · nullable
    Alias italiano: opening_hours
    Description

    Opening hours.

  • Name
    distance_km
    Type
    number · nullable
    Alias italiano: distance_km
    Description

    Distance from the search point. Only for radius searches, which are sorted by distance.

PageMeta

Pagination metadata.

  • Name
    total
    Type
    integer
    obbligatorio
    Description

    Total number of items matching the filters.

  • Name
    page
    Type
    integer
    obbligatorio
    Description

    Current page, starting at 1.

  • Name
    per_page
    Type
    integer
    obbligatorio
    Description

    Items per page.

BadRequest

Unauthorized

Forbidden

Gone

TooManyRequests

ServerError

BadGateway

Was this page helpful?