getAllStatusesByStorageMarker
Obtiene todos los estados de pedido disponibles en un almacenamiento de pedidos. 🔐 Este método requiere autorización.
Descripción
Obtiene los estados de pedido definidos en el almacén con el marcador indicado. Se resuelve en un array de objetos IOrderStatus.
.getAllStatusesByStorageMarker(
,
,
,
);
Esquema de parámetros
Esquema
marker(required): string
Marcador del almacenamiento de pedidos.
ejemplo: "order_storage_1"
langCode: string
Código de idioma. Predeterminado: el langCode pasado a defineOneEntry ("en_US" si no se pasó ninguno).
ejemplo: "en_US"
offset: number
Número de registros que se omiten. Predeterminado: 0. offset + limit no debe superar 200; una ventana mayor se rechaza con 400.
ejemplo: 0
limit: number
Número máximo de registros que se devuelven. Predeterminado: 30.
ejemplo: 30
Ejemplos
Ejemplo mínimo
const response = await Orders.getAllStatusesByStorageMarker('my_order');
Ejemplo con langCode
const response = await Orders.getAllStatusesByStorageMarker('my_order', 'en_US');
Ejemplo de respuesta
[
{
"id": 9,
"identifier": "completed-payment",
"localizeInfos": {
"title": "Completed"
},
"isDefault": false,
"isCancelFinal": false,
"isFinalSuccess": true,
"axis": "payment",
"position": 1,
"isUsed": false,
"isMapped": true
},
{
"id": 7,
"identifier": "inProgress-payment",
"localizeInfos": {
"title": "In progress"
},
"isDefault": true,
"isCancelFinal": false,
"isFinalSuccess": false,
"axis": "payment",
"position": 2,
"isUsed": true,
"isMapped": true
},
{
"id": 11,
"identifier": "expired-payment",
"localizeInfos": {
"title": "Expired"
},
"isDefault": false,
"isCancelFinal": false,
"isFinalSuccess": false,
"axis": "payment",
"position": 3,
"isUsed": false,
"isMapped": true
}
]
Esquema de respuesta
Schema: IOrderStatus[]
id: number
ID del estado.
ejemplo: 1
localizeInfos: ILocalizeInfo
Datos localizados del estado.
identifier: string
Marcador del estado.
ejemplo: "inProgress-payment"
position: number
Posición del estado, usada para ordenar.
ejemplo: 1
isUsed: boolean
Indica si el estado está en uso.
ejemplo: true
isDefault: boolean
Indica si es el estado predeterminado.
ejemplo: true
axis: string
Eje de estados (pipeline) al que pertenece el estado.
ejemplo: "payment"
isCancelFinal: boolean
Indica si el estado es un estado final de cancelación.
ejemplo: false
isFinalSuccess: boolean
Indica si el estado es un estado final de éxito.
ejemplo: true
isMapped: boolean
Indica si el estado está asignado a su eje.
ejemplo: true