GEgetjusto

List orders

Changed on
get/ecommerce/orders

Request

  • Base URL
    https://api.service.getjusto.com/v3
  • Auth
    none declared

Query parameters

filterstring

Un texto que se usa para filtrar por código de pedido o nombre del comprador.

storesIdsstring[]

Un arreglo con el ID o ID externo de los locales.

fromDatestring date-time

Incluir pedidos desde alguna fecha.

toDatestring date-time

Incluir pedidos hasta alguna fecha.

orderStatusesstring[]

Muestra los pedidos que tengan estos estados.

useDeliverAtboolean

Si es verdadero, ordena y filtra los pedidos por fecha de entrega. Si es falso, usa fecha de creación.

includeNotPaidboolean

Si es verdadero, incluye pedidos con pago no completado (paymentStatus distinto de done).

pagenumber

Número de página.

Example:1
limitnumber

Número de items por página. Max 100. Por defecto: 10.

Example:10

Response

The OpenAPI spec

successboolean

Example response

{
  "success": true,
  "data": {
    "items": [
      {
        "_id": "ord-123",
        "code": "123",
        "fullCode": "C#123",
        "createdAt": "2020-01-01T00:00:00.000Z",
        "address": {
          "address": "Av. Apoquindo 3000",
          "addressLine2": "Depto 1201",
          "location": {
            "lat": -33.4489,
            "lng": -70.6693
          }
        },
        "deliverAt": "2020-01-01T00:00:00.000Z",
        "items": [
          {
            "product": {
              "name": "Hamburguesa"
            },
            "unitPrice": 5990,
            "baseUnitPrice": 5990,
            "productPrice": 5990,
            "baseProductPrice": 5990,
            "amount": 2,
            "description": "Bebida: Coca Zero - Comentario: \"Sin cebolla\"",
            "modifiers": [
              {
                "name": "Agregados",
                "options": [
                  {
                    "name": "Queso",
                    "price": 1000
                  }
                ]
              }
            ]
          }
        ],
        "deliveries": [
          {
            "price": 2500,
            "driverPassword": "5366",
            "fromLocation": {
              "lat": -33.4489,
              "lng": -70.6693
            },
            "toLocation": {
              "lat": -33.4489,
              "lng": -70.6693
            },
            "activatesAt": "2020-01-01T00:00:00.000Z",
            "createdAt": "2020-01-01T00:00:00.000Z",
            "forDate": "2020-01-01T00:00:00.000Z",
            "nearStoreAt": "2020-01-01T00:00:00.000Z",
            "pickupAt": "2020-01-01T00:00:00.000Z",
            "nearClientAt": "2020-01-01T00:00:00.000Z",
            "completedAt": "2020-01-01T00:00:00.000Z",
            "canceledAt": "2020-01-01T00:00:00.000Z",
            "deliveryExpectedAt": "2020-01-01T00:00:00.000Z",
            "estimatedArrivalAtStoreAt": "2020-01-01T00:00:00.000Z",
            "driverReceivedAt": "2020-01-01T00:00:00.000Z"
          }
        ]
      }
    ]
  }
}

Changes

  • 4ad06bd631ceRevision changes
    • info

      added the optional property ///// to the response with the status

  • cc5462313cebRevision changes
    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status