getAllOrdersStorage

Getting all order storage objects 🔐 This method requires authorization.

Orders.getAllOrdersStorage(langCode, offset, limit)

const value = await Orders.getAllOrdersStorage()

Schema

langCode: number
Optional language field
example: en_US

offset: number
Optional parameter for pagination, default is 0
example: 0

limit: number
Optional parameter for pagination, default is 30
example: 30

This method getting all the order storage objects. 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:

[
  {
    "id": 1764,
    "localizeInfos": {
        "title": "Order 1"
    },
    "identifier": "catalog",
    "generalTypeId": 4,
    "formIdentifier": "catalog-form",
    "paymentAccountIdentifiers": [
      {
        "identifier": "p1"
      }
    ]
  }
]

Schema

id: number
object identifier
example: 1764

localizeInfos: Record<string, any>
json description of the main page data object taking into account the language "en_US" (for example)
example:

{
  "en_US": {
    "title": "Catalog",
    "plainContent": "Content for catalog",
    "htmlContent": "<b>Content for catalog</b>",
    "menuTitle": "Catalog"
  }
}

identifier string
textual identifier for the record field
example: catalog

generalTypeId number
type identifier
example: 4

formIdentifier string
textual identifier for the form used by the order storage
example: catalog-form

paymentAccountIdentifiers Array<{ identifier: string }
array of textual identifiers of payment accounts used by the order storage
example:

[
  {
    "identifier": "p1"
  }
]

---