Download as pdf or txt
Download as pdf or txt
You are on page 1of 58

05/07/2024, 09:49 Autorizations

Developers

Introduction 

Integration points


OAuth Token

Shipping Authorization

Cancellation of Shipments

Shipping Tracking 

Real Time Tracking 

Documents 

Security 

Tracking News Flow 

Tools 

Autorizations
Content
Introduction

Request Format

Request OAuth Format

Response Format

Status Codes

Examples

The following information provides the API


details to authorize a shipment with the

https://developers.mercadoenvios.com/en_us/authorization 1/58
05/07/2024, 09:49 Autorizations

carrier and get the tracking number and


any additional information to generate the
label that will be provided to the seller.

All the web services should be HTTP


REST. It’s expected that the web service
response uses the status codes
specification depending if the request was
successful or not.

Once a purchase has been performed on


the site, Mercado Libre will make a POST
request to the carrier as follows

POST /shipments/shipment_id/authorization

Note:

The shipment identifier


(shipment_id) is unique at
MELI´s side and must be
used to validate if there was
any previous autorization,
taking into account that a
retry mechanism is in place
just in case an authorization
fails.
The shipment identifier could
eventually be associated to
more than a tracking number
but, it must only exist a
unique "active" tracking
number at the carrier side.
Idempotence: in case of
receiving a request with a
shipment already authorized,
the service must retrieve a
response with “HTTP Code”
= 200, the same body and
tracking number that was
retrieved during the original
authorization.

https://developers.mercadoenvios.com/en_us/authorization 2/58
05/07/2024, 09:49 Autorizations

A cancelled shipment could


be authorized in a future so
this case should be taken
into account.
Mercado Libre will send data
with variable length in all
fields which could also
change over time so is
responsability of the carrier
to truncate data according to
their storage requirements.

Important:
The Tracking Number of any shipment must only change on “n” authorizations if, and only if, a cancellation
was prevously requested.

https://developers.mercadoenvios.com/en_us/authorization 3/58
05/07/2024, 09:49 Autorizations

https://developers.mercadoenvios.com/en_us/authorization 4/58
05/07/2024, 09:49 Autorizations

Depending on whether the authorization


was succesfull or not, it is expected that the
carrier retrieves a result according to the
specified at "Status Code" section. In case
of error, the communication will be retried
according to the retry schema defined as
part of the integration.

Important:
MTLS will be used for secure authorizations.

Request Format

Inside the body of the request a JSON will


be sent with the following attributes

id
Name

Long
Data type

Unique identifier of the shipment used by Mercado Libre, required to authorize. This ID will later be
Description used to notify the events that occur in the operational flow of the shipment.

Mandatory
Type

carrier
Name

String
Data type

https://developers.mercadoenvios.com/en_us/authorization 5/58
05/07/2024, 09:49 Autorizations

Name of the carrier on which we are going to authorize the shipment.


Description

Optional
Type

logistic
Name

String
Data type

Represents the shipment operation type. Possible values:


drop_off
Description
cross_docking
fulfillment

Optional
Type

market_place
Name

String
Data type

Indicates if the shipment was generated inside the Marketplace or outside.


Description

Optional
Type

direction
Name

String
Data type

https://developers.mercadoenvios.com/en_us/authorization 6/58
05/07/2024, 09:49 Autorizations

Indicates the direction of shipping. The allowed values are:


If the direction is
Description from the seller
to the buyer →
"foward"
If the direction is
from the buyer
to the seller →
"return"

Mandatorio
Type

site_id
Name

String
Data type

