Pular para o conteúdo principal

getAllOrdersByMarker

Obtendo todos os pedidos do objeto de armazenamento de pedidos criado pelo usuário. 🔐 Este método requer autorização.

Descrição​

Este método obtém todos os objetos de armazenamento de pedidos por marcador. O método adicionará o idioma padrão ao corpo da solicitação. Se você quiser mudar o idioma, basta passá-lo como o segundo argumento. Ele retorna uma Promise que resolve para um objeto IOrdersByMarkerEntity.

Orders.getAllOrdersByMarker(

marker, langCode, offset, limit

);

Esquema de parâmetros​

Esquema

marker(obrigatório): string
Identificador textual do objeto de armazenamento de pedidos
exemplo: "order_storage_1"

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

offset: number
Parâmetro de deslocamento. Padrão: 0
exemplo: 0

limit: number
Parâmetro de limite. Padrão: 30
exemplo: 30

Exemplos​

Exemplo mínimo​

const response = await Orders.getAllOrdersByMarker('my-order');

Exemplo com atributos​

const response = await Orders.getAllOrdersByMarker('my-order', 'en_US', 0, 30);

Exemplo de resposta​

{
  "items": [
    {
      "id": 276,
      "storageId": 1,
      "createdDate": "2025-09-30T20:32:45.338Z",
      "statusIdentifier": "inProgress",
      "formIdentifier": "orderForm",
      "formData": [
        {
          "marker": "order_name",
          "value": "Ivan",
          "type": "string"
        }
      ],
      "attributeSetIdentifier": "order_form",
      "totalSum": "300.00",
      "currency": "",
      "paymentAccountIdentifier": "cash",
      "paymentAccountLocalizeInfos": {
        "title": "Dinheiro"
      },
      "products": [
        {
          "id": 2957,
          "title": "Cosmo",
          "sku": null,
          "previewImage": null,
          "price": 150,
          "quantity": 2
        }
      ],
      "isCompleted": false
    },
    {
      "id": 275,
      "storageId": 1,
      "createdDate": "2025-09-30T20:31:44.881Z",
      "statusIdentifier": "inProgress",
      "formIdentifier": "orderForm",
      "formData": [
        {
          "marker": "order_name",
          "value": "Ivan",
          "type": "string"
        }
      ],
      "attributeSetIdentifier": "order_form",
      "totalSum": "300.00",
      "currency": "",
      "paymentAccountIdentifier": "cash",
      "paymentAccountLocalizeInfos": {
        "title": "Dinheiro"
      },
      "products": [
        {
          "id": 2957,
          "title": "Cosmo",
          "sku": null,
          "previewImage": null,
          "price": 150,
          "quantity": 2
        }
      ],
      "isCompleted": false
    },
    {
      "id": 274,
      "storageId": 1,
      "createdDate": "2025-09-30T17:36:19.027Z",
      "statusIdentifier": "inProgress",
      "formIdentifier": "orderForm",
      "formData": [
        {
          "marker": "order_name",
          "value": "Ivan",
          "type": "string"
        }
      ],
      "attributeSetIdentifier": "order_form",
      "totalSum": "300.00",
      "currency": "",
      "paymentAccountIdentifier": "cash",
      "paymentAccountLocalizeInfos": {
        "title": "Dinheiro"
      },
      "products": [
        {
          "id": 2957,
          "title": "Cosmo",
          "sku": null,
          "previewImage": null,
          "price": 150,
          "quantity": 2
        }
      ],
      "isCompleted": false
    },
    "..."
  ],
  "total": 83
}

Esquema de resposta​

Esquema: IOrdersByMarkerEntity

items: IOrderByMarkerEntity[]
Array de objetos de armazenamento de pedidos.
exemplo:

[
  {
    "id": 55,
    "storageId": 1,
    "createdDate": "2025-03-22T21:12:42.371Z",
    "statusIdentifier": "inProgress",
    "formIdentifier": "orderForm",
    "formData": [
      {
        "marker": "order_name",
        "value": "Ivan",
        "type": "string"
      }
    ],
    "attributeSetIdentifier": "order_form",
    "totalSum": "300.00",
    "currency": "",
    "paymentAccountIdentifier": "cash",
    "paymentAccountLocalizeInfos": {
      "title": "Dinheiro"
    },
    "products": [
      {
        "id": 2957,
        "title": "Cosmo",
        "sku": null,
        "previewImage": null,
        "price": 150,
        "quantity": 2
      }
    ],
    "isCompleted": false
  }
]

total: number
Total de registros encontrados.
exemplo: 100