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 recupera todos os pedidos do armazenamento de pedidos especificado pelo seu marcador, com paginação. Ele retorna uma Promise que resolve para um objeto IOrdersByMarkerEntity contendo os pedidos paginados.
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ó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
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": 681,
"storageId": 1,
"createdDate": "2026-06-12T18:05:22.470Z",
"statusIdentifier": "inProgress",
"statusLocalizeInfos": {
"title": "In progress"
},
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
],
"attributeSetIdentifier": "order_form",
"paymentStrategy": "once",
"totalSum": "285",
"totalSumRaw": "300",
"currency": "USD",
"paymentAccountIdentifier": "cash",
"paymentAccountLocalizeInfos": {
"title": "Cash"
},
"products": [
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": "",
"price": 150,
"quantity": 2,
"isGift": false
}
],
"paymentUrl": null,
"discountConfig": {
"orderDiscounts": [
{
"id": 2,
"identifier": "personal_discount",
"type": "PERSONAL_DISCOUNT",
"localizeInfos": {
"title": "Personal discount"
},
"startDate": "2026-04-21T18:26:19.815Z",
"endDate": "2028-03-21T19:26:24.741Z",
"discountValue": {
"value": 15,
"maxAmount": null,
"discountType": "FIXED_AMOUNT",
"applicability": "TO_ORDER"
},
"exclusions": null,
"position": 1,
"conditionLogic": "AND",
"gifts": [],
"userGroups": null,
"userExclusions": null,
"conditions": [],
"coupon": null
}
],
"productDiscounts": [],
"coupon": null,
"settings": {
"allowStacking": true,
"maxDiscountValue": 50,
"allowGiftStacking": false,
"maxBonusPaymentPercent": null,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"giftRefundPolicy": "KEEP_GIFT"
},
"additionalDiscountsMarkers": [],
"totalRaw": 300,
"totalSumWithDiscount": 285,
"excludedGiftProductIds": [],
"bonus": {
"availableBalance": 0,
"maxBonusDiscount": 0,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"bonusApplied": 0
},
"bonusApplied": 0,
"totalDue": 285
},
"isPartial": false,
"isCompleted": null
},
{
"id": 680,
"storageId": 1,
"createdDate": "2026-06-12T17:37:59.815Z",
"statusIdentifier": "inProgress",
"statusLocalizeInfos": {
"title": "In progress"
},
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
],
"attributeSetIdentifier": "order_form",
"paymentStrategy": "once",
"totalSum": "285",
"totalSumRaw": "300",
"currency": "USD",
"paymentAccountIdentifier": "cash",
"paymentAccountLocalizeInfos": {
"title": "Cash"
},
"products": [
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": "",
"price": 150,
"quantity": 2,
"isGift": false
}
],
"paymentUrl": null,
"discountConfig": {
"orderDiscounts": [
{
"id": 2,
"identifier": "personal_discount",
"type": "PERSONAL_DISCOUNT",
"localizeInfos": {
"title": "Personal discount"
},
"startDate": "2026-04-21T18:26:19.815Z",
"endDate": "2028-03-21T19:26:24.741Z",
"discountValue": {
"value": 15,
"maxAmount": null,
"discountType": "FIXED_AMOUNT",
"applicability": "TO_ORDER"
},
"exclusions": null,
"position": 1,
"conditionLogic": "AND",
"gifts": [],
"userGroups": null,
"userExclusions": null,
"conditions": [],
"coupon": null
}
],
"productDiscounts": [],
"coupon": null,
"settings": {
"allowStacking": true,
"maxDiscountValue": 50,
"allowGiftStacking": false,
"maxBonusPaymentPercent": null,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"giftRefundPolicy": "KEEP_GIFT"
},
"additionalDiscountsMarkers": [],
"totalRaw": 300,
"totalSumWithDiscount": 285,
"excludedGiftProductIds": [],
"bonus": {
"availableBalance": 0,
"maxBonusDiscount": 0,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"bonusApplied": 0
},
"bonusApplied": 0,
"totalDue": 285
},
"isPartial": false,
"isCompleted": null
},
{
"id": 679,
"storageId": 1,
"createdDate": "2026-06-12T15:47:12.814Z",
"statusIdentifier": "inProgress",
"statusLocalizeInfos": {
"title": "In progress"
},
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
],
"attributeSetIdentifier": "order_form",
"paymentStrategy": "once",
"totalSum": "285",
"totalSumRaw": "300",
"currency": "",
"paymentAccountIdentifier": "cash",
"paymentAccountLocalizeInfos": {
"title": "Cash"
},
"products": [
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": "",
"price": 150,
"quantity": 2,
"isGift": false
}
],
"paymentUrl": null,
"discountConfig": {
"orderDiscounts": [
{
"id": 2,
"identifier": "personal_discount",
"type": "PERSONAL_DISCOUNT",
"localizeInfos": {
"title": "Personal discount"
},
"startDate": "2026-04-21T18:26:19.815Z",
"endDate": "2028-03-21T19:26:24.741Z",
"discountValue": {
"value": 15,
"maxAmount": null,
"discountType": "FIXED_AMOUNT",
"applicability": "TO_ORDER"
},
"exclusions": null,
"position": 1,
"conditionLogic": "AND",
"gifts": [],
"userGroups": null,
"userExclusions": null,
"conditions": [],
"coupon": null
}
],
"productDiscounts": [],
"coupon": null,
"settings": {
"allowStacking": true,
"maxDiscountValue": 50,
"allowGiftStacking": false,
"maxBonusPaymentPercent": null,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"giftRefundPolicy": "KEEP_GIFT"
},
"additionalDiscountsMarkers": [],
"totalRaw": 300,
"totalSumWithDiscount": 285,
"excludedGiftProductIds": [],
"bonus": {
"availableBalance": 0,
"maxBonusDiscount": 0,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"bonusApplied": 0
},
"bonusApplied": 0,
"totalDue": 285
},
"isPartial": false,
"isCompleted": null
},
"..."
],
"total": 429
}
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 de pedidos.
exemplo:
[
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
]
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.totalSumRaw: string
Valor total bruto do pedido com precisão total.
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
}
]
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.isPartial: boolean | null
Indica que o pedido está parcialmente pago; null em pedidos mais antigos onde não foi rastreado.
exemplo: false
items.paymentStrategy: string
Estratégia de pagamento do pedido.
exemplo: "once"
items.statusLocalizeInfos: ILocalizeInfo
Nome do status localizado.
items.discountConfig: IOrderDiscountConfig | null
Configuração de desconto resolvida aplicada ao pedido (orderDiscounts, productDiscounts, coupon, settings, bonus, totals); null em pedidos mais antigos sem uma configuração de desconto resolvida.
items.split: IOrderSplit
Configuração de pagamento dividido (em etapas); presente no endpoint de pedido por ID.
total: number
Total de registros encontrados.
exemplo: 100
Exemplos de uso
Passo a passo na documentação:
- Histórico de pedidos — buscar e exibir os pedidos passados de um usuário pelo marcador de armazenamento.
- Assinatura de pedidos — verificar se um usuário tem um pedido de assinatura ativo.
Experimente ao vivo
Execute este método interativamente no sandbox do JS SDK — conecte sua URL do Projeto e Token do App na primeira visita, depois abra:
- Histórico de pedidos — buscar e exibir os pedidos passados de um usuário pelo marcador de armazenamento.
- Assinatura de pedidos — verificar se um usuário tem um pedido de assinatura ativo.