콘텐츠로 건너뛰기
/
쿠폰 프로모션 생성하기

Shop Builder API (2.0.0)

Overview

  • 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.

OpenAPI 설명 다운로드
index.json
index.yaml
언어
서버
Mock server
https://xsolla.redocly.app/_mock/ko/api/shop-builder/
https://store.xsolla.com/api/

관리자

작업

개인 맞춤형 카탈로그

이 API를 사용하여 사용자 특성에 대한 규칙을 지정할 수 있습니다. 사용자가 구체적인 규칙에 대한 모든 조건을 충족하면 개인 맞춤형 아이템이 표시됩니다.

개인 맞춤형 프로모션에 대한 내용은 프로모션 섹션을 참조하십시오.

구매 전에 특성을 전달하려면 엑솔라 로그인 API를 사용하거나 페이 스테이션 API를 사용하여 토큰을 생성하는 동안 user.attributes 특성으로 특성을 전달할 수 있습니다.

작업

관리자

작업

카탈로그

작업

장바구니(클라이언트 측)

작업

장바구니(서버 측)

작업

결제(클라이언트 측)

작업

결제(서버 측)

작업

주문

작업

무료 아이템

작업

웹훅

작업

선주문

작업

판매자

작업

카탈로그

이 API를 사용하면 모든 종류의 판매할 수 있는 아이템 또는 특정 아이템을 가져올 수 있습니다.

작업

공통 지역

작업

카탈로그

작업

권한

작업

관리자

작업

일반

작업

쿠폰

이 API를 사용하여 쿠폰을 관리할 수 있습니다.

작업

쿠폰 프로모션 목록 가져오기Server-sideAdmin

요청

프로젝트의 쿠폰 프로모션 목록을 가져옵니다.

보안
basicAuth
경로
project_idinteger필수

프로젝트 ID입니다. 이 매개 변수는 관리자 페이지의 프로젝트 이름 옆에서 확인할 수 있습니다.

예제: 44056
쿼리
limitinteger>= 1

페이지 요소 개수 제한입니다.

예제: limit=50
offsetinteger>= 0

목록이 생성된 요소의 개수입니다(개수는 0부터 시작함).

예제: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/shop-builder/v3/project/44056/admin/coupon?limit=50&offset=0'

응답

쿠폰 목록을 성공적으로 수신했습니다.

본문application/json
active_promotions_countinteger(active_promotions_count)

활성 프로모션의 수입니다.

inactive_promotions_countinteger(inactive_promotions_count)

비활성 프로모션의 수입니다.

itemsArray of objects(admin-promotions_200-get-coupon-promotion-model)
total_promotions_countinteger(total_promotions_count)

총 프로모션 개수입니다.

응답
application/json
{
  "active_promotions_count": 2,
  "inactive_promotions_count": 0,
  "items": [
    { … },
    { … }
  ],
  "total_promotions_count": 2
}

쿠폰 프로모션 생성하기Server-sideAdmin

요청

쿠폰 프로모션을 생성합니다.

보안
basicAuth
경로
project_idinteger필수

프로젝트 ID입니다. 이 매개 변수는 관리자 페이지의 프로젝트 이름 옆에서 확인할 수 있습니다.

예제: 44056
본문application/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-post)[ 1 .. 100 ] items

사용자 특성 검증 조건. 사용자 특성이 지정된 모든 조건과 일치하는지 여부에 따라 프로모션의 가용성을 결정합니다.

bonusArray of objects or null(Promotions_coupon_bonus)
external_idstring(Promotions_coupon-external_id)필수

고유 프로모션 ID입니다. external_id는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.

기본값 "coupon_external_id"
예제: "coupon_external_id"
nameobject(Promotions_coupon_name)필수

프로모션의 이름입니다. 키가 "^[a-z]{2}-[A-Z]{2}$" 형식의 로케일인 키/값 쌍을 포함해야 하며 값은 문자열입니다.

기본값 {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
예제: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
name.​property name*string추가 속성
promotion_periodsArray of objects(promotion_periods)

프로모션의 유효 기간. 기간이 여러 개 지정된 경우 date_from와 date_until가 모두 필요합니다.

redeem_code_limitinteger or null(Promotions_redeem_code_limit)

코드당 사용 횟수입니다.

기본값 10
예제: 10
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

총 쿠폰 수를 제한합니다.

기본값 10
예제: 10
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

단일 사용자가 사용한 총 쿠폰 수를 제한합니다.

기본값 10
예제: 10
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v3/project/44056/admin/coupon \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "account_status",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "golden"
      }
    ],
    "bonus": [
      {
        "quantity": 1,
        "sku": "com.xsolla.elven_sword_2"
      }
    ],
    "external_id": "coupon_external_id",
    "name": {
      "de-DE": "Neujahrsbonus",
      "en-US": "New Year Bonus"
    },
    "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
  }'

응답

쿠폰을 성공적으로 생성했습니다.

본문application/json
external_idstring(Promotions_coupon-external_id)

고유 프로모션 ID입니다. external_id는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.

기본값 "coupon_external_id"
예제: "coupon_external_id"
응답
application/json
{
  "external_id": "coupon_external_id"
}

쿠폰 프로모션 삭제Server-sideAdmin

요청

쿠폰 프로모션을 삭제합니다. 삭제된 프로모션:

  • 프로젝트에 설정된 프로모션 목록에서 사라집니다.
  • 더 이상 아이템 카탈로그에 적용되지 않습니다. 사용자는 이 프로모션으로 보너스 아이템을 얻을 수 없습니다.

삭제한 후에는 프로모션을 복원할 수 없습니다. 삭제된 프로모션의 쿠폰 코드는 기존 프로모션에 추가할 수 있습니다.

보안
basicAuth
경로
project_idinteger필수

프로젝트 ID입니다. 이 매개 변수는 관리자 페이지의 프로젝트 이름 옆에서 확인할 수 있습니다.

예제: 44056
external_idinteger필수

프로모션 외부 ID입니다. 프로젝트 내부의 고유 프로모션 식별자입니다.

예제: coupon_44056_1
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v3/project/44056/admin/coupon/coupon_44056_1

응답

쿠폰 프로모션을 성공적으로 삭제했습니다.

응답
콘텐츠 없음

프로모션 코드

이 API를 사용하여 프로모션 코드를 관리할 수 있습니다.

작업

고유 카탈로그 혜택

이 API를 사용하여 고유 카탈로그 혜택을 관리할 수 있습니다.

작업

할인

이 API를 사용하여 할인 프로모션을 관리할 수 있습니다.

작업

보너스

이 API를 사용하여 보너스 프로모션을 관리할 수 있습니다.

작업

관리자

작업

카탈로그

작업

가상 결제

작업

관리

작업

관리자

작업

클라이언트

작업

클랜 클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업