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.

Pedidos.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ódigodo 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

Por padrão, você pode recuperar 10 objetos. Isso se deve ao limite de registro nas configurações de permissões do módulo.
Para que a paginação funcione corretamente, você precisa configurar as Permissões do módulo de acordo com suas necessidades na seção correspondente.

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": 551,
      "storageId": 1,
      "createdDate": "2026-04-15T14:20:29.645Z",
      "statusIdentifier": "inProgress",
      "statusLocalizeInfos": {
        "title": "In progress"
      },
      "formIdentifier": "orderForm",
      "formData": [
        {
          "marker": "order_name",
          "value": "Ivan",
          "type": "string"
        }
      ],
      "attributeSetIdentifier": "order_form",
      "paymentStrategy": "once",
      "totalSum": "300",
      "totalSumRaw": "300",
      "currency": "",
      "paymentAccountIdentifier": "cash",
      "paymentAccountLocalizeInfos": {
        "title": "Cash"
      },
      "products": [
        {
          "id": 2957,
          "title": "Cosmo",
          "sku": null,
          "previewImage": null,
          "price": 150,
          "quantity": 2,
          "isGift": false
        }
      ],
      "paymentUrl": null,
      "discountConfig": {
        "orderDiscounts": [],
        "productDiscounts": [],
        "coupon": null,
        "settings": {
          "allowStacking": false,
          "maxDiscountValue": null,
          "allowGiftStacking": false,
          "maxBonusPaymentPercent": null,
          "minBonusAmount": null,
          "minOrderAmountForBonus": null,
          "giftRefundPolicy": "KEEP_GIFT"
        },
        "additionalDiscountsMarkers": [],
        "totalRaw": 300,
        "totalSumWithDiscount": 300,
        "excludedGiftProductIds": [],
        "bonus": {
          "availableBalance": 0,
          "maxBonusDiscount": 0,
          "minBonusAmount": null,
          "minOrderAmountForBonus": null,
          "bonusApplied": 0
        },
        "bonusApplied": 0,
        "totalDue": 300
      },
      "isPartial": false,
      "isCompleted": null
    },
    {
      "id": 550,
      "storageId": 1,
      "createdDate": "2026-04-14T14:53:59.484Z",
      "statusIdentifier": "inProgress",
      "statusLocalizeInfos": {
        "title": "In progress"
      },
      "formIdentifier": "orderForm",
      "formData": [
        {
          "marker": "order_name",
          "value": "Ivan",
          "type": "string"
        }
      ],
      "attributeSetIdentifier": "order_form",
      "paymentStrategy": "once",
      "totalSum": "300",
      "totalSumRaw": "300",
      "currency": "",
      "paymentAccountIdentifier": "cash",
      "paymentAccountLocalizeInfos": {
        "title": "Cash"
      },
      "products": [
        {
          "id": 2957,
          "title": "Cosmo",
          "sku": null,
          "previewImage": null,
          "price": 150,
          "quantity": 2,
          "isGift": false
        }
      ],
      "paymentUrl": null,
      "discountConfig": {
        "orderDiscounts": [],
        "productDiscounts": [],
        "coupon": null,
        "settings": {
          "allowStacking": false,
          "maxDiscountValue": null,
          "allowGiftStacking": false,
          "maxBonusPaymentPercent": null,
          "minBonusAmount": null,
          "minOrderAmountForBonus": null,
          "giftRefundPolicy": "KEEP_GIFT"
        },
        "additionalDiscountsMarkers": [],
        "totalRaw": 300,
        "totalSumWithDiscount": 300,
        "excludedGiftProductIds": [],
        "bonus": {
          "availableBalance": 0,
          "maxBonusDiscount": 0,
          "minBonusAmount": null,
          "minOrderAmountForBonus": null,
          "bonusApplied": 0
        },
        "bonusApplied": 0,
        "totalDue": 300
      },
      "isPartial": false,
      "isCompleted": null
    },
    {
      "id": 549,
      "storageId": 1,
      "createdDate": "2026-04-14T13:22:58.354Z",
      "statusIdentifier": "inProgress",
      "statusLocalizeInfos": {
        "title": "In progress"
      },
      "formIdentifier": "orderForm",
      "formData": [
        {
          "marker": "order_name",
          "value": "Ivan",
          "type": "string"
        }
      ],
      "attributeSetIdentifier": "order_form",
      "paymentStrategy": "once",
      "totalSum": "300",
      "totalSumRaw": "300",
      "currency": "",
      "paymentAccountIdentifier": "cash",
      "paymentAccountLocalizeInfos": {
        "title": "Cash"
      },
      "products": [
        {
          "id": 2957,
          "title": "Cosmo",
          "sku": null,
          "previewImage": null,
          "price": 150,
          "quantity": 2,
          "isGift": false
        }
      ],
      "paymentUrl": null,
      "discountConfig": {
        "orderDiscounts": [],
        "productDiscounts": [],
        "coupon": null,
        "settings": {
          "allowStacking": false,
          "maxDiscountValue": null,
          "allowGiftStacking": false,
          "maxBonusPaymentPercent": null,
          "minBonusAmount": null,
          "minOrderAmountForBonus": null,
          "giftRefundPolicy": "KEEP_GIFT"
        },
        "additionalDiscountsMarkers": [],
        "totalRaw": 300,
        "totalSumWithDiscount": 300,
        "excludedGiftProductIds": [],
        "bonus": {
          "availableBalance": 0,
          "maxBonusDiscount": 0,
          "minBonusAmount": null,
          "minOrderAmountForBonus": null,
          "bonusApplied": 0
        },
        "bonusApplied": 0,
        "totalDue": 300
      },
      "isPartial": false,
      "isCompleted": null
    },
    "..."
  ],
  "total": 357
}

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": "Cash"
    },
    "products": [
      {
        "id": 2957,
        "title": "Cosmo",
        "sku": null,
        "previewImage": null,
        "price": 150,
        "quantity": 2
      }
    ],
    "isCompleted": false
  }
]

