Saltar al contenido principal

getAllOrdersByMarker

Obteniendo todas las órdenes del objeto de almacenamiento de órdenes creado por el usuario. 🔐 Este método requiere autorización.

Descripción

Este método recupera todas las órdenes del almacenamiento de órdenes especificado por su marcador, con paginación. Devuelve una Promesa que se resuelve en un objeto IOrdersByMarkerEntity que contiene las órdenes paginadas.

Órdenes.getAllOrdersByMarker(

marker*, langCode, offset, limit

);

Esquema de parámetros

Esquema

marker(requerido): string
Identificador textual del objeto de almacenamiento de órdenes
ejemplo: "order_storage_1"

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

offset: number
Parámetro de desplazamiento. Predeterminado: 0
ejemplo: 0

limit: number
Parámetro de límite. Predeterminado: 30
ejemplo: 30

Por defecto, puedes recuperar 10 objetos. Esto se debe al límite de registros en la configuración de permisos del módulo.
Para que la paginación funcione correctamente, necesitas configurar Permisos del módulo de acuerdo a tus necesidades en la sección correspondiente.

Ejemplos

Ejemplo mínimo

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

Ejemplo con atributos

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

Ejemplo de respuesta

{
"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 respuesta

Esquema: IOrdersByMarkerEntity

items: IOrderByMarkerEntity[]
Array de objetos de almacenamiento de órdenes.
ejemplo:

[
{
"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 del objeto.
ejemplo: 125

items.storageId: number
Identificador del objeto de almacenamiento de órdenes.
ejemplo: 1

items.createdDate: string
Fecha en que se creó la orden.
ejemplo: "2023-10-01T12:00:00Z"

items.statusIdentifier: string
Identificador textual del estado de la orden.
ejemplo: "order-status-1"

items.formIdentifier: string
Identificador textual del formulario.
ejemplo: "bar-orders-form"

items.formData: IOrdersFormData[]
Datos enviados por el formulario vinculado a la tienda de órdenes.
ejemplo:

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

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

items.totalSum: string
Monto total de la orden.
ejemplo: "100.00"

items.totalSumRaw: string
Monto total bruto de la orden con precisión completa.
ejemplo: "100.00"

items.currency: string
Moneda utilizada para pagar la orden.
ejemplo: "USD"

items.paymentAccountIdentifier: string | null
Identificador textual para el pago de la orden.
ejemplo: "payment-1"

items.paymentAccountLocalizeInfos: ILocalizeInfo
Nombre de la cuenta de pago considerando la localización.
ejemplo:

{
"title": "Cash"
}

items.products: IOrderProducts[]
Array de productos añadidos a la orden.
ejemplo:

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

items.paymentUrl: string | null
Enlace de pago.
ejemplo: "https://example.com/pay/123"

items.isCompleted: boolean | null
Indica que la orden ha sido completada.
ejemplo: true

items.isPartial: boolean | null
Indica que la orden está parcialmente pagada; null en órdenes más antiguas donde no se rastreó.
ejemplo: false

items.paymentStrategy: string
Estrategia de pago de la orden.
ejemplo: "once"

items.statusLocalizeInfos: ILocalizeInfo
Nombre del estado localizado.

items.discountConfig: IOrderDiscountConfig | null
Configuración de descuento resuelta aplicada a la orden (orderDiscounts, productDiscounts, coupon, settings, bonus, totals); null en órdenes más antiguas sin una configuración de descuento resuelta.

items.split: IOrderSplit
Configuración de pago dividido (por etapas); presente en el endpoint de orden por ID.

total: number
Número total de registros encontrados.
ejemplo: 100


Ejemplos de uso

Guías paso a paso en la documentación:

Pruébalo en vivo

Ejecuta este método de forma interactiva en el sandbox del SDK de JS — conecta tu URL de Proyecto y Token de App en la primera visita, luego abre: