Documentação do Mercado Livre
Confira todas as informações necessárias sobre as APIs Mercado Livre.
Documentação
Explicação de segmentos
Nesta seção você encontrará todos os segmentos que compõe uma ordem de compra e poderá conhecer sua definição, elemento principal e EDIFACT. Além disso, terá um exemplo em cada segmento.
UNH Cabeçalho da mensagem
É o segmento do cabeçalho da ordem de compra que identifica e específica o tipo de mensagem e versão.
Identifica o tipo de mensagem do segmento de serviço, sua versão e as agências responsáveis por sua manutenção:
- O código para o tipo de mensagem de Pedido é ORDERS.
- Os DE 0065, 0052, 0054 y 0051: indicam que a mensagem é um Pedido UNSM baseado no diretório D.96A sobre controle das Nações Unidas.
Exemplo: UNH+ME000001+ORDERS:D:96A:UN:EAN008'
Elemento principal | Elemento componente | EDIFACT | Descrição | |
---|---|---|---|---|
0062 | Número de referência da mensagem | M | an..14 | Referência da mensagem única do emissor. Número de sequência das mensagens na troca.DE 0062 ser idêntico a UNT. Gerado pelo emissor. |
S009 | Identificador da mensagem | M | ||
0065 Identificador do tipo de mensagem | M | an..6 | ORDERS = Pedido | |
0052 Número de versão do tipo de mensagem | M | an..3 | D = Diretório de trabalho | |
0054 Número de sub-versão do tipo de mensagem | M | an..3 | 96A = Diretório EDIFACT D.96A | |
0051 Agência controladora | M | an..2 | UN = Agência responsável do tipo de mensagem | |
0057 Código atribuído pela associação | M | an..6 | EAN008 = Número de controle da versão EAN |
BGM Início da mensagem
É o segmento onde se indica o tipo e função de uma mensagem, e onde se transmite seu número de identificação. .
Todas as referências distintas ao número de documento DE 1004 estão no segmento RFF.
Exemplo: BGM+YB1+128576+9'
Elemento principal | Elemento componente | EDIFACT | Descrição | ||
---|---|---|---|---|---|
NOME DO DOCUMENTO OU MENSAGEM | M | ||||
C002 | 1001 | Nome do documento ou mensagem, codificada | M | an..3 | YB1 = Pedido de cross docking 220 = Pedido normal |
1004 | Número do documento ou mensagem | M | an..17 | Número de Pedido atribuído pelo emissor do documento | |
1225 | Função da mensagem, codificada | M | an..6 | 1 = Anular 5 = Substituir 9 = Original |
DTM Fecha/hora/período
É o segmento utilizado para especificar a data do Pedido e quando seja solicitado, as datas relacionadas com a entrega dos produtos.
- DE 2005: a identificação da 'Data/hora do documento/mensagem (valor de código 137) é obrigatória na mensagem de Pedido. .
Exemplo: DTM+137:20010830:102'
Elemento principal | Elemento componente | EDIFACT | Descrição | ||
---|---|---|---|---|---|
DATA/HORA/PERÍODO | M |
63 = Última Data/Hora de entrega
64 = Primeira Data/Hora de entrega 137 = Data/Hora do Documento/Mensagem |
|||
C507 | 2005 | Qualificador de data/hora/período | M | an..3 | 171 = Data referência |
2380 | Data/hora/período | M | an..35 | ||
2379 | Qualificador de formato de data/hora/período | M | an..3 | 203 = Formato CCAAMMDDHHMM |
FTX Texto livre
É o segmento com informação codificada ou de texto e formato livre, relacionada com todo o Pedido.
Exemplo: FTX+AAI+++COMENTARIOS'
Elemento principal | Elemento componente | EDIFACT | Descrição | ||
---|---|---|---|---|---|
4451 | Qualificador do tema do texto | M | an..3 | AAI = Informação geral | |
4453 | Função do texto, codificado | N | an..3 | ||
C107 | REFERÊNCIA DE TEXTO | N | an..3 | ||
TEXTO LITERAL | M | ||||
4440 | Texto livre | M | an..70 | ||
C108 | 4440 | Texto livre | C | an..70 | |
4440 | Texto livre | C | an..70 | ||
4440 | Texto livre | C | an..70 |
RFF Referências de ordem de compra
É o segmento utilizado para especificar outras referências relacionadas com o Pedido e serve para identificar o tipo de mensagem com sua versão.
Exemplo: RFF+ON:652744'
Elemento principal | Elemento componente | EDIFACT | Descrição | ||
---|---|---|---|---|---|
C506 | REFERÊNCIA | M | |||
1153 | Qualificador de referência | M | an..3 | ON = Número de pedido (comprador) | |
1154 | Número de referência | M | an..35 |
Grupo segmento NAD-RFF
a. NAD Nome e endereço (Grupo segmento NAD-RFF)
É o segmento utilizado para identificar os interlocutores comerciais envolvidos no processo de Pedido.
Você encontrará as identificações de:
- O comprador: quem pede, código BY.
- O provedor: a quem se pede, código SU.
Exemplo:
NAD+BY+8412345000010'NAD+SU+8412345500000'
NAD+ST+8412345000010'
Elemento principal | Elemento componente | EDIFACT | Descrição | ||
---|---|---|---|---|---|
BY = Comprador (quem pede) | |||||
3035 | Qualificador de parte | M | an..3 | SU = Provedor (A quem se pede) ST = Destino mercancia | |
C082 | DETALHES DE IDENTIFICAÇÃO DA PARTE | M | |||
3039 | Identificação de parte, codificado | M | an..35 | ||
NOME E ENDEREÇO | C | ||||
3124 | Linha de nome e endereço | M | an..35 | Endereço completo | |
3124 | Linha de nome e endereço | C | an..35 | ||
C058 | 3124 | Linha de nome e endereço | C | an..35 | |
3124 | Linha de nome e endereço | C | an..35 | ||
3124 | Linha de nome e endereço | C | an..35 | ||
C080 | NOME DA PARTE | C | |||
3036 | Nome da parte | M | an..35 | Nome do interlocutor em texto claro | |
3036 | Nome da parte | C | an..35 | ||
3036 | Nome da parte | C | an..35 | ||
3036 | Nome da parte | C | an..35 | ||
C059 | RUA | C | |||
3164 | Nome da cidade | C | an..35 | Nome Cidade/Vila, em texto claro | |
3229 | Sub-entidades de país, codificado | C | an..9 | Provincia en texto claro | |
3251 | Código postal | C | an..9 | Código postal | |
3207 | País, codificado | C | an..3 | ISO 3166 código duas letras |
b. Grupo segmento NAD-RFF
RFF Referência (Grupo segmento NAD-RFF)
O segmento utilizado para especificar referências relacionadas com o interlocutor identificado no segmento NAD de nome e endereço.
Exemplo: RFF+IA:11232'
Elemento principal | Elemento componente | EDIFACT | Descrição | ||
---|---|---|---|---|---|
C506 | REFERÊNCIA | M | |||
1153 | Qualificador de referência | M | an..3 | IA = Número interno do vendedor (atribuído por cliente) | |
1154 | Número de referência | M | an..35 |
PAT Condições básicas de pagamento
É o segmento utilizado pelo emissor do Pedido para solicitar prazos especiais de pagamentos.
Exemplo: vencimento único, data de pagamento 30 dias depois da data de vencimento. PAT+10E++5:3:D:30'
Elemento principal | Elemento componente | EDIFACT | Descrição | ||
---|---|---|---|---|---|
4279 | Qualificador das condições de pagamento | M | an..3 | 10E = Pagamento único | |
C110 | CONDIÇÕES DE PAGAMENTO | N | |||
4277 | Condições de pagamento, codificado | C | an..17 | 92 = Transferência | |
C112 | INFORMAÇÃO SOBRE TIEMPOS DE PRAZOS | C | |||
2475 | Referência de tempo de pagamento, codificado | M | an..3 | 68 = Data valor (a acordar entre interlocutores) | |
2009 | Relação de tempo, codificado | M | an..3 | 1 = Data da referência | |
2151 | Tipo de período, codificado | M | an..3 | D = Dia | |
2152 | Número de períodos | M | an..3 | Número de períodos para o pagamento |
Grupo segmento LIN-PIA-QTY-PRI-(LOC-QTY)
a. LIN Linha de produto (Grupo segmento LIN-PIA-QTY-PRI-LOC)
É o segmento que serve para indicar o código dos produtos solicitados. Encontram-se os códigos de Unidade de Consumo e Unidade de Expedição. Cada aparição de LIN, em geral, corresponderá a um produto diferente.
Exemplo: LIN+1++8412345111115:SK'
Elemento principal | Elemento componente | EDIFACT | Descrição | ||
---|---|---|---|---|---|
1082 | |||||
1229 | Número de linha de produto | M | an..6 | Número sequencial de linha | |
Solicitação de ação ou notificação, codificado | N | an..3 | |||
C112 | IDENTIFICAÇÃO DO NÚMERO DE PRODUTO | M | |||
7140 | Número de produto | M | an..35 | ||
7143 | Tipo de número de produto | M | an..3 | SK = SKU |
b. PIA Identificação adicional do produto (Grupo segmento LIN-PIA-QTY-PRI-LOC)
É o segmento utilizado para especificar códigos de identificação adicionais do produto indicado no segmento LIN.
Exemplo:
PIA+1+8423450000015:IN'PIA+1+7509552915341:SRV'
Elemento principal | Elemento componente | EDIFACT | Descrição | ||
---|---|---|---|---|---|
4347 | Qualificador de função do código do produto | ||||
C212 | IDENTIFICAÇÃO DO NÚMERO DE PRODUTO | M | an..3 | 1 = Identificação adicional | |
7140 | Número de produto | M | an..35 |
IN = Número de Produto Interno do Comprador SRV = GTIN (Número global de produto comercial) IB = ISBN (Identificador global de um livro individual) AN = UPC (Código Universal de Produto) |
|
7143 | Tipo de número de produto | M | an..3 | EN = EAN (Número de Produto Internacional) |
c. QTY Quantidade (Grupo segmento LIN-PIA-QTY-PRI-LOC)
É o segmento utilizado para especificar a quantidade total solicitada do código de produto identificado no segmento LIN.
Exemplo: QTY+21:7000:PCE'
Elemento principal | Elemento componente | EDIFACT | Descrição | ||
---|---|---|---|---|---|
C186 | DETALHES SOBRE QUANTIDADE | M | |||
6063 | Qualificador de quantidade | M | an..3 | 21 = Quantidade Pedida | |
6060 | Quantidade | M | n..15 | ||
6411 | Especificador de unidade de medida | M | an..3 | PCE = Unidades |
d. PRI Detalhes sobre o preço (Grupo segmento LIN-PIA-QTY-PRI-LOC)
É o segmento utilizado para detalhar o preço para o produto atual, identificado no segmento LIN.
Exemplo: PRI+AAA:158'
Elemento principal | Elemento componente | EDIFACT | Descrição | ||
---|---|---|---|---|---|
C509 | INFORMAÇÃO DE PREÇOS | M | |||
5125 | Qualificador de preços | M | an..3 | AAA = Preço Neto Unitário | |
5118 | Preço | M | n..15 |
e. LOC Identificação de lugar ou localização (Grupo segmento LOC-QTY)
É o segmento utilizado para identificar o lugar de entrega para um Aviso de Expedição de uma entrega dividida.
Pode-se identificar o país, lugar ou localização da primeira entrega relacionada, ou a segunda.
Revisar os centros logísticos do Mercado Livre.
Ejemplo: LOC+7+1212::ZZZ'
Elemento principal | Elemento componente | EDIFACT | Descrição | ||
---|---|---|---|---|---|
3227 | Qualificador do lugar ou localização | M | an..3 | 7 = Lugar de entrega | |
C517 | IDENTIFICAÇÃO DO LUGAR | M | |||
3225 | Identificação do lugar ou localização | M | an..25 | Códigos de Localização | |
1131 | Qualificador da lista de códigos | N | an..3 | ||
3055 | Agência responsável da lista de códigos, codificado | M | an..3 | ZZZ = Valor de mutuo acordo | |
3224 | Lugar ou localização | C | an..70 |
f. QTY Quantidade (Grupo segmento LOC-QTY)
É o segmento utilizado para identificar a quantidade de produtos que serão entregues no lugar especificado no segmento LOC.
O total de todas as quantidades especificadas no grupo de segmentos 18 para a linha, deve ser igual ao valor da quantidade total detalhada nol segmento QTY ao nível de linha.
Exemplo: QTY+21:14'
Elemento principal | Elemento componente | EDIFACT | Descrição | ||
---|---|---|---|---|---|
C186 | DETALHES SOBRE QUANTIDADE | M | |||
6063 | Qualificador de quantidade | M | an..3 | 11 = Quantidade parcial | |
6060 | Cantidade | M | n..15 |
UNS Separador de secciones
É a seção do resumo da ordem de compra. Utilizada para separar as seções de resumo e a de detalhe da mensagem PEDIDO.
Exemplo: UNS+S'
Elemento principal | Elemento componente | EDIFACT | Descrição | |
---|---|---|---|---|
0081 | Identificação de seção | M | a1 |
MOA Importe monetário
É o segmento onde se específica o importe Neto Total (código 79) que é a soma dos importes netos por linha que inclui as cobranças e descontos por cada um, mas exclui os globais.
Fórmula: soma dos resultados de multiplicar Quantidade Pedida x Preço Neto Unitário.
Exemplo: MOA+79:15000'
Elemento principal | Elemento componente | EDIFACT | Descrição | ||
---|---|---|---|---|---|
C516 | IMPORTE MONETARIO | M | |||
5025 | Qualificador de tipo de importe monetário | M | an..3 | 79 = Importe Total Neto | |
5004 | Importe monetário | M | n..18 |
CNT Total de controle
Este segmento é utilizado para proporcionar os totais de controle da mensagem.
Ejemplo: quatro segmentos LIN na mensagem atual: CNT+2:4'
Elemento principal | Elemento componente | EDIFACT | Descrição | ||
---|---|---|---|---|---|
C270 | CONTROL | M | |||
6069 | Qualificador de control | M | an..3 | 2 = Número de linhas de produto na mensagem | |
6066 | Valor de control | M | n..18 |
UNT Final da mensagem
O segmento UN/EDIFACT é obrigatório. Sempre tem que ser o último segmento da mensagem.
Exemplo: UNT+48+ME000001'
Elemento principal | Elemento componente | EDIFACT | Descrição | ||
---|---|---|---|---|---|
0074 | Número de segmentos na mensagem | M | n..6 | O número total de segmentos na mensagem está detalhado aqui. | |
0062 | Número de referência da mensagem | M | an..14 | O número de referência da mensagem detalhada aqui deve ser igual ao especificado no segmento UNH. |