getOrderByMarkerAndId

Mengambil satu pesanan berdasarkan marker dan id dari objek penyimpanan pesanan yang dibuat oleh pengguna. 🔐 Metode ini memerlukan otorisasi.

Deskripsi

Metode ini mengambil satu objek penyimpanan pesanan berdasarkan marker dan id. Ini mengembalikan sebuah Promise yang menyelesaikan menjadi objek IOrderByMarkerEntity.

Pesanan.getOrderByMarkerAndId(

marker*, id*, langCode

);

Skema parameter

Skema

marker(diperlukan): string
Identifikasi teks dari objek penyimpanan pesanan
contoh: "order_storage_1"

id(diperlukan): number
ID dari objek pesanan
contoh: 12345

langCode: string
Kode bahasa. Default: "en_US"
contoh: "en_US"

Contoh

Contoh minimal

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

Contoh dengan atribut

const response = await Orders.getOrderByMarkerAndId('my-order', 1764, 'en_US');

Contoh respons

{
  "id": 205,
  "storageId": 1,
  "createdDate": "2025-07-18T05:51:09.924Z",
  "statusIdentifier": "inProgress",
  "statusLocalizeInfos": {
    "title": "In progress"
  },
  "formIdentifier": "orderForm",
  "formData": [
    {
      "marker": "order_name",
      "type": "string",
      "value": "Ivan"
    }
  ],
  "attributeSetIdentifier": "order_form",
  "paymentStrategy": "once",
  "totalSum": "51",
  "totalSumRaw": "51",
  "currency": "usd",
  "paymentAccountIdentifier": "stripe",
  "paymentAccountLocalizeInfos": {
    "title": "Stripe"
  },
  "products": [
    {
      "id": 2954,
      "title": "Box",
      "sku": null,
      "previewImage": null,
      "price": 51,
      "quantity": 1,
      "isGift": false
    }
  ],
  "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a19RuP9hh4gGmaSOQwb57OBpnypIifa0FDnGhYe7od5XkRXRUpYXUKDRtm#fidnandhYHdWcXxpYCc%2FJ2FgY2RwaXEnKSd2cXdsdWBEZmZqcGtxJz8nZGZmcVo0VHJuTndEZlZqS2YybGBzJyknZHVsTmB8Jz8ndW5acWB2cVowNEtDcERXRG9vaE89NUZTa2tDan1AdkJNaHN2YnE2Tmw8YE5zVUJCb1ZTYXBkQEBgSXNkZ3JTVj1UbmZDUTVVTXA0cH1CMkZXXDVfUUM0YUJRQTVLTGZPbjU1d0tkcmFoNV8nKSdjd2poVmB3c2B3Jz9xd3BgKSdnZGZuYndqcGthRmppancnPycmY2NjY2NjJyknaWR8anBxUXx1YCc%2FJ3Zsa2JpYFpscWBoJyknYGtkZ2lgVWlkZmBtamlhYHd2Jz9xd3BgeCUl",
  "discountConfig": {
    "orderDiscounts": [],
    "productDiscounts": [],
    "coupon": null,
    "settings": {
      "allowStacking": false,
      "maxDiscountValue": null,
      "allowGiftStacking": false
    },
    "additionalDiscountsMarkers": [],
    "totalRaw": 51,
    "totalSumWithDiscount": 51,
    "excludedGiftProductIds": [],
    "bonus": null,
    "bonusApplied": 0,
    "totalDue": 51
  },
  "isPartial": false,
  "isCompleted": false,
  "split": {
    "completed": false,
    "partial": false,
    "stages": [
      {
        "marker": "default",
        "sessionId": null,
        "productId": 2954,
        "title": "Default",
        "value": 51,
        "status": "planned"
      }
    ]
  }
}

Skema respons

Skema: IOrderByMarkerEntity

id: number
Identifikasi objek.
contoh: 125

storageId: number
Identifikasi dari objek penyimpanan pesanan.
contoh: 1

createdDate: string
Tanggal ketika pesanan dibuat.
contoh: "2023-10-01T12:00:00Z"

statusIdentifier: string
Identifikasi teks dari status pesanan.
contoh: "order-status-1"

formIdentifier: string
Identifikasi teks dari formulir.
contoh: "bar-orders-form"

formData: IOrdersFormData[]
Data yang dikirimkan oleh formulir yang terhubung ke penyimpanan pesanan.
contoh:

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

formData.marker: string
Marker dari field formulir.
contoh: "name_1"

formData.type: string
Tipe nilai.
contoh: "string"

formData.value: string
Nilai.
contoh: "Nama"

