Skip to main content

getAllOrdersByMarker

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

Description​

This method getting all order storage object by marker. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument It returns a Promise that resolves to an IOrdersByMarkerEntity object.

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​

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": 418,
      "storageId": 1,
      "createdDate": "2026-01-28T16:02:08.865Z",
      "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
        }
      ],
      "paymentUrl": null,
      "isCompleted": null
    },
    {
      "id": 417,
      "storageId": 1,
      "createdDate": "2026-01-10T00:49:19.926Z",
      "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
        }
      ],
      "paymentUrl": null,
      "isCompleted": null
    },
    {
      "id": 416,
      "storageId": 1,
      "createdDate": "2026-01-10T00:47:33.951Z",
      "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
        }
      ],
      "paymentUrl": null,
      "isCompleted": null
    },
    "..."
  ],
  "total": 235
}

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: Record<string, any>
Payment account name considering localization.
example:

{
  "en_US": "USD Payment",
  "ru_RU": "Оплата в долларах США"
}

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: any
Product previewImage.
example:

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

products.price: number
Product price.
example: 150

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

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