Shopee: Most-used fields

The final shipping cost for an order, which is a positive value. For non-integrated logistics channels, this value is 0. This field is only displayed for non-CB SIP affiliate shops.

Indicates if the actual shipping fee for an order has been confirmed.

A unique identifier for an add-on deal or promotion.

A list of attributes defining specific characteristics of a product.

The unique identifier for a product attribute.

The original name of the attribute value, as retrieved from the product attributes API.

The unique identifier for a specific attribute value.

The unit of measurement for a quantitative product attribute value.

Indicates if the product attribute is mandatory for listing.

The original name of the product attribute.

A collection of product attributes defining its characteristics.

Contains information about the brand of the product.

The unique identifier for the brand.

The original name of the brand.

The reason provided by the buyer for cancelling an order.

The CPF ID of the buyer (specific to certain regions like Brazil). This field is available when requesting optional fields in order details.

The unique identifier for the buyer of an order.

The username of the buyer who placed the order. This information is available when retrieving order details.

Indicates who canceled the order. This field is available when requesting optional fields in order details.

The reason provided for the cancellation of an order.

The unique identifier for the product category.

The name of the product category.

The total number of comments or reviews received for a product.

Indicates if the order is a Cash on Delivery (COD) order.

The two-letter ISO ALPHA-2 code representing the country.

The timestamp when the order or item was created.

The three-digit ISO currency code for the order's total amount.

A standardized date field derived from API timestamps, representing the date of an event.

The number of days required to ship a pre-order item.

The detailed description of the product.

Contains detailed description information about the product.

This field defines the type of content within an extended product description. It indicates whether a specific part of the description contains text or an image. Possible values include "text" and "image".

The unique identifier for an image included in a product's extended description.

The URL where an image, part of a product's extended description, can be accessed.

The textual content of a specific field within a product's extended description.

The physical dimensions of the item or package.

The height of the product package in centimeters.

The length of the product package in centimeters.

The width of the product package in centimeters.

The unique identifier for a discount promotion.

The name of the discount promotion.

Indicates whether the order is handled by a dropshipper. This field is available when requesting optional fields in order details.

The phone number of the dropshipper. This field is available when requesting optional fields in order details.

The timestamp indicating when a discount activity or promotion ends.

The amount held in escrow for an order, which is released to the seller upon successful completion of the transaction.

Cross-border tax imposed by the Indonesian government on sellers. This field is only displayed for non-CB SIP affiliate shops.

The estimated shipping fee for the order.

A flag indicating how the order is fulfilled (e.g., by Shopee, cross-border seller, local seller).

Information related to goods that need to be declared. This field is available when requesting optional fields in order details.

Indicates whether a product has specific models, which are often used to define variations or distinct versions of a product.

Indicates whether shipping proof, such as a tracking receipt or photo, has been uploaded for the return.

Indicates whether a product has different variations, such as size, color, or other attributes.

Contains image-related information for the product.

A list of unique identifiers for product images.

A list of URLs for product images.

A list of image URLs for the product.

Invoice-related data for an order. This field is available when requesting optional fields in order details.

Indicates whether the actual shipping fee has been confirmed. This field is available when requesting optional fields in order details.

Indicates if the item is part of an add-on deal.

Indicates if the returned item has arrived at the designated warehouse.

Indicates if the item is the main item in a bundle or a sub-item.

Indicates if the return request involves a partial quantity of items from the original order.

Indicates if the item is a pre-order item.

Indicates if the item is a prescription-required product.

Indicates whether the refund amount for the return request has been adjusted from the original value.

Indicates if the reverse logistics channel used for the return is integrated with the Shopee platform.

Indicates if the seller is responsible for arranging the return shipping or other logistics for the item.

Indicates whether uploading shipping proof is a mandatory requirement for the current return or refund request.

Indicates if an order has been split into multiple packages. This field is available when requesting optional fields in order details.

Indicates if the item is available for wholesale purchase.