items.id: number
Identificador do objeto.
exemplo: 125

items.storageId: number
Identificador do objeto de armazenamento de pedidos.
exemplo: 1

items.createdDate: string
Data em que o pedido foi criado.
exemplo: "2023-10-01T12:00:00Z"

items.statusIdentifier: string
Identificador textual do status do pedido.
exemplo: "order-status-1"

items.formIdentifier: string
Identificador textual do formulário.
exemplo: "bar-orders-form"

items.formData: IOrdersFormData[]
Dados enviados pelo formulário vinculado ao armazenamento do pedido.
exemplo:

[
  {
    "marker": "order_name",
    "value": "Ivan",
    "type": "string"
  }
]

formData.marker: string
Marcador do campo do formulário.
exemplo: "name_1"

formData.type: string
Tipo de valor.
exemplo: "string"

formData.value: string
Valor.
exemplo: "Nome"

items.attributeSetIdentifier: string | null
Identificador textual do conjunto de atributos.
exemplo: "attribute-set-1"

items.totalSum: string
Valor total do pedido.
exemplo: "100.00"

items.currency: string
Moeda utilizada para pagar o pedido.
exemplo: "USD"

items.paymentAccountIdentifier: string | null
Identificador textual para o pagamento do pedido.
exemplo: "payment-1"

items.paymentAccountLocalizeInfos: ILocalizeInfo
Nome da conta de pagamento considerando a localização.
exemplo:

{
  "title": "Cash"
}

items.products: IOrderProducts[]
Array de produtos adicionados ao pedido.
exemplo:

[
  {
    "id": 1,
    "name": "Product 1",
    "quantity": 2
  }
]

products.id: number
ID do produto.
exemplo: 2957

products.quantity: number
Quantidade do produto.
exemplo: 1

products.title: string
Título do produto.
exemplo: "Cosmo"

products.sku: string | null
SKU do produto.
exemplo: "SKU"

products.previewImage: IPicture | null
Imagem de pré-visualização do produto.
exemplo:

{
  "filename": "image.jpg",
  "downloadLink": "https://example.com/image.jpg",
  "size": 102400,
  "previewLink": "https://example.com/image-preview.jpg"
}

previewImage.filename: string
O nome do arquivo.
exemplo: "image.jpg"

previewImage.downloadLink: string
O link da URL para baixar a imagem.
exemplo: "https://example.com/image.jpg"

previewImage.size: number
O tamanho da imagem em bytes.
exemplo: 102400

previewImage.previewLink: string
O link da URL para visualizar a imagem.
exemplo: "https://example.com/image-preview.jpg"

products.price: number
Preço do produto.
exemplo: 150

products.isGift: boolean
Se o produto é um presente.
exemplo: false

items.paymentUrl: string | null
Link de pagamento.
exemplo: "https://example.com/pay/123"

items.isCompleted: boolean | null
Indica que o pedido foi concluído.
exemplo: true

items.statusLocalizeInfos: ILocalizeInfo
Nome do status localizado.

total: number
Total de registros encontrados.
exemplo: 100

Descrição​

Esquema de parâmetros​

Exemplos​

Exemplo mínimo​

Exemplo com atributos​

Exemplo de resposta​

Esquema de resposta​