# Promote data interfaces

# I. Generating promotional materials

# Interface Dxplaination

By docking the interface, the promoter can promote the bound business in the following two ways: A) Weixin Mini Program card: After entering the Mini Program, directly forward the product / activity page to the single chat / group chat, and promote it in the form of Mini Program card; B) Weixin Mini Program material: Forwarding the Mini Program code, tag and other Mini Program material generated through the platform link interface, and promoting it in the form of Mini Program pictures / link material. Note: Promotional material is valid for 30 days. Please re-access the material after it has expired.

# Request address

POST https://api.weixin.qq.com/promoter/getsharematerial?access_token=ACCESS_TOKEN

# Request parameters

Note 1: Only if the merchant has declared it and the promoter has authorized can you generate shared material, otherwise you will return 10306 (data does not exist). NOTE 2: The sharing of the material is valid for 30 days. Please re-access the material when it expires. Note 3: Only the short chain (share_type = 1) supports jumping to the development / experience version.

# Example Requests

{
  "path": "xxxxx",
  "openid": "xxxxx",
  "extra_info": "xxxxx",
  "title": "xxxxx",
  "share_type": 0,
  "env_version": "trial"
}

# Return value

# Return data example

{
  "share_path": "xxxxx",
  "qrcode": "xxxxx",
  "tag": "xxxxx",
  "errcode": 0,
  "errmsg": "OK"
}

# II. Analysis of the effects of touch

# Interface Dxplaination

Through the interface, a merchant can query the status of access users brought by a particular promoter at a specific time.

# Request address

POST https://api.weixin.qq.com/promoter/getrelation?access_token=ACCESS_TOKEN

# Request parameters

# Example Requests

{
  "openid": "xxxxx",
  "begin_time": 1668614400,
  "end_time": 1668666429,
  "scene": 1077,
  "path": "pages/xxxxx",
  "start_id": "123",
  "need_unionid": 1
}

# Return value

Note: When paging is required, insert the return start_id into the request. If total_cnt is less than 1000 or the return is empty (error code: 103006, data does not exist), the data pull is complete.

# Return data example

{
  "relation_list":
  [
    {
      "promoter_openid": "xxxxx",
      "role_id": 1,
      "retail_id": "xxxxx",
      "extra_info": "xxxxx",
      "openid": "xxxxx",
      "create_time": 1668667349,
      "path": "pages/xxxxx",
      "scene": 1077,
      "share_extra_info": "xxxxx"
    },
    {
      "promoter_openid": "xxxxx",
      "role_id": 1,
      "retail_id": "xxxxx",
      "extra_info": "xxxxx",
      "openid": "xxxxx",
      "create_time": 1668667349,
      "path": "pages/xxxxx",
      "scene": 1077,
      "share_extra_info": "xxxxx"
    }
  ],
  "total_cnt": 2,
  "start_id": "2",
  "errcode": 0,
  "errmsg": "OK"
}

# III. Enquire about promotional orders

# Interface Dxplaination

The order queried by this interface will be attributed to the promotion member who reached the user last before the order was generated (reached: the user entered Weixin Mini Program through the promotion material),If a merchant has other requirements (such as orders should be attributed to the promoter that the user is associated with, regardless of the order of communication between the promoter and the user), they can consider attributing promotional orders based on the promotional effect of the promoter on the user (refer to Section II) and combine it with their own order data.

# Request address

POST https://api.weixin.qq.com/promoter/getorder?access_token=ACCESS_TOKEN

# Request parameters

# Example Requests

{
  "openid": "xxxxx",
  "mch_id": "xxxxx",
  "trade_no": "xxxxx",
  "out_trade_no": "xxxxx",
  "status": 1,
  "start_id": "123",
  "need_unionid": 1
}

# Return value

Note: When paging is required, insert the return start_id into the request. If total_cnt is less than 1000 or the return is empty (error code: 103006, data does not exist), the data pull is complete.

# Return data example

{
  "order_list":
  [
    {
      "promoter_openid": "xxxxx",
      "role_id": 1,
      "retail_id": "xxxxx",
      "extra_info": "xxxxx",
      "openid": "xxxxx",
      "create_time": 1668667349,
      "path": "pages/xxxxx",
      "scene": 1077,
      "share_extra_info": "xxxxx",
      "mch_id": "xxxxx",
      "trade_no": "xxxxx",
      "out_trade_no": "xxxxx",
      "status": 1,
      "paid_amount": 150,
      "paid_time": 1668667360
    },
    {
      "promoter_openid": "xxxxx",
      "role_id": 1,
      "retail_id": "xxxxx",
      "extra_info": "xxxxx",
      "openid": "xxxxx",
      "create_time": 1668667349,
      "path": "pages/xxxxx",
      "scene": 1077,
      "share_extra_info": "xxxxx",
      "mch_id": "xxxxx",
      "trade_no": "xxxxx",
      "out_trade_no": "xxxxx",
      "status": 2,
      "paid_amount": 150,
      "paid_time": 1668667360,
      "paid_time": 1668668000
    }
  ],
  "total_cnt": 2,
  "start_id": "2",
  "errcode": 0,
  "errmsg": "OK"
}