Details about the specific product item involved in the order or return request.

Shopee's unique identifier for a product item.

A list of items included in an order or package.

Indicates if the item in the list is part of an add-on deal.

The unique identifier for an add-on deal that this item belongs to.

The URL of the image for the product item in the list.

Indicates if the item in the list is a prescription-required product.

Shopee's unique identifier for the product item in the list.

The name of the product item in the list.

The Stock Keeping Unit (SKU) for the product item in the list.

Indicates if the item is the main item in a bundle or a sub-item.

The discounted price of the specific product model within the item list.

The unique identifier for the product model within the item list.

The name of the product model within the item list.

The original price of the product model within the item list.

The quantity of a specific model within a product that has been purchased as part of an order.

The Stock Keeping Unit (SKU) for the product model within the item list.

The unique identifier for the order item within the item list.

The unique identifier for the warehouse or location where the product item in the list is stored.

The unique identifier for a product promotion group within an item list.

The unique identifier for the promotion applied to this item in the list.

The type of promotion applied to this item in the list.

The weight of the item, measured in kilograms (KG). For product models, if not specified, it defaults to the item's weight.

Indicates if the item in the list is available for wholesale purchase.

The name of the product item.

The original price of the product item before any discounts or promotions.

The discounted price of the item during a promotion. If the item has variations, this value will be 0, and the promotion price for variations should be checked separately.

The reserved stock quantity of the item for a promotion. This parameter is necessary if the item has no variation.

The Stock Keeping Unit (SKU) for the product item, defined by the seller.

The current status of the product item on Shopee (e.g., normal, banned, unlisted).

The number of likes a product has received. This metric is available through the v2.product.get_item_extra_info API and represents the cumulative value of likes for a product.

Contains detailed information about the logistics arrangements for an order.

Indicates if a specific logistics option is enabled.

The estimated shipping fee for the specific logistics option.

Indicates whether free shipping is offered for the logistics option or product.

The unique identifier for the logistics channel.

The name of the logistics channel or service.

Contains general logistics information for the product or order.

The current status of the logistics process for the returned item.

A message from the buyer to the seller for the order.

A list of product models or variations for an item.

The unique identifier for a specific product model.

The name of the product model.

The regular stock quantity available for the product model.

The original price of the product model before any discounts.

The discounted price of a specific model (variation) during a promotion.

The reserved stock quantity of a specific model (variation) for a promotion.

The name of the item in the local language.

Information about the negotiation process between the buyer and seller regarding the return or refund request.

The regular stock quantity available for an item, not including promotional or reserved stock.

A note made by the seller for internal reference regarding the order.

The timestamp when the seller's note for the order was last updated.

The chargeable weight of the order in grams, used for calculating shipping fees.

The unique identifier for an item within a specific order.

Shopee's unique identifier for an order.

The current status of the order (e.g., unpaid, ready to ship, completed).

Shopee's unique identifier for an order.

The original price of the product or its variation before any discounts.

The height of the product package in centimeters.

The length of the product package in centimeters.

A list of packages associated with an order.

Shopee's unique identifier for an item within a package list.

The unique identifier for a product model within an item in the package list.

The logistics status of a specific package within an order.

Shopee's unique identifier for a package within an order.

The chargeable weight of the parcel in grams, used for calculating shipping fees.

The name of the shipping carrier for the package.

An identifier used to query the status of a specific package, often a tracking number.

The width of the product package in centimeters.

The timestamp indicating when the buyer completed payment for the order. This field is available when requesting optional fields in order details.

The method used by the buyer to pay for the order.

The timestamp when the package pickup for the order was completed by the logistics provider.

Contains information indicating if the item is a pre-order.

The number of days required to ship a pre-order item.

Indicates if the item is designated as a pre-order.

The original price of the item before any promotions or discounts in the listing currency.

Contains detailed pricing information for the product, including current and original prices.

The three-digit ISO currency code for the product's price.

