getOrderById

Obteniendo un solo pedido creado por el usuario, por su propio id.

Descripción

Este método recupera un pedido del usuario autenticado solo por el id del pedido, sin el marcador de almacenamiento. Devuelve una Promesa que se resuelve en un objeto IOrderByMarkerEntity: la misma entidad que devuelve getOrderByMarkerAndId.

Pedidos.getOrderById(id, langCode);

Parámetros

id: number
ID del objeto de pedido.
ejemplo: 12345

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

💡 Cuándo usarlo en lugar de getOrderByMarkerAndId

getOrderByMarkerAndId necesita tanto el marcador de almacenamiento como el id. El marcador es exactamente lo que falta cuando el id llega desde fuera de tu aplicación: la URL de retorno de un proveedor de pagos, un enlace en una notificación, un número de pedido que un cliente lee por teléfono. En esos casos, utiliza este método.

🔐 Autorización

Este método requiere autorización del usuario. Consulta el módulo AuthProvider.

Ejemplos

Ejemplo mínimo

const response = await Orders.getOrderById(205);

Con un código de idioma

const response = await Orders.getOrderById(205, 'en_US');

Ejemplo de respuesta

{
  "id": 205,
  "storageId": 1,
  "createdDate": "2025-07-18T05:51:09.924Z",
  "statusIdentifier": "inProgress",
  "statusLocalizeInfos": {
    "title": "In progress"
  },
  "fulfillmentStatusIdentifier": null,
  "fulfillmentStatusLocalizeInfos": null,
  "paymentStatusIdentifier": null,
  "paymentStatusLocalizeInfos": null,
  "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": [
        {
          "size": 742690,
          "filename": "files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.jpeg",
          "contentType": "image/jpeg",
          "previewLink": {
            "default": [
              "data:image/webp;base64,UklGRmwAAABXRUJQVlA4IGAAAADQAQCdASoQABAABUB8JbACdACZZ3P8AAD+wGsUXBs/r069WpdrcuaTNfVxqWIetuaIdIvOMkSp9iJRxE+KhA2YHbrVehhMRj/j5+DUdjWn1v5YtZ7vw0IgPi9R5vkAAAA=",
              "https://your-project.oneentry.cloud/cloud-static/files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.preview.default.jpeg"
            ]
          },
          "downloadLink": "https://your-project.oneentry.cloud/cloud-static/files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.jpeg",
          "defaultPreview": "default"
        }
      ],
      "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 del pedido.
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 del pedido.
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"

totalSumRaw: string
Monto total bruto del pedido con precisión total.
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"
}

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

products.isGift: boolean
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

isPartial: boolean | null
Indica que el pedido está parcialmente pagado; null en pedidos más antiguos donde no se rastreó.
ejemplo: false

paymentStrategy: string
Estrategia de pago del pedido.
ejemplo: "once"

statusLocalizeInfos: ILocalizeInfo
Nombre del estado localizado.

fulfillmentStatusIdentifier: string | null
Identificador de texto del estado de cumplimiento (entrega); null mientras no se asigne ningún estado de cumplimiento.
ejemplo: "shipped"

fulfillmentStatusLocalizeInfos: ILocalizeInfo | null
Nombre del estado de cumplimiento localizado; null mientras no se asigne ningún estado de cumplimiento.

paymentStatusIdentifier: string | null
Identificador de texto del estado de pago; null mientras no se asigne ningún estado de pago.
ejemplo: "inProgress-payment"

paymentStatusLocalizeInfos: ILocalizeInfo | null
Nombre del estado de pago localizado; null mientras no se asigne ningún estado de pago.

discountConfig: IOrderDiscountConfig | null
Configuración de descuento resuelta aplicada al pedido (orderDiscounts, productDiscounts, coupon, settings, bonus, totals); null en pedidos más antiguos sin una configuración de descuento resuelta.

discountConfig.bonus: IOrderDiscountBonus | null
Resultado del cálculo de bonificación, null cuando no se utilizan bonificaciones, o omitido por completo cuando el pedido no tiene contexto de bonificación.

discountConfig.coupon: unknown | null
Cupón resuelto, o null cuando no se aplica ningún cupón.

discountConfig.orderDiscounts: unknown[]
Descuentos a nivel de pedido que fueron coincidentes y aplicados.

discountConfig.productDiscounts: unknown[]
Descuentos a nivel de producto que fueron coincidentes y aplicados.

discountConfig.settings: IOrderDiscountSettings
Configuraciones de apilamiento y límite utilizadas durante el cálculo.

discountConfig.additionalDiscountsMarkers: string[]
Marcadores de descuentos adicionales solicitados por el cliente (omitidos en respuestas de vista previa).

discountConfig.bonusApplied: number
Monto de bonificación aplicado al pedido (omitido en respuestas de vista previa).
ejemplo: 0

discountConfig.excludedGiftProductIds: string[]
IDs de productos excluidos de la selección de regalos (omitidos en respuestas de vista previa).

discountConfig.totalDue: number
Monto total a pagar después de descuentos y bonificaciones (omitido en respuestas de vista previa).
ejemplo: 300

discountConfig.totalRaw: number
Monto total antes de descuentos (omitido en respuestas de vista previa).
ejemplo: 300

discountConfig.totalSumWithDiscount: number
Monto total después de descuentos pero antes de bonificaciones (omitido en respuestas de vista previa).
ejemplo: 300

split: IOrderSplit
Configuración de pago dividido (por etapas); presente en el endpoint de pedido por id.

split.completed: boolean
Si todas las etapas del split están completadas.
ejemplo: false

split.partial: boolean
Si el split está parcialmente pagado.
ejemplo: false

split.stages: IOrderSplitStage[]
Lista ordenada de etapas de pago dividido.

distance: number
Distancia coseno a la consulta. Devuelto solo por el endpoint de búsqueda semántica (vector) cuando se pasa debug: true en el cuerpo de búsqueda.
ejemplo: 0.12

---