快工助手跨境电商知识与商机助手

[TW] How to integrate Shopee integrated logistics order?

Shopee 官方资料 · Shopee Open Platform 常见问题(FAQ) · 适合开发者

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.faq
语言
en
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/help_centertopic/apitopic/developertopic/faqtopic/feature-apistopic/logistics

资料正文

§1 [TW] How to integrate Shopee integrated logistics order?

Q1: What is Shopee Integrated Logistics?

A1: When using Shopee Integrated Logistics, the system will request a tracking number from the logistics provider through Shopee’s system, and the AWB will also be retrieved by Shopee. Sellers cannot get any buyer personal information (including name, address, or phone number). Shopee will directly provide this information to the logistics provider.

In summary, once a seller integrates with Shopee Integrated Logistics, there is no need to interact directly with logistics providers. All actions, such as requesting tracking numbers and retrieving shipping documents are fully processed through Shopee OpenAPI.

------------------------------------------------------------------------------------------------------------------------------------------------------------------

Q2: How can I enable Shopee Integrated Logistics for my items? How should I configure shipping fees?

A2:

  • Retrieve available logistics channel: Call "v2.logistics.get_channel_list" API to obtain the list of logistics channels available to the shop, along with detailed information.Key fields:logistics_channel_id: Unique identifier for the logistics channel in Shopee’s system; used when viewing item or order information.logistics_channel_name: Display name of the logistics option in Traditional Chinese.Shipping fee related fieldsfee_type: indicates how the shipping fee is determined"FIXED_DEFAULT_PRICE": The shipping fee is fixed."SIZE_SELECTION": The shipping fee can be configured at the item level based on parcel size. Fee details are provided in the size_list field.
  • Enable logistics channels for an iem: When calling "v2.product.add_item" or "v2.product.update_item", configure the logistics channels under the logistic_info field in the request body.

------------------------------------------------------------------------------------------------------------------------------------------------------------------

Q3: With so many logistics channels available, how can I know which one is used for each order?

A3: Call "v2.order.get_order_detail" API, and check:

  • shipping_carrier: Display name of the logistics option in Traditional Chinese.
  • logistics_channel_id: Unique identifier for the logistics channel in Shopee’s system.

These fields indicate which logistics channel the order is using.

------------------------------------------------------------------------------------------------------------------------------------------------------------------

Q4: Which APIs do I need to call to ship orders using Shopee Integrated Logistics?

A4: - Order Shipment (Request Tracking Number):

  1. v2.logistics.get_shipping_parameter / v2.logistics.get_mass_shipping_parameter

  2. v2.logistics.ship_order / v2.logistics.mass_ship_order

  3. v2.logistics.get_tracking_number / v2.logistics.get_mass_tracking_number

*The generation of the “tracking_number” may be delayed due to factors related to third-party logistics providers. If Step 2 is successfully executed but an empty “tracking_number” is returned in Step 3, please try repeating Step 3 first. You may also refer to the “order_trackingno_push” in the Push Mechanism integration to receive a notification once the “tracking_number” is ready.

- Retrieve AWB:

  1. v2.logistics.get_shipping_document_parameter

  2. v2.logistics.create_shipping_document

  3. v2.logistics.get_shippping_document_result

  4. v2.logistics.download_shipping_document

*If your shop is using 黑貓 C2C, 黑貓宅急便's order AWB cannot be downloaded through these APIs. See Q8 for details.

------------------------------------------------------------------------------------------------------------------------------------------------------------------

Q5: Integrated logistics includes convenience store types(e.g. 蝦皮店到店 related、7-11...) and home delivery types(e.g. 黑貓宅急便、新竹物流....). Are there differences in the integration process?

A5: The overall API call flow is the same. The only differences are in certain fields required by the APIs. (Sample responses are for reference only. Always refer to your actual API output.)

  • Convenience store types
  1. You will get "dropoff" in the "info_needed" field in “v2.logistics.get_shipping_parameter” API.
{
    "error": "",
    "message": "",
    "response": {
        "info_needed": {
            "dropoff": [
                "sender_real_name"
            ]
        },
        "dropoff": {
            "branch_list": null
        }
    },
    "request_id": "e3e3e7f3449e7897aca1e0b268995e01:01000306d0b99c9a:000000ee0d052250"
}
  1. When calling “v2.logistics.ship_order” , construct the request based on the info you got in pervious step.
{
    "order_sn": "251121QQY0WASP",
    "dropoff": {
          "sender_real_name": "蝦小編"
  }
}

