v2.order.get_package_detail

GET /api/v2/order/get_package_detail

Use this api to get package detail.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/order/get_package_detail

Common Request Parameters

Name	Type	Sample	Description
partner_id	int	1	Partner ID is assigned upon registration is successful. Required for all requests.
timestamp	timestamp	1610000000	This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_id	int	600000	Shopee's unique identifier for a shop. Required param for most APIs.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2

Request Parameters

Name	Type	Required	Sample	Description
package_number_list	string	True	OFG1156498731071468,OFG199593509207187	The set of package_number. If there are multiple package_number, you need to use English comma to connect them. limit [1,50]

Response Parameters

Name	Type	Sample	Description
error	string		Indicate error type if hit error. Empty if no error happened.
message	string		Indicate error details if hit error. Empty if no error happened.
request_id	string	69ee3f61ec6f4e3f85836391e5b78dbc	The identifier for an API request for error tracking.
response	object		Detail informations you are querying.
package_list	object[]		The list of packages.
order_sn	string	220831EGF1JMXF	Shopee's unique identifier for an order.
package_number	string	OFG1156498731071468	Shopee's unique identifier for the package under an order.
fulfillment_status	string	LOGISTICS_READY	The Shopee fulfillment status for the package. Applicable values: See V2.0 Data Definition - PackageFulfillmentStatus.
update_time	int64	1661950674	Timestamp that indicates the last time that there was a change in value of package.
logistics_channel_id	int64	80008	The identity of logistic channel.
shipping_carrier	string	JNE Trucking (JTR) LPS	The logistics service provider that the buyer selected for the package to deliver items. Note: If logistics_channel_id is 90021, 90025 or 90026, service_code will be appended, e.g., Entrega Turbo - M1020.
allow_self_design_awb	boolean	true	To indicate whether the package allows for self-designed AWB, if allow_self_design_awb returns false, it means that the package does not allow for self-designed AWB and only the system-AWB can be used.
days_to_ship	int64	3	Shipping preparation time set by the seller when listing item on Shopee.
ship_by_date	int64	1662209873	The deadline to ship out the package.
pending_terms	string[]	["SYSTEM_PENDING"]	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.
pending_description	string[]	["Order is being processed by Shopee"]	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.
tracking_number	string		The tracking number of this package.
tracking_number_expiration_date	int64		[TW only] Tracking number expiration date
pickup_done_time	int64		The timestamp when pickup is done.
is_split_up	boolean	false	To indicate whether this parcel is split.
item_list	object[]		The lis of items in the package.
item_id	int64	2200149592	Shopee's unique identifier for an item.
model_id	int64		Shopee's unique identifier for a model.
item_sku	string		A item SKU (stock keeping unit) is an identifier defined by a seller, sometimes called parent SKU. Item SKU can be assigned to an item in Shopee Listings.
model_sku	string		ID of the model that belongs to the same item.
model_quantity	int64	1	The number of identical items/variations purchased at the same time by the same buyer from one listing/item.
order_item_id	int64	2200149592	The identify of order item. For items in one same bundle deal promotion, the order_item_id should share the same id, such as 1,2. For items not in bundle deal promotion, the order_item_id should be the same as item_id.
promotion_group_id	int64		The identify of product promotion.
product_location_id	string		The warehouse ID of the item.
consultation_id	string		An identifier of teleconsultation session which buyer did to order this item. Empty if item is not ordered through teleconsultation session
recipient_address	object		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.
name	string	b***r	Recipient's name for the address.
phone	string	******78	Recipient's phone number input when order was placed. [Only for TW non-integrated channel] Will return "****" when the "virtual_contact_number" is available
town	string	****	The town of the recipient's address. Whether there is a town will depend on the region and/or country.
district	string	****	The district of the recipient's address. Whether there is a district will depend on the region and/or country.
city	string	****	The city of the recipient's address. Whether there is a city will depend on the region and/or country.
state	string	****	The state/province of the recipient's address. Whether there is a state/province will depend on the region and/or country.
region	string	****	The two-digit code representing the region of the Recipient.
zipcode	string	****	Recipient's postal code.
full_address	string	******11	The full address of the recipient, including country, state, even street, and etc.
geolocation	object		Geolocation info. Only available for logistics_channel_id 90026.
latitude	float	-23.567851	Latitude.
longitude	float	-46.6912611	Longitude.
parcel_chargeable_weight_gram	int64		display weight used to calculate ASF for this parcel
group_shipment_id	int64		The common identifier for multiple orders combined in the same parcel.
virtual_contact_number	string		[Only for TW non-integrated channel] The virtual phone number to contact the recipient.
package_query_number	string	false	[Only for TW non-integrated channel] The query number used in virtual phone number calls to contact the recipient of this package.
sorting_group	string	North	[Only for TW 30029 channel] This field indicate the sorting group value of the package. This field is only available for logistics_channel_id = 30029 and after the package has been arranged for shipment.
is_shipment_arranged	boolean	false	Only effective when the package's logistics_status/fulfillment_status is LOGISTICS_READY. This parameter further distinguishes between two scenarios: - true: Package shipment has been arranged (Seller has processed shipment, system is generating tracking number, not yet updated to LOGISTICS_REQUEST_CREATED, no duplicate action needed) - false: Package awaiting shipment arrangement (Seller hasn't processed shipment yet, shipping arrangement required)
status_info_tag	object		Package shipping urgency tag information.
tag_id	int32	0	Shipping urgency tag type, applicable values below: 0: No tag 1: Will be cancelled within 1 day 2: Must ship before the specified timestamp 3: Shipment delayed 4: Must ship within the current hour 5: Will be cancelled at the specified timestamp
timestamp	timestamp	0	When tag_id is 2 or 5, returns specific timestamp (e.g., cancel time, shipment deadline); otherwise returns 0.
can_split_order	boolean	false	This field indicates whether this order can be split into multiple packages for separate shipment. - true: Support splitting, can call v2.order.split_order to execute - false: Does not support splitting
can_unsplit_order	boolean	false	This field indicates whether this order can be unsplit. - true: Support unsplitting, can call v2.order.unsplit_order to execute - false: Does not support unsplitting
is_pre_order	boolean	false	This field indicates whether this order is a pre-order. - true: Pre-order - false: Non pre-order
pharmacist_name	string		Name of the Pharmacist for Prescription Order.
prescription_images	string[]		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\_image for PH: https://cf.shopee.ph/file/+prescription\_image
prescription_approval_time	timestamp		Time of when the prescription is approved.
prescription_rejection_time	timestamp		Time of when the prescription is rejected.
is_buyer_shop_collection	boolean		To indicate if this order is buyer self collection at store order.
buyer_proof_of_collection	string[]		The image url of the proof for buyer self collection at the store.
preparation_end_time	timestamp	1772276400	The system-calculated deadline for package preparation. When the package fulfillment_status/logistics_status changes to "LOGISTICS_READY", the system calculates this time based on the "Preparation Time" configured for the logistics channel of this package. Notes: 1) Only effective for logistics channels that have Auto Call Driver enabled and Preparation Time configured. 2) Seller needs to complete packing and waybill printing before this time to ensure the package is ready when the driver arrives. 3) When this time is reached, the system will automatically arrange shipment and trigger driver dispatch: - If driver calling is successful, the package fulfillment_status/logistics_status will change from “LOGISTICS_READY” to “LOGISTICS_REQUEST_CREATED”. - If driver calling fails, the package fulfillment_status/logistics_status will remain unchanged, and the seller must arrange shipment manually.
driver_info	object		After the driver is successfully called, the driver's information will be returned. Note: Data availability depends on the specific 3PL provider; certain fields may be omitted due to provider policies, PII restrictions, or data unavailability.
driver_name	string		Driver Name
driver_phone	string		Driver phone number
vehicle_type	string		Delivery vehicle type
license_plate	string		License plate number
courier_photo	string		URL of the driver's photo
eta_start_time	int64		Earliest estimated arrival time at pickup address
eta_end_time	int64		Latest estimated arrival time at pickup address
driver_status	string	Driver is on the way	Driver status. Applicable values: - Allocating Driver - Driver assigned - Driver is on the way - Driver is arrived
warning	string		Indicate warning message you should take care.