Pular para o conteúdo principal

getAllStatusesByStorageMarker

Obtenha todos os status de pedido disponíveis em um armazenamento de pedidos. 🔐 Este método requer autorização.

Descrição​

Busca os status de pedido definidos no armazenamento com o marcador informado. Resolve para um array de objetos IOrderStatus.

.getAllStatusesByStorageMarker(

, , ,

);

Esquema de parâmetros​

Esquema

marker(required): string
Marcador do armazenamento de pedidos.
exemplo: "order_storage_1"

langCode: string
Código do idioma. Padrão: o langCode passado para defineOneEntry ("en_US" se nenhum for passado).
exemplo: "en_US"

offset: number
Número de registros a pular. Padrão: 0. offset + limit não pode ultrapassar 200; uma janela maior é rejeitada com 400.
exemplo: 0

limit: number
Número máximo de registros a retornar. Padrão: 30.
exemplo: 30

Exemplos​

Exemplo mínimo​

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

Exemplo com langCode​

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

Exemplo de resposta​

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

Schema: IOrderStatus[]

id: number
ID do status.
exemplo: 1

localizeInfos: ILocalizeInfo
Dados localizados do status.

identifier: string
Marcador do status.
exemplo: "inProgress-payment"

position: number
Posição do status, usada para ordenação.
exemplo: 1

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

isDefault: boolean
Se este é o status padrão.
exemplo: true

axis: string
Eixo de status (pipeline) ao qual o status pertence.
exemplo: "payment"

isCancelFinal: boolean
Se o status é um status final de cancelamento.
exemplo: false

isFinalSuccess: boolean
Se o status é um status final de sucesso.
exemplo: true

isMapped: boolean
Se o status está mapeado ao seu eixo.
exemplo: true