Packeta API

Documentation

Branch export version 5

Branches feed

The feed contains data about all the currently open branches. You can access the feed via following URLs:

https://pickup-point.api.packeta.com/v5/__API_KEY__/branch.json?lang=__LANGUAGE__

Only two-letter ISO 639-1 format is allowed for LANGUAGE parameter, e.g. cs, en, sk.

Boxes feed

The feed contains data about all the currently open boxes. You can access the feed via following URLs:

https://pickup-point.api.packeta.com/v5/__API_KEY__/box.json?lang=__LANGUAGE__

Only two-letter ISO 639-1 format is allowed for LANGUAGE parameter, e.g. cs, en, sk.

Carriers feed (Address delivery)

The above exports only include standard branches and boxes, since they are primarily used to generate a list of options for the end user to pick from. However, if you wish to use our services for address delivery, whether just in the Czech Republic or in other countries as well, you will need to download a list of address delivery options.

Address delivery option is represented by a branch entry and is also treated like one when creating a packet entry in our system. You just use its ID as you would with a standard branch.

You can access the feed via following URLs:

https://pickup-point.api.packeta.com/v5/__API_KEY__/carrier.json?lang=__LANGUAGE__

Changes

The version 5 introduces following changes compared to version 4:

The XML format has been removed and there is only one supported format JSON.
The feed branch.json contains only pickup points.
The boxes (example: Z-BOX) is available in the separated feed (box.json).
Added attribute type in list of boxes. Example content: zbox.
The carriers are available in separate feed (carrier.json).
Keypad detail added.

Export specification - branches, boxes and carriers

Branches

[
  {
    "id": "1",
    "name": "Prague 1, Teststreet 1",
    "special": "The branch is next to the big building on the right side.",
    "place": "Zásilkovna",
    "street": "Teststreet 1",
    "city": "Prague",
    "zip": "100 00",
    "country": "cz",
    "currency": "CZK",
    "status": {
      "statusId": "1",
      "description": "In operation"
    },
    "displayFrontend": "1",
    "directions": "You walk straight from the bus station, the left.",
    "directionsCar": "You drive on the main street, then right",
    "directionsPublic": "Subway A, or tram 1",
    "wheelchairAccessible":"no",
    "creditCardPayment":"yes",
    "dressingRoom":"0",
    "claimAssistant":"1",
    "packetConsignment":"1",
    "latitude":"50.00000",
    "longitude":"14.00000",
    "url":"https://www.zasilkovna.cz/pobocky/prague1",
    "maxWeight":"10",
    "labelRouting":"C37-B11-012",
    "labelName":"Prague 1, Teststreet 1",
    "photos":[
      {
        "thumbnail":"https://www.zasilkovna.cz/images/branch/thumb/img_1.jpg",
        "normal":"https://www.zasilkovna.cz/images/branch/normal/img_1.jpg"
      }
    ],
    "openingHours":{
      "regular":{
        "monday":"08:30-18:30",
        "tuesday":"08:30-18:30",
        "wednesday":"08:30-18:30",
        "thursday":"08:30-18:30",
        "friday":"08:30-18:30",
        "saturday":"08:30-14:00",
        "sunday":""
      },
      "exceptions": [
        {
          "date":"2023-01-30",
          "hours":"08:00-12:00, 12:45-16:30"
        },
        {
          "date":"2023-01-31",
          "hours":"08:00-12:00, 12:45-16:30"
        }
      ]
    }
  }
]

Boxes

[
  {
    "id": "1",
    "type": "zbox",
    "name": "Z-BOX Praha 9, Libeň, Českomoravská 2408",
    "special": "",
    "place": "Z-BOX",
    "street": "Českomoravská 2408",
    "city": "Praha",
    "zip": "190 00",
    "country": "cz",
    "currency": "CZK",
    "status": {
      "statusId": "1",
      "description": "In operation"
    },
    "codAllowed": "1",
    "displayFrontend": "0",
    "exportedUntil": "2023-01-30",
    "directions": "<p>Z-BOX je umístěn při vstupu do budovy Balabenka office z ulic Sokolovská a Na Rozcestí.</p>",
    "directionsCar": {},
    "directionsPublic": {},
    "wheelchairAccessible": "no",
    "creditCardPayment": "no",
    "dressingRoom": "0",
    "claimAssistant": "0",
    "packetConsignment": "0",
    "latitude": "50.10480",
    "longitude": "14.49168",
    "url": "https://www.zasilkovna.cz/pobocky/z-box-praha-9-liben-ceskomoravska-2408",
    "maxWeight": "15",
    "labelRouting": "C10-1TS-18579",
    "labelName": "Z-BOX Praha 9, Libeň, Českomoravská 2408",
    "hasKeypad": "0",
    "photos": [
      {
        "thumbnail":"https://www.zasilkovna.cz/images/branch/thumb/point_18579_4299c793b533.jpg",
        "normal":"https://www.zasilkovna.cz/images/branch/normal/point_18579_4299c793b533.jpg"
      }
    ],
    "openingHours": {
      "regular": {
        "monday": "00:00-23:59",
        "tuesday": "00:00-23:59",
        "wednesday": "00:00-23:59",
        "thursday": "00:00-23:59",
        "friday": "00:00-23:59",
        "saturday": "00:00-23:59",
        "sunday": "00:00-23:59"
      },
      "exceptions": [
        {
          "date": "2023-01-30",
          "hours": "08:00-12:00, 12:45-16:30"
        },
        {
          "date": "2023-01-31",
          "hours": "08:00-12:00, 12:45-16:30"
        }
      ]
    }
  }  
]

