创建优惠链

Xsolla Developers

或

前往发布商帐户

创建优惠链Server-sideAdmin

post/v2/project/{project_id}/admin/offer_chain

创建优惠链。

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

项目ID。您可以在您的发布商帐户项目名称旁边找到。

Example: 44056

Request Body schema: application/json

required

(two-letter (object or null)) or (five-letter (object or null))

包含商品本地化名称的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，en）或五个字符的语言代码（例如，en-US）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：en和en-US），将存储最后提供的值。您可以在文档中找到支持语言的完整列表。

One of:

两个小写字母的语言代码。

ar	string or null 阿拉伯语
bg	string or null 保加利亚语
cn	string or null 中文（简体）
cs	string or null 捷克语
de	string or null 德语
en	string or null 英语
es	string or null 西班牙语（西班牙）
fr	string or null 法语
he	string or null 希伯来语
id	string or null 印度尼西亚语
it	string or null 意大利语
ja	string or null 日语
km	string or null 高棉语
ko	string or null 韩语
lo	string or null 老挝语
my	string or null 缅甸语
ne	string or null 尼泊尔语
ph	string or null 菲律宾语
pl	string or null 波兰语
pt	string or null 葡萄牙语
ro	string or null 罗马尼亚语
ru	string or null 俄语
th	string or null 泰语
tr	string or null 土耳其语
tw	string or null 中文（繁体）
vi	string or null 越南语

date_start

required

string <date-time>

优惠链开始日期。

required

Array of objects

Array

step_number

required

integer >= 1

步骤编号。

is_free

required

boolean

是否为免费步骤：

如为true，需通过领取免费优惠链步骤调用来领取。
如为false，需通过为付费优惠链步骤创建订单调用来购买。

required

Array of objects non-empty

Array (non-empty)

sku required	string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\-–.]*$ 唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。
quantity required	integer >= 1 此步骤的奖励品数量。
order	integer or null >= 0 优惠链步骤奖励顺序。

is_enabled

required

boolean

date_end

string or null <date-time>

优惠链结束日期。可为null，若date_end为null则无时间限制。

(two-letter (object or null)) or (five-letter (object or null))

包含本地化商品描述的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，en）或五个字符的区域设置代码（例如，en-US）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：en和en-US），将存储最后提供的值。您可以在文档中找到支持语言的完整列表。

One of:

两个小写字母的语言代码。

ar	string or null 阿拉伯语
bg	string or null 保加利亚语
cn	string or null 中文（简体）
cs	string or null 捷克语
de	string or null 德语
en	string or null 英语
es	string or null 西班牙语（西班牙）
fr	string or null 法语
he	string or null 希伯来语
id	string or null 印度尼西亚语
it	string or null 意大利语
ja	string or null 日语
km	string or null 高棉语
ko	string or null 韩语
lo	string or null 老挝语
my	string or null 缅甸语
ne	string or null 尼泊尔语
ph	string or null 菲律宾语
pl	string or null 波兰语
pt	string or null 葡萄牙语
ro	string or null 罗马尼亚语
ru	string or null 俄语
th	string or null 泰语
tr	string or null 土耳其语
tw	string or null 中文（繁体）
vi	string or null 越南语

order

integer

定义排列顺序。

(interval_type = weekly (object or null)) or (interval_type = monthly (object or null))

优惠链的重置周期。

One of:

每周重置优惠链。

interval_type required	string 优惠链重置频率。 Value: "weekly"
time required	string((0[0-9]\|1[0-9]\|2[0-3]):00:00)(\+\|-)(0[0-9]\|1... 用指定时区重置奖励链的时间（四舍五入到小时）。例如：吉隆坡时区（GMT+8）重置时间为01:00，则`time`参数值为`01:00:00+08:00`。
day_of_week required	integer [ 1 .. 7 ] 每周优惠链重置日，`1`为周一，`7`为周日。

Responses

201

优惠链创建成功。

401

基本认证未通过或错误。确保您使用了基本认证或正确的凭据。

422

优惠链配置无效。

Request samples

application/json

{"date_end": null,
"date_start": "2023-04-15T18:16:00+05:00",
"description": {"en": "New offer chain short description"
},
"is_enabled": true,
"name": {"en": "New offer chain",
"ru": "Новая цепочка товаров"
},
"order": 4,
"recurrent_schedule": null,
"steps": [{"is_free": false,
"items": [{"quantity": 2,
"sku": "vg_enabled_shown_in_store_1"
}
],
"step_number": 1
},
{"is_free": false,
"items": [{"quantity": 2,
"sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg"
}
],
"step_number": 2
},
{"is_free": false,
"items": [{"quantity": 2,
"sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1"
}
],
"step_number": 3
},
{"is_free": true,
"items": [{"quantity": 1,
"sku": "vg_enabled_shown_in_store_1"
}
],
"step_number": 4
},
{"is_free": true,
"items": [{"quantity": 1,
"sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg"
}
],
"step_number": 5
},
{"is_free": true,
"items": [{"quantity": 1,
"sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1"
}
],
"step_number": 6
}
]
}

Response samples

application/json

{"offer_chain_id": 10
}