Saltar al contenido principal

getOrderByMarker

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

Orders?.getOrderByMarker( marker?, langCode? );

Ejemplo mínimo

const value = await Orders.getOrderByMarker('my-order')
Esquema

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

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

Este método recupera un objeto de almacenamiento de pedido por marcador.

Ejemplo de respuesta

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

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