Consulta de Pedido

API Explorer: https://rest.hub2b.com.br/orders-docs/index.html

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 de 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. Porém deve-se atentar para não estourar os 2048 caracteres de limite de URL.

O retorno esperado é como no exemplo a seguir:

{
  "totalObjects": 0,
  "response": [
    {
      "reference": {
        "idTenant": 0,
        "store": "string",
        "id": 0,
        "virtual": "string",
        "source": "string",
        "destination": "string",
        "system": {
          "source": "string",
          "destination": "string"
        }
      },
      "shipping": {
        "shippingDate": "2021-05-25T11:32:39.890Z",
        "estimatedDeliveryDate": "2021-05-25T11:32:39.890Z",
        "responsible": "seller",
        "provider": "string",
        "service": "string",
        "price": 0,
        "receiverName": "string",
        "address": {
          "address": "string",
          "neighborhood": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "zipCode": "string",
          "additionalInfo": "string",
          "reference": "string",
          "number": "string"
        }
      },
      "payment": {
        "method": "string",
        "paymentDate": "2021-05-25T11:32:39.890Z",
        "purchaseDate": "2021-05-25T11:32:39.890Z",
        "approvedDate": "2021-05-25T11:32:39.891Z",
        "totalAmount": 0,
        "totalAmountPlusShipping": 0,
        "totalDiscount": 0,
        "installments": 0,
        "address": {
          "address": "string",
          "neighborhood": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "zipCode": "string",
          "additionalInfo": "string",
          "reference": "string",
          "number": "string"
        }
      },
      "status": {
        "status": "pending",
        "updatedDate": "2021-05-25T11:32:39.891Z",
        "active": true,
        "message": "string"
      },
      "customer": {
        "name": "string",
        "documentNumber": "string",
        "telephone": "string",
        "mobileNumber": "string",
        "email": "string"
      },
      "createdDate": "2021-05-25T11:32:39.891Z",
      "canceledDate": "2021-05-25T11:32:39.891Z",
      "products": [
        {
          "idProduct": 0,
          "sku": "string",
          "name": "string",
          "quantity": 0,
          "unity": "string",
          "price": 0,
          "shippingCost": 0,
          "discount": 0,
          "type": "none"
        }
      ],
      "orderNotes": [
        {
          "idUser": 0,
          "createDate": "2021-05-25T11:32:39.891Z",
          "message": "string"
        }
      ]
    }
  ]
}

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.

Last updated