# Upload Shopping Details

Interface should be called on the server side, seeHattori API。

# Interface Dxplaination

# Interface name

uploadShoppingInfo

# Functional description

Call this interface to upload order information
This interface is used for merchants to access shopping order business. After the merchant is connected, it helps the user to view the/Manage orders within WeChat, track order progress, obtain after-sales service, etc. Users can follow up from WeChatI-service-Wallet-billYou can also backtrack the purchase order by entering the billing details page from the payment voucher message.
Specific service introduction and complete access guide can be found at Shopping Order。

# Note

According to the specified order number type, use different parameters to upload the order information to the specified order.
- In the form of merchant side order number (enumerating value 1), an order is determined by placing single merchant number and merchant side order number.
- WeChat Pay order number (enumerating value 2), through WeChat Pay order number to determine an order
When the merchant transaction order details page link type is a Mini Program, appid needs to be appid that calls api, if it is called by a third party, appid that is uploaded by the third party on behalf of the merchant
The appid and path of the link are required when the link type is Mini Program (enum value 1), and the URL is required when the link type is url (enum value 2)
Upload time, used to identify the order of the request, if you want to update the order information, upload time must be updated than the previous request, please fill in the Rfc3399 format
You cannot modify the order information after the order payment has been completed.
Logistics form Fill in the form of delivery according to your own logistics form
- Physical logistics distribution (enumeration value 1), using courier companies to carry out physical logistics distribution form
- City Distribution (Enumeration Value 2)
- Virtual goods (enumeration value 3), virtual goods, such as phone recharge, point cards, etc., no physical distribution form

# Calling mode

# HTTPS call


POST https://api.weixin.qq.com/user-order/orders?access_token=ACCESS_TOKEN

# Third Party Invocation

The calling method and parameters are the same as HTTPS, only the calling token is different
The permission set to which this interface belongs is: 120, 121
After the service provider has been authorized with one of the permission sets, it can do so by usingauthorizer_access_TokenCalling on behalf of the merchant

# Request parameters

attribute

type

Required

Introductions

access_Token

string

yes

Interface invokes the certificate, which is URL Parameters, non Body Parameters. usegetAccessToken or authorizer_access_Token

order_key

object

yes

Order, need to upload the purchase details of the order, according to the order type of two to choose one

attribute	type	Required	Introductions
order_number_type	number	no	Order Number type, used to confirm orders requiring details to be uploaded
transaction_id	string	no	WeChat order number corresponding to the original payment transaction
mchid	string	no	The merchant number of the payment merchant is generated and issued by WeChat Pay.
out_trade_no	string	no	The internal order number of the merchant system can only be numbers, upper and lower letters_-*Only in the same shop.

order_list

array

List of Shopping Details

attribute

type

Required

Introductions

merchant_order_no

string

yes

Merchant Transaction Order Number, the order number displayed to the user by the Transaction Order Details page on the merchant side

初始值 232457563423 Character byte limit: [1, 64]

order_detail_jump_link

object

yes

The merchant transaction order details page link, the user view "mall order", jump to the merchant side to view the transaction order details page link. The details page category can be H5 or Mini Program

attribute	type	Required	Introductions
url	string	no	Link Address (required when link type is H5) Example value: https://www.WeChat.qq.com/wxpay/pay.php Character byte limit: [1, 1024] Regular expressions: https?😕/([s/?#[]@]+@)?([s/?#@:]+)(?::d{2,5})?([[]]*)$
appid	string	no	Appid (required when link type is MINIAPP) Example value: wxd678efh567hg6787 Character byte limit: [初始值 32]
path	string	no	Path (required when link type is MINIAPP) Example value: /path/index/index Character byte limit: [1, 512]
type	number	yes	Link type enumeration value: 1, URL2、MINI_PROGRAM Example value: MINI_PROGRAM

item_list

array<object&gt

List of items purchased by the order, a list of all items purchased by the user in the order, up to 50 items can be uploaded

Multiplicity: [1, 50]

attribute	type	Required	Introductions
merchant_item_id	string	no	The merchant side product ID, the internal product code of the merchant system, is used to identify different commodities. Please note that when shipping mode selects "Split Shipping," you need to use the merchant side item ID to mark the specific items included in each logistic order. Example value: 1246464644 Character byte limit: [1, 64]
name	string	yes	Name of product Example value: iPhoneX 256G Character length limit: [1, 256]
description	string	no	Product description Example value: Image Store - Shenzhen Teng Da - QQ doll Character length limit: [1, 512]
unit_price	number	yes	Unit price of product (unit: cent) Example value: 828800
quantity	number	yes	Number of purchases 初始值 2
image_url	array<初始值	no	Product Image Links Example value: https://qpic. cn/xxx Multiplicity: [1, 3] Character byte limit: [1, 1024] Regular expressions: https?😕/([s/?#[]@]+@)?([s/?#@:]+)(?::d{2,5})?([[]]*)$

pay

object

yes

Payer, payer information

	attribute	type	Required	Introductions
	openid	string	yes	User ID, the user's unique identification under merchant appid. You need to get the user's Openid before placing an order Example value: oUpF8uMuAJO_M2pxb1Q9zNjWeS6o Character byte limit: [1, 128]

logistics_type

number

Form of logistics, the form of logistics for the distribution of ordered goods, defaults to physical logistics

upload_time

string

yes

Upload time, used to identify the order of requests

Example value: 2022-05-20T13:29:35.120+08:00

# Return parameters

attribute	type	Introductions
errcode	number	Error code
errmsg	string	Wrong reasons

# Call Example

Example Dxplaination: JS Fetch API

# Sample Request Data


// Assemble URL
let url = `https://api.weixin.qq.com/user-order/orders`


// Json Package
let jsonBody = {}
jsonBody["order_key"] = {
   "order_number_type": "WXPAY_TRADE_NUMBER",
   "transaction_id": "0unu3"
   "mchid": "idgsc",
   "out_trade_no": "e8zef"
}
jsonBody["order_list"] = [
   {
      "merchant_order_no": "232457563423",
      "order_detail_jump_link": {
         "url": "https://www.WeChat.qq.com/wxpay/pay.php",
         "appid": "wxd678efh567hg6787",
         "path": "/path/index/index",
         "type": "MINI_PROGRAM"
      },
      "item_list": [
         {
            "merchant_item_id": "1246464644",
            "name": "iPhoneX 256G " ,
            "description": "Image Store - Shenzhen Teng Da - QQ doll,"
            "unit_price": 828800,
            "quantity": 2,
            "image_url": [
               "https://qpic. cn/xxx,
               "https://qpic. cn/xxx,
               "https://qpic. cn/xxx"
            ],
            "item_detail_jump_link": {
               "url": "https://www.WeChat.qq.com/wxpay/pay.php",
               "appid": "wxd678efh567hg6787",
               "path": "/path/index/index",
               "type": "URL"
            }
         },
         {
            "merchant_item_id": "1246464644",
            "name": "iPhoneX 256G " ,
            "description": "Image Store - Shenzhen Teng Da - QQ doll,"
            "unit_price": 828800,
            "quantity": 2,
            "image_url": [
               "https://qpic. cn/xxx,
               "https://qpic. cn/xxx"
            ],
            "item_detail_jump_link": {
               "url": "https://www.WeChat.qq.com/wxpay/pay.php",
               "appid": "wxd678efh567hg6787",
               "path": "/path/index/index",
               "type": "MINI_PROGRAM"
            }
         },
         {
            "merchant_item_id": "1246464644",
            "name": "iPhoneX 256G " ,
            "description": "Image Store - Shenzhen Teng Da - QQ doll,"
            "unit_price": 828800,
            "quantity": 2,
            "image_url": [
               "https://qpic. cn/xxx,
               "https://qpic. cn/xxx,
               "https://qpic. cn/xxx"
            ],
            "item_detail_jump_link": {
               "url": "https://www.WeChat.qq.com/wxpay/pay.php",
               "appid": "wxd678efh567hg6787",
               "path": "/path/index/index",
               "type": "URL"
            }
         }
      ]
   },
   {
      "merchant_order_no": "232457563423",
      "order_detail_jump_link": {
         "url": "https://www.WeChat.qq.com/wxpay/pay.php",
         初始值 "wxd678efh567hg6787",
         "path": "/path/index/index",
         "type": "URL"
      },
      "item_list": [
         {
            "merchant_item_id": "1246464644",
            "name": "iPhoneX 256G " ,
            "description": "Image Store - Shenzhen Teng Da - QQ doll,"
            "unit_price": 828800,
            "quantity": 2,
            "image_url": [
               "https://qpic. cn/xxx,
               "https://qpic. cn/xxx"
            ],
            "item_detail_jump_link": {
               "url": "https://www.WeChat.qq.com/wxpay/pay.php",
               "appid": "wxd678efh567hg6787",
               "path": "/path/index/index",
               "type": "URL"
            }
         },
         {
            "merchant_item_id": "1246464644",
            "name": "iPhoneX 256G " ,
            "description": "Image Store - Shenzhen Teng Da - QQ doll,"
            "unit_price": 828800,
            "quantity": 2,
            "image_url": [
               "https://qpic. cn/xxx,
               "https://qpic. cn/xxx,
               "https://qpic. cn/xxx"
            ],
            "item_detail_jump_link": {
               "url": "https://www.WeChat.qq.com/wxpay/pay.php",
               "appid": "wxd678efh567hg6787",
               "path": "/path/index/index",
               "type": "URL"
            }
         }
      ]
   },
   {
      "merchant_order_no": "232457563423",
      "order_detail_jump_link": {
         "url": "https://www.WeChat.qq.com/wxpay/pay.php",
         "appid": "wxd678efh567hg6787",
         "path": "/path/index/index",
         "type": "MINI_PROGRAM"
      },
      "item_list": [
         {
            "merchant_item_id": "1246464644",
            "name": "iPhoneX 256G " ,
            "description": "Image Store - Shenzhen Teng Da - QQ doll,"
            "unit_price": 828800,
            "quantity": 2,
            "image_url": [
               "https://qpic. cn/xxx,
               初始值//qpic. cn/xxx,
               "https://qpic. cn/xxx"
            ],
            "item_detail_jump_link": {
               "url": "https://www.WeChat.qq.com/wxpay/pay.php",
               "appid": "wxd678efh567hg6787",
               "path": "/path/index/index",
               "type": "URL"
            }
         },
         {
            "merchant_item_id": "1246464644",
            "name": "iPhoneX 256G " ,
            "description": "Image Store - Shenzhen Teng Da - QQ doll,"
            "unit_price": 828800,
            初始值 2,
            "image_url": [
               "https://qpic. cn/xxx,
               "https://qpic. cn/xxx"
            ],
            "item_detail_jump_link": {
               "url": "https://www.WeChat.qq.com/wxpay/pay.php",
               "appid": "wxd678efh567hg6787",
               "path": "/path/index/index",
               "type": "MINI_PROGRAM"
            }
         },
         {
            "merchant_item_id": "1246464644",
            "name": "iPhoneX 256G " ,
            "description": "Image Store - Shenzhen Teng Da - QQ doll,"
            "unit_price": 828800,
            "quantity": 2,
            "image_url": [
               "https://qpic. cn/xxx,
               "https://qpic. cn/xxx"
            ],
            "item_detail_jump_link": {
               "url": "https://www.WeChat.qq.com/wxpay/pay.php",
               "appid": "wxd678efh567hg6787",
               "path": "/path/index/index",
               "type": "MINI_PROGRAM"
            }
         }
      ]
   }
]
jsonBody["pay"] = {
   "opens": "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o"
}
jsonBody["logistics_type"] = "LOCATION_BASED_LOGISTICS"
jsonBody["upload_time"] = "2022-05-20T13:29:35.120 08:00"

