getAllStatusesByStorageMarker

Obtendo todos os status de pedidos disponíveis para um armazenamento de pedidos específico pelo seu marcador.

Descrição

Este método recupera todos os objetos de status de pedidos associados a um armazenamento de pedidos específico, identificado pelo seu marcador textual. Ele retorna uma Promise que resolve para um array de objetos IOrderStatusEntity.

Pedidos.getAllStatusesByStorageMarker(

marker*, langCode, offset, limit

);

Esquema de parâmetros

Esquema

marker(obrigatório): string
Identificador textual do objeto de armazenamento de pedidos
exemplo: "order_storage_1"

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

offset: number
Parâmetro de deslocamento. Padrão: 0
exemplo: 0

limit: number
Parâmetro de limite. Padrão: 30
exemplo: 30

Exemplos

Exemplo mínimo

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

Exemplo com atributos

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

Exemplo de resposta

[
  {
    "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 resposta

Esquema: IOrderStatusEntity[]

id: number
Identificador do status.
exemplo: 1

localizeInfos: object
Informações localizadas para o status.

identifier: string
Identificador textual do status.
exemplo: "inProgress"

position: Record<string, unknown>
Posição do status.

isUsed: boolean
Se o status está em uso.
exemplo: true

---