Shipments

Search pickup points

Find pickup points for a shipping method and destination address or coordinates. Use the chosen point's ID when creating a shipment.

post/api/external/v1/pickup-points/search

Request

  • Base URL: http://localhost
  • URL: http://localhost/api/external/v1/pickup-points/search
  • Auth: HTTP bearer

Request body

shipping_method_idstring required

Shipping method (sm_…) or checkout shipping-option (so_…) ID.

countrystring required

Two-letter country code.

postal_codestring
citystring
address1string
latitudenumber

Destination latitude in degrees. Supply with longitude.

longitudenumber

Destination longitude in degrees. Supply with latitude.

limitinteger

Maximum number of pickup points (1–50).

Example request

{
  "shipping_method_id": "sm_a1b2c3",
  "country": "SE",
  "postal_code": "11151",
  "city": "Stockholm",
  "address1": "Drottninggatan 1",
  "latitude": 59.33258,
  "longitude": 18.0649,
  "limit": 5
}

Response

Example response

{
  "data": [
    {
      "id": "sp_xyz789",
      "name": "PostNord Ombud City",
      "carrier": {
        "id": "postnord",
        "name": "PostNord"
      },
      "type": "service_point",
      "vendor_identifier": "12345",
      "address": {
        "address1": "Drottninggatan 10",
        "postal_code": "11151",
        "city": "Stockholm",
        "country": "SE"
      },
      "coordinates": {
        "latitude": 59.333,
        "longitude": 18.065
      },
      "distance_meters": 180,
      "opening_hours": null
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.