Adiciona um endereço de entrega

POST

/api/v2/carts/{cart_id}/shipping_address

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

Adiciona um endereço de entrega no carrinho

Authorizations

• Token
• X-Shop-Host

Parameters

Path Parameters

cart_id

required

string

Código identificador ID ou token do carrinho

Request Body

Endereço de envio

Modelo de endereço de envio para carrinho e pedido

object

first_name

Nome do cliente

string

last_name

Sobrenome do cliente

string

company_name

Nome da empresa (para clientes jurídicos)

string

email

Email do cliente

string format: email

first_phone_area

Código de Discagem Direta à Distância (DDD)

string

first_phone

Telefone do cliente

string

second_phone_area

Código de Discagem Direta à Distância (DDD)

string

second_phone

Telefone do cliente

string

recipient_name

Nome do recebedor

street_name

Logradouro

string

street_number

Número

string

complement

Complemento

string

neighborhood

Bairro

string

reference

Ponto de referência

string

zip

required

Código de Endereçamento Postal (CEP)

string

documents

Array<object>

object

cpf

Cadastro de Pessoa Física

string

rg

Registro Geral

string

cnpj

Cadastro Nacional de Pessoas Jurídicas

string

ie

Inscrição Estadual

string

Responses

201

Endereço adicionado com sucesso

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

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