Cria um carrinho

POST

/api/v2/carts

• Servidor do ambiente de produção
• Servidor do ambiente de testes

Permite criar um carrinho

Authorizations

• Token
• X-Shop-Host

Parameters

Header Parameters

X-Browser-Ip

required

string format: ipv4

Internet Protocol (IP) da máquina de onde é criado o carrinho

X-User-Agent

required

string

Identificador da origem do carrinho na loja (como navegador ou dispositivo)

Request Body

Parâmetros de carrinho resumido

Parâmetros criação e atualização de carrinho

object

agent

Agente que criou o carrinho

string

zip

Código de Endereçamento Postal (CEP) do destinatário do pedido

string

client_id

Código identificador ID do cliente

integer

coupon_code

Código identificador ID do desconto do carrinho

string

email

Email do cliente

string format: email

rebate_token

Token do desconto

string

Responses

201

Carrinho criado com sucesso

Cart

Modelo de carrinho

object

agent

Agente que criou o carrinho

string

nullable

billing_address_id

Código identificador ID do endereço de cobrança do carrinho

integer

nullable

channel

Canal de venda que originou o carrinho

string

nullable

client_id

Código identificador ID do cliente

integer

nullable

code

Código identificador ID do carrinho

string

coupon_code

Código de cupom de desconto utilizado no carrinho

string

nullable

discount

Propriedades de um desconto

Promoção aplicada no carrinho

object

id

Código identificador ID do desconto

integer

name

required

Nome do desconto ou promoção

string

description

Descrição do desconto

string

start_at

required

Data de início da regra do desconto

string format: date-time

end_at

Data de fim da regra do desconto

string format: date-time

enabled

required

Indica se o desconto está habilitado (true) ou desabilitado (false)

boolean

default: true

valid_to

Indica a regra da promoção: se o desconto é aplicado na vitrine ou no carrinho da loja

string

email

Email do cliente, no caso de promoções direcionadas para clientes específicos

string format: email

cpf

Cadastro de Pessoa Física (CPF) do cliente, no caso de promoções direcionadas para clientes específicos

string

/[0-9]{11}/

tags

Tag de agrupamento de promoção

string

discount_price

Valor do desconto

number

extra

Campo para registro de observações, chave ou valores necessários

object

id

Código identificador ID do carrinho

integer

installments

Parcelas do carrinho

Parcelas para pagamento parcelado

object

interest

Identifica se há (true) ou não (false) juros no parcelamento

boolean

interest_rate

Taxa de juros do parcelamento

number

number

Número de parcelas

integer

price

Valor de cada parcela

number

total

Valor total das parcelas

number

items

Itens do carrinho

Array<object>

Cart Item

Item no carrinho

object

id

Código identificador do item no carrinho

string

available_quantity

Unidades disponíveis do produto

integer

delivery_days

Número de dias para a entrega

integer

extra

Campo para registro de observações, chave ou valores necessários

object

place_id

Código identificador do local do produto

integer

nullable

price

Preço do produto

number

intl_price

Preço internacional

number

product_id

Código identificador ID do produto

integer

product_name

Nome do produto

string

product_reference

Código de referência do produto

string

product_url

URL do produto no e-commerce

string

quantity

required

Unidades do produto no carrinho

integer

seller

Identificador do seller

string

nullable

seller_name

Nome do seller

string

nullable

subtotal

Valor do produto sem descontos e promoções

number

total

Valor total do produto

number

updated_at

Data da última atualização do carrinho

string format: date-time

variant_attributes

Atributos da variante

object

variant_min_quantity

Quantidade miníma de variantes para compra

integer

variant_name

Nome da variante

string

variant_price

Preço da variante

number

variant_intl_price

Preço internacional da variante

number

variant_properties

Variant

Modelo de variante

object

id

Código identificador da variante

integer

main

boolean

available

Indica se a variante está disponível true e indisponível false

boolean

sku

Código SKU da variante

string

name

Nome da variante

string

slug

string

min_quantity

Quantidade mínima da variante que deve ser adicionada ao carrinho

integer

quantity

Quantidade física

integer

quantity_sold

Quantidade vendida da variante

integer

stock

Quantidade disponível

integer

custom_attributes

object

properties

object

property1

variant_property

Modelo que representa uma propriedade customizada na API

object

defining

required

Indica se a variante possui uma definição (true) ou se a variante não possui (false)

boolean

name

required

