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

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": 233,
      "storageId": 1,
      "createdDate": "2025-07-21T09:40:08.552Z",
      "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
    },
    {
      "id": 232,
      "storageId": 1,
      "createdDate": "2025-07-21T01:54:32.065Z",
      "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
    },
    {
      "id": 231,
      "storageId": 1,
      "createdDate": "2025-07-21T01:49:51.641Z",
      "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
    },
    "..."
  ],
  "total": 40
}

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
  }
]

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