Ask the carrier to pick up parcels at a shipper, put the request on a tour and read its outcome.
List pickup requests
Newest first, cursor paginated. A shipper only sees its own. Allowed to shippers for their own account, carrier admins and dispatchers.
query Parameters
limitMaximum number of items in the page.
cursorThe next_cursor of the previous page, passed back as is. Omit it to get the first page.
day^(?:(?:\d\d[2468][04…A Noumea day.
statusComma-separated statuses to keep.
shipper_account_id^([0-9a-fA-F]{8}-[0-…Keep the requests of this shipper account.
qHeld anywhere in the account name, the commune or the tour code, ignoring case.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
List pickup requests › Responses
One page of pickup requests.
next_cursorPass it as cursor to get the next page. null on the last page.
Request a pickup
Asks the carrier to collect parcels at the pickup address of the account, or at address. The slot must come after the pickup cutoff of the zone: pickup_too_early names the earliest one. Allowed to shippers for their own account, carrier admins and dispatchers.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Request a pickup › Request Body
day^(?:(?:\d\d[2468][04… · requiredA Noumea day.
slotWhen the driver comes by, Noumea time: 08-10 is from 8 to 10 am.
parcel_countHow many parcels the driver takes.
shipper_account_id^([0-9a-fA-F]{8}-[0-…The account to collect from. Required for carrier staff, ignored for a shipper.
shipment_idsThe shipments to collect. Leave it empty to collect every shipment of the account still at the sender when dispatch schedules the pickup.
notesWhere to collect, when it is not the pickup address of the shipper account.
Request a pickup › Responses
The pickup request.
idday^(?:(?:\d\d[2468][04… · requiredA Noumea day.
slotWhen the driver comes by, Noumea time: 08-10 is from 8 to 10 am.
statusrequested: waiting for dispatch. scheduled: on a tour as a pickup stop. picked_up: the driver took the parcels. missed: the driver came by and took none. cancelled: withdrawn before it was scheduled.
address_linescommunezoneparcel_countshipment_idsThe shipments the pickup collects; filled in when dispatch schedules it.
notesThe tour the pickup is a stop of, once scheduled.
missed_reasonWhat the driver reported, when the pickup is missed.
scheduled_at^(?:(?:\d\d[2468][04… · requiredsettled_at^(?:(?:\d\d[2468][04… · requiredWhen the parcels were picked up, or the pickup was missed or cancelled.
created_at^(?:(?:\d\d[2468][04… · requiredGet the earliest pickup slot
The earliest day and slot a driver can come to the pickup address of the account, after the pickup cutoff of its zone. Allowed to shippers for their own account, carrier admins and dispatchers.
query Parameters
shipper_account_id^([0-9a-fA-F]{8}-[0-…The account to collect from. Required for carrier staff, ignored for a shipper.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get the earliest pickup slot › Responses
The earliest slot and the cutoff it comes from.
zoneearliest_day^(?:(?:\d\d[2468][04… · requiredA Noumea day.
earliest_slotWhen the driver comes by, Noumea time: 08-10 is from 8 to 10 am.
cutoffNoumea time after which the day is too late; null when the zone has none.
cutoff_previous_dayThe cutoff applies the day before the pickup instead of the same day.
Get a pickup request
With its tour once scheduled, and its outcome once the driver came by. Allowed to shippers for their own account, carrier admins and dispatchers.
path Parameters
idThe pickup request id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get a pickup request › Responses
The pickup request.
idday^(?:(?:\d\d[2468][04… · requiredA Noumea day.
slotWhen the driver comes by, Noumea time: 08-10 is from 8 to 10 am.
statusrequested: waiting for dispatch. scheduled: on a tour as a pickup stop. picked_up: the driver took the parcels. missed: the driver came by and took none. cancelled: withdrawn before it was scheduled.
address_linescommunezoneparcel_countshipment_idsThe shipments the pickup collects; filled in when dispatch schedules it.
notesThe tour the pickup is a stop of, once scheduled.
missed_reasonWhat the driver reported, when the pickup is missed.
scheduled_at^(?:(?:\d\d[2468][04… · requiredsettled_at^(?:(?:\d\d[2468][04… · requiredWhen the parcels were picked up, or the pickup was missed or cancelled.
created_at^(?:(?:\d\d[2468][04… · requiredCancel a pickup request
Withdraws a request that is not on a tour yet; cancelling it again changes nothing. Once scheduled, ask dispatch instead. Allowed to shippers for their own account, carrier admins and dispatchers.
path Parameters
idThe pickup request id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Cancel a pickup request › Responses
The cancelled pickup request.
idday^(?:(?:\d\d[2468][04… · requiredA Noumea day.
slotWhen the driver comes by, Noumea time: 08-10 is from 8 to 10 am.
statusrequested: waiting for dispatch. scheduled: on a tour as a pickup stop. picked_up: the driver took the parcels. missed: the driver came by and took none. cancelled: withdrawn before it was scheduled.
address_linescommunezoneparcel_countshipment_idsThe shipments the pickup collects; filled in when dispatch schedules it.
notesThe tour the pickup is a stop of, once scheduled.
missed_reasonWhat the driver reported, when the pickup is missed.
scheduled_at^(?:(?:\d\d[2468][04… · requiredsettled_at^(?:(?:\d\d[2468][04… · requiredWhen the parcels were picked up, or the pickup was missed or cancelled.
created_at^(?:(?:\d\d[2468][04… · requiredSchedule a pickup on a tour
Adds a pickup stop to a tour of the pickup day for each shipment the request collects: the ones it names, or else every shipment of the account still at the sender. The request becomes picked_up or missed from the events the driver records on those stops. Scheduling it again on the same tour changes nothing. Allowed to carrier admins and dispatchers.
path Parameters
idThe pickup request id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Schedule a pickup on a tour › Request Body
tour_id^([0-9a-fA-F]{8}-[0-… · requiredA tour of the pickup day that is not completed.
Schedule a pickup on a tour › Responses
The scheduled pickup request.
idday^(?:(?:\d\d[2468][04… · requiredA Noumea day.
slotWhen the driver comes by, Noumea time: 08-10 is from 8 to 10 am.
statusrequested: waiting for dispatch. scheduled: on a tour as a pickup stop. picked_up: the driver took the parcels. missed: the driver came by and took none. cancelled: withdrawn before it was scheduled.
address_linescommunezoneparcel_countshipment_idsThe shipments the pickup collects; filled in when dispatch schedules it.
notesThe tour the pickup is a stop of, once scheduled.
missed_reasonWhat the driver reported, when the pickup is missed.
scheduled_at^(?:(?:\d\d[2468][04… · requiredsettled_at^(?:(?:\d\d[2468][04… · requiredWhen the parcels were picked up, or the pickup was missed or cancelled.
created_at^(?:(?:\d\d[2468][04… · required