Skip to main content

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? );

Minimal example

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

marker(required): string
The text identifier of the order storage object
example: "order_storage_1"

id(required): number
ID of the order object
example: 12345

langCode: string
Language code. Default: "en_US"
example: "en_US"

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

Example response

{
"id": 205,
"storageId": 1,
"createdDate": "2025-07-18T05:51:09.924Z",
"statusIdentifier": "inProgress",
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"type": "string",
"value": "Ivan"
}
],
"attributeSetIdentifier": "order_form",
"totalSum": "50.00",
"currency": "usd",
"paymentAccountIdentifier": "stripe",
"paymentAccountLocalizeInfos": {
"title": "Stripe"
},
"products": [
{
"id": 2954,
"title": "Box",
"sku": null,
"previewImage": null,
"price": 50,
"quantity": 1
}
],
"isCompleted": false
}
Schema

id: number
Object identifier.
example: 125

storageId: number
Identifier of the order storage object.
example: 1

createdDate: string
Date when the order was created.
example: "2023-10-01T12:00:00Z"

statusIdentifier: string
Text identifier of the order status.
example: "order-status-1"

formIdentifier: string
Text identifier of the form.
example: "bar-orders-form"

formData: IOrdersFormData[]
Data submitted by the form linked to the order store.
example:

[
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
]

attributeSetIdentifier: string | null
Text identifier of the attribute set.
example: "attribute-set-1"

totalSum: string
Total order amount.
example: "100.00"

currency: string
Currency used to pay for the order.
example: "USD"

paymentAccountIdentifier: string | null
Textual identifier for the order payment.
example: "payment-1"

paymentAccountLocalizeInfos: Record<string, any>
Payment account name considering localization.
example:

{
"en_US": "USD Payment",
"ru_RU": "Оплата в долларах США"
}

products: IOrderProducts[]
Array of products added to order.
example:

[
{
"id": 1,
"name": "Product 1",
"quantity": 2
}
]

isCompleted: boolean
Indicates that the order has been completed.
example: true