Country API (https://api.mercadolibre.com/sites)Site (https://api.mercadolibre.com/sites/xxx).


Description identifier on Sitesand the details in details
which the API
shipment
authorization
is to be
carried out.
The list of
possible
values can
be found in
the
Mandatory
Type

service_id
Name

Long
Data type

Service identifier used internally Services(https://api.mercadolibre.com/sites/xxx/shipping_services/)


Description by Mercado Libre to differentiateAPI for more information.
a specific contractual service of
the carrier. You can consult the
Mandatory
Type

https://developers.mercadoenvios.com/en_us/authorization 7/58
05/07/2024, 09:49 Autorizations

carrier_information
Name

Node
Data type

Contains elements relevant to the carrier.


Description

Mandatory
Type

carrier_information.contract
Name

String
Data type

Identifies the contract / service defined by the carrier with which the shipment is to be authorized.
Description For example, home delivery from the XD, shipment to DS agency, etc.

Optional
Type

carrier_information.account
Name

String
Data type

Identifies the account given by the carrier to Mercado Libre.


Description

Optional
Type

carrier_information.user
Name

String
Data type

https://developers.mercadoenvios.com/en_us/authorization 8/58
05/07/2024, 09:49 Autorizations

Identifies a mail system user assigned to the Mercado Libre client.


Description

Mandatory
Type

carrier_information.password
Name

String
Data type

Identifies the password associated with the system user..


Description

Mandatory
Type

carrier_information.agency
Name

Node
Data type

Contains information related to the destination agency. Mandatory only when it is a shipment to a
Description carrier agency.

Optional
Type

carrier_information.agency.id
Name

String
Data type

Id give Mercado Libre to the agency.


Description

Mandatory
Type

https://developers.mercadoenvios.com/en_us/authorization 9/58
05/07/2024, 09:49 Autorizations

carrier_information.agency.acronym
Name

String
Data type

Id give the carrier to the agency.


Description

Mandatory
Type

carrier_information.agency.description
Name

String
Data type

Agency name.
Description

Optional
Type

order_id
Name

Numeric
Data type

Internal purchase order id given by Mercado Libre.


Description

Optional
Type

shipment_information
Name

Node
Data type

https://developers.mercadoenvios.com/en_us/authorization 10/58
05/07/2024, 09:49 Autorizations

It contains all the information that is considered relevant for shipping authorization. Sender, grams.
Description receiver, item, etc. Measurements are in centimeters and weights in

Mandatory
Type

shipment_information.id
Name

Numeric
Data type

Shipment ID given by Mercado Libre.


Description

Mandatory
Type

shipment_information.international_information
Name

Node
Data type

Contains information related to international shipments


Description

Mandatory. Only for international shipments


Type

shipment_information.international_information.cif
Name

Node
Data type

Shipping cost concepts


Description

Optional
Type

https://developers.mercadoenvios.com/en_us/authorization 11/58
05/07/2024, 09:49 Autorizations

shipment_information.international_information.cif.cost
Name

Numeric
Data type

Declared value
Description

Optional
Type

shipment_information.international_information.cif.freight
Name

Numeric
Data type

Transport cost
Description

Optional
Type

shipment_information.international_information.cif.insurance
Name

Numeric
Data type

Insurance cost
Description

Optional
Type

shipment_information.international_information.tax_modality
Name

String
Data type

https://developers.mercadoenvios.com/en_us/authorization 12/58
05/07/2024, 09:49 Autorizations

Incoterms (International Commercial Terms). Values: DDP (Delivery Duty Paid) or DDU (Delivered
Description Duty Unpaid)

Mandatory
Type

shipment_information.international_information.destination_address
Nombre

Node
Tipo de dato

Receiver address, only applies to international shipments within the Mercado Libre logistics
Descripción network. The structure is the same as the shipment_information.receiver.address node

Optional
Tipo

shipment_information.international_information.delivery_to
Nombre

Nodo
Tipo de dato

Full name of the person receiving and flag that identifies whether the person receiving is the
Descripción importer or not.

Opcional
Tipo

shipment_information.international_information.delivery_to.full_name
Nombre

String
Tipo de dato

Full name of the person receiving the package.


Descripción

Mandatorio
Tipo

https://developers.mercadoenvios.com/en_us/authorization 13/58
05/07/2024, 09:49 Autorizations

shipment_information.international_information.delivery_to.full_name
Nombre

Boolean
Tipo de dato

Indicates whether the person to whom it is delivered is the importer.


Descripción

Opcional
Tipo

shipment_information.package
Name

Node
Data type

Package related information


Description

Mandatory
Type

shipment_information.package.tags
Name

String[]
Data type

Identify the characteristics that the package may have. For example: "bulky"
Description

Optional
Type

shipment_information.package.items
Name

Node
Data type

https://developers.mercadoenvios.com/en_us/authorization 14/58
05/07/2024, 09:49 Autorizations

Information related to the items


Description

Mandatory
Type

shipment_information.package.items.item_id
Name

String
Data type

Item identification number on Mercadolibre


Description

Mandatory
Type

shipment_information.package.items.description
Name

String
Data type

Item description on Mercadlibre


Description

Mandatory
Type

shipment_information.package.items.domain_id
Name

String
Data type

Item domain number on Mercado Libre


Description

Optional
Type

https://developers.mercadoenvios.com/en_us/authorization 15/58
05/07/2024, 09:49 Autorizations

shipment_information.package.items.tariff_code
Name

String
Data type

Global standard maintained byWCO.


Description

Optional. Only for international shipments


Type

shipment_information.package.items.made_in
Name

String
Data type

Description

Optional
Type

shipment_information.package.items.quantity
Name

Numeric
Data type

Quantity per item.


Description

Mandatory
Type

shipment_information.package.currency_id
Name

String
Data type

https://developers.mercadoenvios.com/en_us/authorization 16/58
05/07/2024, 09:49 Autorizations

Currency (USD)
Description

Mandatory. Only for international shipments


Type

shipment_information.package.amount
Name

Numeric
Data type

Amount paid for the package content.


Description

Mandatory
Type

shipment_information.package.description
Name

String
Data type

Package content.
Description

Optional
Type

shipment_information.package.dimensions
Name

Node
Data type

Package dimensions and weight.


Description

Type

https://developers.mercadoenvios.com/en_us/authorization 17/58
05/07/2024, 09:49 Autorizations

shipment_information.package.dimensions.height
Name

Numeric
Data type

Height of the package in centimeters.


Description

Mandatory
Type

shipment_information.package.dimensions.length
Name

Numeric
Data type

Length of the package in centimeters.


Description

Mandatory
Type

shipment_information.package.dimensions.width
Name

Numeric
Data type

Width of the package in centimeters.


Description

Mandatory
Type

shipment_information.package.dimensions.weight
Name

Numeric
Data type

https://developers.mercadoenvios.com/en_us/authorization 18/58
05/07/2024, 09:49 Autorizations

Weight of the package in grams.


Description

Mandatory
Type

shipment_information.receiver
Name

Node
Data type

Information related to the receiver


Description

Mandatory
Type

shipment_information.receiver.id
Name

Numeric
Data type

Receiver id.
Description

Mandatory
Type

shipment_information.receiver.nickname
Name

String
Data type

Receiver nickname.
Description

Mandatory
Type

https://developers.mercadoenvios.com/en_us/authorization 19/58
05/07/2024, 09:49 Autorizations

shipment_information.receiver.email
Name

String
Data type

Receiver email.
Description

Mandatory
Type

shipment_information.receiver.full_name
Name

String
Data type

Full name or company name of the recipient


Description

Mandatory
Type

shipment_information.receiver.first_name
Name

String
Data type

First name
Description

Mandatory
Type

shipment_information.receiver.last_name
Name

String
Data type

https://developers.mercadoenvios.com/en_us/authorization 20/58
05/07/2024, 09:49 Autorizations

Last name.
Description

Mandatory
Type

shipment_information.receiver.brand_name
Name

String
Data type

Trade name.
Description

Optional
Type

shipment_information.receiver.phone
Name

Node
Data type

Information related to the receiver's phone data


Description

Type

shipment_information.receiver.phone.number
Name

String
Data type

Only numbers
Description

Mandatory
Type

https://developers.mercadoenvios.com/en_us/authorization 21/58
05/07/2024, 09:49 Autorizations

shipment_information.receiver.phone.extension
Name

String
Data type

Only numbers
Description

Optional
Type

shipment_information.receiver.phone.area_code
Name

String
Data type

Only numbers
Description

Optional
Type

shipment_information.receiver.address
Name

Node
Data type

Information related to the receiver's address


Description

Mandatory
Type

shipment_information.receiver.address.street_name
Name

String
Data type

https://developers.mercadoenvios.com/en_us/authorization 22/58
05/07/2024, 09:49 Autorizations

Street name
Description

Mandatory
Type

shipment_information.receiver.address.street_number
Name

String
Data type

Street number.
Description

Optional
Type

shipment_information.receiver.address.intersection
Name

String
Data type

Secondary street.
Description

Mandatory in Ecuador
Type

shipment_information.receiver.address.address_line
Name

String
Data type

Contains the street_name and street_number fields data


Description

Mandatory
Type

https://developers.mercadoenvios.com/en_us/authorization 23/58
05/07/2024, 09:49 Autorizations

shipment_information.receiver.address.comment
Name

String
Data type

Comments
Description

Optional
Type

shipment_information.receiver.address.zip_code
Name

String
Data type

Zip code
Description

Mandatory in Argentina, Brasil, México and Peru. Optional in Colombia, Uruguay, Chile and
Type Ecuador.

shipment_information.receiver.address.city
Name

Node
Data type

Destination city
Description

Mandatory
Type

shipment_information.receiver.address.city.id
Name

String
Data type

https://developers.mercadoenvios.com/en_us/authorization 24/58
05/07/2024, 09:49 Autorizations

Unique city identifier provided by Mercado Libre.


Description

Mandatory in Colombia, Uruguay, Chile and Ecuador. Optional in Argentina, Brasil, Mexico and
Type Peru

shipment_information.receiver.address.city.name
Name

String
Data type

City name
Description

Mandatory
Type

shipment_information.receiver.address.state
Name

Node
Data type

State, department or province of destination.


Description

Mandatory
Type

shipment_information.receiver.address.state.id
Name

String
Data type

Unique state identifier provided by Mercado Libre. Format ISO 3166.


Description

Mandatory
Type

https://developers.mercadoenvios.com/en_us/authorization 25/58
05/07/2024, 09:49 Autorizations

shipment_information.receiver.address.state.name
Name

String
Data type

State name.
Description

Mandatory
Type

shipment_information.receiver.address.country
Name

Node
Data type

Destination country.
Description

Mandatory
Type

shipment_information.receiver.address.country.id
Name

String
Data type

Unique identifier that Mercado Libre gives the country in ISO 3166 Format.
Description

Mandatory
Type

shipment_information.receiver.address.country.name
Name

String
Data type

https://developers.mercadoenvios.com/en_us/authorization 26/58
05/07/2024, 09:49 Autorizations

Country name.
Description

Mandatory
Type

shipment_information.receiver.address.neighborhood
Name

Node
Data type

Destination neighborhood.
Description

Optional
Type

shipment_information.receiver.address.neighborhood.id
Name

String
Data type

Unique neighborhood identifier.


Description

Optional
Type

shipment_information.receiver.address.neighborhood.name
Name

String
Data type

Neighborhood name.
Description

Optional
Type

https://developers.mercadoenvios.com/en_us/authorization 27/58
05/07/2024, 09:49 Autorizations

shipment_information.receiver.address.municipality
Name

Node
Data type

Municipality of destination.
Description

Optional
Type

shipment_information.receiver.address.municipality.id
Name

String
Data type

Unique municipality identifier.


Description

Optional
Type

shipment_information.receiver.address.municipality.name
Name

String
Data type

Municipality name.
Description

Optional
Type

shipment_information.receiver.address.geolocation
Name

Node
Data type

https://developers.mercadoenvios.com/en_us/authorization 28/58
05/07/2024, 09:49 Autorizations

Address location.
Description

Optional
Type

shipment_information.receiver.address.geolocation.geolocation_type
Name

String
Data type

It can be one of the following values:


APPROXIMATE:
Description approximate
geolocation.
GEOMETRIC_CENTER:
locates the
center of a
region that is
used as a
reference.
RANGE_INTERPOLATED:
restricts
precision to the
midpoint of 2
nearby
reference
points.
ROOFTOP:
indicates that
the location is
exact.
UNKNOWN:
indicates that
the location was
not validated.

Mandatory
Type

shipment_information.receiver.address.geolocation.latitude
Name

Numeric
Data type

https://developers.mercadoenvios.com/en_us/authorization 29/58
05/07/2024, 09:49 Autorizations

Latitude in number format with 8 decimal places.


Description

Mandatory
Type

shipment_information.receiver.address.geolocation.longitude
Name

Numeric
Data type

Longitude of the location in number format with 8 decimal places.


Description

Mandatory
Type

shipment_information.receiver.address.delivery_preference
Name

String
Data type

Type of address where it's send the package.


Description It has two possibles values "business" or "residential".

Optional
Type

shipment_information.receiver.identification
Name

Node
Data type

Receiver Identification
Description

Mandatory for international shipments to Chile and Brazil (MLC and MLB). Optional for other
Type destinations

https://developers.mercadoenvios.com/en_us/authorization 30/58
05/07/2024, 09:49 Autorizations

shipment_information.receiver.identification.type
Name

String
Data type

Receiver Identification Type (it may vary depending on the country)


Description

Mandatory for international shipments to Chile and Brazil (MLC and MLB). Optional for other
Type destinations

shipment_information.receiver.identification.number
Name

Numeric
Data type

Receiver identification number


Description

Mandatory for international shipments to Chile and Brazil (MLC and MLB). Optional for the other
Type destinations

shipment_information.sender
Name

Node
Data type

Sender information
Description

Mandatory
Type

shipment_information.sender.id
Name

Numeric
Data type

https://developers.mercadoenvios.com/en_us/authorization 31/58
05/07/2024, 09:49 Autorizations

Sender id.
Description

Mandatory
Type

shipment_information.sender.nickname
Name

String
Data type

Sender nickname.
Description

Mandatory
Type

shipment_information.sender.email
Name

String
Data type

Sender email.
Description

Mandatory
Type

shipment_information.sender.full_name
Name

String
Data type

Sender full name or company name


Description

Mandatory
Type

https://developers.mercadoenvios.com/en_us/authorization 32/58
05/07/2024, 09:49 Autorizations

shipment_information.sender.first_name
Name

String
Data type

Sender name
Description

Mandatory
Type

shipment_information.sender.last_name
Name

String
Data type

Sender last name


Description

Mandatory
Type

shipment_information.sender.brand_name
Name

String
Data type

Trade name.
Description

Optional
Type

shipment_information.sender.phone
Name

Node
Data type

https://developers.mercadoenvios.com/en_us/authorization 33/58
05/07/2024, 09:49 Autorizations

Sender phone information


Description

Mandatory
Type

shipment_information.sender.phone.number
Name

String
Data type

Only numbers
Description

Mandatory
Type

shipment_information.sender.phone.extension
Name

String
Data type

Only numbers
Description

Optional
Type

shipment_information.sender.phone.area_code
Name

String
Data type

Only numbers
Description

Optional
Type

https://developers.mercadoenvios.com/en_us/authorization 34/58
05/07/2024, 09:49 Autorizations

shipment_information.sender.address
Name

Node
Data type

Information related to the sender address


Description

Mandatory
Type

shipment_information.sender.address.street_name
Name

String
Data type

Street name.
Description

Mandatory
Type

shipment_information.sender.address.street_number
Name

String
Data type

Street number.
Description

Optional
Type

shipment_information.sender.address.intersection
Name

String
Data type

https://developers.mercadoenvios.com/en_us/authorization 35/58
05/07/2024, 09:49 Autorizations

Secondary street.
Description

Mandatory in Ecuador
Type

shipment_information.sender.address.address_line
Name

String
Data type

Contains the street_name and street_number fields data


Description

Mandatory
Type

shipment_information.sender.address.comment
Name

String
Data type

Description

Optional
Type

shipment_information.sender.address.zip_code
Name

String
Data type

Zip code.
Description

Mandatory in Argentina, Brasil, México and Peru. Optional in Colombia, Uruguay, Chile and
Type Ecuador.

https://developers.mercadoenvios.com/en_us/authorization 36/58
05/07/2024, 09:49 Autorizations

shipment_information.sender.address.city
Name

Node
Data type

Origin city.
Description

Mandatory
Type

shipment_information.sender.address.city.id
Name

String
Data type

Unique city identifier provided by Mercado Libre.


Description

Mandatory in Colombia, Uruguay, Chile and Ecuador. Optional in Argentina, Brasil, Mexico and
Type Peru

shipment_information.sender.address.city.name
Name

String
Data type

City name.
Description

Mandatory
Type

shipment_information.sender.address.state
Name

Node
Data type

https://developers.mercadoenvios.com/en_us/authorization 37/58
05/07/2024, 09:49 Autorizations

State, department or province of origin.


Description

Mandatory
Type

shipment_information.sender.address.state.id
Name

String
Data type

Unique state identifier provided by Mercado Libre. Format ISO 3166.


Description

Mandatory
Type

shipment_information.sender.address.state.name
Name

String
Data type

State name.
Description

Mandatory
Type

shipment_information.sender.address.country
Name

Node
Data type

Origin country.
Description

Mandatory
Type

https://developers.mercadoenvios.com/en_us/authorization 38/58
05/07/2024, 09:49 Autorizations

shipment_information.sender.address.country.id
Name

String
Data type

Unique identifier that Mercado Libre gives the country in ISO 3166 Format.
Description

Mandatory
Type

shipment_information.sender.address.country.name
Name

String
Data type

Country name.
Description

Mandatory
Type

shipment_information.sender.address.neighborhood
Name

Node
Data type

Origin neighborhood
Description

Optional
Type

shipment_information.sender.address.neighborhood.id
Name

String
Data type

https://developers.mercadoenvios.com/en_us/authorization 39/58
05/07/2024, 09:49 Autorizations

Unique neighborhood identifier.


Description

Optional
Type

shipment_information.sender.address.neighborhood.name
Name

String
Data type

Neighborhood name.
Description

Optional
Type

shipment_information.sender.address.municipality
Name

Node
Data type

Municipality of origin.
Description

Optional
Type

shipment_information.sender.address.municipality.id
Name

String
Data type

Unique municipality identifier.


Description

Optional
Type

https://developers.mercadoenvios.com/en_us/authorization 40/58
05/07/2024, 09:49 Autorizations

shipment_information.sender.address.municipality.name
Name

String
Data type

Municipality name.
Description

Optional
Type

shipment_information.sender.address.geolocation
Name

Node
Data type

Address location.
Description

Optional
Type

shipment_information.sender.address.geolocation.geolocation_type
Name

String
Data type

It can be one of the following values:


APPROXIMATE:
Description
approximate
geolocation.
GEOMETRIC_CENTER:
locates the
center of a
region that is
used as a
reference.
RANGE_INTERPOLATED:
restricts
precision to the
midpoint of 2
nearby
reference
points.

https://developers.mercadoenvios.com/en_us/authorization 41/58
05/07/2024, 09:49 Autorizations
ROOFTOP:
indicates that
the location is
exact.
UNKNOWN:
indicates that
the location was
not validated.

Mandatory
Type

shipment_information.sender.address.geolocation.latitude
Name

Numeric
Data type

Latitude in number format with 8 decimal places.


Description

Mandatory
Type

shipment_information.sender.address.geolocation.longitude
Name

Numeric
Data type

Longitude of the location in number format with 8 decimal places.


Description

Mandatory
Type

shipment_information.sender.address.facility_id
Name

String
Data type

Unique facility identifier


Description

https://developers.mercadoenvios.com/en_us/authorization 42/58
05/07/2024, 09:49 Autorizations

Optional
Type

shipment_information.order_pickup_information
Nombre

Node
Tipo de dato

Information related to Proximity Marketplace shipments.


Descripción

Optional
Tipo

shipment_information.order_pickup_information.id
Nombre

Long
Tipo de dato

Order identifier.
Descripción

Mandatory
Tipo

shipment_information.order_pickup_information.cooking_time
Nombre

Node
Tipo de dato

It contains information about order preparation time.


Descripción

Mandatory
Tipo

shipment_information.order_pickup_information.cooking_time.value
Nombre

https://developers.mercadoenvios.com/en_us/authorization 43/58
05/07/2024, 09:49 Autorizations

Long
Tipo de dato

Preparation time numeric value.


Descripción

Mandatory
Tipo

shipment_information.order_pickup_information.cooking_time.measure
Nombre

String
Tipo de dato

Preparation time unit of measure.


Descripción

Mandatory
Tipo

shipment_information.order_pickup_information.store_name
Nombre

String
Tipo de dato

Store name.
Descripción

Mandatory
Tipo

shipment_information.order_pickup_information.tip
Nombre

Nodo
Tipo de dato

Contains the information The tip If the tip value is assigned, but the
regarding the tip benefit AMOUNT:
Descripción Represents the node is only responsible api does not respond
sent from the buyer to
the rider. The node is numerical value
present if with the aforementioned
composed of the fields: of the tip. (It is
possible that it there is a tipinformation, the authorization flow
https://developers.mercadoenvios.com/en_us/authorization 44/58
05/07/2024, 09:49 Autorizations
is presented value will continue, without presenting the
with decimals)
CURRENCY: assigned. tip node.
Represents the
currency value
of the tip.

Optional
Tipo

shipment_information.order_pickup_information.tip.amount
Nombre

Numeric
Tipo de dato

Tip value.
Descripción

Mandatorio
Tipo

shipment_information.order_pickup_information.tip.currency
Nombre

String
Tipo de dato

Type of currency that represents the value of the tip.


Descripción

Mandatorio
Tipo

requirements
Nombre

Nodo
Tipo de dato

Node that contains special/particular details to execute the transportation of the shipment.
Descripción

https://developers.mercadoenvios.com/en_us/authorization 45/58
05/07/2024, 09:49 Autorizations

Optional
Tipo

requirements.delivery
Nombre

Nodo
Tipo de dato

Node that groups the details related to the delivery of the shipment.
Descripción

Optional
Tipo

requirements.delivery.schedule
Nombre

Nodo
Tipo de dato

Node that describes the shipment delivery scheduling details.


Descripción

Optional
Tipo

requirements.delivery.schedule.from
Nombre

Nodo
Tipo de dato

Start date and time of the requested delivery time window (shift start). Example: 2024-01-
Descripción 09T17:04:49.219-03:00

Optional
Tipo

requirements.delivery.schedule.to
Nombre

https://developers.mercadoenvios.com/en_us/authorization 46/58
05/07/2024, 09:49 Autorizations

Nodo
Tipo de dato

End date and time of the requested delivery schedule window (end of shift). Example: 2024-01-
Descripción 09T18:00:00.000-03:00

Optional
Tipo

test
Name

Boolean
Data type

Indicates that the request sent is for testing


Description

Optional
Type

keyword
Name

String
Data type

The HASH secret . The value of this parameter can be empty. If a secret from the receiver
Description (SHA256) of a word value is present, the Carrier must request the word of the package.

Optional
Type

Note:
It should be noted that carrier account information must follow this order:

Contract: it is the number


that uses the carrier to
identify the contract
(agreement) of rates
established with Mercado
Libre. It is being used to
know how to define the
shipment cost. This is the
most used field by carriers.
https://developers.mercadoenvios.com/en_us/authorization 47/58
05/07/2024, 09:49 Autorizations

Account: it is the identifier


used by the carrier to
differentiate areas of
Mercado Libre. For instance
Cross Border Trade has a
different account id at the
carrier side.
User: it is a user name
assigned to Mercado Libre's
clients.
Password: it is the
password associated to the
user.

OAuth Request Format

For the authentication mechanism through


the generation of a token with OAuth, the
following header must be added to the
request:

--request POST 'https://hostname/shipments/{shiment_id}/authorization'


--header 'Authorization: Bearer + TOKEN'
--body 'What is described in each integration is maintained'

Note:
Once the OAuth solution is implemented,
the use of username and password in the
integrations should be deprecated in favor
of the use of the token. The fields to be
deprecated are the following:

carrier_information.user
Nombre

String
Tipo de dato

https://developers.mercadoenvios.com/en_us/authorization 48/58
05/07/2024, 09:49 Autorizations

Identifies a mail system user assigned to the Mercado Libre customer.


Descripción

carrier_information.password
Nombre

String
Tipo de dato

Identifies the password associated with the system user.


Descripción

Formato Response

Inside the body, the system will return all


the data from the authorization, listed
below:

id
Name

Long
Data type

Unique identifier of the shipment used by Mercado Libre, required to authorize. This ID will later be
Description used to notify the events that occur in the operational flow of the shipment.

Mandatory
Type

status
Name

String
Data type

Status of the authorization request


AUTHORIZED
Description FAILED
ERROR

https://developers.mercadoenvios.com/en_us/authorization 49/58
05/07/2024, 09:49 Autorizations

Mandatory
Type

status_message
Name

String
Data type

Any relevant detail regarding the authorization status.


Description

Mandatory in case of failure (status = FAILED or status = ERROR).


Type

tracking_number
Name

String
Data type

Tracking Number
Description

Mandatory in case the authorization was successfully processed. (status = AUTHORIZED).


Type

authorization_information
Name

Node
Data type

Contains any information related to the date and time of the authorization. Also any extra
Description information for the label generation.

Type

authorization_information.date
Name

https://developers.mercadoenvios.com/en_us/authorization 50/58
05/07/2024, 09:49 Autorizations

Date (ISO 8601)


Data type

Valid values. In UTC format: 2020-07-04T12:08:56.235Z or in local relative local time: 2020-07-
Description 04T12:08:56.235-07:00.

Mandatory in case the authorization was successfully processed. (status = AUTHORIZED).


Type

authorization_information.custom_data
Name

Node
Data type

Contains any relevant information for the label generation. There can be as many fields as needed
Description in the key:value format.

Optional
Type

authorization_information.custom_data.key
Name

String|Long
Data type

“Key” refers to the name of the key in the key:value format. The value can be either text or number.
Description

Mandatory
Type

Performance

Important:
It’s expected that the average request response time is under one second.

Status Codes

https://developers.mercadoenvios.com/en_us/authorization 51/58
05/07/2024, 09:49 Autorizations

AUTHORIZED
Status

200
HTTP code

The authorization was successfully processed.


Description

The shipment was already authorized and won't retry.


Action

FAILED
Status

400
HTTP code

The authorization was not able to be processed due to an error on the request. It’s expected to
Description return status=FAILED with the status_message specifying the error cause.

Depending on the nature of the error, the data will try to be fixed before retrying. Periodic retries
Action could happen.

ERROR
Status

500
HTTP code

Any server side error. In this case status and status_message are optional.
Description

There will be retry attempts to perform the authorization until the authorization is performed
Action successfully.

Example
Request:

POST https://hostName/shipments/26379079680/authorization

https://developers.mercadoenvios.com/en_us/authorization 52/58
05/07/2024, 09:49 Autorizations

{
"id":10101033319242,
"service_id":1010001,
"status_history":[

],
"carrier":"carrier1010",
"logistic":"drop_off",
"market_place":"MELI",
"direction":"forward",
"site_id":"MLA",
"carrier_information":{
"account":"",
"contract":"",
"user":"",
"password":"****"
},
"shipment_information":{
"id":10101033319242,
"sender":{
"nickname":"GOLANDS",
"first_name":"PY",
"last_name":"S.A.",
"email":"py.9crb8z@mail.mercadolibre.com",
"phone":{
"area_code":"1010",
"number":"522175123929",
"extension":""
},
"address":{
"address_line":"Calle 12",
"street_name":"Calle 12",
"street_number":"S/N",
"intersection":"Calle 21",
"comment":"",
"zip_code":"1870",
"city":{
"id":"TUxBQ0xBTWF0YW56",
"name":"La Matanza"
},
"state":{
"id":"AR-B",
"name":"Buenos Aires"
},
"country":{
"id":"AR",
"name":"Argentina"

https://developers.mercadoenvios.com/en_us/authorization 53/58
05/07/2024, 09:49 Autorizations

},
"neighborhood":{
"id":null,
"name":"Villa Celina"
},
"municipality":{
"id":null,
"name":"Villa Celina"
},
"geolocation":{
"geolocation_type":"ROOFTOP",
"latitude":-14.10100206,
"longitude":-52.10104811
},
"facility_id":"101010"
},
"full_name":"GOLANDS",
"id":10101098879
},
"receiver":{
"nickname":"CENTER MEL",
"first_name":"MEL",
"last_name":"PY",
"email":"mel.h283j6@mail.mercadolibre.com",
"phone":{
"area_code":"",
"number":"10108508106",
"extension":""
},
"address":{
"address_line":"Calle 23",
"street_name":"Calle 23",
"street_number":"S/N",
"intersection":"Calle 32",
"comment":"",
"zip_code":"1625",
"city":{
"id":"TUxBQ0VTQzQ3YTc0",
"name":"Escobar"
},
"state":{
"id":"AR-B",
"name":"Buenos Aires"
},
"country":{
"id":"AR",
"name":"Argentina"
},

https://developers.mercadoenvios.com/en_us/authorization 54/58
05/07/2024, 09:49 Autorizations

"neighborhood":{
"id":null,
"name":null
},
"municipality":{
"id":null,
"name":null
},
"geolocation":{
"geolocation_type":"RANGE_INTERPOLATED",
"latitude":-32.101012822,
"longitude":-52.10102059
},
"delivery_preference":"business"
},
"identification":{
"type":"DNI",
"number":"1234123",
},
"full_name":"Mel py",
"id":10010389392
},
"package":{
"currency_id":"USD",
"amount":2420,
"tags":["bulky"],
"items":[
{
"item_id":"MLA101010618394",
"tariff_code":null,
"made_in":null,
"description":"Lampara 100w",
"quantity":1
}
],
"description":"MLA101010618394",
"dimensions":{
"height":15,
"width":25,
"length":70,
"weight":1900
}
},
"international_information":{
"tax_modality":"DDP",
"cif": {
"cost": 19.75,
"freight": 3.84,

https://developers.mercadoenvios.com/en_us/authorization 55/58
05/07/2024, 09:49 Autorizations

"insurance": 0.41
}
"destination_address":{
"address_line":"Calle 23",
"street_name":"Calle 23",
"street_number":"S/N",
"intersection":"Calle 32",
"comment":"",
"zip_code":"1625",
"city":{
"id":"TUxBQ0VTQzQ3YTc0",
"name":"Escobar"
},
"state":{
"id":"AR-B",
"name":"Buenos Aires"
},
"country":{
"id":"AR",
"name":"Argentina"
},
"neighborhood":{
"id":null,
"name":null
},
"municipality":{
"id":null,
"name":null
},
"geolocation":{
"geolocation_type":"RANGE_INTERPOLATED",
"latitude":-32.101012822,
"longitude":-52.10102059
},
"delivery_preference":"business"
},
"delivery_to": {
"full_name": "Lorenzo lamas",
"is_importer_final_receiver": true
}
},
"order_pickup_information":{
"id":"1234",
"cooking_time":{
"value":15,
"measure":"minutes"
},
"store_name":"Burgers",

https://developers.mercadoenvios.com/en_us/authorization 56/58
05/07/2024, 09:49 Autorizations

"store_id": 47873456,
"tip": {
"amount": 100,
"currency": "ARS"
}
}
},
"requirements": {
"delivery": {
"schedule": {
"from": "2024-01-12T16:08:09.000-04:00",
"to": "2024-01-12T17:08:09.000-04:00"
}
}
},
"order_id":101010669519,
"test":false,
"keyword": "3bc405c30cadb4e6eefdf0cff899abcf8234d761c9a3ea1b2f510601ae5fc504"
}

Response:

Authorized (HTTP Status Code 200)

{
"id": "10101033319242",
"status":"AUTHORIZED",
"status_message":"OK",
"tracking_number": "ASDfgh123asd",
"authorization_information": {
"date": "2001-07-04T12:08:56.235-07:00",
"custom_data":{
"ruta_1":"RUTA"
}
}
}

FAIL (HTTP Status Code 400)

{
"error_code": "invalid_user_information.buyer",
"status_message":"Missing receiver information",
"status": "FAILED"
}

https://developers.mercadoenvios.com/en_us/authorization 57/58
05/07/2024, 09:49 Autorizations

FAIL (HTTP Status Code 500)

{
"status_message":"Internal server error",
"status": "ERROR"
}

Language

Copyright © 2024 MercadoLibre S.R.L.

Terms and conditions Privacy politics

https://developers.mercadoenvios.com/en_us/authorization 58/58

You might also like