Checkout
A query checkout retorna informações de um carrinho específico e de seus produtos adicionados.
Requisição
Parâmetros
| Parâmetro | Descrição | Obrigatório | Descrição |
|---|---|---|---|
| checkoutId | String | Sim | ID do carrinho |
Campos
| Campo | Descrição |
|---|---|
| cep | CEP de entrega do pedido |
| checkoutId | ID do carrinho |
| coupon | Cupom utilizado na compra, se existente |
| login | Usuário ligado ao carrinho |
| orders | Pedidos gerados pelo carrinho, caso já tenha sido fechado |
| products | Lista de produtos adicionados ao carrinho |
| shippingFee | Valor do frete |
| subtotal | Valor total dos produtos |
| total | Valor total da compra, incluindo o frete |
| updateDate | Data da última atualização |
| url | URL de checkout |
Exemplos
Neste exemplo são pedidas informações de um carrinho específico e de seus produtos:
query {
checkout(checkoutId:"d0e47846-d2a8-45e0-b51f-f25ee88446a3") {
checkoutId
url
products {
productId
name
price
quantity
productAttributes {
name
value
}
}
}
}
Mostrar resposta
{
"checkout": {
"checkoutId": "d0e47846-d2a8-45e0-b51f-f25ee88446a3",
"url": "https://lojacss.checkout.fbits.store/d0e47846-d2a8-45e0-b51f-f25ee88446a3",
"products": [
{
"productId": 222725,
"name": "Anabela Camurça Animale",
"price": 279,
"quantity": 1,
"productAttributes": [
{
"name": "COR",
"value": "Rose"
},
{
"name": "Tamanho",
"value": "35"
}
]
}
]
}
}
}
Informações de Seller no Produto do Checkout
Segue abaixo um exemplo que apresentará as informações do Seller no produto do checkout:
query {
checkout(checkoutId: "d0e47846-d2a8-45e0-b51f-f25ee8840000") {
checkoutId
products {
productId
name
seller {
distributionCenterId
sellerName
}
}
}
}
Mostrar resposta
{
"checkout": {
"checkoutId": "d0e47846-d2a8-45e0-b51f-f25ee8840000",
"products": [
{
"productId": 222725,
"name": "Anabela Camurça Animale",
"seller": {
"distributionCenterId": "eyJFbnRpdHkiOiJEaXN0cmlidXRpb25DZW50ZXIiLCJJZCI60000",
"sellerName": "Depósito Três Estrelas"
}
},
{
"productId": 222765,
"name": "Anabela Animale",
"seller": {
"distributionCenterId": "eyJFbnRpdHkiOiJEaXN0cmlidXRpb25DZW50ZXIiLCJJZCI61111",
"sellerName": "Depósito Três Mares"
}
}
]
}
}
Produto(s) com personalização no carrinho
Abaixo temos um exemplo, que retornará informações de produtos(s) com personalização em um carrinho:
query {
checkout(checkoutId: "969ca571-5d72-49ed-a172-c460f6c00000") {
checkoutId
products {
name
quantity
productVariantId
productId
customization {
id
values {
cost
name
value
}
}
}
}
}
Mostrar resposta
{
"data": {
"checkout": {
"checkoutId": "969ca571-5d72-49ed-a172-c460f6c00000",
"products": [
{
"name": "Bola Adidas Euro Copa 2016",
"quantity": 1,
"productVariantId": 4567,
"productId": 282,
"customization": {
"id": "eyJQcm9kdXRvVmFyaWFudGVJZCI6NTQzOCwiRW50aXR5IjoiQ2hlY2tvdXRQcm9kdWN0SWQiLCJJZCI6MTYxMjUzMn0=",
"values": [
{
"cost": 5,
"name": "Nome",
"value": "teste"
}
]
}
},
{
"name": "Bola Adidas Euro Copa 2016",
"quantity": 1,
"productVariantId": 4567,
"productId": 282,
"customization": {
"id": "eyJQcm9kdXRvVmFyaWFudGVJZCI6NTQzOCwiRW50aXR5IjoiQ2hlY2tvdXRQcm9kdWN0SWQiLCJJZCI6MTYxMjUzMn0=",
"values": [
{
"cost": 5,
"name": "Nome",
"value": "teste"
}
]
}
}
]
}
}
}
Informação de assinatura selecionada para produtos no carrinho
Abaixo temos um exemplo, que retornará as informações de assinatura selecionada e assinaturas disponíveis para o(s) produto(s) no carrinho:
query {
checkout(checkoutId: "4153a797-1731-4487-82bb-bc664d33a8c5") {
checkoutId
products {
name
quantity
subscription {
selected {
name
recurringDays
recurringTypeId
selected
subscriptionGroupDiscount
subscriptionGroupId
}
availableSubscriptions {
name
recurringDays
recurringTypeId
selected
subscriptionGroupDiscount
subscriptionGroupId
}
}
}
}
}
Mostrar resposta
{
"data": {
"checkout": {
"checkoutId": "4153a797-1731-4487-82bb-bc664d33a8c5",
"products": [
{
"name": "Ração Guabi Natural para Gatos Adultos e Castrados Sabor Cordeiro e Aveia",
"quantity": 1,
"subscription": {
"selected": {
"name": "Mensal",
"recurringDays": 30,
"recurringTypeId": 484,
"selected": true,
"subscriptionGroupDiscount": 0,
"subscriptionGroupId": 377
},
"availableSubscriptions": [
{
"name": "Semanal",
"recurringDays": 7,
"recurringTypeId": 482,
"selected": false,
"subscriptionGroupDiscount": 0,
"subscriptionGroupId": 377
},
{
"name": "Mensal",
"recurringDays": 30,
"recurringTypeId": 484,
"selected": true,
"subscriptionGroupDiscount": 0,
"subscriptionGroupId": 377
},
{
"name": "2 Meses",
"recurringDays": 60,
"recurringTypeId": 485,
"selected": false,
"subscriptionGroupDiscount": 0,
"subscriptionGroupId": 377
},
{
"name": "3 Meses",
"recurringDays": 90,
"recurringTypeId": 486,
"selected": false,
"subscriptionGroupDiscount": 0,
"subscriptionGroupId": 377
},
{
"name": "6 Meses",
"recurringDays": 180,
"recurringTypeId": 489,
"selected": false,
"subscriptionGroupDiscount": 0,
"subscriptionGroupId": 377
}
]
}
},
{
"name": "Petisco Bombom Recheado Mastig para Cães 100g ",
"quantity": 1,
"subscription": {
"selected": {
"name": "Semanal",
"recurringDays": 7,
"recurringTypeId": 482,
"selected": true,
"subscriptionGroupDiscount": 0,
"subscriptionGroupId": 377
},
"availableSubscriptions": [
{
"name": "Semanal",
"recurringDays": 7,
"recurringTypeId": 482,
"selected": true,
"subscriptionGroupDiscount": 0,
"subscriptionGroupId": 377
},
{
"name": "Mensal",
"recurringDays": 30,
"recurringTypeId": 484,
"selected": false,
"subscriptionGroupDiscount": 0,
"subscriptionGroupId": 377
},
{
"name": "2 Meses",
"recurringDays": 60,
"recurringTypeId": 485,
"selected": false,
"subscriptionGroupDiscount": 0,
"subscriptionGroupId": 377
},
{
"name": "3 Meses",
"recurringDays": 90,
"recurringTypeId": 486,
"selected": false,
"subscriptionGroupDiscount": 0,
"subscriptionGroupId": 377
},
{
"name": "6 Meses",
"recurringDays": 180,
"recurringTypeId": 489,
"selected": false,
"subscriptionGroupDiscount": 0,
"subscriptionGroupId": 377
}
]
}
}
]
}
}
}
Consulta de checkout com menos processamento
Abaixo temos um exemplo, que retornará as informações de um checkout "mais leve" e com menos processamento.
{
checkoutLite (checkoutId: "e97163ae-0373-4125-9c96-a52f9b32bf01") {
completed
customerId
}
}
Mostrar resposta
{
"data": {
"checkoutLite": {
"completed": false,
"customerId": 123456
}
}
}
Consulta de customizações disponíveis para produtos no checkout
Abaixo temos um exemplo, que retornará as informações de customizações em produtos direto do checkout:
query {
checkout(
checkoutId: "63c6b3fa-43be-4312-b1b9-bd445d0b0496"
customerAccessToken: "eyJQcm9kdXRvVmFyaWFudGVJZCI6MzQwLCJFbnRpdHkiOiJDaGVja291dFByb2R1Y3RJZCIsIklkIjoxNjEyNTI5fQ"
) {
products {
name
productVariantId
productId
totalAdjustedPrice
ajustedPrice
customization {
id
values {
cost
name
value
}
availableCustomizations {
id
name
customizationId
groupName
maxLength
order
type
values
cost
}
}
}
}
}
Mostrar resposta
{
"data": {
"checkout": {
"products": [
{
"name": "Mochila Nike Classic",
"productVariantId": 256639,
"productId": 70129,
"totalAdjustedPrice": 229,
"ajustedPrice": 229,
"customization": {
"id": "eyJQcm9kdXRvVmFyaWFudGVJZCI6MjU2NjM5LCJFbnRpdHkiOiJDaGVja291dFByb2R1Y3RJZCIsIklkIjoxNzAyNjQxfQ==",
"values": [
{
"cost": 5,
"name": "Nome",
"value": "Teste"
},
{
"cost": 5,
"name": "Número",
"value": "1"
}
],
"availableCustomizations": [
{
"id": "eyJFbnRpdHkiOiJDdXN0b21pemF0aW9uIiwiSWQiOjM1fQ==",
"name": "Nome",
"customizationId": 35,
"groupName": "Gravação Nome",
"maxLength": 99,
"order": 1,
"type": "Texto Livre",
"values": [],
"cost": 5
},
{
"id": "eyJFbnRpdHkiOiJDdXN0b21pemF0aW9uIiwiSWQiOjEwMDM1fQ==",
"name": "Valor",
"customizationId": 10035,
"groupName": "Gravação Nome",
"maxLength": 99,
"order": 2,
"type": "Valores Predefinidos",
"values": [],
"cost": 5
},
{
"id": "eyJFbnRpdHkiOiJDdXN0b21pemF0aW9uIiwiSWQiOjEwMDM2fQ==",
"name": "Número",
"customizationId": 10036,
"groupName": "Gravação Nome",
"maxLength": 99,
"order": 3,
"type": "Número",
"values": [],
"cost": 5
}
]
}
}
]
}
}
}
Consulta do saldo da conta corrente do usuário no carrinho
Abaixo temos um exemplo, de consulta de saldo de conta corrente de um usuário no carrinho:
query {
checkout(
checkoutId: "07716392-aef0-463e-bcaa-ff33381d0ece"
customerAccessToken: "Lk7kiuvKnSOZFwjOk/3C1Bb4FeNhYO5IgW3YM9VApudLrIL1w8dixR8A+SeMbzBXa5LDhJ+nxyhUElJzug+ELX1FbzvJ4d4LmaBKbUlIDfCKb2tLY6a99uCrcOadsXk7c2fWFawEYu9sFREE4/ZWJMwGoObt3kwhcBh9VkzgHiFsem+CIY2X+l5T6yidUKCcRUdnTht41geiLOMjOSNnPmqZvTRcowFLlGBDdXwAHXaflwMBZ1gN2XHt6Qwh+AiW"
) {
customer {
checkingAccountBalance
}
}
}
Mostrar resposta
{
"data": {
"checkout": {
"customer": {
"checkingAccountBalance": 100
}
}
}
Consulta do valor debitado da conta corrente do usuário no carrinho
Abaixo temos um exemplo, de consulta do valor debitado da conta corrente de um usuário no carrinho
query {
checkout(
checkoutId: "07716392-aef0-463e-bcaa-ff33381d0ece"
customerAccessToken: "Lk7kiuvKnSOZFwjOk/3C1Bb4FeNhYO5IgW3YM9VApudLrIL1w8dixR8A+SeMbzBXa5LDhJ+nxyhUElJzug+ELX1FbzvJ4d4LmaBKbUlIDfCKb2tLY6a99uCrcOadsXk7c2fWFawEYu9sFREE4/ZWJMwGoObt3kwhcBh9VkzgHiFsem+CIY2X+l5T6yidUKCcRUdnTht41geiLOMjOSNnPmqZvTRcowFLlGBDdXwAHXaflwMBZ1gN2XHt6Qwh+AiW"
) {
products {
name
totalAdjustedPrice
ajustedPrice
}
orders {
adjustments {
name
type
value
}
}
checkingAccountValue
subtotal
total
}
}
Mostrar resposta
{
"data": {
"checkout": {
"products": [
{
"name": "Tênis All Star Vermelho",
"totalAdjustedPrice": 229,
"ajustedPrice": 229
}
],
"orders": [],
"checkingAccountValue": -100,
"subtotal": 229,
"total": 129
}
}
}
Informações de pagamento de cartão no checkout
Abaixo temos um exemplo, de consulta dos dados do cartão no checkout:
query {
checkout(checkoutId:"bebddb4a-3c7a-4492-854f-58aa02babf7c"){
orders{
payment{
name
card{
brand
installments
cardInterest
name
number
}
}
}
}
}
Mostrar resposta
{
"data": {
"checkout": {
"orders": [
{
"payment": {
"name": "Cartão Mundipagg",
"card": {
"brand": "mastercard",
"installments": 2,
"cardInterest": 0,
"name": "Teste TrayCorp",
"number": "4975"
}
}
},
]
}
}
}
Informação do valor unitário dos produtos dos pedidos de um carrinho
Abaixo temos um exemplo, de consulta onde retornará o valor unitário do(s) produto(s) do(s) pedido(s) de um carrinho fechado:
query {
checkout(checkoutId:"bebddb4a-3c7a-4492-854f-58aa02babf7c"
customerAcessToken:"Lk7kiuvKnSOZFwjOk/3C1Bb4FeNhYO5IgW3YM9VApudLrIL1w8dixR8A+SeMbzBXa5LDhJ+nxyhUElJzug+ELX1FbzvJ4d4LmaBKbUlIDfCKb2tLY6a99uCrcOadsXk7c2fWFawEYu9sFREE4/ZWJMwGoObt3kwhcBh9VkzgHiFsem+CIY2X+l5T6yidUKCcRUdnTht41geiLOMjOSNnPmqZvTRcowFLlGBDdXwAHXaflwMBZ1gN2XHt6Qwh+AiW"
) {
orders{
products{
name
quantify
value
unitValue
}
}
}
}
Mostrar resposta
{
"data":{
"checkout":{
"orders":[
{
"products":[
{
"name":"Têncis Converse Chuck 70 HI",
"quantify":2,
"value":2000,
"unitValue":1000
},
{
"name":"Tênis All Star Preto",
"quantify":9,
"value":2061,
"unitValue":229
}
]
}
]
}
}
}
Informação se o carrinho está utilizando valor de conta corrente
Abaixo temos um exemplo, de consulta onde retornará a informação de que o determinado carrinho está utilizando valor de conta corrente.
query {
checkout(checkoutId:"da77dd86-188f-4e06-87f4-bf1411e8cbf1",
customerAccessToken:"TaoUWewI1P4opppp1t2u9KK2CguZ35UVt2fhxV1AZ8JMdrOrCcP9vnMwDguwSbNhuodxVqEV66UbJ/NkZDSMlLoDNo4h3oH1EbO+dnzKiA2wm3rrt2WKspxx+A0WltE0eIKe5WrXaVqOJt4YW+sJCHzowr+zeT26krjeqe1HsJf5LIQbDwGMxP/fDagm9AtE7lGd/1mEBdPSq/0VY2ZzekMyXwETcGRfF16KZuQA/tsuHKU9BF5evdUi8PefwhOX"){
checkingAccountActive
}
}
Mostrar resposta
{
"data": {
"checkout": {
"checkingAccountActive": false
}
}
}
Informações de Kit no checkout
Abaixo temos um exemplo, de consulta onde retornará a informação de kit no checkout.
query{
checkout(checkoutId:"8b137ccc-707b-420c-8aa1-2306a98d3adaaaab"){
checkoutId
kits{
name
alias
imageUrl
kitGroupId
kitId
listPrice
price
quantity
totalListPrice
totalAdjustedPrice
ajustePrice
products{
productId
name
}
}
}
}
Mostrar resposta
{
"data": {
"checkout": {
"checkoutId": "8b137ccc-707b-420c-8aa1-2306a98d3adb",
"kits": [
{
"name": "Teste 2",
"alias": "teste-2-60",
"imageUrl": null,
"kitGroupId": "t+dh2KQJHBl2b0Ypo5C5iqqw==",
"kitId": 60,
"listPrice": 12001,
"price": 12761,
"quantity": 2,
"totalListPrice": 25522,
"totalAdjustedPrice":180,
"ajustePrice":90,
"products": [
{
"productId": 175309,
"name": "Smart Tv Led 55 LG Um7470 Ultra Hd 4k Hdr Ativo, Dts Virtual"
},
{
"productId": 174424,
"name": "Brinco Concha Furtacor"
}
]
}
]
}
}
}
Consulta do limite de crédito do usuário no carrinho
Abaixo temos um exemplo de consulta para obter o limite de crédito e o saldo utilizado de um usuário no carrinho:
query {
checkout(
checkoutId: "07716392-aef0-463e-bcaa-ff33381d0ece"
customerAccessToken: "Lk7kiuvKnSOZFwjOk/3C1Bb4FeNhYO5IgW3YM9VApudLrIL1w8dixR8A+SeMbzBXa5LDhJ+nxyhUElJzug+ELX1FbzvJ4d4LmaBKbUlIDfCKb2tLY6a99uCrcOadsXk7c2fWFawEYu9sFREE4/ZWJMwGoObt3kwhcBh9VkzgHiFsem+CIY2X+l5T6yidUKCcRUdnTht41geiLOMjOSNnPmqZvTRcowFLlGBDdXwAHXaflwMBZ1gN2XHt6Qwh+AiW"
) {
customer {
creditLimit
creditLimitBalance
}
}
}
- creditLimit: O limite total de crédito do cliente cadastrado no sistema.
- creditLimitBalance: O valor atual de crédito utilizado pelo cliente.
Mostrar resposta
{
"data": {
"checkout": {
"customer": {
"creditLimit": 5000,
"creditLimitBalance": 1500
}
}
}
}
Consulta da situação do pedido de um carrinho fechado
Abaixo temos um exemplo de consulta para obter a situação do pedido de um carrinho fechado:
query {
checkout(checkoutId: "E259441C-E3B3-456E-9FD6-4BC5A2295D61") {
orders {
orderStatusDisplay
orderStatus
}
}
}
- orderStatus: O status do pedido.
- orderStatusDisplay: O status do pedido em formato de texto. Este campo também pode ser retornado em inglês, conforme definido o idioma na configuração "Storefront - Idioma das mensagens de erro e informações da API" dentro do painel administrativo da loja.
Mostrar resposta
"data": {
"checkout": {
"orders": [
{
"orderStatusDisplay": "Cancelado",
"orderStatus": "CANCELADO"
}
]
}
}
}
Updated 2 months ago