The only option for integration into the system is after business negotiations and agreement on the parameters of the contract. You can contact our business via e-mail jakub.schwarz@oxpoint.cz. Then, you will be redirected to the communication with the technical team, which will set up the necessary data in the system according to the agreed contract and provide you with access. Development and testing take place compared to the staging environment, to which the technical team of the OX Point will send you access.

parcel = package; in some cases, you may encounter parcel and package terms that are interchangeable in our system. The preferred variant is the unification of terminology on parcels.

Most of the endpoints are secured by access token mechanism. Access token can be obtained via Authentication API. Credentials for authentication API are distributed individually according to discussion with technical team. Access token is authentication with limited time to live. Information about expiration period is returned in authentication endpoint response. After expiration access token is no longer valid and new access token needs to be requested.

Some API endpoints are protected with ETag validation against concurrent calls. Selected modification endpoints require HTTP Header “If-Match”. The value needs to exactly equal to latest version of ETag of related entity. ETag is value can be obtained via HTTP header by both read and write operations. Write operation returns ETag value of entity after successful applying the requested modifications. ETag value after successful modification can then be used for next modification call. In order to get latest possible ETag value read operation can be used and ETag value of latest version of entity is returned together with the entity content.

Callback is a notification from OXNet system to defined HTTP endpoint. Notifications are triggered on different type of events or are scheduled. Check specific notification type below to get more details about behavior. Each notification is sent via HTTPS as POST, it also contains a time stamp and a shared key signature. Timeout for individual call is 5 seconds. Retry mechanism is applied and takes at minimum 1 hours. Undelivered notifications are kept for several days in Dead Letter Queue for manual resending in case of solving technical issues with technical team. Callbacks are protected by API key signatures. Callbacks are also called webhooks in OXnet system. See webhook API definition.

According to contract type of registered party some endpoint restricts the view on reservation capacity entities (point and boxes) in OXNet system. Selected endpoints contains "allowForeign" or "boxVisibility" parameter to influence the view. Some contract types restrict the usage, the other can take advantage to use it in order to to prefer certain type of points and boxes.

• ACCEPTED (parcel successfully created via REST API)
• STORING (parcel is in the process of storing into box by courier)
• STORED (parcel successfully stored by courier)
• COMPLETED (parcel successfully picked up by the recipient)
• DISPLACED (parcel picked up by the courier instead of recipient)
• CANCELLED (parcel cancelled from state ACCEPTED by external party via REST API or internally after long-time expired reservations)

• Storing successfully created parcel by QR code or after courier login
• Courier can change the storage box if it is not suitable for parcel storing
• Courier can add more boxes for storing parcel items, usually in case of having multiple items which cannot all fit to reserved boxes
• Picking up stored parcel by recipient via PIN code
• Picking up expired parcels by courier of carrier entity