getAllStatusesByStorageMarker

Obteniendo todos los estados de pedido disponibles para un almacenamiento de pedidos específico por su marcador.

Descripción

Este método recupera todos los objetos de estado de pedido asociados con un almacenamiento de pedidos específico, identificado por su marcador textual. Devuelve una Promesa que se resuelve en un array de objetos IOrderStatusEntity.

Orders.getAllStatusesByStorageMarker(

marker*, langCode, offset, limit

);

Esquema de parámetros

Esquema

marker(requerido): string
Identificador textual del objeto de almacenamiento de pedidos
ejemplo: "order_storage_1"

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

offset: number
Parámetro de desplazamiento. Predeterminado: 0
ejemplo: 0

limit: number
Parámetro de límite. Predeterminado: 30
ejemplo: 30

Ejemplos

Ejemplo mínimo

const response = await Orders.getAllStatusesByStorageMarker('my_order');

Ejemplo con atributos

const response = await Orders.getAllStatusesByStorageMarker('my_order', 'en_US');

Ejemplo de respuesta

[
  {
    "id": 1,
    "identifier": "inProgress",
    "localizeInfos": {
      "title": "In Progress"
    },
    "isDefault": true,
    "position": 1
  },
  {
    "id": 2,
    "identifier": "completed",
    "localizeInfos": {
      "title": "Completed"
    },
    "isDefault": false,
    "position": 2
  },
  {
    "id": 3,
    "identifier": "cancelled",
    "localizeInfos": {
      "title": "Cancelled"
    },
    "isDefault": false,
    "position": 3
  }
]

Esquema de respuesta

Esquema: IOrderStatusEntity[]

id: number
Identificador del estado.
ejemplo: 1

localizeInfos: object
Información localizada para el estado.

identifier: string
Identificador textual del estado.
ejemplo: "inProgress"

position: Record<string, unknown>
Posición del estado.

isUsed: boolean
Si el estado está en uso.
ejemplo: true

---