Get Batch Child Codes List

Get list of child codes for a specific batch template

GET /merchant/discount/batch/children/list

Get Batch Child Codes List

cURL

curl --request GET \
  --url https://api.unibee.dev/merchant/discount/batch/children/list \
  --header 'Authorization: Bearer <token>'

200

{
  "code": 123,
  "data": {
    "children": [
      {
        "advance": true,
        "billingType": 123,
        "childCodeCount": 123,
        "code": "<string>",
        "codePrefix": "<string>",
        "createTime": 123,
        "currency": "<string>",
        "cycleLimit": 123,
        "discountAmount": 123,
        "discountPercentage": 123,
        "discountType": 123,
        "endTime": 123,
        "id": 123,
        "invoiceId": "<string>",
        "isDeleted": 123,
        "isRedeemed": true,
        "merchantId": 123,
        "metadata": {},
        "name": "<string>",
        "parentTemplateCode": "<string>",
        "paymentId": "<string>",
        "planApplyGroup": {
          "currency": [
            "<string>"
          ],
          "groupPlanIntervalSelector": [
            {
              "intervalCount": 123,
              "intervalUnit": "<string>"
            }
          ],
          "type": [
            123
          ]
        },
        "planApplyType": 123,
        "planId": 123,
        "planIds": [
          123
        ],
        "planName": "<string>",
        "quantity": 123,
        "redeemedAt": 123,
        "redeemedByEmail": "<string>",
        "startTime": 123,
        "status": 123,
        "subscriptionId": "<string>",
        "type": 123,
        "upgradeLongerOnly": true,
        "upgradeOnly": true,
        "usedChildCodeCount": 123,
        "userLimit": 123,
        "userScope": 123
      }
    ],
    "total": 123
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

GET https://api.unibee.dev/merchant/discount/batch/children/list

Get list of child codes for a specific batch template

---

Authorization

All UniBee Merchant API requests require authentication via API key.

Header	Required	Description
Authorization	Yes	Bearer <your_api_key>
Content-Type	Yes	application/json (for request body)

---

Parameters

Parameters for this endpoint are listed below. The schema is also shown in the Try it panel.

Query parameters

Name	Type	Required	Description
templateId	integer	Yes	The template’s Id
code	string	No	Filter by child code, fuzzy search
sortField	string	No	Sort field, gmt_create|gmt_modify, default gmt_create
sortType	string	No	Sort type, asc|desc, default desc
page	integer	No	Page number, start from 0
count	integer	No	Count per page
createTimeStart	integer	No	Filter by create time start, UTC timestamp in seconds
createTimeEnd	integer	No	Filter by create time end, UTC timestamp in seconds

---

Request examples

cURL

curl -X GET "https://api.unibee.dev/merchant/discount/batch/children/list" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Sandbox

curl -X GET "https://api-sandbox.unibee.top/merchant/discount/batch/children/list" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json"

---

Response

Success responses return a JSON envelope with code, data, message, redirect, and requestId. code 0 indicates success.

Field	Type	Description
code	integer	Response code. 0 = success
data	object	Response payload
data.children	array	Child code list
data.total	integer	Total count
message	string	Human-readable message
requestId	string	Request ID for support

---

Error handling

HTTP status	Meaning
400	Bad request — invalid or missing parameters. Check message in the body.
401	Unauthorized — missing or invalid API key.
404	Not found — invalid path or resource.
500	Server error — retry with backoff.

When code in the response body is non-zero, check message for details. Use requestId when contacting support.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

templateId · integer<int64> · required

The template's Id

code · string<string>

Filter by child code, fuzzy search

sortField · string<string>

Sort field, gmt_create|gmt_modify, default gmt_create

sortType · string<string>

Sort type, asc|desc, default desc

page · integer<int>

Page number, start from 0

count · integer<int>

Count per page

createTimeStart · integer<int64>

Filter by create time start, UTC timestamp in seconds

createTimeEnd · integer<int64>

Filter by create time end, UTC timestamp in seconds

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>