콘텐츠로 건너뛰기

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 설명 다운로드
언어
서버
Mock server
https://xsolla.redocly.app/_mock/ko/api/shop-builder/
https://store.xsolla.com/api/
작업

개인 맞춤형 카탈로그

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

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

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

작업
작업
작업
작업

장바구니 ID로 장바구니 가져오기Client-side

요청

장바구니 ID로 사용자의 장바구니를 반환합니다.

보안
AuthForCart
경로
project_idinteger필수

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

예제: 44056
cart_idstring필수

장바구니 ID입니다.

예제: custom_id
쿼리
currencystring

장바구니에 표시되는 아이템 가격 통화입니다. ISO 4217에 따른 3자리 통화 코드입니다. 엑솔라에서 지원하는 통화에 대한 자세한 정보는 설명서를 확인하십시오.

기본값 "USD"
localestring

응답 언어입니다. ISO 639-1에 따른 두 자리 소문자 언어 코드입니다.

기본값 "en"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/ko/api/shop-builder/v2/project/44056/cart/custom_id?currency=USD&locale=en' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

응답

아이템이 있는 장바구니를 성공적으로 반환했습니다.

본문application/json
cart_idstring

장바구니 ID입니다.

예제: "cart_id"
is_freeboolean(value-cart_is_free)

true이면 장바구니는 무료입니다.

기본값 false
예제: false
itemsArray of objects
priceobject or null

장바구니 가격입니다.

예제: {"amount":"6150.0000000000000000","amount_without_discount":"6150.0000000000000000","currency":"USD"}
promotionsArray of objects(Catalog_cart_promotions)

전체 장바구니에 적용된 프로모션. 다음의 경우 배열이 반환됩니다.

  • 구매 시 할인 설정 프로모션 코드와 같이 프로모션이 전체 장바구니 금액에 영향을 미치는 경우

  • 장바구니에 보너스 아이템을 추가하는 프로모션의 경우

적용되는 주문 수준 프로모션이 없는 경우 빈 배열이 반환됩니다.

응답
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ {} ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ {} ] }

장바구니 ID로 모든 장바구니 아이템 삭제하기Client-side

요청

모든 장바구니 아이템을 삭제합니다.

보안
AuthForCart
경로
project_idinteger필수

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

예제: 44056
cart_idstring필수

장바구니 ID입니다.

예제: custom_id
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v2/project/44056/cart/custom_id/clear \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

응답

장바구니 아이템이 성공적으로 삭제되었습니다.

아이템으로 특정 장바구니 채우기Client-side

요청

특정 장바구니를 아이템으로 채웁니다. 장바구니에 동일한 SKU를 가진 아이템이 이미 있으면 기존 아이템의 위치가 전달된 값으로 교체됩니다.

보안
AuthForCart
경로
project_idinteger필수

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

예제: 44056
cart_idstring필수

장바구니 ID입니다.

예제: custom_id
본문application/json
itemsArray of objects필수

아이템 목록입니다.

예제: [{"quantity":123,"sku":"com.xsolla.booster_mega_1"}]
items[].​quantitynumber필수
기본값 123
items[].​skustring필수
기본값 "booster_mega_1"
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v2/project/44056/cart/custom_id/fill \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "quantity": 123,
        "sku": "com.xsolla.booster_mega_1"
      }
    ]
  }'

응답

아이템이 있는 장바구니를 성공적으로 반환했습니다.

본문application/json
cart_idstring

장바구니 ID입니다.

예제: "cart_id"
is_freeboolean(value-cart_is_free)

true이면 장바구니는 무료입니다.

기본값 false
예제: false
itemsArray of objects
priceobject or null

장바구니 가격입니다.

예제: {"amount":"6150.0000000000000000","amount_without_discount":"6150.0000000000000000","currency":"USD"}
promotionsArray of objects(Catalog_cart_promotions)

전체 장바구니에 적용된 프로모션. 다음의 경우 배열이 반환됩니다.

  • 구매 시 할인 설정 프로모션 코드와 같이 프로모션이 전체 장바구니 금액에 영향을 미치는 경우

  • 장바구니에 보너스 아이템을 추가하는 프로모션의 경우

적용되는 주문 수준 프로모션이 없는 경우 빈 배열이 반환됩니다.

warningsArray of objects
응답
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ {} ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ {} ], "warnings": [ {} ] }
작업
작업
작업
작업
작업
작업
작업
작업

카탈로그

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

작업
작업
작업
작업
작업
작업

쿠폰

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

작업

프로모션 코드

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

작업

고유 카탈로그 혜택

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

작업

할인

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

작업

보너스

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

작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업