Enviando dados para geração de etiquetas:

Endpoint POST /api/v2/me/ecommerce/shipping

Payload:

{
  "shipping_id": 12, // id único da cotação selecionada
  "gateway": 'moip' // opções ['moip', 'paghiper ', 'wallet'] obs:: gateways paghiper e wallet, habilitados somente para ambiente Sandbox  
  "transaction_id": "...", // id para consulta ao meio de pagamento
  "tags": [ // tags (id do pedido na sua loja)
    "id-teste"  
  ],
  "agency": 1, // id da agência de postagem (JadLog), opcional, se não informado será utilizado a opção configurada pelo usuário
  "from": { // remetente
    "name": "Nome do remetente", // nome
    "phone": "53984470102", // telefone com ddd (obrigatório se não for Correios)
    "email": "contato@melhorenvio.com.br", // email (opcional)
    "document": "16571478358", // cpf (opcional)
    "company_document": "89794131000100", // cnpj (obrigatório se não for Correios)
    "state_register": "123456", // inscrição estadual (obrigatório se não for Correios) pode ser informado "isento"
    "address": "Endereço do remetente", // logradouro
    "complement": "Complemento", // complemento
    "number": "1", // número
    "district": "Bairro", // bairro
    "city": "São Paulo", // cidade
    "note": "observação" // observação  
  },
  "to": { // destinatário
    "name": "Nome do destinatário",
    "phone": "53984470102", // telefone com ddd (obrigatório se não for Correios)
    "email": "contato@melhorenvio.com.br",
    "document": "16571478358", // obrigatório se for transportadora e não for logística reversa
    "company_document": "89794131000100", // (opcional) (a menos que seja transportadora e logística reversa)
    "state_register": "123456", // (opcional) (a menos que seja transportadora e logística reversa)
    "address": "Endereço do destinatário",
    "complement": "Complemento",
    "number": "2",
    "district": "Bairro",
    "city": "Porto Alegre",
    "note": "observação" // (opcional) impresso na etiqueta
  },
  "options": { // opções
    "reverse": false, // logística reversa (se for reversa = true, ainda sim from será o remetente e to o destinatário)
    "non_commercial": false, // envio de objeto não comercializável (flexibiliza a necessidade de pessoas júridicas para envios com transportadoras como Latam Cargo, porém se for um envio comercializável a mercadoria pode ser confisca pelo fisco)
    "invoice": { // nota fiscal (opcional se for Correios)
      "number": "12345", // número da nota
      "key": "nf-e" // chave da nf-e
    },
    "reminder": "lembrete" // lembrete (opcional) impresso acima da etiqueta
  },
  "coupon": "MEUCUPON" // cupom de desconto
  "mode": "public" // link de impressão pública [public] ou privada [private] (padrão)
}

Nota: O peso, dimensões, opcionais e CEP serão obtidos a partir do id da cotação e o Estado/UF Pela faixa de CEP.

Nota: Novo atributo gateway adicionando nesta requisição, senão encaminhar, é definido por padrão o meio de pagamento (MOIP). Opções de meios de pagamentos são (moip, paghiper e wallet). Meio de pagamento Wallet, corresponde a carteira Melhor Envio, utilizando o saldo disponivel do usuário para aquisição do envio. Quanto aos meios de pagamento paghiper e moip, sempre deverá ser informado o atributo transaction_id, para consultar a situação do pagamento.

Resposta:

{
  "url": "http://www.melhorenvio.dev/imprimir/ylSliWvHW1Mn"
}

Caso o pagamento não esteja autorizado ou tenha sido gerado algum erro na geração da etiqueta será retornado uma mensagem de erro, como por exemplo:

{
  "error": "Pagamento não autorizado"
}

Consultando etiquetas de pedidos:

Endpoint POST /api/v2/me/ecommerce/shipping/search

Payload:

Pelo ID de pedidos (da sua loja):

{
  "tags": [
    100503
  ]
}

Pelo ID de cotações:

{
  "shippings": [
    101
  ]
}

Pelo ID das orders:

{
  "orders": [
    "6e1c864a-fe48-4ae7-baaa-d6e4888bafd1"
  ]
}

Resposta:

