getOrderByMarkerAndId

Obteniendo un pedido por marcador e id del objeto de almacenamiento de pedidos creado por el usuario. 🔐 Este método requiere autorización.

Descripción

Este método recupera un objeto de almacenamiento de pedidos por marcador e id. Devuelve una Promesa que se resuelve en un objeto IOrderByMarkerEntity.

Pedidos.getOrderByMarkerAndId(

marker*, id*, langCode

);

Esquema de parámetros

Esquema

marker(requerido): string
El identificador de texto del objeto de almacenamiento de pedidos
ejemplo: "order_storage_1"

id(requerido): number
ID del objeto de pedido
ejemplo: 12345

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

Ejemplos

Ejemplo mínimo

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

Ejemplo con atributos

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

Ejemplo de respuesta

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

Esquema de respuesta

Esquema: IOrderByMarkerEntity

id: number
Identificador del objeto.
ejemplo: 125

storageId: number
Identificador del objeto de almacenamiento de pedidos.
ejemplo: 1

createdDate: string
Fecha en que se creó el pedido.
ejemplo: "2023-10-01T12:00:00Z"

statusIdentifier: string
Identificador de texto del estado del pedido.
ejemplo: "order-status-1"

formIdentifier: string
Identificador de texto del formulario.
ejemplo: "bar-orders-form"

formData: IOrdersFormData[]
Datos enviados por el formulario vinculado al almacenamiento de pedidos.
ejemplo:

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

formData.marker: string
Marcador del campo del formulario.
ejemplo: "name_1"

formData.type: string
Tipo de valor.
ejemplo: "string"

formData.value: string
Valor.
ejemplo: "Nombre"

attributeSetIdentifier: string | null
Identificador de texto del conjunto de atributos.
ejemplo: "attribute-set-1"

totalSum: string
Monto total del pedido.
ejemplo: "100.00"

currency: string
Moneda utilizada para pagar el pedido.
ejemplo: "USD"

paymentAccountIdentifier: string | null
Identificador textual para el pago del pedido.
ejemplo: "payment-1"

paymentAccountLocalizeInfos: ILocalizeInfo
Nombre de la cuenta de pago considerando la localización.
ejemplo:

{
  "title": "Cash"
}

products: IOrderProducts[]
Array de productos añadidos al pedido.
ejemplo:

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

products.id: number
ID del producto.
ejemplo: 2957

products.quantity: number
Cantidad del producto.
ejemplo: 1

products.title: string
Título del producto.
ejemplo: "Cosmo"

products.sku: string | null
SKU del producto.
ejemplo: "SKU"

products.previewImage: IPicture | null
Imagen de vista previa del producto.
ejemplo:

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

previewImage.filename: string
El nombre del archivo.
ejemplo: "image.jpg"

previewImage.downloadLink: string
El enlace URL para descargar la imagen.
ejemplo: "https://example.com/image.jpg"

previewImage.size: number
El tamaño de la imagen en bytes.
ejemplo: 102400

previewImage.previewLink: string
El enlace URL para ver la imagen.
ejemplo: "https://example.com/image-preview.jpg"

products.price: number
Precio del producto.
ejemplo: 150

products.isGift: boolean
Indica si el producto es un regalo.
ejemplo: false

paymentUrl: string | null
Enlace de pago.
ejemplo: "https://example.com/pay/123"

isCompleted: boolean | null
Indica que el pedido ha sido completado.
ejemplo: true

statusLocalizeInfos: ILocalizeInfo
Nombre del estado localizado.

---