Get Order
Retrieve details for a single order.
Endpoint
GET /v1/order/get/{order_id}
Request
Header Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
Authorization | string | Yes | Bearer YOUR_ACCESS_TOKEN | Bearer access token used for authentication. |
Content-Type | string | Yes | application/json | Request body content type. |
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
order_id | string | Yes | Order ID (numeric string). |
Example request
curl -X GET "${API_URL}/v1/order/get/9206141" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Content-Type: application/json"
Responses
200 Success
200 Success
Response schema:
application/jsondatajson-stringOrder details.
data
json-string
Order details.
order_id
string
Unique order identifier.
Example:
3550875ship_type
string
Shipping type.
Example:
localstatusstringCurrent order status code.Example: READY_TO_SHIP
status
string
Current order status code.
Example:
READY_TO_SHIPOrder status codes:
| Status Code | Description |
|---|---|
DRAFT | Draft order (not submitted) |
PENDING_CONFIRM | Order awaiting confirmation/payment |
READY_TO_SHIP | Order confirmed and ready for pickup |
PENDING_PICKUP | Waiting for courier pickup |
PICKUP_COMPLETED | Picked up by courier |
IN_TRANSIT | Package in transit |
DELIVERED | Package delivered |
COMPLETED | Order completed |
CANCELLED | Order cancelled |
PROCESSING | Order being processed. Example: generating/printing shipping label. |
PENDING_PROCESSING | Order requires manual handling by Fuuffy IT staff. Contact Fuuffy IT for follow-up. |
quote_price
string
Quoted shipping price.
Example:
28.50confirm_shipment
string
Whether order is confirmed (
Y or N).Example:
Ytracking_number
string
Tracking number when assigned.
Example:
SF7444700508450client_remarks
string
Client reference or remarks.
senderjson-stringSender information.
sender
json-string
Sender information.
name
string
Contact name.
Example:
Fuuffy Chaimobile
string
Phone number (without country code).
mobile_prefix
string
Country code.
Example:
852email
string
Email address.
address
string
Full formatted address.
recipientjson-stringRecipient information.
recipient
json-string
Recipient information.
name
string
Contact name.
mobile
string
Phone number (without country code).
mobile_prefix
string
Country code.
email
string
Email address.
address
string
Full formatted address.
shipment_detailjson-stringShipment and parcel details.
shipment_detail
json-string
Shipment and parcel details.
package_type
string
Type of package.
Example:
parcel, documentconsignment_declaration
string
Contents declaration.
parcel_listjson-stringArray of parcels in this shipment.
parcel_list
json-string
Array of parcels in this shipment.
act_weight
string
Actual (gross) weight of this parcel, in kg.
Example:
"0.5"length
string
Length in cm.
Example:
"23"width
string
Width in cm.
Example:
"14"height
string
Height in cm.
Example:
"10"insurance_fee
string
Insurance fee.
Example:
"0"parcel_itemsjson-stringArray of items in this parcel.
parcel_items
json-string
Array of items in this parcel.
name
string
Item name.
Example:
Toyqty
string
Quantity.
Example:
"1"single_value
string
Single item value in HKD.
Example:
"200.00"total_act_weight
string
Total actual (gross) weight of all parcels, in kg.
Example:
0.5total_vol_weight
string
Total volumetric weight of all parcels, in kg. Also called dimensional weight, based on parcel size (L × W × H).
Example:
1total_count_weight
string
Total chargeable weight of all parcels, in kg. For each parcel, chargeable weight is the greater of actual weight and volumetric weight. This is the weight used to quote shipping.
Example:
1final_count_weight
string
Final billed weight confirmed by the courier, in kg. Empty until the courier issues an invoice.
Example:
1shipping_provider
string
Shipping provider code.
Example:
sf_expresshk_localcreate_time
string
Order creation timestamp (ISO 8601).
Example:
2025-12-09T17:01:30+08:00final_count_weight
string
Final billed weight confirmed by the courier, in kg. Empty until the courier issues an invoice. Same value as
shipment_detail.final_count_weight, exposed at the top level for convenience.Example:
1fee_summary
keystringMachine-readable fee item key.Example: cost_price, remote_surcharge_fee, total_price
key
string
Machine-readable fee item key.
Example:
cost_price, remote_surcharge_fee, total_price| Key | Label | Description |
|---|---|---|
cost_price | Shipping Fee | Base freight. |
label_fee | Label Fee | Label-print fee. |
balance_discount | Prepaid Balance Discount | Prepaid-balance discount. |
international_processing_fee | International Processing Fee | International handling surcharge. |
resource_allocation_fee | Resource Allocation Fee | Resource-allocation surcharge |
insurance_fee | Parcel Protection Fee or Full Protection Fee | Optional cargo insurance. |
signature_fee | Sigautre Fee | Signature-on-delivery fee. |
remote_surcharge_fee | Remote Surcharge | Remote-area surcharge. |
ddp_payment_fee | DDP Fee | Duties and taxes prepaid by the sender. |
declaration_handling_fee | Declaration Handling Fee | Customs declaration handling fee. |
ioss_code | IOSS Fee (VOEC Fee for Norway) | IOSS fee (VOEC for Norway). Low-value goods into the EU or Norway. |
cod_fee | COD Fee | Cash-on-delivery (COD) fee. |
delivery_proof_fee | Proof of Delivery Fee | Proof of delivery (POD) fee. |
oversize_surcharge_fee | Oversize surcharge | Oversize surcharge. |
ttl_extra_charge | Extra Large Surcharge | Overlength / overweight surcharge. |
ups_surcharge | UPS Paper Invoice Fee | UPS paper customs invoice fee. |
discount_price | Discount | Coupon or promo discount. |
points_discount | Fuuffy Dollar Discount | Fuuffy Dollar credit. |
extra_payment_fee | Extra Payment | Confirmed extra payment / price-difference charges recorded against this order after it was placed. |
return_fee | Return Fee | Return shipping fee charged for this order. |
duty_tax_add_on_fee | Add-On Duty and Tax | Additional duty/tax collected for this order. |
additional_charge_fee | Additional Charge | Other special additional charge for this order. |
charge_diff_fee | Shipping Fee Charge Diff | Shipping fee price-difference charge recorded against this order after it was placed. |
address_correct_fee | Address Correct Fee | Fee for correcting an incorrect delivery address after the order was placed. |
physical_invoice_fee | Physical Invoice Fee | Physical customs invoice fee charged after the order was placed. |
duty_tax_transfer_confirm_fee | Duty/Tax Trans Handling Fee | Duty/tax transfer handling fee charged after the order was placed. |
duty_tax_fee | Duty and Tax | Duty and tax paid on behalf of the customer for this order. |
remote_surcharge_final_fee | Remote Surcharge Fee | Remote-area surcharge confirmed/adjusted after audit, charged against this order. |
total_price | Total Fee | Grand total after all charges, discounts, and any extra payment items above. |
value
string
Amount for this fee item.
label
json-string
Bilingual label for this fee item.
Example:
{"en":"Shipping Fee","tc":"運費"}message
string
Status message.
Response sample
{
"data": {
"order_id": "3550875",
"ship_type": "local",
"status": "READY_TO_SHIP",
"quote_price": "28.50",
"confirm_shipment": "Y",
"tracking_number": "SF7444700508450",
"client_remarks": "#5493979",
"sender": {
"name": "Fuuffy Chai",
"mobile": "64105317",
"mobile_prefix": "852",
"email": "cs@fuufy.com",
"address": "HONG KONG"
},
"recipient": {
"name": "小編姐姐",
"mobile": "64105317",
"mobile_prefix": "852",
"email": "cs@fuuffy.com",
"address": "HONG KONG"
},
"shipment_detail": {
"package_type": "parcel",
"consignment_declaration": "Toys",
"parcel_list": [
{
"act_weight": "0.5",
"height": "10",
"width": "14",
"length": "23",
"parcel_items": [
{ "name": "Toy", "qty": "1", "single_value": "200" }
],
"insurance_fee": "0"
}
],
"total_act_weight": "0.5",
"total_vol_weight": "1",
"total_count_weight": "1",
"final_count_weight": "1"
},
"shipping_provider": "sf_expresshk_local",
"create_time": "2025-12-09T17:01:30+08:00",
"final_count_weight": "1",
"fee_summary": [
{
"key": "cost_price",
"value": "25.00",
"label": {
"en": "Shipping Fee",
"tc": "運費"
}
},
{
"key": "total_price",
"value": "28.50",
"label": {
"en": "Total Fee",
"tc": "總價"
}
}
],
"message": "OK"
}
}
Note: Only orders belonging to the authenticated member can be retrieved. Some document paths may be hidden for UPS orders under account protection.
400 Bad Request
400 Bad Request
Response schema:
application/jsonerror.code
string
Error code.
Example:
400201 or 400000error.code_reason
string
Error reason.
error.message
string
Summary of the error.
error.error_code
string
Error Code.
Response sample
{
"error": {
"code": "400201",
"code_reason": "ORDER_NOT_FOUND",
"message": "Order not found",
"error_code": "ORDER_NOT_FOUND"
}
}
401 Unauthorized
401 Unauthorized
Response schema:
application/jsoncode
string
Error code.
Example:
401000code_reason
string
Error reason.
Example:
UNAUTHORIZEDmessage
string
Human-readable message.
Example:
Unauthorized{
"error": {
"code": "401000",
"code_reason": "UNAUTHORIZED",
"message": "Unauthorized"
}
}
403 Forbidden
403 Forbidden
Response schema:
application/jsonerror
json-string
Access forbidden for this resource.
404 Not Found
404 Not Found
Response schema:
application/jsonerror
json-string
Resource or endpoint not found.
500 Failure
500 Failure
Response schema:
application/jsoncode
string
Error code.
Example:
500999code_reason
string
Error reason.
Example:
API_ERRORmessage
string
Human-readable message.
Example:
Api Error, please contact customer service{
"error": {
"code": "500999",
"code_reason": "API_ERROR",
"message": "Api Error, please contact customer service"
}
}