Merchant Orders API
Attributes
AttributeTypeDescription
id
Integer
Order identifier.
preference_id
String(UUID)
Payment preference identifier associated to the merchant order.
date_created
Date(ISO_8601)
Order's creation date.
last_updated
Date(ISO_8601)
Order's last update date.
application_id
String
application identifier.
status
String
Show the current merchant order state.
opened
Order without payments.
closed
Order with payments covering total amount.
expired
Canceled order (canceled: true) that does not have approved or pending payments (all rejected or returned).
site_id
String
Country identifier that merchant order belongs to.
payer
Object
Buyer Information.
id
Integer
Buyer id.
email
String(256)
Deprecated field, will return an empty string.
nickname
String(256)
Buyer nickname.
collector
Object
Mercado Pago seller ID.
id
Integer
Collector id.
nickname
String(256)
Collector nickname.
sponsor_id
Integer
Sponsor ID in Mercado Pago.
payments
Array(Object)
Payments information.
id
Integer
Payment id.
transaction_amount
Float
Product Cost.
total_paid_amount
Float
Total amount paid by the buyer.
shipping_cost
Float
Shipping fee.
currency_id
String(3)
ID of the currency used in the payment.
ARS
Argentine peso.
BRL
Brasil real.
CLP
Chilean peso.
MXN
Mexican peso.
COP
Colombian peso.
PEN
Peruvian sol.
UYU
Uruguayan peso.
status
String
Payment status.
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
Gives more detailed information on the current state or rejection cause.
operation_type
String
Operation data_type.
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 a user's cellophone account.
pos_payment
Payment done through a Point Of Sale.
date_approved
Date(ISO_8601)
Payment's approvation date.
date_created
Date(ISO_8601)
Payment's creation date.
last_modified
Date(ISO_8601)
Payment's last modification date.
amount_refunded
Float
Amount refunded in this payment.
paid_amount
Float
Amount paid in this Order.
refunded_amount
Float
Amount refunded in this Order.
shipping_cost
Float
Shipping fee.
cancelled
Boolean
If the Order is expired or not.
items
Array(Object)
items information.
id
String
Item id.
put
Required in PUT
category_id
String
Item category.
currency_id
String(3)
ID of the currency used in the item price.
ARS
Argentine peso.
BRL
Brasil real.
CLP
Chilean peso.
MXN
Mexican peso.
COP
Colombian peso.
PEN
Peruvian sol.
UYU
Uruguayan peso.
description
String
Item description.
picture_url
String
Item picture URL.
quantity
Integer
Item quantity.
put
This is the only field of item that can be modified in put
unit_price
Float
Item unit price.
title
String
Item title.
shipments
Array(Object)
Shipments information.
id
Integer
Shipping identifier.
shipment_type
String
Shipping type.
shipping_mode
String
Shipping mode.
picking_type
String
Shipping picking type.
status
String
Shipping picking type.
substatus
String
Shipping picking type.
items
Array(Object)
Shipping items.
date_created
Date(ISO_8601)
Shipping's creation date.
last_modified
Date(ISO_8601)
Shipping's last modification date.
date_first_printed
Date(ISO_8601)
Shipping's first printed date.
service_id
String
Shipping service identifier.
sender_id
Integer
Sender identifier.
receiver_id
Integer
Receiver identifier.
receiver_address
Object
Shipping address.
id
Integer
Identifier of receiver address.
address_line
String
Street name and number of receiver address.
apartment
String(256)
Apartment.
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)
Zip code.
street_name
String(256)
Street name.
street_number
String(256)
Street number.
floor
String(256)
Floor.
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 where you'd like to receive a payment notification.
additional_info
String(600)
Additional information.
external_reference
String(256)
Reference you can synchronize with your payment system.
marketplace
String(256)
Origin of the payment. Default value: '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.
expired
Canceled order (canceled: true) that does not have approved or pending payments (all rejected or returned).