The current price of the item in the listing currency. If the product is under an ongoing promotion, this will be the promotion price.

The original price of the product before any discounts.

The unique identifier for the warehouse or location where the product is stored.

The unique identifier for a promotion.

The type of promotion applied to the item (e.g., Flash Sale, Bundle Deal).

The maximum number of this product that can be purchased at the promotion price in a discount activity.

The average star rating given to a product by buyers.

The reason provided for the return or refund request.

The reason for a return request after it has been reassessed, potentially by a Shopee agent.

The complete address details of the recipient for the order.

The city component of the recipient's address.

The district component of the recipient's address.

The complete, detailed address of the recipient.

The name of the recipient.

The phone number of the recipient.

The region component of the recipient's address.

The state or province component of the recipient's address.

The town of the recipient's address. The presence of this field depends on the region and/or country.

The postal code of the recipient's address for an order or a shop address.

The amount of money to be refunded to the buyer for the return or cancellation.

The two-digit code representing the region where the order originated.

The total quantity of stock reserved for ongoing promotions or sales events.

The address where the returned item should be sent.

The address from which the returned item will be picked up.

The specific type of request made by the buyer, such as 'Refund Only' or 'Return & Refund'.

The general category or type of the return or refund, e.g., for damaged goods or wrong item.

The deadline for the buyer to complete actions related to the return request, such as shipping the item back.

The deadline for the seller to take action on a return or refund request.

The deadline by which the buyer must ship the returned item.

The unique serial number identifier for a specific return request.

The proposed or accepted solution for resolving a return or refund request, such as a full refund, partial refund, or product exchange.

The name of the logistics channel used for the reverse logistics process (returning the item).

The current status of the reverse logistics process for a returned item.

The shipping fee for returning an item.

The total number of units sold for a product or the total sales revenue generated.

Information regarding any compensation provided to the seller in connection with a return or refund.

Evidence provided by the seller, such as photos or documents, related to a return or refund dispute.

A code required at some sorting hubs for cross-border orders, which must be included on the shipping label.

The deadline for the seller to ship out the package.

The name of the logistics service provider or shipping carrier.

Shopee's unique identifier for a shop.

Information about the size chart applicable to the product.

Indicates if the order has been split into multiple shipments. This field is available when requesting optional fields in order details.

The timestamp indicating when a discount activity or promotion starts.

The current status of an order or return, such as 'CANCELLED' or 'ACCEPTED'.

The current available stock quantity for the item.

Comprehensive information regarding the stock levels and availability of a product.

The current available stock quantity of an item.

The quantity of stock reserved, often due to ongoing or upcoming promotions or pending orders. This field is part of an older stock information structure.

The classification or category of stock for a product, such as regular stock, pre-order stock, or promotional stock.

Detailed stock information including total reserved stock, total available stock, seller stock, and Shopee stock. This field provides a more accurate representation of stock when both seller and Shopee stock are present.

The stock quantity managed by the seller for a specific product or model. This field can be associated with different warehouse locations.

The total quantity of a product's stock that is currently available for sale across all locations.

The total quantity of stock that is reserved for promotions or other purposes, as part of the detailed stock information.

The total amount paid by the buyer for the order.

The tracking number for the shipment or return parcel.

The unique number used to track the shipment of an order or return package.

The timestamp when the item or record was last updated.

The discounted price of a specific variation within an item.

Shopee's unique identifier for a specific variation (model) of an item.

The name of the variation that belongs to the same item.

The original price of a specific product variation.

The quantity of a specific product variation that has been purchased.

The SKU (stock keeping unit) for a specific variation of an item.

A collection of all variations (models) available for an item, including their details.

Information about product videos, including upload IDs.

The length of the video in seconds.

The URL of the thumbnail image associated with the video.

The URL where the video can be accessed for playback.

The total number of times a product listing or shop page has been viewed.

The weight of the item in kilograms (KG).