콘텐츠로 건너뛰기
/
장바구니 ID를 사용하는 장바구니 아이템으로...

Catalog 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

Catalog API는 인게임 스토어 카탈로그를 관리하고 구매를 처리하기 위한 엔드포인트를 제공합니다. 엔드포인트를 사용하여 가상 아이템, 인게임 재화, 게임 키, 번들, 장바구니 및 결제 플로우, 아이템 속성을 구성하고 외부 소스에서 아이템을 가져올 수 있습니다.

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

관리자

작업

카탈로그

작업

가상 결제

작업

카탈로그

작업

권한

작업

관리자

작업

관리자

작업

카탈로그

작업

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

작업

장바구니(서버 측)

작업

아이템으로 장바구니 채우기Server-side

요청

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

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
쿼리
localestring

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

기본값 "en"
헤더
x-user-forstring

사용자 식별자는 엑솔라 로그인 사용자 JWT 또는 페이 스테이션 액세스 토큰을 사용하여 전송할 수 있습니다.

예제: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

게임이 포함된 장바구니를 판매할 때 자신의 사용자 ID를 사용할 수 있습니다.

예제: UNIQUE_ID
본문application/json
countrystring= 2 characters

ISO 3166-1 alpha-2에 따른 2자리 대문자 국가 코드입니다. 엑솔라에서 지원하는 국가에 대한 자세한 정보는 설명서를 확인하십시오.
예: country=US

예제: "US"
currencystring= 3 characters

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

예제: "USD"
itemsArray of objectsnon-empty필수
items[].​quantitynumber>= 1필수

아이템의 수량입니다.

예제: 2
items[].​skustringnon-empty필수

고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.

예제: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/catalog/v2/admin/project/44056/cart/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "items": [
      {
        "quantity": 2,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.t-shirt01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.hat01"
      }
    ]
  }'

응답

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

본문application/json
cart_idstring

장바구니 ID. 구매 페이지 또는 결제 API 엔드포인트를 쿼리하려면 장바구니 ID를 전달합니다.

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

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

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

장바구니 가격입니다.

promotionsArray of objects(Catalog_cart_promotions)

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

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

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

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

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

장바구니 ID를 사용하는 장바구니 아이템으로 채우기Server-side

요청

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

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
cart_idstring필수

장바구니 ID입니다.

예제: custom_id
쿼리
localestring

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

기본값 "en"
헤더
x-user-forstring

사용자 식별자는 엑솔라 로그인 사용자 JWT 또는 페이 스테이션 액세스 토큰을 사용하여 전송할 수 있습니다.

예제: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

게임이 포함된 장바구니를 판매할 때 자신의 사용자 ID를 사용할 수 있습니다.

예제: UNIQUE_ID
본문application/json
countrystring= 2 characters

ISO 3166-1 alpha-2에 따른 2자리 대문자 국가 코드입니다. 엑솔라에서 지원하는 국가에 대한 자세한 정보는 설명서를 확인하십시오.
예: country=US

예제: "US"
currencystring= 3 characters

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

예제: "USD"
itemsArray of objectsnon-empty필수
items[].​quantitynumber>= 1필수

아이템의 수량입니다.

예제: 2
items[].​skustringnon-empty필수

고유한 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.

예제: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/catalog/v2/admin/project/44056/cart/custom_id/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "items": [
      {
        "quantity": 2,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.t-shirt01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.hat01"
      }
    ]
  }'

응답

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

본문application/json
cart_idstring

장바구니 ID. 구매 페이지 또는 결제 API 엔드포인트를 쿼리하려면 장바구니 ID를 전달합니다.

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

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

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

장바구니 가격입니다.

promotionsArray of objects(Catalog_cart_promotions)

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

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

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

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

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

결제(클라이언트 측)

작업

결제(서버 측)

작업

주문

작업

무료 아이템

작업

관리

작업

관리자

작업

웹훅

작업

선주문

작업

판매자

작업

카탈로그

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

작업

공통 지역

작업

관리자

작업