Merchant Orders API
Attributes
AttributeTypeDescription
id
Integer
Identificador de ordem.
preference_id
String(UUID)
Identificação da preferência de pagamento associados à ordem.
date_created
Date(ISO_8601)
Data de criação da ordem.
last_updated
Date(ISO_8601)
Data da última actualização da ordem.
application_id
String
Id do aplicativo.
status
String
Exibe o estado atual da ordem.
opened
Order without payments.
closed
Order with payments covering total amount.
site_id
String
Identificador do país a que pertence a ordem.
payer
Object
Informação do comprador.
id
Integer
Id do comprador.
email
String(256)
E-mail do comprador.
nickname
String(256)
Nick do comprador.
collector
Object
Id do vendedor no Mercado Pago.
id
Integer
Id do collector.
email
String(256)
E-mail do collector.
nickname
String(256)
Nick do collector.
sponsor_id
Integer
Sponsor ID in Mercado Pago.
payments
Array(Object)
Payments information.
id
Integer
Id do pagamento.
transaction_amount
Float
Custo do produto.
total_paid_amount
Float
Montante total pago pelo comprador.
shipping_cost
Float
Custo de transporte.
currency_id
String(3)
Identificador da moeda utilizada no pagamento.
ARS
Argentine peso.
BRL
Brasil real.
CLP
Chilean peso.
MXN
Mexican peso.
COP
Colombian peso.
PEN
Peruvian sol.
UYU
Uruguayan peso.
status
String
Estado do pagamento.
pending
The user has not yet completed the payment process.
approved
The payment has been approved and accredited.
authorized
The payment has been authorized but not captured yet.
in_process
Payment is being reviewed.
in_mediation
Users have initiated a dispute.
rejected
Payment was rejected. The user may retry payment.
cancelled
Payment was cancelled by one of the parties or because time for payment has expired.
refunded
Payment was refunded to the user.
charged_back
Was made a chargeback in the buyer's credit card.
status_detail
String
Fornece mais informações do status do pagamento ou da causa de rejeição.
operation_type
String
data_type da operação.
regular_payment
Typification by default of a purchase being paid using Mercado Pago.
payment_addition
Addition of money to an existing payment, done in Mercado Pago's site.
money_transfer
Funds transfer between two users.
recurring_payment
Automatic recurring payment due to an active user subscription.
account_fund
Money income in the user's account,.
cellphone_recharge
Recharge of an user's cellphone account.
pos_payment
Payment done through a Point Of Sale.
date_approved
Date(ISO_8601)
Data de aprovação do pagamento
date_created
Date(ISO_8601)
Data de criação do pagamento.
last_modified
Date(ISO_8601)
Data da última atualização do pagamento.
amount_refunded
Float
Valor reembolsado a esse pagamento.
paid_amount
Float
Valor pago na ordem.
refunded_amount
Float
Montante reembolsado no caso de na ordem.
shipping_cost
Float
Custo de transporte.
cancelled
Boolean
Indica se a ordem está expirada ou não.
items
Array(Object)
Informação do item.
id
String
Id do anúncio.
put
Required in PUT
category_id
String
Categoria do item.
currency_id
String(3)
Identificador da moeda utilizada no preço do item.
ARS
Argentine peso.
BRL
Brasil real.
CLP
Chilean peso.
MXN
Mexican peso.
COP
Colombian peso.
PEN
Peruvian sol.
UYU
Uruguayan peso.
description
String
Descrição do anúncio.
picture_url
String
URL da imagem do anúncio.
quantity
Integer
Item quantity.
put
This is the only field of item that can be modified in put
unit_price
Float
Preço unitário do item.
title
String
Título do item.
shipments
Array(Object)
Shipments information.
id
Integer
Id do frete.
shipment_type
String
Tipo de transporte.
shipping_mode
String
Modo de envio.
picking_type
String
Taxa de remoção de envio.
status
String
Taxa de remoção de envio.
substatus
String
Taxa de remoção de envio.
items
Array(Object)
Itens a enviar.
date_created
Date(ISO_8601)
Data de criação do frete.
last_modified
Date(ISO_8601)
Data da última atualização do frete.
date_first_printed
Date(ISO_8601)
Primeira data de impressão do frete.
service_id
String
Identificador de serviço do transporte.
sender_id
Integer
Id do remetente.
receiver_id
Integer
Id do receptor.
receiver_address
Object
Endereço de envio.
id
Integer
Identifier of receiver address.
address_line
String
Street name and number of receiver address.
apartment
String(256)
Apartamento.
city
Object
Information about receiver address city.
id
String
City Identifier.
name
String
City name.
country
Object
Information about receiver address country.
id
String
Country identifier.
name
String
Country name.
state
Object
Information about receiver address state.
id
String
State identifier.
name
String
State name.
comment
String
Comment about receiver address.
contact
String
Contact information.
zip_code
String(256)
Código postal.
street_name
String(256)
Rua.
street_number
String(256)
O Número.
floor
String(256)
Apartamento.
phone
String(256)
Receiver address phone.
latitude
String(256)
Receiver address latitude.
longitude
String(256)
Receiver address longitude.
shipping_option
Object
Shipping options.
cost
Float
Net cost absorbed by the receiver.
currency_id
String(3)
Currency identifier.
ARS
Argentine peso.
BRL
Brasil real.
CLP
Chilean peso.
MXN
Mexican peso.
COP
Colombian peso.
PEN
Peruvian sol.
UYU
Uruguayan peso.
estimated_delivery
Object
Estimated delivery time information.
date
Date(ISO_8601)
Estimated delivery date.
time_from
String
Estimated lower delivery time.
time_to
String
Estimated upper delivery time.
id
Integer
Shipping option identifier.
list_cost
Float
Net cost of the shipping.
name
String
Option name.
shipping_method_id
Integer
Shipping method identifier.
speed
Object
Shipping time information.
handling
Integer
Handling time.
shipping
Integer
Shipping time.
notification_url
String(500)
URL em que você gostaria de receber uma notificação de status de pagamento.
additional_info
String(600)
Informações adicionais do pagamento.
external_reference
String(256)
Referência que pode sincronizar com seu sistema de pagamentos.
marketplace
String(256)
Origem do pagamento. Valor padrão: 'NONE'
total_amount
Float
Total amount of the order.
order_status
String
Current merchant order status given the payments status.
payment_required
Order without payments or with all payments "rejected" or "cancelled".
reverted
Order with all payments "refunded" or "chargeback".
paid
Order with the sum of all payments "approved", "chargeback" or "in_mediation" covers the order total amount.
partially_reverted
Order with at least one payment "refunded" or "chargeback".
partially_paid
Order with at least one payment "approved" and not covering order total amount.
payment_in_process
Order with payments "in_process", "pending" or "authorized".
undefined
Order created before the existence of the order_status status.