Xsolla-logo

지정한 무료 아이템으로 주문 생성하기

post/v2/project/{project_id}/free/item/{item_sku}

지정한 무료 아이템으로 주문을 생성합니다. 생성된 주문은 done 주문 상태를 가져옵니다.

SecurityXsollaLoginUserJWT
Request
path Parameters
project_id
required
integer

프로젝트 ID입니다.

Example: 44056
item_sku
required
string

아이템 SKU입니다.

Example: booster_mega_1
Request Body schema: application/json
currency
string

가격 표시에 사용하는 통화(기본적으로 USD)입니다. ISO 4217에 따른 세 자리 통화 코드입니다.

custom_parameters
object [ 1 .. 200 ] properties

프로젝트별 매개 변수입니다.

locale
string

응답 언어입니다.

quantity
integer >= 1
Default: 1

아이템 수량입니다.

sandbox
boolean
Default: false

샌드박스 모드로 주문을 생성합니다. 이 옵션은 회사 사용자 목록에서 지정한 사용자에게 사용할 수 있습니다.

object

사용자의 결제 프로세스와 결제 UI를 구성하는 설정입니다.

payment_method
integer >= 1

결제 방식 ID입니다.

object
delay
integer

지연 후 사용자가 자동으로 반환 URL로 리디렉션됩니다.

redirect_button_caption
string

현지화된 리디렉션 버튼 캡션입니다.

redirect_conditions
string

사용자를 반환 URL로 리디렉션하도록 트리거하는 결제 상태입니다.

Enum: "none" "successful" "successful_or_canceled" "any"
status_for_manual_redirection
string

사용자를 반환 URL로 리디렉션하는 버튼 클릭 표시를 트리거하는 결제 상태입니다.

Enum: "none" "vc" "successful" "successful_or_canceled" "any"
return_url
string <uri> <= 1000 characters

결제 후 사용자를 리디렉션하는 페이지입니다. 매개변수 user_id, foreigninvoice, invoice_id, status가 자동으로 링크에 추가됩니다.

object

인터페이스 설정입니다.

object

데스크톱 버전용 인터페이스 설정입니다.

object

헤더 설정입니다.

close_button
boolean
Default: false

페이 스테이션 데스크톱에서 닫기 버튼을 표시할지 여부. 이 버튼을 누르면 페이 스테이션이 종료되고 settings.return_url 매개변수에서 지정한 URL로 사용자를 리디렉션합니다. 기본값은 false입니다.

is_visible
boolean

결제 UI에 헤더를 표시할지 여부입니다.

type
string
Default: "normal"

헤더를 표시하는 방식입니다. compact(프로젝트 이름 및 사용자 ID 표시 안 함) 또는 normal (기본값)일 수 있습니다.

Enum: "compact" "normal"
visible_logo
boolean

true일 경우 로고가 헤더에 표시됩니다(먼저 계정 관리자에게 로고 파일을 제공해야 함).

visible_name
boolean

프로젝트 이름을 헤더에 표시할지 여부를 나타냅니다.

visible_purchase
boolean
Default: true

헤더에 구매 설명(purchase.description.value)을 표시할지 여부입니다. 기본값은 true입니다.

license_url
string

EULA의 링크입니다.

object
object
is_visible
required
boolean

모바일 버전의 결제 UI에서 바닥글을 표시하거나 숨길지 여부입니다.

object
close_button
required
boolean
Default: false

페이 스테이션 모바일에서 닫기 버튼을 표시할지 여부입니다. 이 버튼을 누르면 페이 스테이션이 종료되고 settings.return_url 매개 변수에서 지정한 URL로 사용자를 리디렉션합니다. 기본값은 false입니다.

mode
any

사용자는 저장된 결제 방식을 통해서만 결제할 수 있습니다. saved_accounts일 수 있습니다.

Value: "saved_accounts"
mode
string

페이 스테이션의 인터페이스 모드입니다. user_account만 사용할 수 있습니다. 헤더에는 계정 탐색 메뉴만 포함할 수 있으며 사용자는 제품을 선택하거나 결제할 수 없습니다. 이 모드는 데스크톱에서만 사용할 수 있습니다.

Enum: "user_account" "without_purchase"
size
string

결제 UI의 크기입니다. 다음과 같을 수 있습니다.

  • 소형: 결제 UI에서 사용할 수 있는 최소 크기. 창 크기가 엄격하게 제한된 경우 이 값을 사용(크기: 620 x 630)
  • 중형: 권장 크기. 라이트박스에 결제 UI를 표시할 경우 이 값을 사용(크기: 740 x 760)
  • 대형: 새 창 또는 탭에 결제 UI를 표시하는 경우 최적의 크기(크기: 820 x 840)
Enum: "large" "medium" "small"
theme
string [ 1 .. 20 ] characters
Default: "default"

결제 UI 테마입니다. default, default_dark 또는 dark일 수 있습니다.

Enum: "default" "default_dark" "dark"
object

사용자 계정 세부 정보입니다.

object

기록의 하위 메뉴입니다.

enable
required
boolean
Default: false

하위 메뉴를 표시할지 여부입니다. 기본값은 false입니다.

order
required
integer >= 1

메뉴에서 하위 메뉴의 위치입니다.

object
Default: "Page **My account**."
enable
required
boolean
Default: false

하위 메뉴를 표시할지 여부입니다. 기본값은 false입니다.

order
required
integer >= 1

메뉴에서 하위 메뉴의 위치입니다.

object

내 결제 계정의 하위 메뉴입니다.

enable
required
boolean
Default: false

하위 메뉴를 표시할지 여부입니다. 기본값은 false입니다.

order
required
integer >= 1

메뉴에서 하위 메뉴의 위치입니다.

object

구독 관리의 하위 메뉴입니다.

enable
required
boolean
Default: false

하위 메뉴를 표시할지 여부입니다. 기본값은 false입니다.

order
required
integer >= 1

메뉴에서 하위 메뉴의 위치입니다.

version
string
Default: "desktop"

장치 유형입니다. desktop(기본값) 또는 mobile일 수 있습니다.

Enum: "desktop" "mobile"
object

사용자 배송 데이터입니다.

country
required
string^[A-Z]{2}$
address1
required
string
address2
required
string
address3
required
string
state
required
string
first_name
required
string
last_name
required
string
city
required
string
postal_code
required
string
region
required
string
phone
required
string^\+
comment
string
email
string
object

선택한 배송 방법입니다. 형식은 통합된 배달 서비스 공급자에 따라 다릅니다.

property name*
additional property
any
Responses
200

무료 주문을 성공적으로 생성했습니다.

422

아이템이 잘못되었습니다. 아이템이 존재하는지, 꺼진 상태가 아닌지, 삭제되었는지, 무료가 아닌지 확인해야 합니다.

Request samples
application/json
{
  • "custom_parameters": {
    },
  • "quantity": 5,
  • "sandbox": true,
  • "settings": {
    }
}
Response samples
application/json
{
  • "order_id": 641
}