콘텐츠로 건너뛰기
/
아이템에 대한 할인 프로모션 생성하기

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를 사용하여 쿠폰을 관리할 수 있습니다.

작업

프로모션 코드

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

작업

고유 카탈로그 혜택

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

작업

할인

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

작업

아이템 프로모션 목록 가져오기Server-sideAdmin

요청

프로젝트의 아이템 프로모션 목록을 가져옵니다.

프로모션은 아이템에 대한 할인(%) 혜택을 제공합니다. 지정된 아이템의 모든 가격에 할인이 적용됩니다.

보안
basicAuth
경로
project_idinteger필수

프로젝트 ID입니다.

기본값 59080
쿼리
limitinteger

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

offsetinteger

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

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/shop-builder/v3/project/{project_id}/admin/promotion/item?limit=0&offset=0'

응답

아이템 프로모션 목록을 성공적으로 접수했습니다.

본문application/json
active_promotions_countinteger(active_promotions_count)

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

inactive_promotions_countinteger(inactive_promotions_count)

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

promotionsArray of objects
total_promotions_countinteger(total_promotions_count)

총 프로모션 개수입니다.

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

아이템에 대한 할인 프로모션 생성하기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

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

discountobject필수
discount.​percentstring필수

퍼센트 할인입니다. 이 퍼센트를 사용하여 계산한 값을 사용하여 아이템의 가격이 낮아지게 한 다음 소수점 이하 2자리로 반올림합니다.

예제: 10
excluded_promotionsArray of integers(excluded_promotions)

이 프로모션을 적용할 때 제외할 프로모션 ID 목록입니다.
Example: [12, 789]

예제: [12,789]
is_enabledboolean(Promotions_is_enabled)

프로모션 활성화 여부.

예제: true
itemsArray of objects필수
items[].​skustring필수

아이템 SKU입니다.

기본값 "elven_sword"
limitsobject(Promotions_promotion_limits)

프로모션 제한입니다.

nameobject필수

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

예제: {"en-US":"Promotion","ru-RU":"Акция"}
name.​property name*string추가 속성
price_conditionsArray of objects or null(price_conditions_discount)

프로모션을 적용하기 위한 가격 범위를 설정하는 조건을 가진 개체 배열입니다.
프로모션은 가격이 배열의 모든 조건을 충족하는 아이템에만 적용됩니다. 이 배열을 전달하는 경우 아이템 개체의 값이 null로 설정됩니다.

promotion_periodsArray of objects(promotion_periods)

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

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v3/project/44056/admin/promotion/item \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "race",
        "operator": "eq",
        "type": "string",
        "value": "ork"
      },
      {
        "attribute": "level",
        "can_be_missing": true,
        "operator": "eq",
        "type": "number",
        "value": "10"
      }
    ],
    "discount": {
      "percent": "24.00"
    },
    "is_enabled": true,
    "items": [],
    "name": {
      "en-US": "Ork set discount",
      "ru-RU": "Скидка на набор для орка"
    },
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      }
    ]
  }'

응답

프로모션을 성공적으로 생성했습니다.

본문application/json
promotion_idinteger

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

응답
application/json
{
  "promotion_id": 2384756
}

아이템 프로모션 삭제Server-sideAdmin

요청

할인 프로모션을 삭제합니다. 삭제된 프로모션:

  • 프로젝트에 설정된 프로모션 목록에서 사라집니다.
  • 아이템 카탈로그 및 장바구니에는 더 이상 적용되지 않습니다. 사용자는 이 프로모션으로 상품을 구매할 수 없습니다.

삭제한 후에는 프로모션을 복원할 수 없습니다.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
promotion_idinteger필수

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

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

응답

프로모션이 성공적으로 삭제되었습니다.

응답
콘텐츠 없음

보너스

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

작업

관리자

작업

카탈로그

작업

가상 결제

작업

관리

작업

관리자

작업

클라이언트

작업

클랜 클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업