Ana içeriğe geç

getAllOrdersByMarker

Kullanıcı tarafından oluşturulan sipariş depolama nesnesinden tüm siparişleri almak. 🔐 Bu yöntem yetkilendirme gerektirir.

Açıklama

Bu yöntem, işaretçi ile tüm sipariş depolama nesnelerini alır. Yöntem, isteğin gövdesine varsayılan dili ekleyecektir. Dili değiştirmek isterseniz, sadece ikinci argüman olarak geçirin. Bir IOrdersByMarkerEntity nesnesine çözülen bir Promise döner.

Siparişler.getAllOrdersByMarker(

marker*, langCode, offset, limit

);

Parametreler şeması

Şema

marker(required): string
Sipariş depolama nesnesinin metinsel tanımlayıcısı
örnek: "order_storage_1"

langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"

offset: number
Ofset parametresi. Varsayılan: 0
örnek: 0

limit: number
Limit parametresi. Varsayılan: 30
örnek: 30

Varsayılan olarak, 10 nesne alabilirsiniz. Bu, modülün izin ayarlarındaki kayıt limitinden kaynaklanmaktadır.
Sayfalandırmanın doğru çalışması için, ihtiyaçlarınıza göre Modül izinlerini ilgili bölümde yapılandırmanız gerekir.

Örnekler

Minimal örnek

const response = await Orders.getAllOrdersByMarker('my-order');

Özelliklerle örnek

const response = await Orders.getAllOrdersByMarker('my-order', 'en_US', 0, 30);

Örnek yanıt

{
"items": [
{
"id": 551,
"storageId": 1,
"createdDate": "2026-04-15T14:20:29.645Z",
"statusIdentifier": "inProgress",
"statusLocalizeInfos": {
"title": "In progress"
},
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
],
"attributeSetIdentifier": "order_form",
"paymentStrategy": "once",
"totalSum": "300",
"totalSumRaw": "300",
"currency": "",
"paymentAccountIdentifier": "cash",
"paymentAccountLocalizeInfos": {
"title": "Cash"
},
"products": [
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": null,
"price": 150,
"quantity": 2,
"isGift": false
}
],
"paymentUrl": null,
"discountConfig": {
"orderDiscounts": [],
"productDiscounts": [],
"coupon": null,
"settings": {
"allowStacking": false,
"maxDiscountValue": null,
"allowGiftStacking": false,
"maxBonusPaymentPercent": null,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"giftRefundPolicy": "KEEP_GIFT"
},
"additionalDiscountsMarkers": [],
"totalRaw": 300,
"totalSumWithDiscount": 300,
"excludedGiftProductIds": [],
"bonus": {
"availableBalance": 0,
"maxBonusDiscount": 0,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"bonusApplied": 0
},
"bonusApplied": 0,
"totalDue": 300
},
"isPartial": false,
"isCompleted": null
},
{
"id": 550,
"storageId": 1,
"createdDate": "2026-04-14T14:53:59.484Z",
"statusIdentifier": "inProgress",
"statusLocalizeInfos": {
"title": "In progress"
},
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
],
"attributeSetIdentifier": "order_form",
"paymentStrategy": "once",
"totalSum": "300",
"totalSumRaw": "300",
"currency": "",
"paymentAccountIdentifier": "cash",
"paymentAccountLocalizeInfos": {
"title": "Cash"
},
"products": [
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": null,
"price": 150,
"quantity": 2,
"isGift": false
}
],
"paymentUrl": null,
"discountConfig": {
"orderDiscounts": [],
"productDiscounts": [],
"coupon": null,
"settings": {
"allowStacking": false,
"maxDiscountValue": null,
"allowGiftStacking": false,
"maxBonusPaymentPercent": null,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"giftRefundPolicy": "KEEP_GIFT"
},
"additionalDiscountsMarkers": [],
"totalRaw": 300,
"totalSumWithDiscount": 300,
"excludedGiftProductIds": [],
"bonus": {
"availableBalance": 0,
"maxBonusDiscount": 0,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"bonusApplied": 0
},
"bonusApplied": 0,
"totalDue": 300
},
"isPartial": false,
"isCompleted": null
},
{
"id": 549,
"storageId": 1,
"createdDate": "2026-04-14T13:22:58.354Z",
"statusIdentifier": "inProgress",
"statusLocalizeInfos": {
"title": "In progress"
},
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
],
"attributeSetIdentifier": "order_form",
"paymentStrategy": "once",
"totalSum": "300",
"totalSumRaw": "300",
"currency": "",
"paymentAccountIdentifier": "cash",
"paymentAccountLocalizeInfos": {
"title": "Cash"
},
"products": [
{
"id": 2957,
"title": "Cosmo",
"sku": null,
"previewImage": null,
"price": 150,
"quantity": 2,
"isGift": false
}
],
"paymentUrl": null,
"discountConfig": {
"orderDiscounts": [],
"productDiscounts": [],
"coupon": null,
"settings": {
"allowStacking": false,
"maxDiscountValue": null,
"allowGiftStacking": false,
"maxBonusPaymentPercent": null,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"giftRefundPolicy": "KEEP_GIFT"
},
"additionalDiscountsMarkers": [],
"totalRaw": 300,
"totalSumWithDiscount": 300,
"excludedGiftProductIds": [],
"bonus": {
"availableBalance": 0,
"maxBonusDiscount": 0,
"minBonusAmount": null,
"minOrderAmountForBonus": null,
"bonusApplied": 0
},
"bonusApplied": 0,
"totalDue": 300
},
"isPartial": false,
"isCompleted": null
},
"..."
],
"total": 357
}