Nome da propriedade

string

value

Valor da propriedade

string

Example

{
  "example-property1": {
    "name": "Tamanho",
    "value": "G",
    "defining": true
  },
  "example-property2": {
    "name": "Cor",
    "value": "Amarelo",
    "defining": true
  }
}

property2

variant_property

Modelo que representa uma propriedade customizada na API

object

defining

required

Indica se a variante possui uma definição (true) ou se a variante não possui (false)

boolean

name

required

Nome da propriedade

string

value

Valor da propriedade

string

Example

{
  "example-property1": {
    "name": "Tamanho",
    "value": "G",
    "defining": true
  },
  "example-property2": {
    "name": "Cor",
    "value": "Amarelo",
    "defining": true
  }
}

property3

variant_property

Modelo que representa uma propriedade customizada na API

object

defining

required

Indica se a variante possui uma definição (true) ou se a variante não possui (false)

boolean

name

required

Nome da propriedade

string

value

Valor da propriedade

string

Example

{
  "example-property1": {
    "name": "Tamanho",
    "value": "G",
    "defining": true
  },
  "example-property2": {
    "name": "Cor",
    "value": "Amarelo",
    "defining": true
  }
}

updated_at

Data e horário da última atualização do item

string format: date-time

price

Preço unitário do produto

number

installments

Parcelas para pagamento parcelado

Array<number>

available_quantity

Unidades da variante disponíveis para compra

integer

weight

Massa da unidade, em gramas

number

width

Largura da unidade, em centímetros

number

height

Altura da unidade, em centímetros

number

length

Comprimento da unidade, em centímetros

number

handling_days

Número de dias para manuseio do produto

integer

inventories

Array<object>

Modelo que representa um inventário da variante

object

id

integer

>= 1

name

string

>= 1 characters

place_id

integer

price

Preço do item

number

quantity

integer

quantity_sold

Quantidade de itens vendidos

integer

sale_price

Preço promocional

number

slug

string

sale_price

Preço promocional da variante

number

intl_price

Preço internacional

number

image_url

URL da imagem da variante

string

product_id

Código identificador do produto

integer

barcode

Código de barras da variante

string

nullable

norder

integer

variant_sku

required

Código SKU da Variante

string

product_type

Tipo de produto

string

image_url

URL da imagem da variante

string

nullable

items_count

Unidades do item no carrinho

integer

shipping_address_id

Código identificador ID do endereço de entrega do carrinho

integer

nullable

shipping_method

Método de envio selecionado para o carrinho, como por exemplo: normal, expressa e agendada.

string

nullable

shipping_methods

Lista com as entregas disponíveis para os itens do carrinho de acordo com o endereço de envio

Array<object>

Métodos de envio

Modelo de método de envio

object

name

Nome do tipo de entrega, como por exemplo Normal, Expressa e Agendada

string

value

Identificador do método de envio

string

price

Preço de envio

number

description

Descrição do tipo de envio e prazo

string

delivery_days

Número em dias do prazo de envio

integer

value_needed_to_discount

Valor restante da compra para que o carrinho fique elegível para frete grátis

number

nullable

shipping_method_id

Código identificador ID do tipo de envio

integer

notice

Mensagem ou observação sobre a forma de envio

string

nullable

fulfillment_company

Empresa responsável pelo envio

string

nullable

shipping_price

Preço de envio

number

nullable

subtotal

Valor da soma dos itens do carrinho, sem considerar descontos de cupom, carrinho e frete.

number

token

Token do carrinho

string

total

Valor final do carrinho

number

total_for_deposit

Valor total do carrinho para pagamento por depósito

number

total_for_slip

Valor total do carrinho para pagamento por boleto

number

total_for_pix

Valor do carrinho para pagamento por PIX

number

updated_at

Data da última atualização do carrinho

string format: date-time

rebate_token

Código identificador ID do desconto por bônus

string

nullable

rebate_discount

Desconto por bônus do cliente

number

handling_days

Número de dias para manuseio dos itens

number

subtotal_discount

Valor de desconto de promoções aplicadas ao subtotal do carrinho

number

total_discount

Valor de desconto de promoções aplicadas ao valor total do carrinho

number

user_id

Código identificador ID do cliente

string

422

Parâmetros enviados inválidos

422

Erro de validação na criação e atualização de registros

object

errors

object

{field}

Array<string>

Headers

X-Request-Id

string

Código Identificador ID da requisição