Quantidade do item.
- Preencher o carrinho com itens
Preencha o ID do carrinho pelo carrinho com itens
Preencher o carrinho com...
API Shop Builder (2.0.0)
- 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.
Transferir a descrição da OpenAPI
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/shop-builder/
https://store.xsolla.com/api/
Catálogo personalizado
Essa API permite especificar regras para atributos de usuário. Se o usuário atender a todas as condições para uma regra concreta, serão exibidos itens personalizados.
Para promoções personalizadas, consulte a seção Promotions.
Para passar atributos antes de uma compra, você pode usar a Xsolla Login API ou passá-los para a propriedade user.attributes ao gerar o token usando a Pay Station API.
Operações
Caminho
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
Cabeçalhos
Corpoapplication/jsonO identificador do usuário pode ser transferido usando o Xsolla Login User JWT ou o token de acesso Pay Station.
Exemplo: ACCESS_TOKEN/LOGIN_JWT
Código de país de duas letras maiúsculas de acordo com o padrão ISO 3166-1 alfa-2. Verifique a documentação para obter informações detalhadas sobre os países suportados pela Xsolla.
Exemplo: country=US
Exemplo: "US"
A moeda do preço do item exibida no carrinho. Código de três letras de acordo com a ISO 4217. Consulte a documentação para obter informações detalhadas sobre as moedas suportadas pelo Xsolla.
Exemplo: "USD"
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/admin/project/{project_id}/cart/fill
- https://store.xsolla.com/api/v2/admin/project/{project_id}/cart/fill
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/pt/api/shop-builder/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"
}
]
}'O carrinho com itens foi devolvido com sucesso.
ID do carrinho. Passe-o para consulta da página de compra ou os pontos de extremidade da API de pagamento.
Exemplo: "cart_id"
Promoções aplicadas para todo o carrinho. A matriz é retornada nos seguintes casos:
Uma promoção afeta o valor total do carrinho, como um código promocional com a configuração Desconto na compra.
Uma promoção adiciona itens bônus ao carrinho.
Se nenhuma promoção no nível do pedido for aplicada, é retornada uma matriz vazia.
Resposta
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ { … }, { … }, { … } ], "price": { "amount": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ { … } ], "warnings": [ { … } ] }
Caminho
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
Cabeçalhos
Corpoapplication/jsonO identificador do usuário pode ser transferido usando o Xsolla Login User JWT ou o token de acesso Pay Station.
Exemplo: ACCESS_TOKEN/LOGIN_JWT
Código de país de duas letras maiúsculas de acordo com o padrão ISO 3166-1 alfa-2. Verifique a documentação para obter informações detalhadas sobre os países suportados pela Xsolla.
Exemplo: country=US
Exemplo: "US"
A moeda do preço do item exibida no carrinho. Código de três letras de acordo com a ISO 4217. Consulte a documentação para obter informações detalhadas sobre as moedas suportadas pelo Xsolla.
Exemplo: "USD"
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/admin/project/{project_id}/cart/{cart_id}/fill
- https://store.xsolla.com/api/v2/admin/project/{project_id}/cart/{cart_id}/fill
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/pt/api/shop-builder/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"
}
]
}'O carrinho com itens foi devolvido com sucesso.
ID do carrinho. Passe-o para consulta da página de compra ou os pontos de extremidade da API de pagamento.
Exemplo: "cart_id"
Promoções aplicadas para todo o carrinho. A matriz é retornada nos seguintes casos:
Uma promoção afeta o valor total do carrinho, como um código promocional com a configuração Desconto na compra.
Uma promoção adiciona itens bônus ao carrinho.
Se nenhuma promoção no nível do pedido for aplicada, é retornada uma matriz vazia.
Resposta
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ { … }, { … }, { … } ], "price": { "amount": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ { … } ], "warnings": [ { … } ] }