Atualiza dados extras de um pedido

PATCH

/api/v2/orders/{order_code}

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

Atualiza o campo de dados extras de um pedido pelo code do pedido

Authorizations

• Token
• X-Shop-Host

Parameters

Path Parameters

order_code

required

string

>= 10 characters <= 64 characters

Código identificador (code) ou token do pedido

Query Parameters

include_customizations_in_total

boolean

Se “true” inclui o preço dos produtos customizados no total do pedido. Se “false” retorna o total do pedido sem a somatória do preço de produtos customizados.

Request Body

object

extra

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

object

Responses

204

Dado extra alterado

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

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

404

Pedido não encontrado

404

Domínio de loja não encontrado

object

error

required

string

Allowed values: not found

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