Yanıt şeması

Şema: IOrdersByMarkerEntity

items: IOrderByMarkerEntity[]
Sipariş depolama nesnelerinin dizisi.
örnek:

[
{
"id": 55,
"storageId": 1,
"createdDate": "2025-03-22T21:12:42.371Z",
"statusIdentifier": "inProgress",
"formIdentifier": "orderForm",
"formData": [
{
"marker": "order_name",
"value": "Ivan",
"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
Nesne tanımlayıcısı.
örnek: 125

items.storageId: number
Sipariş depolama nesnesinin tanımlayıcısı.
örnek: 1

items.createdDate: string
Siparişin oluşturulduğu tarih.
örnek: "2023-10-01T12:00:00Z"

items.statusIdentifier: string
Sipariş durumunun metinsel tanımlayıcısı.
örnek: "order-status-1"

items.formIdentifier: string
Formun metinsel tanımlayıcısı.
örnek: "bar-orders-form"

items.formData: IOrdersFormData[]
Sipariş deposuna bağlı form tarafından gönderilen veriler.
örnek:

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

formData.marker: string
Form alanının işaretçisi.
örnek: "name_1"

formData.type: string
Değerin türü.
örnek: "string"

formData.value: string
Değer.
örnek: "İsim"

items.attributeSetIdentifier: string | null
Özellik setinin metinsel tanımlayıcısı.
örnek: "attribute-set-1"

items.totalSum: string
Toplam sipariş tutarı.
örnek: "100.00"

items.currency: string
Siparişin ödenmesinde kullanılan para birimi.
örnek: "USD"

items.paymentAccountIdentifier: string | null
Sipariş ödemesi için metinsel tanımlayıcı.
örnek: "payment-1"

items.paymentAccountLocalizeInfos: ILocalizeInfo
Yerelleştirmeyi dikkate alarak ödeme hesabı adı.
örnek:

{
"title": "Cash"
}

items.products: IOrderProducts[]
Siparişe eklenen ürünlerin dizisi.
örnek:

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

products.id: number
Ürün id'si.
örnek: 2957

products.quantity: number
Ürün miktarı.
örnek: 1

products.title: string
Ürün başlığı.
örnek: "Cosmo"

products.sku: string | null
Ürün sku'su.
örnek: "SKU"

products.previewImage: IPicture | null
Ürün önizleme resmi.
örnek:

{
"filename": "image.jpg",
"downloadLink": "https://example.com/image.jpg",
"size": 102400,
"previewLink": "https://example.com/image-preview.jpg"
}

previewImage.filename: string
Dosyanın adı.
örnek: "image.jpg"

previewImage.downloadLink: string
Resmi indirmek için URL bağlantısı.
örnek: "https://example.com/image.jpg"

previewImage.size: number
Resmin boyutu bayt cinsinden.
örnek: 102400

previewImage.previewLink: string
Resmin önizlemesi için URL bağlantısı.
örnek: "https://example.com/image-preview.jpg"

products.price: number
Ürün fiyatı.
örnek: 150

products.isGift: boolean
Ürünün hediye olup olmadığını belirtir.
örnek: false

items.paymentUrl: string | null
Ödeme bağlantısı.
örnek: "https://example.com/pay/123"

items.isCompleted: boolean | null
Siparişin tamamlandığını gösterir.
örnek: true

items.statusLocalizeInfos: ILocalizeInfo
Yerelleştirilmiş durum adı.

total: number
Bulunan kayıtların toplam sayısı.
örnek: 100