getOrderByMarker

Obtiene un objeto de almacenamiento de pedido por marcador. 🔐 Este método requiere autorización.

Descripción

Este método recupera un objeto de almacenamiento de pedido por marcador. Devuelve una Promesa que se resuelve en un objeto IOrdersEntity.

Orders.getOrderByMarker(

marker, langCode

);

Esquema de parámetros

Esquema

marker(requerido): string
Marcador del objeto de pedido
ejemplo: "order_storage_1"

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

Ejemplos

Ejemplo mínimo

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

Ejemplo con atributos

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

Ejemplo de respuesta

{
  "id": 1,
  "localizeInfos": {
    "title": "Mi pedido"
  },
  "position": 1,
  "identifier": "my_order",
  "formIdentifier": "orderForm",
  "generalTypeId": 21,
  "paymentAccountIdentifiers": [
    {
      "identifier": "cash"
    },
    {
      "identifier": "stripe"
    }
  ]
}

Esquema de respuesta

Esquema: IOrdersEntity

id: number
Identificador del objeto.
ejemplo: 1

localizeInfos: ILocalizeInfo
Nombre considerando la localización.
ejemplo:

{
  "title": "Efectivo"
}

position: number | null
Posición en el almacenamiento de pedidos.
ejemplo: 1

identifier: string
Identificador textual para el campo del registro.
ejemplo: "order_storage_1"

formIdentifier: string
Identificador textual para el formulario utilizado por el almacenamiento de pedidos.
ejemplo: "bar-orders-form"

generalTypeId: number | null
Identificador de tipo.
ejemplo: 1

paymentAccountIdentifiers: IPaymentAccountIdentifiers[]
Array de identificadores textuales de cuentas de pago utilizadas por el almacenamiento de pedidos.
ejemplo:

[
  {
    "identifier": "payment-1"
  }
]

---