Repository navigation
Service Points
| Endpoint | /service_partners |
| Formats | XML, JSON |
| Authentication required? | No, but strongly recommended |
| Sender ID required? | No, but strongly recommended |
These parameters tell us which carrier's service points to query. The carrier parameter is required. product and transport_agreement_id are recommended and will provide more accurate results in some cases.
- carrier
- product
- transport_agreement_id (requires authentication and sender)
Find service points close to this address. country and postcode are always required; the rest are recommended to provide more accurate results.
- country
- postcode
- city
- address
- name
Some carriers accept custom parameters. These are provided using the custom top-level parameter, and nested parameters are encoded using custom[sub1][sub2]=value.
In particular, some custom parameters are passed through to the carrier's API using custom[params]. These parameters will override any dynamically derived parameters, e.g. given address=123 Some street, the derived streetNumber API parameter "123" can be overridden using custom[params][streetNumber]=321 (assuming that the carrier's API uses that parameter).
- custom
- postnord/tollpost_globe
- params
- https://developer.postnord.com/apis/details?systemName=location-v5-servicepoints (see "Nearest Service Points > nearest/byaddress > Parameters")
- params
- bring/bring2
- params
- https://developer.bring.com/api/pickup-point/#get-pickup-points-by-address-get (see "Query parameters")
- params
- helthjem
- postnord/tollpost_globe
The API does not require authentication, but it is strongly recommended to both authenticate and provide a Sender ID for more functionality and accuracy.
GET https://api.cargonizer.no/service_partners.xml?carrier=bring2&product=bring2_parcel_pickup_point&country=NO&postcode=1337&address=Kadettangen 14
GET https://api.cargonizer.no/service_partners.xml?carrier=tollpost_globe&product=postnord_mypack_small&country=NO&postcode=1337&address=Kadettangen 14
Please note! This carrier requires Transport Agreement ID. Use of Transport Agreement ID requires Authentication.
Authentication required
Using transport_agreement_id requires authentication and a Sender ID.
GET /service_partners.json?transport_agreement_id=000&product=helthjem_hentepakke&country=NO&postcode=1337&address=Kadettangen 14
X-Cargonizer-Key: 1234567890
X-Cargonizer-Sender: 1234GET https://api.cargonizer.no/service_partners.xml?transport_agreement_id=123&country=NO&product=helthjem_hentepakke&carrier=helthjem&postcode=1337&address=Kadettangen 14
Authentication required
Using transport_agreement_id requires authentication and a Sender ID.
GET /service_partners.json?transport_agreement_id=000&product=bring2_parcel_pickup_point&country=NO&postcode=1337&address=Kadettangen 14
X-Cargonizer-Key: 1234567890
X-Cargonizer-Sender: 1234GET https://api.cargonizer.no/service_partners.xml?carrier=bring2&product=bring2_parcel_pickup_point&transport_agreement_id=000&country=NO&postcode=1337&address=Kadettangen 14
The carrier parameter can be omitted when transport_agreement_id is given, as the carrier can be derived from it.
GET https://api.cargonizer.no/service_partners.xml?transport_agreement_id=000&product=bring2_parcel_pickup_point&country=NO&postcode=1337&address=Kadettangen 14
GET https://api.cargonizer.no/service_partners.xml?transport_agreement_id=000&product=bring2_parcel_pickup_point&country=NO&postcode=1337&address=Kadettangen 14&custom[params][pickupPointType]=locker
GET https://api.cargonizer.no/service_partners.xml?transport_agreement_id=000&product=postnord_mypack&country=NO&postcode=1337&address=Kadettangen 14&custom[params][typeId]=2
GET https://api.cargonizer.no/service_partners.xml?carrier=helthjem&product=helthjem_mypack&country=NO&postcode=1337&address=Kadettangen 14&custom[params][transportSolutionId]=3&custom[params][shopId]=1234
You may send a POST request to the endpoint with a Content-Type: application/json header and the parameters encoded in a JSON body.
curl \
-XPOST \
-H'Content-Type: application/json' \
https://api.cargonizer.no/service_partners.json \
-d @- <<'EOF'
{
"carrier": "bring2",
"country": "NO",
"postcode": "1337",
"address": "Kadettangen 14",
"product": "bring2_parcel_pickup_point",
"transport_agreement_id": "15222",
"custom": {
"params": {
"pickupPointType": "manned"
}
}
}
EOF