Shop Builder API (2.0.0)
- Version: 2.0.0
- Servers:
https://store.xsolla.com/api - Contact Us by Email
- Contact URL: https://xsolla.com/
- Required TLS version: 1.2
Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.
개인 맞춤형 카탈로그
이 API를 사용하여 사용자 특성에 대한 규칙을 지정할 수 있습니다. 사용자가 구체적인 규칙에 대한 모든 조건을 충족하면 개인 맞춤형 아이템이 표시됩니다.
개인 맞춤형 프로모션에 대한 내용은 프로모션 섹션을 참조하십시오.
구매 전에 특성을 전달하려면 엑솔라 로그인 API를 사용하거나 페이 스테이션 API를 사용하여 토큰을 생성하는 동안 user.attributes 특성으로 특성을 전달할 수 있습니다.
사용자 특성 검증 조건. 사용자 특성이 지정된 모든 조건과 일치하는지 여부에 따라 프로모션의 가용성을 결정합니다.
이 프로모션을 적용할 때 제외할 프로모션 ID 목록입니다.
Example: [12, 789]
고유 프로모션 ID입니다. external_id는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.
장바구니의 특정 아이템에 프로모션을 적용하기 위한 가격 범위를 설정하는 조건을 가진 개체 배열입니다.
사용자 장바구니에 있는 각 아이템의 가격은 조건에 지정된 가격 범위와 비교됩니다.보너스 및 할인은 가격이 조건을 충족하는 장바구니에 있는 아이템에만 적용됩니다.
이 배열을 전달하면 discounted_items 배열의 값이 null로 설정됩니다.
프로모션의 이름입니다. 키가 "^[a-z]{2}-[A-Z]{2}$" 형식의 로케일인 키/값 쌍을 포함해야 하며 값은 문자열입니다.
프로모션을 전체 카트에 적용하기 위한 가격 범위를 설정하는 조건을 가진 개체 배열입니다.
사용자 장바구니에 있는 모든 아이템의 총 가격을 조건에 지정된 가격 범위와 비교합니다.보너스 및 할인은 장바구니의 가격이 지정된 조건을 충족할 경우 장바구니의 모든 아이템에 적용됩니다.
이 배열을 전달할 경우 discounted_items 배열의 값이 null로 설정됩니다.
프로모션의 유효 기간. 기간이 여러 개 지정된 경우 date_from와 date_until가 모두 필요합니다.
- Mock serverhttps://xsolla.redocly.app/_mock/ko/api/shop-builder/v3/project/{project_id}/admin/promocode
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promocode
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/ko/api/shop-builder/v3/project/44056/admin/promocode \
-H 'Content-Type: application/json' \
-d '{
"attribute_conditions": [
{
"attribute": "account_status",
"can_be_missing": false,
"operator": "eq",
"type": "string",
"value": "golden"
}
],
"discount": {
"percent": "10.10"
},
"external_id": "coupon_external_id",
"name": {
"de-DE": "Neujahrsrabatt",
"en-US": "New Year Discount"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"redeem_code_limit": 1,
"redeem_total_limit": 100,
"redeem_user_limit": 1
}'{ "external_id": "coupon_external_id" }
요청
프로모션 코드 프로모션을 삭제합니다. 삭제된 프로모션:
- 프로젝트에 설정된 프로모션 목록에서 사라집니다.
- 아이템 카탈로그 및 장바구니에는 더 이상 적용되지 않습니다. 사용자는 이 프로모션을 사용하여 보너스 아이템을 얻거나 아이템을 구매할 수 없습니다.
삭제한 후에는 프로모션을 복원할 수 없습니다. 삭제된 프로모션의 프로모션 코드는 기존 프로모션에 추가할 수 있습니다.
- Mock serverhttps://xsolla.redocly.app/_mock/ko/api/shop-builder/v3/project/{project_id}/admin/promocode/{external_id}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promocode/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/ko/api/shop-builder/v3/project/44056/admin/promocode/coupon_44056_1- Mock serverhttps://xsolla.redocly.app/_mock/ko/api/shop-builder/v3/project/{project_id}/admin/promocode/{external_id}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promocode/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/ko/api/shop-builder/v3/project/44056/admin/promocode/coupon_44056_1프로모션 코드를 성공적으로 수신했습니다.
사용자 특성 검증 조건. 사용자 특성이 지정된 모든 조건과 일치하는지 여부에 따라 프로모션의 가용성을 결정합니다.
이 프로모션을 적용할 때 제외할 프로모션 ID 목록입니다.
Example: [12, 789]
고유 프로모션 ID입니다. external_id는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.
장바구니의 특정 아이템에 프로모션을 적용하기 위한 가격 범위를 설정하는 조건을 가진 개체 배열입니다.
사용자 장바구니에 있는 각 아이템의 가격은 조건에 지정된 가격 범위와 비교됩니다.보너스 및 할인은 가격이 조건을 충족하는 장바구니에 있는 아이템에만 적용됩니다.
이 배열을 전달하면 discounted_items 배열의 값이 null로 설정됩니다.
프로모션의 이름입니다. 키가 "^[a-z]{2}-[A-Z]{2}$" 형식의 로케일인 키/값 쌍을 포함해야 하며 값은 문자열입니다.
프로모션을 전체 카트에 적용하기 위한 가격 범위를 설정하는 조건을 가진 개체 배열입니다.
사용자 장바구니에 있는 모든 아이템의 총 가격을 조건에 지정된 가격 범위와 비교합니다.보너스 및 할인은 장바구니의 가격이 지정된 조건을 충족할 경우 장바구니의 모든 아이템에 적용됩니다.
이 배열을 전달할 경우 discounted_items 배열의 값이 null로 설정됩니다.
프로모션의 유효 기간. 기간이 여러 개 지정된 경우 date_from와 date_until가 모두 필요합니다.
단일 사용자가 사용한 총 쿠폰 수를 제한합니다.
{ "bonus": [ { … } ], "discount": { "percent": "10.99" }, "discounted_items": null, "excluded_promotions": [ 23, 45 ], "external_id": "summer20221", "is_enabled": true, "name": { "en-US": "Coupon name", "ru-RU": "Название купона" }, "promotion_periods": [ { … }, { … } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": null, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } }