getAllOrdersByMarker

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

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

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

Schema

marker:* string
Textual identifier of the order storage object
example: my-order

langCode: string
Optional language field
example: en_US

offset: number
Offset parameter. Default 0
example: 0

limit: number
Limit parameter. Default 30
example: 30

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

Example return:

{
  "total": 100,
  "items": [
    {
      "id": 1764,
      "statusIdentifier": "inprogress",
      "formIdentifier": "order-form",
      "formData": [
        {
          "marker": "name_1",
          "type": "string",
          "value": "Name"
        }
      ],
      "products": [
        {
          "id": 1,
          "title": "Laminate Floorwood Maxima, 9811 Oak Mistral",
          "sku": null,
          "price": "1.00",
          "quantity": 10,
          "previewImage": [
            {
              "filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
              "downloadLink": "http://my-site.zone/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
              "size": 296391,
              "previewLink": ""
            }
          ]
        }
      ],
      "totalSum": "12.00",
      "currency": "USD",
      "createdDate": "2023-01-01 12:12",
      "paymentAccountIdentifier": "payment-1",
      "paymentAccountLocalizeInfos": {"title": "Account 1"
      },
      "isHistory": true
    }
  ]

}

Schema

total: number
total number of found records
example: 100

statusIdentifier: string
text identifier of the order status
example: inprogress

formIdentifier: string
text identifier of the form status
example: order-form

formData FormDataType
data submitted by the form linked to the order store
example:

[
  {
    "marker": "name_1",
    "value": "Name"
  }
]

products Record<string, string | any>[]
array of products added to order

totalSum string
total order amount
example: 12.00

currency string
currency used to pay for the order
example: USD

createdDate string
date when the order was created
example: 2023-01-01 12:12

price number
price of the product per unit (at the time of ordering)
example: 20.00

paymentAccountIdentifier string
textual identifier for the order payment
example: payment-1

paymentAccountLocalizeInfos CommonLocalizeInfos
payment account name considering localization
example:

{
  "title": "Account 1"
}

isHistory boolean
indicates that the order has been saved in the order history
example: true