# Small package shipping information management service

according toThe operating specifications for merchant-owned Mini ProgramsHowever, certain types of Mini Programs need to complete the shipping information entry and confirm the receipt process on the platform before the funds can be settled.

Developers can use this access service to complete the item shipping information entry, remind users to confirm receipt, and call the confirmation receipt component in the Mini Program to improve the efficiency of shipping information entry and optimize the user experience.

# Shipping Receipt Management Service API Capabilities:

I. Entry of shipping information into the interface

II. Entry of shipping information contracts into the interface

III. Checking the status of the order shipment

IV. Query Order List

V. Confirming the shipping reminder interface

VI. Message Jump Path Settings Interface

VII. Check whether the Mini Program has activated the shipping information management service

VIII. Query whether the Mini Program has completed transaction settlement management confirmation

IX. Relevant Messaging

X. Special shipment notification

# Confirm delivery within the small printout

A Mini Program confirms receipt component access instructions

# I. Entry of shipping information into the interface

After the user makes a transaction, the default funds will be frozen, and after the shipment, the developer needs to record the relevant shipment information on the Mini Program platform, and the platform will push the shipment information in the form of a message to the WeChat user who purchased.

If you have entered shipping information, you can modify the shipping information through this interface when the user has not confirmed the receipt, but a payment order can only update the shipping information once, so be cautious.

If you have not completed the relevant API docking development work, you can also log in the background of the Mini Program and manually enter the shipping information through the shipping letter management page.

# Note

1. Depending on the type of order number specified, different parameters are used to upload logistics information to the specified order:

   (1). In the form of merchant side order number (enumeration value 1), an order is determined by the merchant number where the order is placed and the merchant side number

   (2). Weixin Pay single form (enumeration value 2), through WeChat Pay single number to determine an order

2. Shipping mode is selected based on specific shipping conditions:

   (1). Unified shipment (enumeration value 1) A single order is shipped unified, with only one logistics number.

   (2). Separate shipment (enumeration value 2). A single order is separated and shipped, including multiple logistics order numbers.

3. Logistics companies code, seeAcquiring capacity id List get_delivery_list。

4. The upload time is used to identify the order of requests. If you want to update the logistics information, the upload time must be updated compared to the previous request. Please follow RFC 3339 Fill in the format.

5. Split shipping is only supported using logistics courier, and a payment order can be split up to a maximum 10 A package.

6. The following cases will be considered re-shipment and there is only one re-shipement opportunity per payment.

   (1). Call the payment order for a completed shipment again API。

   (2). Use this API Modify the shipping mode or logistics mode.

# How to call

# HTTPS call

POST https://api.weixin.qq.com/wxa/sec/order/upload_shipping_info?access_token=ACCESS_TOKEN

# Third party invocation

• The invocation method and entry and exit parameters are the same as HTTPS, only the calling token is different

• This interface belongs to a permission set id: 142

• When a service provider is authorized by one of these permissions sets, it can useauthorizer_access_TokenCall on behalf of the merchant

# Request parameters

# Return Parameters

# Example call

# Example of request data

{
    "order_key": {
        "order_number_type": 2,
        "transaction_id": "fake-transid-20221214190427-1"
    },
    "delivery_mode": 1,
    "logistics_type": 1,
    "shipping_list": [
        {
            "tracking_no": "fake-trackingno-2022121419042711",
            "express_company": "STO",
            "item_desc": " WeChat Bubble Dog Chainer*1",
            "contact": {
                "consignor_contact": "+86-177****1234"
            }
        }
    ],
    "upload_time": "2022-12-15T13:29:35.120+08:00",
    "payer": {
        "openid":  "ogqztkPsejM9MQAFfwCQSCi4oNg3"
    }
}

# Return data example

{
    "errcode": 0,
    "errmsg": "ok"
}

# Error code

# II. Entry of shipping information contracts into the interface

After the user makes a transaction, the default funds will be frozen, and after the shipment, the developer needs to record the relevant shipment information on the Mini Program platform, and the platform will push the shipment information in the form of a message to the WeChat user who purchased.

If you have entered shipping information, you can modify the shipping information through this interface when the user has not confirmed the receipt, but a payment order can only update the shipping information once, so be cautious.

If you have not completed the relevant API docking development work, you can also log in the background of the Mini Program, manually enter the shipping information through the shipping information entry page.

# Note