`Branch attributes`

Name	Mandatory	Type	Description
id	Yes	Integer	A unique id.
name	Yes	String	Branch name.
special	No	String	Special orientation feature of the location.
place	Yes	String	Name of the place hosting the branch i.e. Baker & Sons bakery.
street	Yes	String	Street name and number.
city	Yes	String	City.
zip	Yes	String	Zip code. Contains spaces based on standard country format.
country	Yes	String	Country code.
currency	Yes	String	Currency code accepted by the branch.
status	Yes	Object	Container for the status code and status message of the branch. See `status`.
displayFrontend	Yes	Integer	Indicates whether the branch is supposed to be shown to the end customer. If the value equals '0', the branch is intended to be used only for your administrative purposes.
exportedUntil	No	Date	If the branch is scheduled to close, the field contains date when the branch is last contained in the export. The format is YYYY-MM-DD.
enterableUntil	No	Date	If the branch is scheduled to close, the field contains last date when our system will accept packet data for this branch. The format is YYYY-MM-DD.
openUntil	No	Date	If the branch is scheduled to close, the field contains last date of the branch being open for pick up of delivered packets. The format is YYYY-MM-DD.
openSince	No	Date	If the branch is scheduled to open, the field contains the first date of the branch being open for pick up of delivered packets. The format is YYYY-MM-DD.
directions	No	String	HTML directions to the branch.
directionsCar	No	String	HTML directions to the branch when travelling by car.
directionsPublic	No	String	HTML directions to the branch when travelling via public transport.
wheelchairAccessible	Yes	String	Indicates whether the branch is wheelchair accessible.
creditCardPayment	Yes	String	Indicates whether the branch accepts credit card as payment option.
dressingRoom	Yes	Integer	Indicates whether the branch has a dressing room.
claimAssistant	Yes	Integer	Indicates whether the branch accepts Claim Assistant packets.
packetConsignment	Yes	Integer	Indicates whether the branch accepts packet consignment.
latitude	Yes	Decimal	Latitude.
longitude	Yes	Decimal	Longitude.
url	Yes	String	URL with branch information.
maxWeight	Yes	Integer	Maximal weight of the packet the branch is able to handle.
holidayStart	No	Date	The date of the start of the holiday. If the branch is contiuously closed for at least 7 days, the time is considered a holiday. This field is present at most 14 days before the start of the holiday.
holidayEnd	No	Date	The date of the end of the holiday.
labelRouting	No	String	Routing code of the branch. Used for custom labels.
labelName	No	String	Branch name for printing on custom labels.
photos	Yes	Object	Container for `photo` elements.
openingHours	Yes	Object	Container for opening hours information. See `openingHours` documentation.

`Box attributes`

The box has same attributes as branch, plus the following:

Name	Mandatory	Type	Description
type	Yes	String	Type of box. Current possible value: `zbox`
codAllowed	Yes	Integer	If 0 (zero) is marked, it is not possible to send a cash on delivery shipment to this box.
hasKeypad	Yes	Integer	If 1 is marked, `zbox` contains keypad. Valid only for Z-Boxes

`status`

Contained once by branches.

Contains a status code and a message. The language of the status message is determined by the lang GET parameter. If no lang parameter is supplied, default value en is used.

{
  "statusId": "1",
  "description": "In operation"
}

Name	Type	Description
statusId	Integer	Numeric code of branch status.
description	String	Text message of the branch status in chosen language.

Statuses

Status code	Description
1	In operation.
2	Temporarily closed due to holiday.
3	Temporarily does not receive packets due to exceeded capacity.
4	Temporarily does not receive packets due to technical reasons.
5	The branch has ended cooperation and no longer accepts new packets.

`photo`

Contained zero to many times by photos attribte.

{
  "thumbnail":"https://www.zasilkovna.cz/images/branch/thumb/img_1.jpg",
  "normal":"https://www.zasilkovna.cz/images/branch/normal/img_1.jpg"
}

Name	Type	Description
thumbnail	String	URL of a thumbnail image 160px*120px.
normal	String	URL of a image 720px*540px.

`openingHours`

Contained once by branch and box attribute.

