getOrderByMarker

Get one order storage object by marker 🔐 This method requires authorization.

Orders.getOrderByMarker(marker, langCode)

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

Schema

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

langCode: string
Optional language field
example: en_US

This method retrieves one order storage object by marker.

Example return:

{
  "id": 2,
  "localizeInfos": {
    "title": "My order"
  },
  "position": 1,
  "identifier": "my_order",
  "formIdentifier": "orderForm",
  "generalTypeId": 21,
  "paymentAccountIdentifiers": [
    {
      "identifier": "cash"
    }
  ]
}

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