1. Depending on the specified order number type, use different parameters to upload logistics information to the specified Order. Note that the order number type of the sub-order and main order must be consistent:

   (1). In the form of merchant side order number (enumeration value 1), an order is determined by the merchant number where the order is placed and the merchant side number

   (2). Weixin Pay single form (enumeration value 2), through WeChat Pay single number to determine an order

2. Shipping mode is selected based on specific shipping conditions:

   (1). Unified shipment (enumeration value 1) A single order is shipped unified, with only one logistics number.

   (2). Separate shipment (enumeration value 2). A single order is separated and shipped, including multiple logistics order numbers.

3. Logistics companies code, seeAcquiring capacity id List get_delivery_list。

4. Upload time, used to identify the order of the request, if you want to update the logistics information, upload time must be updated than the previous request, please follow the RFC Please fill in the format 3339.

5. Split shipping is only supported using logistics courier, and a payment order can be split up to a maximum 10 A package.

6. The following cases will be considered re-shipment and there is only one re-shipement opportunity per payment. (1). Call the payment order for a completed shipment again API。

   (2). Use this API Modify the shipping mode or logistics mode.

# How to call

# HTTPS call

POST https://api.weixin.qq.com/wxa/sec/order/upload_combined_shipping_info?access_token=ACCESS_TOKEN

# Third party invocation

• The invocation method and entry and exit parameters are the same as HTTPS, only the calling token is different

• This interface belongs to a permission set id: 142

• When a service provider is authorized by one of these permissions sets, it can useauthorizer_access_TokenCall on behalf of the merchant

# Request parameters

# Return Parameters

# Example call

# Example of request data

{
    "order_key": {
        "order_number_type": 1,
        "mchid": "fake-mchid-123",
        "out_trade_no": "fake-tradeno-20221214190427-0"
    },
    "sub_orders": [
        {
            "order_key": {
                "order_number_type": 1,
                "mchid": "fake-mchid-123",
                "out_trade_no": "fake-tradeno-20221214190427-01"
            },
            "delivery_mode": 2,
            "logistics_type": 1,
            "is_all_delivered": true,
            "shipping_list": [
                {
                    "tracking_no": "fake-trackingno-202212141904271",
                    "express_company": "YD",
                    "item_desc": " WeChat Bubble Dog Change Wallet*1",
                    "contact": {
                        "consignor_contact": "021-**34-12"
                    }
                },
                {
                    "tracking_no": "fake-trackingno-202212141904272",
                    "express_company": "DHL",
                    "item_desc": " WeChat Yellow Face Fabric Ties*1WeChat Bubble Dog Change Wallet*1",
                    "contact": {
                        "consignor_contact": "021-**34-12"
                    }
                }
            ]
        },
        {
            "order_key": {
                "order_number_type": 1,
                "mchid": "fake-mchid-321",
                "out_trade_no": "fake-tradeno-20221214190427-02"
            },
            "delivery_mode": 1,
            "logistics_type": 1,
            "shipping_list": [
                {
                    "tracking_no": "fake-trackingno-202212141904273",
                    "express_company": "YTO",
                    "item_desc": " WeChat Bubble Dog Two-Side Key Buttons*1",
                    "contact": {
                        "receiver_contact": "+86-123****4321"
                    }
                }
            ]
        }
    ],
    "upload_time": "2022-12-15T13:29:35.120+08:00",
    "payer": {
        "openid":  "ogqztkPsejM9MQAFfwCQSCi4oNg3"
    }
}

# Return data example

{
    "errcode": 0,
    "errmsg": "ok"
}

# Error code

# III. Checking the status of the order shipment

You can check the shipping status of the payment order by either the transaction number or the merchant number + merchant number.

# Note

# How to call

# HTTPS call

POST https://api.weixin.qq.com/wxa/sec/order/get_order?access_token=ACCESS_TOKEN

# Third party invocation

• The invocation method and entry and exit parameters are the same as HTTPS, only the calling token is different

• This interface belongs to a permission set id: 142

• When a service provider is authorized by one of these permissions sets, it can useauthorizer_access_TokenCall on behalf of the merchant

# Request parameters

# Return Parameters

# Example call

# Example of request data

{
    "transaction_id": "fake-transid-20221209132531-44",
    "merchant_id": "fake-mchid-123",
    "merchant_trade_no": "fake-tradeno-20221209132531-44"
}

# Return data example

