Pular para o conteúdo
Olist Ecommerce

Lista os pedidos

GET
/api/v2/clients/{id}/orders

Retorna a lista de pedidos do cliente

Authorizations

Seção intitulada “Authorizations ”

Parameters

Seção intitulada “ Parameters ”

Path Parameters

Seção intitulada “Path Parameters ”
id
required
string

Responses

Seção intitulada “ Responses ”

200

Seção intitulada “200 ”

Quando os pedidos são retornados

Array<object>
Order

Modelo que representa um pedido na API

object
rebate_discount
required
number
rebate_token
string
nullable
user_id
integer
updated_at
required
string
tracking_code_list
Array<string>
tracking_code
string
total
required
number
token
required
string
taxes
required
number
subtotal
required
number
status
required
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
string format: date-time
nullable
received_at
required
string format: date-time
nullable
payment_tid
string
nullable
payment_method
required
string
payment_gateway
required
string
nullable
payment_authorization
required
string
nullable
paid_at
required
string format: date-time
nullable
items
Array<object>
object
extra
required
object
height
number
id
integer
length
number
original_price
number
package
string
picture_url
string
place_city
string
nullable
place_id
integer
place_name
string
nullable
price
number
product_id
required
integer
product_name
required
string
quantity
required
integer
reference
required
string
sku
required
string
total
required
number
variant_id
required
integer
variant_name
required
string
nullable
weight
required
number
width
required
number
barcode
string
installments
number
>= 1
id
integer
extra
object
expected_delivery_date
string format: date
email
required
string
discount_price
required
number
deposit
required
boolean
delivery_type
string
delivery_message
string
delivery_days
integer
delivered_at
required
string format: date-time
nullable
coupon_code
required
string
nullable
confirmed_at
required
string format: date-time
nullable
code
required
string
client_id
required
integer
channel
required
string
Allowed values: ecommerce direct
cart_id
required
integer
card_validity
required
string
nullable
card_number
required
string
/^[*]{10,12}[0-9]{4}$/
card
required
boolean
canceled_at
string format: date-time
nullable
browser_ip
required
string format: ipv4
agent
string
nullable
affiliate_tag
string
nullable
pix_qr_code
string
nullable
payment_authorization_code
string
nullable
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