[
  {
    "id": "6e1c864a-fe48-4ae7-baaa-d6e4888bafd2", // id interno da etiqueta
    "protocol": "ORD-20170951", // protocolo da etiqueta (id do painel informado ao usuário)
    "service_id": 1, // id do serviço
    "agency_id": null, // id da agência
    "price": 17.57, // preço final da etiqueta
    "coupon": null, // cupom de desconto (se houver)
    "discount": 0.73, // desconto repassado ao cliente (não incluí valor de cupon)
    "delivery_time": 10, // tempo de entrega
    "status": "pending", // status da etiqueta
    "reminder": null, // lembrete
    "insurance_value": 20.5, // valor declarado
    "weight": 1, // peso
    "width": 12, // largura
    "height": 4, // altura
    "length": 17, // comprimento
    "diameter": null, // diametro
    "format": "box", // formato do pacote
    "billed_weight": null, // peso faturado (se houver)
    "receipt": false, // aviso de recebimento
    "own_hand": false, // mão própria
    "collect": false, // coleta
    "collect_scheduled_at": null, // data de agendamento da coleta
    "reverse": false, // logística reversa
    "non_commercial": false, // envio de objeto não comercializável
    "authorization_code": null, // autorização de postagem (ex.: plp (Correios))
    "tracking": null, // rastreio o envio (fornecido pela transportadora)
    "self_tracking": null, // rastreio interno
    "paid_at": null, // data em que foi pago a etiqueta
    "generated_at": null, // data em que foi gerada a etiqueta (depois que gerado validade de 7d)
    "posted_at": null, // data em que foi postado
    "delivered_at": null, // data em foi entregue
    "canceled_at": null, // data em que foi cancelado
    "expired_at": null, // data em que expirou a etiqueta
    "created_at": "2017-09-27 15:19:19", // data em que foi cadastrada a etiqueta
    "updated_at": "2017-09-27 15:19:19", // data da última atualização
    "from": { // remetente
      "name": "Nome do remetente",
      "phone": "53984470102",
      "email": "contato@melhorenvio.com.br",
      "document": "16571478358",
      "company_document": "89794131000100",
      "state_register": "123456",
      "postal_code": "1002001",
      "address": "Endereço do remetente",
      "location_number": "1",
      "complement": "Complemento",
      "district": "Bairro",
      "city": "São Paulo",
      "state_abbr": "SP",
      "country_id": "BR",
      "latitude": 0,
      "longitude": 0,
      "note": "observação"
    }, // destinatário
    "to": {
      "name": "Nome do destinatário",
      "phone": "53984470102",
      "email": "contato@melhorenvio.com.br",
      "document": "16571478358",
      "company_document": "89794131000100",
      "state_register": "123456",
      "postal_code": "90570020",
      "address": "Endereço do destinatário",
      "location_number": "2",
      "complement": "Complemento",
      "district": "Bairro",
      "city": "Porto Alegre",
      "state_abbr": "RS",
      "country_id": "BR",
      "latitude": -30.0224236,
      "longitude": -51.20224590000001,
      "note": "observação"
    },
    "service": { // informações do serviço
      "id": 1,
      "name": "Econômico",
      "status": "available",
      "picture": null,
      "type": "normal",
      "range": "interstate",
      "restrictions": "{\"insurance_value\":{\"min\":0,\"max\":3000},\"formats\":{\"box\":{\"weight\":{\"min\":0.1,\"max\":15},\"width\":{\"min\":11,\"max\":105},\"height\":{\"min\":2,\"max\":105},\"length\":{\"min\":16,\"max\":105},\"sum\":200},\"roll\":{\"weight\":{\"min\":0.1,\"max\":30},\"diameter\":{\"min\":5,\"max\":91},\"length\":{\"min\":18,\"max\":105},\"sum\":200},\"letter\":{\"weight\":{\"min\":0.01,\"max\":0.5},\"width\":{\"min\":11,\"max\":60},\"length\":{\"min\":16,\"max\":60}}}}",
      "requirements": "[\"names\",\"addresses\"]",
      "optionals": "[\"AR\",\"MP\",\"VD\"]",
      "company": {
        "id": 1,
        "name": "Correios",
        "status": "available",
        "picture": "/images/shipping-companies/correios.png"
      }
    },
    "agency": { // informações da agência (se houver)
      // ...
    },
    "invoice": { // informações da nota  (se houver)
      "number": "12345", // número
      "serie": null, // série
      "key": null, // chave
      "value": null, // valor
      "issued_at": null // data emissão
    }
  },
  // ...
]

Endpoint POST /api/v2/me/ecommerce/print

Payload:

Pelo ID de pedidos (da sua loja):

{
  "tags": [
    100503, // pode ser númerico
    "6e1c864a-fe48-4ae7-baaa-d6e4888bafd1", // ou pode ser uma string
  ]
}

Pelo ID de cotações:

{
  "shippings": [
    101,
    102,
    503
  ]
}

Pelo ID das orders:

{
  "orders": [
    "6e1c864a-fe48-4ae7-baaa-d6e4888bafd1",
    "6e1c864a-fe48-4ae7-baaa-d6e4888bafd2",
    "6e1c864a-fe48-4ae7-baaa-d6e4888bafd3"
  ]
}

Resposta:

{
  "url": "http://www.melhorenvio.dev/imprimir/ylSliWvHW1Mn"
}

Nota: Para obter os dados para realizar o split por meio de pagamento entre em contato com nossa equipe por meio do email dev@melhorenvio.com.br. Se o pagamento não estiver autorizado não será possível gerar e imprimir as etiquetas.

results matching ""

    No results matching ""