{ 
    "errcode": 0,
    "errmsg": "ok",
    "order": {
        "transaction_id": "fake-transid-20221209132531-44",
        "merchant_trade_no": "fake-tradeno-20221209132531-44",
        "merchant_id": "fake-mchid-123",
        "sub_merchant_id": "",
        "description": "*1",
        "paid_amount": 916,
        "openid":  "ogqztkPsejM9MQAFfwCQSCi4oNg3",
        "trade_create_time": 1670563533,
        "pay_time": 1670563533,
        "in_complaint": false,
        "order_state": 2,
        "shipping": {
            "delivery_mode": 1,
            "logistics_type": 1,
            "finish_shipping": true,
            "finish_shipping_count": 1,
            "goods_desc": "*1",
            "shipping_list": [
                {
                    "tracking_no": "JT1234567890",
                    "express_company": "JTSD",
                    "upload_time": 1670832735
                }
            ]
        }
    }
} 

# Error code

# IV. Query Order List

You can check the order list by time of payment, payer openid or order status.

# Note

# How to call

# HTTPS call

POST https://api.weixin.qq.com/wxa/sec/order/get_order_list?access_token=ACCESS_TOKEN

# Third party invocation

• The invocation method and entry and exit parameters are the same as HTTPS, only the calling token is different

• This interface belongs to a permission set id: 142

• When a service provider is authorized by one of these permissions sets, it can useauthorizer_access_TokenCall on behalf of the merchant

# Request parameters

# Return Parameters

# Example call

# Example of request data

{
    "pay_Time_range": {
        "begin_time": 1670563531,
        "end_time": 1670563531
    },
    "page_size": 2
}

# Return data example

{
    "errcode": 0,
    "errmsg": "ok",
    "order_list": [
        {
            "transaction_id": "fake-transid-20221209132531-0",
            "merchant_trade_no": "fake-tradeno-20221209132531-0",
            "merchant_id": "fake-mchid-123",
            "sub_merchant_id": "",
            "description": "",
            "paid_amount": 4353,
            "openid":  "ogqztkPsejM9MQAFfwCQSCi4oNg3",
            "trade_create_time": 1670563531,
            "pay_time": 1670563531,
            "order_state": 1,
            "in_complaint": false,
            "shipping": {}
        },
        {
            "transaction_id": "fake-transid-20221209132531-1",
            "merchant_trade_no": "fake-tradeno-20221209132531-1",
            "merchant_id": "fake-mchid-123",
            "sub_merchant_id": "",
            "description": "",
            "paid_amount": 29767,
            "openid":  "ogqztkPsejM9MQAFfwCQSCi4oNg3",
            "trade_create_time": 1670563531,
            "pay_time": 1670563531,
            "order_state": 1,
            "in_complaint": false,
            "shipping": {}
        }
    ],
    "last_index": "092dd3cecbc6926301",
    "has_more": true
}

# Error code

# V. Confirming the shipping reminder interface

If you have learned from your courier logistics service that the user has signed up for the relevant goods, you can use this interface to remind the user to confirm the receipt in time to improve the efficiency of financial settlement. Each order can only be invoked once.

# Note

1. Specify an order by transaction number or merchant number + merchant number.
2. Reminders can only be made when the type of logistics is a logistics courier.
3. The receipt time is entered by the merchant and displayed when a reminder message is sent to the user. The receipt must be after the shipping time.

# How to call

# HTTPS call

POST https://api.weixin.qq.com/wxa/sec/order/notify_confirm_receive?access_token=ACCESS_TOKEN

# Third party invocation

• The invocation method and entry and exit parameters are the same as HTTPS, only the calling token is different

• This interface belongs to a permission set id: 142

• When a service provider is authorized by one of these permissions sets, it can useauthorizer_access_TokenCall on behalf of the merchant

# Request parameters

# Return Parameters

# Example call

# Example of request data

{
    "transaction_id": "fake-transid-20221209132531-44",
    "merchant_id": "fake-mchid-123",
    "merchant_trade_no": "fake-tradeno-20221209132531-44",
    "received_time": 1670829139
}

# Return data example

{
    "errcode": 0,
    "errmsg": "ok"
}

# Error code

# VI. Message Jump Path Settings Interface

If you already have access to the confirmation receipt component provided by the platform within the Mini Program, you can set the jump action for the shipping message and confirmation receipts message through this interface. When users click on the shipping message, they will go directly to your Mini Program order list page or details page to confirm the receipt, further optimizing the user experience.

# Note

1. If set to an empty path or a path that does not exist in your Mini Program, it will still jump to the platform's default confirmation delivery page and won't enter your Mini Program.

2. The platform will add payment orders behind the path transaction_id、merchant_id、merchant_trade_no As a query parameter, if there is a second merchant number, it will be added again sub_merchant_id Parameters, developers can get in Mini programs through onLaunch and so on.