*If you got empty value in the "info_needed" field in“v2.logistics.get_shipping_parameter” API , just use empty object in the "dropoff" field when using“v2.logistics.ship_order” API.

  • Home delivery types
  1. You will get "pickup" in the "info_needed" field in “v2.logistics.get_shipping_parameter” API. Additional details are found in the "pickup" field:

a. "address_list": List of seller addresses configured in Seller Center that can use as the pickup address in this order.

b. "time_slot_list": Available pickup times for each address for this order.

{
    "error": "",
    "message": "",
    "response": {
        "info_needed": {
            "pickup": [
                "address_id",
                "pickup_time_id"
            ]
        },
        "pickup": {
            "address_list": [
                
                {
                    "address_id": 11807,
                    "region": "TW",
                    "state": "台北市",
                    "city": "信義區",
                    "district": "",
                    "town": "",
                    "address": "蝦皮路111號",
                    "zipcode": "110",
                    "address_flag": [
                        "return_address"
                    ],
                    "time_slot_list": [
                        {
                            "date": 1764403200,
                            "pickup_time_id": "1764403200",
                            "flags": [
                                "recommended"
                            ]
                        }
                    ]
                },
                {
                    "address_id": 11717,
                    "region": "TW",
                    "state": "台北市",
                    "city": "文山區",
                    "district": "",
                    "town": "",
                    "address": "蝦皮街123號",
                    "zipcode": "116",
                    "address_flag": [],
                    "time_slot_list": [
                        {
                            "date": 1764403200,
                            "pickup_time_id": "1764403200",
                            "flags": [
                                "recommended"
                            ]
                        }
                    ]
                }
            ]
        }
    },
    "request_id": "e3e3e7f3449e7cec382fe3e73a194301:010003033fb4f906:000000a83741298d"
}
  1. When calling “v2.logistics.ship_order” API , construct the request based on the info you got in pervious step.
{
    "order_sn": "251128W02SE615",
    "pickup": {
        "address_id": 11807,
        "pickup_time_id": "1764403200"
    }
}
  • Each order shipment call is independent, so you may choose different address_ids for different shipments.

*Seller Center currently allows each seller to set up to 10 pickup addresses. In addition, OpenAPI does not provide an address editing function. If you wish to change address details, please do so in the Seller Center.

------------------------------------------------------------------------------------------------------------------------------------------------------------------

Q6: If items in the same order must be shipped from different warehouses, how should I implement this?

A6: You can use the order-splitting feature to divide one order into multiple packages. After splitting, perform the standard logistics flow (as described in A5) for each package.

The API used for splitting orders:

v2.order.split_order

Important Notes:

  • Order splitting is only supported when the order is in READY_TO_SHIP status.
  • After splitting, "split_up" field becomes true in "v2.order.get_order_detail" API, and multiple package_number entries will appear in package_list.
  • All logistics-related APIs must include "package_number" field in the request after splitting.
  • Order splitting is enabled at the shop level. To activate it, please contact your Shopee Key Account Manager (KAM).

------------------------------------------------------------------------------------------------------------------------------------------------------------------

Q7: What's the response content of "v2.logistics.download_shipping_document" API ?

A7:

  • Most of the logistics channel will return PDF file. (The file is returned directly, not as a download link)
  • For non-Shopee Xpress related convenience store logistics, if the logistics mode is C2C, AWB will be returned in HTML format

OpenAPI does not provide a field that shows whether your shop logistics using B2C or C2C mode. For adjustments or confirmation, please contact your Shopee KAM.

------------------------------------------------------------------------------------------------------------------------------------------------------------------

Q8: Both are Shopee-integrated 黑貓宅急便. What is the difference between 黑貓 VIP and 黑貓 C2C?

A8:

Aside from how the AWB is obtained, everything else is the same (including logistics_channel_id and logistics_channel_name).

黑貓 VIP黑貓 C2C
AWB RetrievalFully retrieved through API.AWB is attached by 黑貓 staff upon pickup; cannot be retrieved by Shopee.
logistics_channel_id / nameSameSame

*OpenAPI does not provide a field that shows whether your shop uses VIP or C2C. For adjustments or confirmation, please contact your Shopee KAM.

------------------------------------------------------------------------------------------------------------------------------------------------------------------

Q9: How can I integrate Shopee Xpress - Package-free (logistic channel id: 30029) logistics?

A9:

Please refer to this developer guide: Shopee Xpress - Package-free Integration Guide

For more detail, please refer to the API referencr or Developer Guide - Order Management page.

#