Retorna um pedido

GET

/api/v2/orders/{order_code}

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

Retorna os dados de um pedido pelo code ou token 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.

include_shipping_address

boolean

Inclui as formas de entrega do pedido

Responses

200

OK

Pedido

Modelo de pedido

object

rebate_discount

required

Desconto por bônus do cliente

number

rebate_token

Código identificador ID do desconto por bônus

string

nullable

user_id

Código identificador ID do cliente

integer

updated_at

required

Data da última atualização do pedido

string

tracking_code_list

Lista com os códigos de rastreio dos pacotes do pedido

Array<string>

tracking_code

Código de rastreio do pacote

string

total

required

Valor final do pedido

number

token

required

string

taxes

required

number

subtotal

required

Valor da soma dos itens do pedido, desconsiderando descontos e frete.

number

status

required

Status do pedido

string

Allowed values: received confirmed canceled

payment_due_date

string format: date

slip_url

string

slip_token

string

slip_due_date

string format: date

slip

required

boolean

shipping_tracked_at

string format: date-time

shipping_price

number

shipping_label

string

shipped_at

required

Data e horário de envio do pedido

string format: date-time

nullable

received_at

required

Data e horário de recebimento do pedido

string format: date-time

nullable

payment_tid

string

nullable

payment_method

required

Método de pagamento do pedido

string

payment_gateway

required

string

nullable

payment_authorization

required

string

nullable

paid_at

required

Data e horário do pagamento do pedido

string format: date-time

nullable

items

Array<object>

Produto em um pedido

Modelo de produto em um pedido

object

extra

required

Dados extra do produto

object

height

Altura do produto, em centímetros.

number

id

Código identificador do produto

integer

length

Comprimento do produito, em centímetros.

number

original_price

Preço original

number

package

Pacote do produto

string

picture_url

URL da imagem do produto

string

place_city

Cidade que o produto está

string

nullable

place_id

Código identificador do local do produto

integer

place_name

Nome do local do produto

string

nullable

price

Preço do produto

number

product_id

required

integer

product_name

required

string

quantity

required

Unidades do produto

integer

reference

required

Código de referência do produto

string

sku

required

Código SKU da variante do produto

string

total

required

Valor total do produto

number

variant_id

required

Código identificador da variante do produto

integer

variant_name

required

Nome da variante do produto

string

nullable

weight

required

Massa do produto, em gramas

number

width

required

Largura do produto, em centímetros

number

barcode

Código de barras do produto

string

has_customizations

Indica se o produto possui customização.

boolean

installments

Parcelas do pagamento parcelado

number

>= 1

id

Código identificador do pedido

integer

extra

Campo de observações do pedido

object

expected_delivery_date

string format: date

email

required

Email do cliente

string

discount_price

required

Valor do desconto aplicado no pedido

number

deposit

required

boolean

delivery_type

string

delivery_message

string

delivery_days

Dias para entrega

integer

delivered_at

required

Data de entrega do pedido

string format: date-time

nullable

coupon_code

required

Código de cupom do pedido

string

nullable

confirmed_at

required

Data e horário de confirmação do pedido

string format: date-time

nullable

code

required

Código do pedido

string

client_id

required

Código identificador (ID) do cliente

integer

channel

required

Canal de venda que originou o pedido

string

Allowed values: ecommerce direct

cart_id

required

Código identificador do carrinho que originou o pedido

integer

card_validity

required

Data de validade do cartão de crédito

string

nullable

card_number

required

Número do cartão de crédito

string

/^[*]{10,12}[0-9]{4}$/

card

required

Retorna true se o método de pagamento do pedido é por cartão de crédito.

boolean

canceled_at

Data e horário do cancelamento do pedido

string format: date-time

nullable

browser_ip

required

Endereço IP de origem do pedido

string format: ipv4

agent

Agente do pedido

string

nullable

affiliate_tag

string

nullable

pix_qr_code

string

nullable

payment_authorization_code

Código de autorização do pagamento

string

nullable

credits_discount

Indica o desconto de bônus nos pedidos

number

Example

0.1

bonus_granted

Indica se o pedido gerou bônus

boolean

has_split

boolean

pix

required

Indica se o pedido foi pago usando o Pix

boolean

ame_qr_code

string

nullable

ame

required

Indica se o pedido foi pago usando o Ame

boolean

antifraud_assurance

string

nullable

404

Pedido não encontrado

404

Domínio de loja não encontrado

object

error

required

string

Allowed values: not found