Optionalactual_The actual shipping fee of the order if available from external logistics partners.
Optionalactual_Use this filed to judge whether the actual_shipping_fee is confirmed.
Optionaladvance_Indicate whether order will be fulfilled using advance fulfilment stock or not. If value is true, order will be matched with a booking and seller should not arrange shipment.
Optionalaffiliate_Indicates that this order is a refundable sample order. Applicable values:0 = Order is not a refundable sample order1 = Order is a refundable sample order
Optionalbooking_Return by default. Shopee's unique identifier for a booking.Only returned for advance fulfilment matched order only.
Optionalbuyer_Cancel reason from buyer, could be empty.
Optionalbuyer_Buyer's CPF number for taxation and invoice purposes. Only for Brazil order.
Optionalbuyer_Indicates the buyer’s preference for handling out-of-stock items in the order. Applicable values:0 = Ship Available Items Only (The buyer allows the seller to cancel unavailable items and continue shipping the remaining available items)1 = Cancel The Entire Order (The buyer does not allow partial cancellation. If any item is unavailable, the seller should cancel the entire order instead)
Optionalbuyer_The image url of the buyer self collection at the store.
Optionalbuyer_The user id of buyer of this order, will be empty if it is a non-integrated order in TW region.
Optionalbuyer_The name of buyer, will be masked as "****" if it is a non-integrated order in TW region.
Optionalcan_Indicates whether the order can be full cancelled: - If this value is true, seller can cancel the entire order- If the value is false, full order cancellation is not available for the order
Optionalcan_Indicates whether the order is eligible for partial cancellation. This value is determined by both the system eligibility check and the buyer’s out-of-stock handling preference. - If this value is true, seller can cancel selected out-of-stock item quantities while continuing to fulfill the remaining items. - If this value is false, partial cancellation is not allowed.
Optionalcancel_Could be one of buyer, seller, system or Ops.
Optionalcancel_Use this field to get reason for buyer, seller, and system cancellation.
Optionalcheckout_For non masking order, the logistics service provider that the buyer selected for the order to deliver items. For masking order, the logistics service type that the buyer selected for the order to deliver items.
OptionalcodReturn by default. This value indicates whether the order was a COD (cash on delivery) order.
Optionalcreate_Return by default. Timestamp that indicates the date and time that the order was created.
OptionalcurrencyReturn by default. The three-digit code representing the currency unit for which the order was paid.
Optionaldays_Return by default. Shipping preparation time set by the seller when listing item on Shopee.
OptionaldropshipperFor Indonesia orders only. The name of the dropshipper.
Optionaldropshipper_The phone number of dropshipper, could be empty.
Optionaledt_Earliest estimated delivery date of orders (only available for BR region)
Optionaledt_Latest estimated delivery time of orders (only available for BR region)
Optionalestimated_The estimated shipping fee is an estimation calculated by Shopee based on specific logistics courier's standard.
Optionalfulfillment_Use this field to indicate the order is fulfilled by shopee or seller. Applicable values: fulfilled_by_shopee, fulfilled_by_cb_seller, fulfilled_by_local_seller.
Optionalgoods_Only work for cross-border order.This value indicates whether the order contains goods that are required to declare at customs. "T" means true and it will mark as "T" on the shipping label; "F" means false and it will mark as "P" on the shipping label. This value is accurate ONLY AFTER the order trackingNo is generated, please capture this value AFTER your retrieve the trackingNo.
Optionalhot_[Only for PH,TH,VN,MY,BR,TW] True if the order includes hot listing item.
Optionalinvoice_The invoice data of the order.
Optionalis_To indicate if this order is buyer self collection at store order
Optionalis_[Only for BR] Indicate if the order is SIP order. This field will only be returned if international_label is included in response_optional_field in the request.
Optionalitem_This object contains the detailed breakdown for the result of this API call.
Optionalmessage_Return by default. Message to seller.
OptionalnoteThe note seller made for own reference.
Optionalnote_Update time for the note.
Optionalorder_display weight used to calculate ASF for this order
Optionalorder_Return by default. Shopee's unique identifier for an order.
Optionalorder_Return by default. Enumerated type that defines the current status of the order.
Optionalpackage_The list of package under an order
Optionalpay_The time when the order status is updated from UNPAID to PAID. This value is NULL when order is not paid yet.
Optionalpayment_[Only for BR] List of payment information, to follow NT 2025.001 (BR government invoice rules).
Optionalpayment_The payment method that the buyer selected to pay for the order. Applicable values: See Data Definition- Payment Methods.
Optionalpending_The value of this field is the description of pending reason corresponding with pending terms. Applicable values: - For SYSTEM_PENDING: Order is being processed by Shopee.- For KYC_PENDING: Order is pending buyer TW KYC pre-authorization.- For ARRANGE_SHIPMENT_PENDING: Allocating delivery resources due to high order volume. Label print will be available within 4 days after buyer paid.
Optionalpending_The list of pending terms. Applicable values:- SYSTEM_PENDING: Under Shopee internal processing.- KYC_PENDING: Under KYC checking (TW CB order only).- ARRANGE_SHIPMENT_PENDING: Temporarily held due to 3PL capacity constraints.
Optionalpharmacist_Name of the Pharmacist for Prescription Order.
Optionalpickup_The timestamp when pickup is done.
Optionalprescription_Time of when the prescription is approved.
Optionalprescription_Prescription check status. For ID, PH whitelisted sellers, the applicable values:0: NONE1: PASSED2: FAILEDFor TH whitelisted sellers, the applicable values:0: NONE1: PASSED
Optionalprescription_Return prescription images of this order, only for ID and PH whitelist sellers.Please add the prefix to review:for ID: https://cf.shopee.co.id/file/+prescription_imagefor PH:https://cf.shopee.ph/file/+prescription_image
Optionalprescription_Return the reason why a prescription is rejected. If there is no rejection reason, return empty.Only for ID and PH whitelist sellers
Optionalprescription_Time of when the prescription is rejected.
Optionalrecipient_This object contains detailed breakdown for the recipient address.Different parameters might be masked according to each market and kind of seller.For TW region integrated channel orders will be all masked as "****". More details may refer the announcement.
OptionalregionReturn by default. The two-digit code representing the region where the order was made.
Optionalreturn_This field represents the deadline for buyers to initiate returns and refunds after order is completed.The “return_request_due_date” response parameter will be returned if the requested order meets ALL the conditions below:- The status of the order is COMPLETED- The return refund eligibility of the order is trueIf you have any questions related to the function of "returns and refunds after order is completed," please refer to the following link: https://seller.shopee.tw/edu/article/18474
Optionalreverse_Shopee charges the reverse shipping fee for the returned order.The value of this field will be non-negative.
Optionalship_Return by default. The deadline to ship out the parcel.
Optionalshipping_The logistics service provider that the buyer selected for the order to deliver items. Note: If logistics_channel_id is 90021, 90025 or 90026, service_code will be appended, e.g., Entrega Turbo - M1020.
Optionalsplit_To indicate whether this order is split to fullfil order(forder) level. Call GetForderInfo if it's "true".
Optionaltotal_The total amount paid by the buyer for the order. This amount includes the total sale price of items, shipping cost beared by buyer; and offset by Shopee promotions if applicable. This value will only return after the buyer has completed payment for the order.
Optionalupdate_Return by default. Timestamp that indicates the last time that there was a change in value of order, such as order status changed from 'Paid' to 'Completed'.
GetOrderDetailOrder sub-interface for GetOrderDetailResponseData