getAllOrdersByMarker
Get all of the user's orders from an order storage. 🔐 This method requires authorization.
Description
Fetches the authenticated user's orders from the storage with the given marker, one page at a time (offset, limit). Resolves to an IOrdersByMarkerEntity: the orders are in items, their count in total.
.getAllOrdersByMarker(
,
,
,
);
Parameters schema
Schema
marker(required): string
Marker of the order storage.
example: "order_storage_1"
langCode: string
Language code. Default: the langCode passed to defineOneEntry ("en_US" if none).
example: "en_US"
offset: number
Number of records to skip. Default: 0. offset + limit must not exceed 200; a larger window is rejected with 400.
example: 0
limit: number
Maximum number of records to return. Default: 30.
example: 30
Record limit. If the user group's permission for this method allows only restricted reading, the API returns at most the number of records set in the project settings (10 by default), whatever limit you pass. With full read access, limit works as usual. See Module permissions (opens in a new tab).
Examples
Minimal example
const response = await Orders.getAllOrdersByMarker('my_order');
Example with all parameters
const response = await Orders.getAllOrdersByMarker('my_order', 'en_US', 0, 30);
Example response
{
"items": [
{
"id": 797,
"storageId": 1,
"createdDate": "2026-10-27T09:15:17.494Z",
"statusIdentifier": "inProgress-payment",
"statusLocalizeInfos": {
"title": "In progress"
},
"fulfillmentStatusIdentifier": null,
"fulfillmentStatusLocalizeInfos": null,
"paymentStatusIdentifier": "inProgress-payment",
"paymentStatusLocalizeInfos": {
"title": "In progress"
},
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"value": "John",
"type": "string"
}
],
"attributeSetIdentifier": "order_form",
"paymentStrategy": "once",
"totalSum": "285",
"totalSumRaw": "300",
"currency": "USD",
"paymentAccountIdentifier": "cash",
"paymentAccountLocalizeInfos": {
"title": "Cash"
},
"products": [
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": [],
"price": 150,
"quantity": 2,
"isGift": false
}
],
"paymentUrl": null,
"discountConfig": {
"orderDiscounts": [
{
"id": 2,
"identifier": "personal_discount",
"type": "PERSONAL_DISCOUNT",
"localizeInfos": {
"title": "Personal discount"
},
"startDate": "2026-04-21T18:26:19.815Z",
"endDate": "2028-03-21T19:26:24.741Z",
"discountValue": {
"value": 15,
"maxAmount": null,
"discountType": "FIXED_AMOUNT",
"applicability": "TO_ORDER"
},
"exclusions": null,
"position": 1,
"conditionLogic": "AND",
"gifts": [],
"userGroups": null,
"userExclusions": null,
"conditions": [],
"coupon": null
}
],
"productDiscounts": [],
"coupon": null,
"settings": {
"allowStacking": true,
"maxDiscountValue": 50,
"allowGiftStacking": false,
"maxBonusPaymentPercent": null,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"giftRefundPolicy": "KEEP_GIFT"
},
"additionalDiscountsMarkers": [],
"totalRaw": 300,
"totalSumWithDiscount": 285,
"excludedGiftProductIds": [],
"bonus": {
"availableBalance": 0,
"maxBonusDiscount": 0,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"bonusApplied": 0
},
"bonusApplied": 0,
"totalDue": 285
},
"isPartial": false,
"isCompleted": null
},
{
"id": 796,
"storageId": 1,
"createdDate": "2026-10-26T16:26:31.147Z",
"statusIdentifier": "inProgress-payment",
"statusLocalizeInfos": {
"title": "In progress"
},
"fulfillmentStatusIdentifier": null,
"fulfillmentStatusLocalizeInfos": null,
"paymentStatusIdentifier": "inProgress-payment",
"paymentStatusLocalizeInfos": {
"title": "In progress"
},
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"value": "John",
"type": "string"
}
],
"attributeSetIdentifier": "order_form",
"paymentStrategy": "once",
"totalSum": "285",
"totalSumRaw": "300",
"currency": "USD",
"paymentAccountIdentifier": "cash",
"paymentAccountLocalizeInfos": {
"title": "Cash"
},
"products": [
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": [],
"price": 150,
"quantity": 2,
"isGift": false
}
],
"paymentUrl": null,
"discountConfig": {
"orderDiscounts": [
{
"id": 2,
"identifier": "personal_discount",
"type": "PERSONAL_DISCOUNT",
"localizeInfos": {
"title": "Personal discount"
},
"startDate": "2026-04-21T18:26:19.815Z",
"endDate": "2028-03-21T19:26:24.741Z",
"discountValue": {
"value": 15,
"maxAmount": null,
"discountType": "FIXED_AMOUNT",
"applicability": "TO_ORDER"
},
"exclusions": null,
"position": 1,
"conditionLogic": "AND",
"gifts": [],
"userGroups": null,
"userExclusions": null,
"conditions": [],
"coupon": null
}
],
"productDiscounts": [],
"coupon": null,
"settings": {
"allowStacking": true,
"maxDiscountValue": 50,
"allowGiftStacking": false,
"maxBonusPaymentPercent": null,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"giftRefundPolicy": "KEEP_GIFT"
},
"additionalDiscountsMarkers": [],
"totalRaw": 300,
"totalSumWithDiscount": 285,
"excludedGiftProductIds": [],
"bonus": {
"availableBalance": 0,
"maxBonusDiscount": 0,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"bonusApplied": 0
},
"bonusApplied": 0,
"totalDue": 285
},
"isPartial": false,
"isCompleted": null
},
{
"id": 795,
"storageId": 1,
"createdDate": "2026-10-26T13:46:33.726Z",
"statusIdentifier": "inProgress-payment",
"statusLocalizeInfos": {
"title": "In progress"
},
"fulfillmentStatusIdentifier": null,
"fulfillmentStatusLocalizeInfos": null,
"paymentStatusIdentifier": "inProgress-payment",
"paymentStatusLocalizeInfos": {
"title": "In progress"
},
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"value": "John",
"type": "string"
}
],
"attributeSetIdentifier": "order_form",
"paymentStrategy": "once",
"totalSum": "285",
"totalSumRaw": "300",
"currency": "USD",
"paymentAccountIdentifier": "cash",
"paymentAccountLocalizeInfos": {
"title": "Cash"
},
"products": [
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": [],
"price": 150,
"quantity": 2,
"isGift": false
}
],
"paymentUrl": null,
"discountConfig": {
"orderDiscounts": [
{
"id": 2,
"identifier": "personal_discount",
"type": "PERSONAL_DISCOUNT",
"localizeInfos": {
"title": "Personal discount"
},
"startDate": "2026-04-21T18:26:19.815Z",
"endDate": "2028-03-21T19:26:24.741Z",
"discountValue": {
"value": 15,
"maxAmount": null,
"discountType": "FIXED_AMOUNT",
"applicability": "TO_ORDER"
},
"exclusions": null,
"position": 1,
"conditionLogic": "AND",
"gifts": [],
"userGroups": null,
"userExclusions": null,
"conditions": [],
"coupon": null
}
],
"productDiscounts": [],
"coupon": null,
"settings": {
"allowStacking": true,
"maxDiscountValue": 50,
"allowGiftStacking": false,
"maxBonusPaymentPercent": null,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"giftRefundPolicy": "KEEP_GIFT"
},
"additionalDiscountsMarkers": [],
"totalRaw": 300,
"totalSumWithDiscount": 285,
"excludedGiftProductIds": [],
"bonus": {
"availableBalance": 0,
"maxBonusDiscount": 0,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"bonusApplied": 0
},
"bonusApplied": 0,
"totalDue": 285
},
"isPartial": false,
"isCompleted": null
}
],
"total": 545
}
Response schema
Schema: IOrdersByMarkerEntity
items: IOrderByMarkerEntity[]
Orders on this page.
example:
[
{
"id": 55,
"storageId": 1,
"createdDate": "2025-03-22T21:12:42.371Z",
"statusIdentifier": "inProgress",
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"value": "John",
"type": "string"
}
],
"attributeSetIdentifier": "order_form",
"totalSum": "300.00",
"currency": "",
"paymentAccountIdentifier": "cash",
"paymentAccountLocalizeInfos": {
"title": "Cash"
},
"products": [
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": null,
"price": 150,
"quantity": 2
}
],
"isCompleted": false
}
]
items.id: number
Object ID.
example: 125
items.storageId: number
ID of the order storage.
example: 1
items.createdDate: string
Date when the order was created.
example: "2023-10-01T12:00:00Z"
items.statusIdentifier: string
Marker of the order status.
example: "order-status-1"
items.formIdentifier: string
Marker of the form.
example: "bar-orders-form"
items.formData: IOrdersFormData[]
Data from the form linked to the order storage.
example:
[
{
"marker": "order_name",
"value": "John",
"type": "string"
}
]
items.attributeSetIdentifier: string | null
Marker of the attribute set.
example: "attribute-set-1"
items.totalSum: string
Total order amount.
example: "100.00"
items.totalSumRaw: string
Raw total order amount with full precision.
example: "100.00"
items.currency: string
Currency used to pay for the order.
example: "USD"
items.paymentAccountIdentifier: string | null
Marker of the payment account.
example: "payment-1"
items.paymentAccountLocalizeInfos: ILocalizeInfo
Localized name of the payment account.
example:
{
"title": "Cash"
}
items.products: IOrderProducts[]
Products in the order.
example:
[
{
"id": 1,
"name": "Product 1",
"quantity": 2
}
]
items.paymentUrl: string | null
Payment page URL.
example: "https://example.com/pay/123"
items.isCompleted: boolean | null
Whether the order has been completed.
example: true
items.isPartial: boolean | null
Whether the order is partially paid; null on older orders where this was not tracked.
example: false
items.paymentStrategy: string
Payment strategy of the order.
example: "once"
items.statusLocalizeInfos: ILocalizeInfo
Localized status name.
items.fulfillmentStatusIdentifier: string | null
Marker of the fulfillment (delivery) status; null while no fulfillment status is assigned.
example: "shipped"
items.fulfillmentStatusLocalizeInfos: ILocalizeInfo | null
Localized fulfillment status name; null while no fulfillment status is assigned.
items.paymentStatusIdentifier: string | null
Marker of the payment status; null while no payment status is assigned.
example: "inProgress-payment"
items.paymentStatusLocalizeInfos: ILocalizeInfo | null
Localized name of the payment status; null while no payment status is assigned.
items.discountConfig: IOrderDiscountConfig | null
Discount configuration resolved for the order: orderDiscounts, productDiscounts, coupon, settings, bonus and totals. null on older orders without a resolved configuration.
items.split: IOrderSplit
Split (staged) payment configuration; present on the by-id order endpoint.
items.distance: number
Cosine distance to the query. Returned on every item by the semantic (vector) search endpoint.
example: 0.12
total: number
Total number of found records.
example: 100
Usage examples
Step-by-step walkthroughs in the documentation:
- Order history: fetch and display a user's past orders by storage marker.
- Order subscription: check whether a user has an active subscription order.
Try it live
Run this method interactively in the JS SDK sandbox. On your first visit, connect your Project URL and App Token, then open:
- Order history: fetch and display a user's past orders by storage marker.
- Order subscription: check whether a user has an active subscription order.