Para listar os pedidos na Hub2b basta enviar um GET para /Orders enviando nos parâmetros de URL os filtros desejados, sendo os mais comuns: Status, Data inicial e final de compra e canal de venda.
Para filtrar pelos códigos dos pedidos ou pelos SKUs, basta enviar o filtro separando por vírgula. Cuidar para não estourar os 2048 caracteres de limite de URL.
O retorno esperado é como no exemplo a seguir:
{
"reference": {
"idTenant": 9999, //código do cliente na Hub2b
"store": "NOMEDALOJA", //nome da loja no marketplace
"id": 2, //idOrder - código do pedido na Hub2b
"source": "2000999999999999", //código do pedido no Marketplace
"system": {
"source": "mercadolivre" //sistema de origem do pedido (marketplace ou sistema)
}
},
"shipping": {
"estimatedDeliveryDate": "2024-11-16T00:00:00", //data estimada de entrega
"responsible": "Marketplace", //sistema responsável pela logística (envio, etiqueta e rastreio)
"service": "Prioritario", //tipo do serviço de envio
"price": 14.15, //custo de envio
"receiverName": "priscila vladislav parchay", //nome do recebedor
"address": { //endereço de entrega
"address": "Rua Humanidade",
"neighborhood": "Vila Das Flores",
"city": "Atlântida",
"state": "SC",
"country": "Brasil",
"zipCode": "89999090",
"additionalInfo": "casa Referencia: ao lado prana yoga Contato: XXXXXXX",
"reference": "casa Referencia: ao lado prana yoga",
"number": "999"
}
},
"payment": {
"method": "digital_currency", //método de pagamento - como vem do marketplace
"paymentDate": "2024-11-13T21:41:21", //data de pagamento
"purchaseDate": "2024-11-13T21:41:20", //data de compra
"approvedDate": "2024-11-13T21:41:27.152688", //data de aprovação
"totalAmount": 64.99, //total do pedido
"totalAmountPlusShipping": 79.14, //total do pedido + custo de envio
"totalDiscount": 0, //total de desconto
"installments": 1, //quantidade de parcelas
"address": { //endereço de cobrança
"address": "Rua Humanidade",
"neighborhood": "Vila Das Flores",
"city": "Atlântida",
"state": "SC",
"country": "BR",
"zipCode": "89999090",
"additionalInfo": "casa",
"reference": "casa",
"number": "999"
}
},
"status": {
"status": "Completed", //status do pedido
"updatedDate": "2024-11-16T05:09:05", //data de atualização
"active": true,
"message": ""
},
"customer": { //dados do consumidor
"name": "Priscila Vladislav Parchay",
"documentNumber": "99719994899",
"telephone": "11999999999",
"mobileNumber": "55011999999999",
"email": "priscilavladislav@integracao.com.br"
},
"createdDate": "2024-11-13T18:41:27", //data de criação na Hub2b
"products": [
{
"sku": "MLB9938998399-199559923992", //código do pedido no Marketplace (sistema de origem do pedido)
"name": "Cinto Revestido Em Palha Com Fivela", //nome do produto
"quantity": 1, //quantidade
"price": 64.99, //preço
"discount": 0, //desconto
"type": "None"
}
],
"orderNotes": [
{
"createDate": "2024-11-13T21:41:27.152698", //data de criação da mensagem
"message": "Necessário enviar este pedido até 14/11/2024 às 13:00 horas." //conteúdo da mensagem
}
],
"orderAdditionalInfos": []
}
Em caso de pagamento parcelado, será preenchido o campo "installments", já o restante dos dados como nota fiscal e rastreio podem ser listados na URL /Orders/{idOrder}/Invoice e /Orders/{idOrder}/Tracking respectivamente. Ambos serão documentados a seguir.
O campo "orderNotes" são observações que vem do Marketplace para serem enviados ao ERP.
Importante:
O tipo de envio fulfillment identifica o pedido com o campo "reference.destination" = "fulfillment" se for configurado na conta para que o sistema faça essa marcação. Porém existem outras modalidades onde a responsabilidade de envio e entrega também é do marketplace, e este emite as etiquetas e vem buscar os produtos no estoque do seller. Neste caso o sistema não irá adicionar a descrição de fulfillment no pedido, mantendo apenas o campo "shipping.responsible" = "Marketplace".
Nestes casos pode ser necessário ignorar esses pedidos da API, ou buscá-los apenas para fins de relatórios e reserva de estoque, mas garantir que seus produtos não sejam enviados, e que os clientes não recebam os pedidos em duplicidade.