3. If you need to carry custom query parameters in the path, be careful to distinguish from the parameters above.

# How to call

# HTTPS call

POST https://api.weixin.qq.com/wxa/sec/order/set_msg_jump_path? access_token=ACCESS_TOKEN

# Third party invocation

• The invocation method and entry and exit parameters are the same as HTTPS, only the calling token is different

• This interface belongs to a permission set id: 142

• When a service provider is authorized by one of these permissions sets, it can useauthorizer_access_TokenCall on behalf of the merchant

# Request parameters

# Return Parameters

# Example call

# Example of request data

{
    "path": "pages/order/detail"
}

# Return data example

{
    "errcode": 0,
    "errmsg": "ok"
}

# Error code

# VII. Check whether the Mini Program has activated the shipping information management service

# Features Description

Calling the interface can query whether the Mini Program account has opened the Mini Program delivery credit management service (the Mini Program has opened, you can access the delivery credit management service API for delivery management).

# Note

The service provider is licensed 18 or 142 A query can only be made when the permission set is set.

# How to call

# HTTPS call

POST https://api.weixin.qq.com/wxa/sec/order/is_trade_managed?access_token=ACCESS_TOKEN

# Request parameters

# Return Parameters

# Example call

# Example of request data

{
    "appid":  "wx0123456789abcdef"
}

# Return data example

{
    "errcode": 0,
    "errmsg": "ok",
    "is_trade_managed": true
}

# Error code

# VIII. Query whether the Mini Program has completed transaction settlement management confirmation

# Features Description

Calling this interface can query whether the Mini Program account has completed transaction settlement management confirmation (i.e., all merchant numbers associated with the Mini Program have completed order management authorization or unbundled). The merchant number that has completed the order management authorization, and the resulting orders need to be shipped through the shipping information management service.

# Note

The service provider is licensed 18 or 142 A query can only be made when the permission set is set.

# How to call

# HTTPS call

POST https://api.weixin.qq.com/wxa/sec/order/is_trade_management_confirmation_completed?access_token=ACCESS_TOKEN

# Request parameters

# Return Parameters

# Example call

# Example of request data

{
    "appid":  "wx0123456789abcdef"
}

# Return data example

{
    "errcode": 0,
    "errmsg": "ok",
    "completed": true
}

# Error code

# IX. Relevant Messaging

When a transaction or order is settlement generated, the WeChat server will receive messages and events from the developer server and third party platform parties. URL with POST Ways to push relevant events. Note that you need to be connected first WeChat App Messaging Service Only then can you receive an incident.

# Type of event

# The timing of the message push

trade_Manage_remind_access_api Events:

• When the Mini Program completes the authorization of the accounts
• When a Mini Program generates the first transaction
• A Mini Program that has generated a transaction but never shipped, once a day

trade_Manage_remind_shipping Events:

• Once shipped small packages, when the order has not been shipped for more than 48 hours

trade_Manage_order_settlement Events:

• When the order is completed and shipped
• When the order is settled

# Field Dxplaination

trade_Manage_remind_access_api Dxplaination of the event field

trade_Manage_remind_shipping Dxplaination of the event field

trade_Manage_order_settlement Dxplaination of the event field

# X. Special shipment notification

# Features Description

The interface can be invoked to make special shipment reports for undispatched orders, which are suitable for pre-sold goods orders and test orders. Orders with a shipping time limit of more than 15 days need to be reported as pre-sold goods orders. After reporting, the user will receive a notification of the estimated shipping time. After the test order is submitted, there is no need to ship, and the funds will be automatically returned to the user within a period of time.

# Note

1. Specify the order via Weixin Pay or merchant number.
2. The expected shipment time of an order for pre-sold goods must be 15 days after the time of payment of the order and must not exceed 330 days.

# How to call

# HTTPS call

POST https://api.weixin.qq.com/wxa/sec/order/opspecialorder?access_token=ACCESS_TOKEN

# Third party invocation

• The invocation method and entry and exit parameters are the same as HTTPS, only the calling token is different

• This interface belongs to a permission set id: 142

• When a service provider is authorized by one of these permissions sets, it can useauthorizer_access_TokenCall on behalf of the merchant

# Request parameters

# Return Parameters

# Example call

# Example of request data

{
    "order_id": "123456",
    "type": 1,
    "delay_to": 1752035828
}

# Return data example

{
    "errcode": 0,
    "errmsg": "ok"
}

# Error code