harbordocs Get API keys

Orders

Every completed checkout becomes an order you can follow to delivery.

The order object

json
{
  "id": "ord_0n2k29185t5p1u04644a",
  "checkout_id": "chk_162g7258534z6g3e1o5k",
  "user_id": "usr_4n4363bk6m0x516172",
  "merchant_id": "allbirds",
  "merchant_order_ref": "1041",
  "status": "shipped",
  "total": { "amount": 14000, "currency": "USD" },
  "tracking": [{ "carrier": "UPS", "number": "1Z999…", "url": "https://…" }],
  "created_at": "2026-09-24T18:02:11.000Z",
  "updated_at": "2026-09-25T09:40:00.000Z"
}

merchant_order_ref is the store's own order number, the one in the user's confirmation email.

Statuses

Status Meaning
placed The store accepted the order.
shipped On its way. tracking is set.
delivered Arrived.
canceled Canceled by the store or the user.
returned Returned.

Each change sends an order.updated webhook with the whole order.

List and get

curl
# All orders for one user, newest first (up to 100)
curl https://www.useharbor.io/v1/orders \
  -H "Authorization: Bearer $HARBOR_KEY" \
  -H "Harbor-User-Token: $USER_TOKEN"

# One order
curl https://www.useharbor.io/v1/orders/ord_0n2k29185t5p1u04644a \
  -H "Authorization: Bearer $HARBOR_KEY" \
  -H "Harbor-User-Token: $USER_TOKEN"

In the sandbox

Move a sandbox order along with POST /v1/sandbox/orders/{id}/advance: placed → shipped (adds tracking) → delivered. Each step sends order.updated.