Skip to main content

Get Order

Retrieve details for a single order.

Endpoint​

GET /v1/order/get/{order_id}

Request​

Header Parameters​


ParameterTypeRequiredExampleDescription
AuthorizationstringYesBearer YOUR_ACCESS_TOKENBearer access token used for authentication.
Content-TypestringYesapplication/jsonRequest body content type.

Path Parameters​

FieldTypeRequiredDescription
order_idstringYesOrder 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/json
data
json-string
Order details.
Expand for fields.
order_id
string
Unique order identifier.
Example: 3550875
ship_type
string
Shipping type.
Example: local
status
string
Current order status code.
Example: READY_TO_SHIP
Expand for supported values.
Order status codes:
Status CodeDescription
DRAFTDraft order (not submitted)
PENDING_CONFIRMOrder awaiting confirmation/payment
READY_TO_SHIPOrder confirmed and ready for pickup
PENDING_PICKUPWaiting for courier pickup
PICKUP_COMPLETEDPicked up by courier
IN_TRANSITPackage in transit
DELIVEREDPackage delivered
COMPLETEDOrder completed
CANCELLEDOrder cancelled
PROCESSINGOrder being processed.
Example: generating/printing shipping label.
PENDING_PROCESSINGOrder requires manual handling by Fuuffy IT staff. Contact Fuuffy IT for follow-up.
quote_price
string
Quoted shipping price.
Example: 28.50
confirm_shipment
string
Whether order is confirmed (Y or N).
Example: Y
tracking_number
string
Tracking number when assigned.
Example: SF7444700508450
client_remarks
string
Client reference or remarks.
sender
json-string
Sender information.
Expand for fields.
name
string
Contact name.
Example: Fuuffy Chai
mobile
string
Phone number (without country code).
mobile_prefix
string
Country code.
Example: 852
email
string
Email address.
address
string
Full formatted address.
recipient
json-string
Recipient information.
Expand for fields.
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_detail
json-string
Shipment and parcel details.
Expand for fields.
package_type
string
Type of package.
Example: parcel, document
consignment_declaration
string
Contents declaration.
parcel_list
json-string
Array of parcels in this shipment.
Expand for item fields.
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_items
json-string
Array of items in this parcel.
Expand for item fields.
name
string
Item name.
Example: Toy
qty
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.5
total_vol_weight
string
Total volumetric weight of all parcels, in kg. Also called dimensional weight, based on parcel size (L × W × H).
Example: 1
total_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: 1
final_count_weight
string
Final billed weight confirmed by the courier, in kg. Empty until the courier issues an invoice.
Example: 1
shipping_provider
string
Shipping provider code.
Example: sf_expresshk_local
create_time
string
Order creation timestamp (ISO 8601).
Example: 2025-12-09T17:01:30+08:00
final_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: 1
fee_summary
array
Fee breakdown for this order.
Reference: Get Fee Summary.
key
string
Machine-readable fee item key.
Example: cost_price, remote_surcharge_fee, total_price
Expand for all possible keys.
KeyLabelDescription
cost_priceShipping FeeBase freight.
label_feeLabel FeeLabel-print fee.
balance_discountPrepaid Balance DiscountPrepaid-balance discount.
international_processing_feeInternational Processing FeeInternational handling surcharge.
resource_allocation_feeResource Allocation FeeResource-allocation surcharge
insurance_feeParcel Protection Fee or Full Protection FeeOptional cargo insurance.
signature_feeSigautre FeeSignature-on-delivery fee.
remote_surcharge_feeRemote SurchargeRemote-area surcharge.
ddp_payment_feeDDP FeeDuties and taxes prepaid by the sender.
declaration_handling_feeDeclaration Handling FeeCustoms declaration handling fee.
ioss_codeIOSS Fee (VOEC Fee for Norway)IOSS fee (VOEC for Norway). Low-value goods into the EU or Norway.
cod_feeCOD FeeCash-on-delivery (COD) fee.
delivery_proof_feeProof of Delivery FeeProof of delivery (POD) fee.
oversize_surcharge_feeOversize surchargeOversize surcharge.
ttl_extra_chargeExtra Large SurchargeOverlength / overweight surcharge.
ups_surchargeUPS Paper Invoice FeeUPS paper customs invoice fee.
discount_priceDiscountCoupon or promo discount.
points_discountFuuffy Dollar DiscountFuuffy Dollar credit.
extra_payment_feeExtra PaymentConfirmed extra payment / price-difference charges recorded against this order after it was placed.
return_feeReturn FeeReturn shipping fee charged for this order.
duty_tax_add_on_feeAdd-On Duty and TaxAdditional duty/tax collected for this order.
additional_charge_feeAdditional ChargeOther special additional charge for this order.
charge_diff_feeShipping Fee Charge DiffShipping fee price-difference charge recorded against this order after it was placed.
address_correct_feeAddress Correct FeeFee for correcting an incorrect delivery address after the order was placed.
physical_invoice_feePhysical Invoice FeePhysical customs invoice fee charged after the order was placed.
duty_tax_transfer_confirm_feeDuty/Tax Trans Handling FeeDuty/tax transfer handling fee charged after the order was placed.
duty_tax_feeDuty and TaxDuty and tax paid on behalf of the customer for this order.
remote_surcharge_final_feeRemote Surcharge FeeRemote-area surcharge confirmed/adjusted after audit, charged against this order.
total_priceTotal FeeGrand 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/json
error.code
string
Error code.
Example: 400201 or 400000
error.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/json
code
string
Error code.
Example: 401000
code_reason
string
Error reason.
Example: UNAUTHORIZED
message
string
Human-readable message.
Example: Unauthorized
{
"error": {
"code": "401000",
"code_reason": "UNAUTHORIZED",
"message": "Unauthorized"
}
}

403 Forbidden​

403 Forbidden

Response schema: application/json
error
json-string
Access forbidden for this resource.

404 Not Found​

404 Not Found

Response schema: application/json
error
json-string
Resource or endpoint not found.

500 Failure​

500 Failure

Response schema: application/json
code
string
Error code.
Example: 500999
code_reason
string
Error reason.
Example: API_ERROR
message
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"
}
}