What the staff of a pickup point do at the counter: check parcels in, hand them over, give them back. Each call sees only the parcels of the signed-in point.
Get the signed-in counter
The person and the pickup point they work at.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get the signed-in counter › Responses
The person and their pickup point.
user_idfull_nameemailList the parcels of the point
Every parcel addressed to the point, newest first: expected, waiting at the counter, collected or returned.
query Parameters
statusexpected: addressed to the point. arrived: the driver left it at the point, which has not checked it in yet. held: checked in, waiting for the recipient. collected: handed over to the recipient. returned: given back to the carrier after the holding period.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
List the parcels of the point › Responses
The parcels.
Check a parcel in
The counter scanned or typed the tracking number of a parcel addressed to the point. The holding period starts when the parcel arrives, and the recipient is told it waits there. Checking a parcel in again changes nothing.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Check a parcel in › Request Body
tracking_numberTwo-letter carrier prefix, 8 digits and a check digit. Spaces and case are ignored.
Check a parcel in › Responses
The parcel, now held.
idtracking_numbercarrier_namerecipient_namestatusexpected: addressed to the point. arrived: the driver left it at the point, which has not checked it in yet. held: checked in, waiting for the recipient. collected: handed over to the recipient. returned: given back to the carrier after the holding period.
expected_at^(?:(?:\d\d[2468][04… · requiredarrived_at^(?:(?:\d\d[2468][04… · requiredchecked_in_at^(?:(?:\d\d[2468][04… · requiredhold_until^(?:(?:\d\d[2468][04… · requiredis_overdueHeld past the holding period: the counter may return it.
collected_at^(?:(?:\d\d[2468][04… · requiredreturned_at^(?:(?:\d\d[2468][04… · requiredcode_attempts_leftHow many more wrong recipient codes the counter may type before the handover locks. Five from the start.
handover_lockedToo many wrong codes were typed: the parcel cannot be handed over until its carrier issues a new code.
Hand a parcel over to its recipient
The recipient shows the six-digit code they received by text message. A wrong code answers a 422 whose details.codes_left tells how many more the counter may type; after five wrong codes the handover of the parcel is locked (handover_locked) and answers a 409 until its carrier issues a new code.
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Hand a parcel over to its recipient › Request Body
code^\d{6}$ · requiredThe six-digit code the recipient received by text message.
Hand a parcel over to its recipient › Responses
The parcel, now collected.
idtracking_numbercarrier_namerecipient_namestatusexpected: addressed to the point. arrived: the driver left it at the point, which has not checked it in yet. held: checked in, waiting for the recipient. collected: handed over to the recipient. returned: given back to the carrier after the holding period.
expected_at^(?:(?:\d\d[2468][04… · requiredarrived_at^(?:(?:\d\d[2468][04… · requiredchecked_in_at^(?:(?:\d\d[2468][04… · requiredhold_until^(?:(?:\d\d[2468][04… · requiredis_overdueHeld past the holding period: the counter may return it.
collected_at^(?:(?:\d\d[2468][04… · requiredreturned_at^(?:(?:\d\d[2468][04… · requiredcode_attempts_leftHow many more wrong recipient codes the counter may type before the handover locks. Five from the start.
handover_lockedToo many wrong codes were typed: the parcel cannot be handed over until its carrier issues a new code.
Give a parcel back to its carrier
Only once the holding period ran out without the recipient.
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Give a parcel back to its carrier › Responses
The parcel, now returned.
idtracking_numbercarrier_namerecipient_namestatusexpected: addressed to the point. arrived: the driver left it at the point, which has not checked it in yet. held: checked in, waiting for the recipient. collected: handed over to the recipient. returned: given back to the carrier after the holding period.
expected_at^(?:(?:\d\d[2468][04… · requiredarrived_at^(?:(?:\d\d[2468][04… · requiredchecked_in_at^(?:(?:\d\d[2468][04… · requiredhold_until^(?:(?:\d\d[2468][04… · requiredis_overdueHeld past the holding period: the counter may return it.
collected_at^(?:(?:\d\d[2468][04… · requiredreturned_at^(?:(?:\d\d[2468][04… · requiredcode_attempts_leftHow many more wrong recipient codes the counter may type before the handover locks. Five from the start.
handover_lockedToo many wrong codes were typed: the parcel cannot be handed over until its carrier issues a new code.