// Set the header
let headers = {"Content-Type": "application/json"}


// Send Request
fetch(url, {
  body: JSON.stringify(jsonBody),
  headers: headers,
  method: "POST"
})
  .then(response => response.json())
  .then(response => console.log("Success:", JSON.stringify(response)))
  . catch(error => console.error("Error:", error))

# Return Data Example


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

# Error code

Error code	Error code	Solutions
-1	system error	The system is busy, please wait for the developer to try again
268435461	Parameter error	Modify the parameters according to the description of the cause of the error
268485191	Shopping details list cannot be empty	At least one shopping detail is required in the list of shopping details
268485192	User ID openid is empty	User ID openid must be filled in
268485193	Illegal forms of transportation	Set this field by enumeration in the form of logistics in the document
268485214	Upload time must be set	Upload time must be filled in
268485216	Upload time is illegal, please fill in Rfc3399 format	Upload time must meet the Rfc3399 format, such as 2021-05-20 T13: 29: 35.120 + 08: 00
268485195	WeChat payment in the form of transaction_The id field must be set	WeChat payment in the form of transaction_The id field must be set
268485196	The mchid field in the form of merchant side order number must be set	The mchid field in the form of merchant side order number must be set
268485197	Merchant side single number form out_trade_The no field must be set	Out in the form of merchant side single number_trade_The no field must be set
268485194	Order Number Type Illegal	Fill in the field as enumerated by the order type in the document
268485201	Merchant Transaction Order Number Empty	Merchant side order form under the merchant transaction order form must be completed
268485204	Appid cannot be empty when link type is Mini Program	Link type is Mini Program must be set appid
268485205	Path cannot be empty when link type is Mini Program	Link type is Mini Program must set path
268485206	When the link type is a URL, you need to set the url	The link type is URL The url must be set
268485211	The list of items purchased in an order cannot be empty	The list of items purchased in an order cannot be empty
268485207	Product name cannot be empty	Product name must be filled in
268485208	Unit price cannot be empty	Unit price of goods must be filled in
268485209	Purchase quantity cannot be empty	Purchase quantity must be completed
268485210	The link cannot be empty.	Product image link Fill in at least one
268485272	The link cannot be empty.	Product Details Link Must Be Set
268485202	Link Type Illegal	Link type must be Mini Program or URL
268486029	When the link type is a Mini Program, the link appid must be consistent with the shopping details attributed to the merchant appid	When the link type is a Mini Program, the link appid is filled in as the merchant appid
268459788	The jump type of the order detail page and the product detail page should be consistent	Order Details Page and Item Details Page Jump Type The jump type filled in the same
268459789	Order detail page and product detail page appid need to be consistent	Order Detail Page and Item Detail Page appid Settings
268486047	Product ID cannot be repeated in the same internal order	The product id is not repeated in the same internal order
268459786	Internal Order Number Repeat	The internal order number of the merchant needs to be different
268485184	No Shopping Order Product Permissions	No shopping order product permission, please apply for shopping order product permission before calling
268456389	Appid non-Mini Program type	When the link type is specified as an Mini Program, the link appid set needs to be of the Mini Program type