{
  "regular": {
    "monday": "08:30-18:30",
    "tuesday": "08:30-18:30",
    "wednesday": "08:30-18:30",
    "thursday": "08:30-18:30",
    "friday": "08:30-18:30",
    "saturday": "08:30-14:00",
    "sunday": ""
  },
  "upcoming": {
    "monday": "08:30-18:30",
    "tuesday": "08:30-18:30",
    "wednesday": "08:30-18:30",
    "thursday": "08:30-18:30",
    "friday": "08:30-18:30",
    "saturday": "08:30-14:00",
    "sunday": "08:30-14:00",
    "startDate": "2016-08-23"
  },
  "exceptions": [
    {
      "date": "2023-01-30",
      "hours": "08:00-12:00, 12:45-16:30"
    },
    {
      "date": "2023-01-31",
      "hours": "08:00-12:00, 12:45-16:30"
    }
  ]
}

Name	Type	Description
regular	Object	Container for opening hours by day. See documentation for `regular` element.
upcoming	Object	Container for upcoming opening hours by day. See documentation for `upcoming` element.
exceptions	Object	Container for `exception` elements.

`regular`

Contained once by openingHours attribute.

Contains opening hours for each day in day-named elements. In the table below we only show monday since the same applies for other week days.

{
    "monday":"08:30-18:30",
    "tuesday":"08:30-18:30",
    "wednesday":"08:30-18:30",
    "thursday":"08:30-18:30",
    "friday":"08:30-18:30",
    "saturday":"08:30-14:00",
    "sunday":"08:30-14:00"
}

Name	Type	Description
monday	String	Range representation of opening hours for the day.

`upcoming`

Contained once by openingHours element.

Contains upcoming opening hours for each day in day-named elements along with an element indicating when the new opening hours start. In the table below we only show <monday> since the same applies for other week days.

{
    "monday": "08:30-18:30",
    "tuesday": "08:30-18:30",
    "wednesday": "08:30-18:30",
    "thursday": "08:30-18:30",
    "friday": "08:30-18:30",
    "saturday": "08:30-14:00",
    "sunday": "08:30-14:00",
    "startDate": "2016-08-23"
}

Name	Type	Description
monday	String	Range representation of opening hours for the day.
startDate	Date	The day on which the new opening hours come to effect.

`exceptions`

Contained once by openingHours attribute.

`exception`

Contained none or many times by exceptions attribute.

This object is optional and exceptions attribute can be empty.

{
  "exception": {
    "date": "2016-08-02",
    "hours": "10:00–13:30, 16:00–17:30"
  }
}

Name	Type	Description
date	Date	Date of the opening hours exception.
hours	String	Range representation of opening hours for the day. If omitted, the branch is closed on that day.

`Carriers`

[
  {
    "id":"1",
    "name":"AT Austrian Post HD",
    "available":"true",
    "pickupPoints":"false",
    "apiAllowed":"true",
    "separateHouseNumber":"false",
    "customsDeclarations":"false",
    "requiresEmail":"true",
    "requiresPhone":"true",
    "requiresSize":"false",
    "disallowsCod":"false",
    "country":"at",
    "currency":"EUR",
    "maxWeight":"30",
    "labelRouting":"C38-***-080",
    "labelName":"AT Austrian Post HD"
  }
]

`carrier`

Contained none or many times by carriers.

Represents a carrier.

Name	Mandatory	Type	Description
id	Yes	Integer	A unique id.
name	Yes	String	Carrier name.
available	Yes	Boolean	Indicates whether the carrier is available for delivery.
pickupPoints	Yes	Boolean	Indicates whether the carrier offers its own pickup points. Please refer to our carrier pick up points documentation for more information.
apiAllowed	Yes	Boolean	Indicates whether the carrier supports direct label printing, ie. whether the label is available via packetCourierLabelPdf(), packetCourierLabelPng() and packetsCourierLabelsPdf() methods.
separateHouseNumber	Yes	Boolean	Indicates whether the carrier requires a descriptive number to be entered in the houseNumber parameter.
customsDeclarations	Yes	Boolean	Indicates whether the carrier requires the completion of customs declarations in the CustomsDeclaration parameter - custom declarations documentation.
requiresEmail	Yes	Boolean	Indicates whether the carrier requires an email.
requiresPhone	Yes	Boolean	Indicates whether the carrier requires a phone number.
requiresSize	Yes	Boolean	Indicates whether the carrier requires size.
disallowsCod	Yes	Boolean	If true is marked, it is not possible to send a cash on delivery shipment through this carrier.
country	Yes	String	Country code.
currency	Yes	String	Currency code accepted by the carrier.
maxWeight	Yes	Integer	Maximal weight of the packet the carrier is able to handle.
labelRouting	No	String	Routing code of the carrier. Used for custom labels.
labelName	No	String	Carrier name for printing on custom labels.