使用免费购物车创建订单

post/v2/project/{project_id}/free/cart

使用免费购物车中的所有商品创建一个订单。创建的订单将具有done的订单状态。

SecurityAuthForCart

Request

path Parameters

project_id

required

integer

项目ID。

Example: 44056

Request Body schema: application/json

currency

string

表示价格的货币（默认为美元）。符合ISO 4217的三字母货币代码。

custom_parameters

object [ 1 .. 200 ] properties

项目特定参数。

locale

string

响应语言。

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`，标题中将显示Logo（请先把Logo文件提供给您的项目经理）。
visible_name	boolean 页眉中是否显示项目名称。
visible_purchase	boolean Default: true 是否在页眉中显示购买描述（`purchase.description.value`）。默认为`true`。

license_url

string

EULA的链接。

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的所需大小：

small：支付UI支持的最小尺寸。当窗口大小严格受限时，请使用此值（尺寸：620 x 630）
medium：支付UI的推荐大小。使用此值可以在灯箱中显示支付UI（尺寸：740 x 760）
large：在新窗口或者选项卡中显示支付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": {"character_id": "ingameUsername"
},
"sandbox": true,
"settings": {"ui": {"desktop": {"header": {"close_button": false,
"is_visible": true,
"type": "normal",
"visible_logo": true,
"visible_name": true,
"visible_purchase": true
}
},
"mobile": {"footer": {"is_visible": true
},
"header": {"close_button": false
}
},
"size": "large",
"theme": "default",
"version": "desktop"
}
}
}

Response samples

application/json

{"order_id": 641
}