Warehouse handling API

This Warehouse's orders, by tab.

SEARCH · ผู้สร้าง key ต้องมีสิทธิ์: ดูออเดอร์ที่รับดูแล (HANDLING_VIEW)

• tab — expected (to receive) | held (default) | awaiting-release | history.
• q — an order no. (contains), or exactly an owner's Member ID or a first-mile tracking no. (or a linked unmatched parcel's).
• page — from 0; size — default 100, at most 100.
• stalled=true — only the tab's Stalled rows: held too long in held; dispatched weeks ago or past a line-haul ETA in awaiting-release.

200 {tab, page, size, total, items: [InboxItem]}.

• 400 error.request.invalid — an unknown tab.

curl "https://api-sandbox.parcelradar.io/api/handling/inbox?tab=expected" \
  -H "Authorization: Bearer <WAREHOUSE_KEY_TOKEN>"

Find the orders this Warehouse expects or holds for a scanned or typed term.

SEARCH · ผู้สร้าง key ต้องมีสิทธิ์: รับพัสดุ (HANDLING_RECEIVE)

• {term} — a Member ID (RDT-XXXXXX), an order no. (RDOR…; a carton QR's :CODE suffix is ignored) or a first-mile tracking no.

200 {termKind (MEMBER_ID|ORDER_NO|TRACKING_NO|EMAIL), items: [InboxItem]}.

• 400 error.handling.termRequired.
• 404 error.handling.notExpected — one answer for anything else: no order, no customer data.
• 429 error.handling.rateLimited — the search limits (see Limits).

• Every search is logged, with the key, and counts against the search limits.

curl -X POST "https://api-sandbox.parcelradar.io/api/handling/search" \
  -H "Authorization: Bearer <WAREHOUSE_KEY_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"term":"<ORDER_NO>"}'

Receive an expected parcel into this Warehouse — as JSON, or as a form with photos.

RECEIVE · ผู้สร้าง key ต้องมีสิทธิ์: รับพัสดุ (HANDLING_RECEIVE)

• JSON {orderId, requestId, damagedNote?}.
• Or multipart/form-data with the fields orderId, requestId, damagedNote (≤ 1,000 characters: it arrived damaged) and up to 10 parts named photos (JPEG or PNG, ≤ 10 MB each; the whole request ≤ 105 MB).

200 LegResult — the leg is HELD; handedOverFrom names the Warehouse that held it before you, when there was one.

• 400 error.request.invalid — no orderId.
• 400 error.handling.photoRequired / error.handling.photoInvalid / error.handling.photoCount.
• 404 error.handling.notFound — not an order of yours.
• 404 error.handling.legNotFound — not waiting to be received here (a lost race included).
• 409 error.request.idConflict — the requestId was another handler's or user's.
• 403 error.handling.keyNotAllowed — an orderNo + code (a Counter claim) or an offlineRef (an offline receipt): people only.

• The FIRST receipt of an import order at a warehouse outside Thailand needs a photo: without one the answer is 400 error.handling.photoRequired and nothing is received.
• Photos are stored as the order's condition photos on your leg; the damaged note rides the receipt.

curl -X POST "https://api-sandbox.parcelradar.io/api/handling/receive" \
  -H "Authorization: Bearer <WAREHOUSE_KEY_TOKEN>" \
  -F orderId=<ORDER_ID> \
  -F requestId=rcv-<ORDER_ID>-1 \
  -F "damagedNote=Corner crushed" \
  -F photos=@front.jpg \
  -F photos=@label.jpg

An order's labels, as HTML ready to print.

LABEL · ผู้สร้าง key ต้องมีสิทธิ์: พิมพ์ฉลาก (HANDLING_LABEL)

• sheet — MARK (default) | HANDOVER | CARRIER.

200 {sheets: [{kind, html, widthMm, heightMm, copy, copies, preview, voided}], missing: [field…]} — never the customer's user id.

• 400 error.handling.sheetInvalid.
• 409 error.handling.noNextLeg — HANDOVER without a next warehouse.
• 404 error.handling.notFound.

curl "https://api-sandbox.parcelradar.io/api/handling/orders/<ORDER_ID>/label?sheet=MARK" \
  -H "Authorization: Bearer <WAREHOUSE_KEY_TOKEN>"

The order's legs and the events posted on them.

TRACKING · ผู้สร้าง key ต้องมีสิทธิ์: ดูออเดอร์ที่รับดูแล (HANDLING_VIEW)

200 {orderNo, status, legs: [Custody], events: [{key, legId, postedAt}]}.

The order's tracking timeline: checkpoints and their events.

TRACKING · ผู้สร้าง key ต้องมีสิทธิ์: ดูออเดอร์ที่รับดูแล (HANDLING_VIEW)

200 Timeline.

Add a checkpoint of your own, optionally with its first event.

TRACKING · ผู้สร้าง key ต้องมีสิทธิ์: จัดการการติดตามพัสดุ (HANDLING_TRACKING)

• {eventType, name, checkpointStatus?, publishStatus?, firstEvent?: {name, detail?, occurredAt, visible?}, requestId?}.

200 Timeline — a replayed requestId adds nothing.

Change one of your own checkpoints.

TRACKING · ผู้สร้าง key ต้องมีสิทธิ์: จัดการการติดตามพัสดุ (HANDLING_TRACKING)

• {name?, checkpointStatus?, publishStatus?}.

200 Timeline.

Remove one of your own checkpoints.

TRACKING · ผู้สร้าง key ต้องมีสิทธิ์: จัดการการติดตามพัสดุ (HANDLING_TRACKING)

200 Timeline.

Add an event — on your own checkpoint or on Parcel Radar's warehouse checkpoint.

TRACKING · ผู้สร้าง key ต้องมีสิทธิ์: จัดการการติดตามพัสดุ (HANDLING_TRACKING)

• {name, detail?, occurredAt, visible?}.

200 Timeline.

Change one of your own events.

TRACKING · ผู้สร้าง key ต้องมีสิทธิ์: จัดการการติดตามพัสดุ (HANDLING_TRACKING)

• {name?, detail?, occurredAt?, visible?}.

200 Timeline.

Remove one of your own events.

TRACKING · ผู้สร้าง key ต้องมีสิทธิ์: จัดการการติดตามพัสดุ (HANDLING_TRACKING)

200 Timeline.

Where a dispatch of your held leg may go.

HANDOVER · ผู้สร้าง key ต้องมีสิทธิ์: ส่งต่อพัสดุ (HANDLING_HANDOVER)

• orderId — required.

200 {items: [{tenantId, name, city, country, isDefault}]} — the default first; empty when the order cannot be dispatched now.

Dispatch your held leg to the next warehouse.

HANDOVER · ผู้สร้าง key ต้องมีสิทธิ์: ส่งต่อพัสดุ (HANDLING_HANDOVER)

• {requestId, nextTenantId?, reasonCode?, note?} — omit nextTenantId for the default; another listed Warehouse needs a NEXT_CHANGE reasonCode.

200 LegResult.

• 409 error.handling.legNotHeld / legDispatched / legOnHold / orderNotMoving / wrongDirection / nextNotEligible / nextAlreadyHandled / legInLineHaul / disposalPending.
• 400 error.handling.reasonCode / error.handling.nextRequired.

• A key cannot list the reason codes: the active NEXT_CHANGE codes are the ones your staff pick in the Member Portal — ask Parcel Radar for the list.

curl -X POST "https://api-sandbox.parcelradar.io/api/handling/orders/<ORDER_ID>/dispatch" \
  -H "Authorization: Bearer <WAREHOUSE_KEY_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"requestId":"dsp-<ORDER_ID>-1"}'

Undo your dispatch before the next warehouse receives the parcel.

HANDOVER · ผู้สร้าง key ต้องมีสิทธิ์: ส่งต่อพัสดุ (HANDLING_HANDOVER)

• {requestId, reason?}.

200 LegResult.

Release the parcel to a carrier.

HANDOVER · ผู้สร้าง key ต้องมีสิทธิ์: ส่งต่อพัสดุ (HANDLING_HANDOVER)

• {outcome: "CARRIER", carrierTrackingNo, requestId} — a key releases to a carrier only.

200 LegResult — RELEASED, outcome CARRIER; the carrier's number is then watched.

• 400 error.handling.outcomeRequired / error.handling.carrierNoRequired.
• 409 error.handling.carrierBeforeCapture — the order must be captured first (a person captures it on the web).
• 409 error.handling.legDispatched / error.handling.legInLineHaul.
• 403 error.handling.keyNotAllowed — any outcome but CARRIER.

curl -X POST "https://api-sandbox.parcelradar.io/api/handling/orders/<ORDER_ID>/release" \
  -H "Authorization: Bearer <WAREHOUSE_KEY_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"outcome":"CARRIER","carrierTrackingNo":"<CARRIER_TRACKING_NO>","requestId":"rel-<ORDER_ID>-1"}'

Your line-haul batches, newest first.

HANDOVER · ผู้สร้าง key ต้องมีสิทธิ์: ดูออเดอร์ที่รับดูแล (HANDLING_VIEW)

• direction — OUTGOING | INCOMING; state — OPEN | DISPATCHED | CLOSED.
• page — from 0; size — default 20, at most 100.

200 {page, size, total, items: [Batch]} — rows without items.

Open a line-haul batch to another Warehouse.

HANDOVER · ผู้สร้าง key ต้องมีสิทธิ์: ส่งต่อพัสดุ (HANDLING_HANDOVER)

• {lineHaulNo, mode (AIR|SEA|ROAD), departureDate, etaDate, destinationTenantId, requestId?} — lineHaulNo is 1–60 of A–Z a–z 0–9 space . / _ -.

201 Batch (OPEN).

• 400 error.handling.lineHaulNo / error.handling.lineHaulMode / error.handling.lineHaulDates — the number, the mode, or the dates (ETA before departure); 400 error.handling.nextRequired — no destination.
• 409 error.handling.sameHandler — the destination is this Warehouse; 409 error.handling.nextNotEligible — not a Warehouse a batch may go to.
• 409 error.request.idConflict — the requestId was another handler's or user's.

curl -X POST "https://api-sandbox.parcelradar.io/api/handling/line-haul-batches" \
  -H "Authorization: Bearer <WAREHOUSE_KEY_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"lineHaulNo":"TG621 AWB 217-12345675","mode":"AIR","departureDate":"2026-10-05","etaDate":"2026-10-06","destinationTenantId":"<WAREHOUSE_ID>","requestId":"lh-2026-10-05-1"}'

One batch with its orders.

HANDOVER · ผู้สร้าง key ต้องมีสิทธิ์: ดูออเดอร์ที่รับดูแล (HANDLING_VIEW)

200 Batch with items: [{orderId, orderNo, memberId, pieces, declaredWeightKg, state, addedAt, checkedOffAt, receivedAt}].

• 404 error.handling.lineHaulNotFound — not a batch of this Warehouse (as origin or destination).

Add orders to an open batch — all or none.

HANDOVER · ผู้สร้าง key ต้องมีสิทธิ์: ส่งต่อพัสดุ (HANDLING_HANDOVER)

• {orderIds: [..]} or {orderId}.

200 Batch — an order already in the batch is skipped, so a retry is safe.

• 409 error.handling.lineHaulRefused {refusals: [{orderId, orderNo, code}]} — e.g. batchDestination: the order's default next warehouse is not the batch's destination.
• 409 error.handling.lineHaulFull — more than 500 orders (after the refusals check).
• 409 error.handling.lineHaulNotOpen — the batch is no longer OPEN; 404 error.handling.lineHaulNotFound.

Take an order out of an open batch.

HANDOVER · ผู้สร้าง key ต้องมีสิทธิ์: ส่งต่อพัสดุ (HANDLING_HANDOVER)

200 Batch — an order no longer in the batch answers the batch as it is, so a retry is safe.

• 409 error.handling.lineHaulNotOpen — the batch is no longer OPEN; 404 error.handling.lineHaulNotFound.

Dispatch the batch — each order as by /orders/{orderId}/dispatch, all or none.

HANDOVER · ผู้สร้าง key ต้องมีสิทธิ์: ส่งต่อพัสดุ (HANDLING_HANDOVER)

• {}.

200 Batch (DISPATCHED); a batch already dispatched answers 200 as it is.

• 409 error.handling.lineHaulRefused — all or none, each refusal listed as for adding orders.
• 409 error.handling.lineHaulEmpty — no orders in the batch; 409 error.handling.lineHaulClosed — the batch is closed.
• 404 error.handling.lineHaulNotFound.

The destination's receipt of one order of an incoming batch.

HANDOVER · ผู้สร้าง key ต้องมีสิทธิ์: ส่งต่อพัสดุ (HANDLING_HANDOVER) + รับพัสดุ (HANDLING_RECEIVE)

• {orderId, requestId?, damagedNote?}.

200 Batch; an order already received answers 200 as it is.

• 403 error.permission.denied — the key's creator does not hold Receive parcels now; nothing is received.
• 404 error.handling.lineHaulNotFound — not an incoming batch of this Warehouse, or still OPEN.
• 404 error.handling.lineHaulItemNotFound — the order is not in the batch (or was recalled or reassigned).
• 409 error.handling.legNotFound — the order's next leg is not this Warehouse's any more.
• The receipt's own refusals — 400 error.handling.photoRequired on an import's first receipt abroad.

• A check-off is the order's receipt: the key needs the HANDOVER scope, and its creator must hold Receive parcels (HANDLING_RECEIVE) as well as Hand over — a key made by someone without Receive parcels cannot check off.
• An import's first receipt abroad cannot carry a photo here: receive it with /receive.

Close a batch.

HANDOVER · ผู้สร้าง key ต้องมีสิทธิ์: ส่งต่อพัสดุ (HANDLING_HANDOVER)

• {reason}.

200 Batch (CLOSED). An OPEN batch: the origin discards it. A DISPATCHED batch: the destination closes it, a reason required, and every order not received becomes MISSING.

• 400 error.handling.lineHaulCloseReason — a DISPATCHED batch closed without a reason.
• 409 error.handling.lineHaulCloseAtDestination — only the destination closes a DISPATCHED batch.
• 404 error.handling.lineHaulNotFound.