Carriers' PUDOs
General information
Certain carriers opt to deliver packets to their own network of pick-up points instead of directly to the recipient.
These pick-up points are distinct from our standard branches and their details can be accessed from a dedicated JSON feed.
Feed for Carriers' Pick-up points
The feed includes information on all currently open carriers' PUDOs. You can navigate to the feed using the following URL:
https://pickup-point.api.packeta.com/v5/__API_KEY__/carrier_point/json
Not updating your carriers' pick-up point data regularly can lead to issues during the packet creation or delivery process.
-
Recommended update of carriers' pick-up point data is once a day after 6:00.
Processing speed optimizationRequest feed at times 'in between', like 6:13 | 6:28 | 6:47, rather than on the hour.
Calling it more than once a day also isn't necessary, as the data is updated daily before 6:00.
Filters
Below you can see the available filters for carrier point feed.
| Name | Description |
|---|---|
| ids | Filter by carrier ID. |
| country | Filter by country. Two-letter ISO 639-1 format country code. No available for carrier list. |
HTTP Status codes
Table below outlines the possible HTTP responses for requests, along with their reasons and additional comments for clarification. More details about HTTP status codes can be found on Wikipedia.
| Code | Status | Description |
|---|---|---|
| 200 | OK | |
| 401 | Unauthorized | Incorrect credentials |
| 404 | Not found | |
| 409 | Conflict | The feed generation was executed from another request and its still running. Try request later. |
| 415 | Unsupported Media Type | Requested invalid format of feed |
Data specification
{
"carriers": [
{
"id": 123,
"name": "Carrier Name",
"points": [
{
"code": "ABC321",
"coordinates": {
"latitude": "52.00000",
"longitude": "18.00000"
},
"street": "Example street",
"streetNumber": "12",
"city": "Example city",
"zip": "11-111",
"country": "PL",
"payment": "Card only",
"displayFrontend": 1
}
]
}
]
}
carriers
Container element of the carriers.
{
"carriers": [
{
"id": 123,
"name": "Carrier Name",
"points": [...]
},
{
"id": 124,
"name": "Carrier Name 2",
"points": [...]
}
]
}
Carrier attributes
Contained once or many times by carriers.
Container element of the points.
{
"id": 123,
"name": "Carrier Name",
"points": [...]
}
| Name | Type | Description |
|---|---|---|
| id | Integer | ID of the carrier. |
| name | String | Name of the carrier. |
| points | Container | Container for point attributes elements. |
points
Contained exactly once by carrier attributes.
Container element of the points.
"points": [
{
*point attributes*
}
]
Point attributes
Contained many times by points.
Represents a carrier's pick up point.
{
"code": "ABC321",
"coordinates": {
"latitude": "52.00000",
"longitude": "18.00000"
},
"street": "Example street",
"streetNumber": "12",
"city": "Example city",
"zip": "11-111",
"country": "PL",
"payment": "Card only",
"displayFrontend": 1
}
| Name | Type | Description |
|---|---|---|
| code | String | Code of the carrier pick up point. |
| coordinates | Container | Coordinates element. See coordinates. |
| street | String | Street name. |
| streetNumber | String | House number. |
| city | String | City name. |
| zip | String | Zip code. |
| country | String | Country code. |
| payment | String | Payment options. See payments. |
| displayFrontend | Integer | Indicates whether the point is supposed to be shown to the end customer. If the value equals '0', the point is intended to be used only for your administrative purposes. |
coordinates
Contained exactly once by point attributes.
Contains latitude and longitude of the carrier pick up point.
"coordinates": {
"latitude": "52.00000",
"longitude": "18.00000"
}
| Name | Type | Description |
|---|---|---|
| latitude | Float | Latitude of the pick up point. |
| longitude | Float | Longitude of the pick up point. |
payments
Contained exactly once by point attributes.
Contains information about payment methods available at the relevant carrier pick up point.
Possible values:
| Value | Description |
|---|---|
| None available | No payment method available at the pick up point. |
| Cash only | Payment with cash available. |
| Card only | Payment with card available. |
| Card and cash | Payment with both cash and card available. |