attributeSetIdentifier: string | null
Identifikasi teks dari set atribut.
contoh: "attribute-set-1"

totalSum: string
Jumlah total pesanan.
contoh: "100.00"

totalSumRaw: string
Jumlah total pesanan mentah dengan presisi penuh.
contoh: "100.00"

currency: string
Mata uang yang digunakan untuk membayar pesanan.
contoh: "USD"

paymentAccountIdentifier: string | null
Identifikasi tekstual untuk pembayaran pesanan.
contoh: "payment-1"

paymentAccountLocalizeInfos: ILocalizeInfo
Nama akun pembayaran dengan mempertimbangkan lokalisasi.
contoh:

{
  "title": "Cash"
}

products: IOrderProducts[]
Array produk yang ditambahkan ke pesanan.
contoh:

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

products.id: number
ID produk.
contoh: 2957

products.quantity: number
Jumlah produk.
contoh: 1

products.title: string
Judul produk.
contoh: "Cosmo"

products.sku: string | null
SKU produk.
contoh: "SKU"

products.previewImage: IPicture | null
Gambar pratinjau produk.
contoh:

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

products.price: number
Harga produk.
contoh: 150

products.isGift: boolean
Apakah produk adalah hadiah.
contoh: false

paymentUrl: string | null
Tautan pembayaran.
contoh: "https://example.com/pay/123"

isCompleted: boolean | null
Menunjukkan bahwa pesanan telah diselesaikan.
contoh: true

isPartial: boolean | null
Menunjukkan bahwa pesanan dibayar sebagian; null pada pesanan lama di mana ini tidak dilacak.
contoh: false

paymentStrategy: string
Strategi pembayaran dari pesanan.
contoh: "once"

statusLocalizeInfos: ILocalizeInfo
Nama status yang dilokalisasi.

discountConfig: IOrderDiscountConfig | null
Konfigurasi diskon yang diterapkan pada pesanan (orderDiscounts, productDiscounts, coupon, settings, bonus, totals); null pada pesanan lama tanpa konfigurasi diskon yang diselesaikan.

discountConfig.bonus: IOrderDiscountBonus | null
Hasil perhitungan bonus, null ketika bonus tidak digunakan, atau dihilangkan sepenuhnya ketika pesanan tidak memiliki konteks bonus.

discountConfig.coupon: unknown | null
Kupon yang diselesaikan, atau null ketika tidak ada kupon yang diterapkan.

discountConfig.orderDiscounts: unknown[]
Diskon tingkat pesanan yang dicocokkan dan diterapkan.

discountConfig.productDiscounts: unknown[]
Diskon tingkat produk yang dicocokkan dan diterapkan.

discountConfig.settings: IOrderDiscountSettings
Pengaturan penumpukan dan batas yang digunakan selama perhitungan.

discountConfig.additionalDiscountsMarkers: string[]
Marker diskon tambahan yang diminta oleh klien (dihilangkan dalam respons pratinjau).

discountConfig.bonusApplied: number
Jumlah bonus yang diterapkan pada pesanan (dihilangkan dalam respons pratinjau).
contoh: 0

discountConfig.excludedGiftProductIds: string[]
ID produk yang dikecualikan dari pemilihan hadiah (dihilangkan dalam respons pratinjau).

discountConfig.totalDue: number
Jumlah total yang harus dibayar setelah diskon dan bonus (dihilangkan dalam respons pratinjau).
contoh: 300

discountConfig.totalRaw: number
Jumlah total sebelum diskon (dihilangkan dalam respons pratinjau).
contoh: 300

discountConfig.totalSumWithDiscount: number
Jumlah total setelah diskon tetapi sebelum bonus (dihilangkan dalam respons pratinjau).
contoh: 300

split: IOrderSplit
Konfigurasi pembayaran terpisah (staged); hadir pada endpoint pesanan berdasarkan id.

split.completed: boolean
Apakah semua tahap terpisah telah diselesaikan.
contoh: false

split.partial: boolean
Apakah pemisahan dibayar sebagian.
contoh: false

split.stages: IOrderSplitStage[]
Daftar terurut dari tahap pembayaran terpisah.

---

Contoh penggunaan

Panduan langkah demi langkah dalam dokumentasi:

• Struk PDF — ambil pesanan yang telah ditempatkan berdasarkan marker dan id, lalu buat struk PDF dari itu.

Coba secara langsung

Jalankan metode ini secara interaktif di JS SDK sandbox — sambungkan URL Proyek dan Token Aplikasi Anda pada kunjungan pertama, lalu buka:

• Struk PDF — ambil pesanan yang telah ditempatkan berdasarkan marker dan id, lalu buat struk PDF dari itu.