getAllOrdersByMarker

Getting all orders from the order storage object created by the user. 🔐 This method requires authorization.

Description

This method retrieves all orders from the specified order storage by its marker, with pagination. It returns a Promise that resolves to an IOrdersByMarkerEntity object containing the paginated orders.

Orders.getAllOrdersByMarker(
marker*,
langCode,
offset,
limit
);

Parameters schema

Schema

marker(required): string
Textual identifier of the order storage object
example: "order_storage_1"

langCode: string
Language code. Default: "en_US"
example: "en_US"

offset: number
Offset parameter. Default: 0
example: 0

limit: number
Limit parameter. Default: 30
example: 30

By default, you can retrieve 10 objects. This is due to the record limit in the module's permissions settings.
For pagination to work correctly, you need to configure Module permissions according to your needs in the corresponding section.

Examples

Try it live

Run this method interactively in the JS SDK sandbox — connect your Project URL and App Token on first visit, then open:

Order history — fetch and display a user's past orders by storage marker.
Order subscription — check whether a user has an active subscription order.

Minimal example

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

Example with attributes

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

Example response

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

Response schema

Schema: IOrdersByMarkerEntity

items: IOrderByMarkerEntity[]
Array of order storage objects.
example:

[
  {
    "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
Object identifier.
example: 125

items.storageId: number
Identifier of the order storage object.
example: 1

items.createdDate: string
Date when the order was created.
example: "2023-10-01T12:00:00Z"

items.statusIdentifier: string
Text identifier of the order status.
example: "order-status-1"

items.formIdentifier: string
Text identifier of the form.
example: "bar-orders-form"

items.formData: IOrdersFormData[]
Data submitted by the form linked to the order store.
example:

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

formData.marker: string
Marker of form field.
example: "name_1"

formData.type: string
Type of value.
example: "string"

formData.value: string
Value.
example: "Name"

items.attributeSetIdentifier: string | null
Text identifier of the attribute set.
example: "attribute-set-1"

items.totalSum: string
Total order amount.
example: "100.00"

items.currency: string
Currency used to pay for the order.
example: "USD"

items.paymentAccountIdentifier: string | null
Textual identifier for the order payment.
example: "payment-1"

items.paymentAccountLocalizeInfos: ILocalizeInfo
Payment account name considering localization.
example:

{
  "title": "Cash"
}

items.products: IOrderProducts[]
Array of products added to order.
example:

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

products.id: number
Product id.
example: 2957

products.quantity: number
Product quantity.
example: 1

products.title: string
Product title.
example: "Cosmo"

products.sku: string | null
Product sku.
example: "SKU"

products.previewImage: IPicture | null
Product previewImage.
example:

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

previewImage.filename: string
The name of the file.
example: "image.jpg"

previewImage.downloadLink: string
The URL link to download the picture.
example: "https://example.com/image.jpg"

previewImage.size: number
The size of the picture in bytes.
example: 102400

previewImage.previewLink: string
The URL link to preview the picture.
example: "https://example.com/image-preview.jpg"

products.price: number
Product price.
example: 150

products.isGift: boolean
Whether the product is a gift.
example: false

items.paymentUrl: string | null
Payment link.
example: "https://example.com/pay/123"

items.isCompleted: boolean | null
Indicates that the order has been completed.
example: true

items.statusLocalizeInfos: ILocalizeInfo
Localized status name.

total: number
Total number of found records.
example: 100

Description​

Parameters schema​

Examples​

Try it live​

Minimal example​

Example with attributes​

Example response​

Response schema​