getOrderByMarkerAndId

Lấy một đơn hàng theo marker và id từ đối tượng lưu trữ đơn hàng được tạo bởi người dùng. 🔐 Phương thức này yêu cầu ủy quyền.

Mô tả

Phương thức này truy xuất một đối tượng lưu trữ đơn hàng theo marker và id. Nó trả về một Promise mà khi hoàn thành sẽ trả về một đối tượng IOrderByMarkerEntity.

Orders.getOrderByMarkerAndId(
marker*,
id*,
langCode
);

Sơ đồ tham số

Sơ đồ

marker(bắt buộc): string
Định danh văn bản của đối tượng lưu trữ đơn hàng
ví dụ: "order_storage_1"

id(bắt buộc): number
ID của đối tượng đơn hàng
ví dụ: 12345

langCode: string
Mã ngôn ngữ. Mặc định: "en_US"
ví dụ: "en_US"

Ví dụ

Ví dụ tối thiểu

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

Ví dụ với thuộc tính

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

Ví dụ phản hồi

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

Sơ đồ phản hồi

Sơ đồ: IOrderByMarkerEntity

id: number
Định danh đối tượng.
ví dụ: 125

storageId: number
Định danh của đối tượng lưu trữ đơn hàng.
ví dụ: 1

createdDate: string
Ngày khi đơn hàng được tạo.
ví dụ: "2023-10-01T12:00:00Z"

statusIdentifier: string
Định danh văn bản của trạng thái đơn hàng.
ví dụ: "order-status-1"

formIdentifier: string
Định danh văn bản của biểu mẫu.
ví dụ: "bar-orders-form"

formData: IOrdersFormData[]
Dữ liệu được gửi bởi biểu mẫu liên kết với cửa hàng đơn hàng.
ví dụ:

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

formData.marker: string
Định danh của trường biểu mẫu.
ví dụ: "name_1"

formData.type: string
Loại giá trị.
ví dụ: "string"

formData.value: string
Giá trị.
ví dụ: "Name"

attributeSetIdentifier: string | null
Định danh văn bản của bộ thuộc tính.
ví dụ: "attribute-set-1"

totalSum: string
Tổng số tiền đơn hàng.
ví dụ: "100.00"

totalSumRaw: string
Tổng số tiền đơn hàng thô với độ chính xác đầy đủ.
ví dụ: "100.00"

currency: string
Tiền tệ được sử dụng để thanh toán cho đơn hàng.
ví dụ: "USD"

paymentAccountIdentifier: string | null
Định danh văn bản cho thanh toán đơn hàng.
ví dụ: "payment-1"

paymentAccountLocalizeInfos: ILocalizeInfo
Tên tài khoản thanh toán với sự xem xét về địa phương hóa.
ví dụ:

{
  "title": "Cash"
}

products: IOrderProducts[]
Mảng các sản phẩm được thêm vào đơn hàng.
ví dụ:

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

products.id: number
ID sản phẩm.
ví dụ: 2957

products.quantity: number
Số lượng sản phẩm.
ví dụ: 1

products.title: string
Tên sản phẩm.
ví dụ: "Cosmo"

products.sku: string | null
SKU sản phẩm.
ví dụ: "SKU"

products.previewImage: IPicture | null
Hình ảnh xem trước sản phẩm.
ví dụ:

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

products.price: number
Giá sản phẩm.
ví dụ: 150

products.isGift: boolean
Liệu sản phẩm có phải là quà tặng hay không.
ví dụ: false

paymentUrl: string | null
Liên kết thanh toán.
ví dụ: "https://example.com/pay/123"

isCompleted: boolean | null
Chỉ ra rằng đơn hàng đã được hoàn thành.
ví dụ: true

isPartial: boolean | null
Chỉ ra rằng đơn hàng đã được thanh toán một phần; null đối với các đơn hàng cũ mà không được theo dõi.
ví dụ: false

paymentStrategy: string
Chiến lược thanh toán của đơn hàng.
ví dụ: "once"

statusLocalizeInfos: ILocalizeInfo
Tên trạng thái đã được địa phương hóa.

discountConfig: IOrderDiscountConfig | null
Cấu hình giảm giá đã được giải quyết áp dụng cho đơn hàng (orderDiscounts, productDiscounts, coupon, settings, bonus, totals); null đối với các đơn hàng cũ mà không có cấu hình giảm giá đã được giải quyết.

discountConfig.bonus: IOrderDiscountBonus | null
Kết quả tính toán bonus, null khi không sử dụng bonus, hoặc bị bỏ qua hoàn toàn khi đơn hàng không có ngữ cảnh bonus.

discountConfig.coupon: unknown | null
Coupon đã được giải quyết, hoặc null khi không có coupon nào được áp dụng.

discountConfig.orderDiscounts: unknown[]
Các giảm giá cấp đơn hàng đã được khớp và áp dụng.

discountConfig.productDiscounts: unknown[]
Các giảm giá cấp sản phẩm đã được khớp và áp dụng.

discountConfig.settings: IOrderDiscountSettings
Cài đặt xếp chồng và giới hạn được sử dụng trong quá trình tính toán.

discountConfig.additionalDiscountsMarkers: string[]
Các định danh của các giảm giá bổ sung được yêu cầu bởi khách hàng (bị bỏ qua trong các phản hồi xem trước).

discountConfig.bonusApplied: number
Số tiền bonus đã được áp dụng cho đơn hàng (bị bỏ qua trong các phản hồi xem trước).
ví dụ: 0

discountConfig.excludedGiftProductIds: string[]
Các ID sản phẩm bị loại trừ khỏi lựa chọn quà tặng (bị bỏ qua trong các phản hồi xem trước).

discountConfig.totalDue: number
Tổng số tiền phải trả sau khi giảm giá và bonus (bị bỏ qua trong các phản hồi xem trước).
ví dụ: 300

discountConfig.totalRaw: number
Tổng số tiền trước khi giảm giá (bị bỏ qua trong các phản hồi xem trước).
ví dụ: 300

discountConfig.totalSumWithDiscount: number
Tổng số tiền sau khi giảm giá nhưng trước khi bonus (bị bỏ qua trong các phản hồi xem trước).
ví dụ: 300

split: IOrderSplit
Cấu hình thanh toán chia (giai đoạn); có mặt trên điểm cuối đơn hàng theo ID.

split.completed: boolean
Liệu tất cả các giai đoạn chia đã hoàn thành hay chưa.
ví dụ: false

split.partial: boolean
Liệu phần chia đã được thanh toán một phần hay không.
ví dụ: false

split.stages: IOrderSplitStage[]
Danh sách có thứ tự các giai đoạn thanh toán chia.

Ví dụ sử dụng

Hướng dẫn từng bước trong tài liệu:

Hóa đơn PDF — lấy một đơn hàng đã đặt theo marker và id, sau đó tạo một hóa đơn PDF từ đó.

Thử nghiệm trực tiếp

Chạy phương thức này một cách tương tác trong JS SDK sandbox — kết nối URL Dự án và Mã Token Ứng dụng của bạn khi lần đầu truy cập, sau đó mở:

Hóa đơn PDF — lấy một đơn hàng đã đặt theo marker và id, sau đó tạo một hóa đơn PDF từ đó.

Mô tả​

Sơ đồ tham số​

Ví dụ​

Ví dụ tối thiểu​

Ví dụ với thuộc tính​

Ví dụ phản hồi​

Sơ đồ phản hồi​

Ví dụ sử dụng​

Thử nghiệm trực tiếp​