getOrderByMarkerAndId

Getting one order by marker and id from the order storage object created by the user 🔐 This method requires authorization.

Orders.getOrderByMarkerAndId(marker, id, langCode)

const value = await Orders.getOrderByMarkerAndId('my-order', 1764)

Schema

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

id:* number
ID of the order object
example: 1764

langCode: string
Optional language field
example: en_US

This method retrieves one order storage object by marker and id.

Example return:

{
  "id": 1764,
  "statusIdentifier": "inprogress",
  "formIdentifier": "order-form",
  "formData": [
    {
      "marker": "name_1",
      "type": "string",
      "value": "Name"
    }
  ],
  "products": [
    {
      "id": 1,
      "title": "Floorwood Maxima Laminate, 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": {
    "en_US": {
      "title": "Account 1"
    }
  },
  "isHistory": true
}

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