O status da venda funciona através de duas funcionalidades da plataforma: campos extras e entidades virtuais.

Para usar corretamente os status da venda, são necessários alguns passos.

Entidade virtual

O primeiro passo é descobrir qual é a entidade virtual referente ao status:

/api/virtual-entities?slug=order-statuses

Esse request deve retornar uma array de registros. É esperado apenas um registro:

{
    "data": [
        {
            "id": 5,
            "name": "Status de venda",
            "slug": "order-statuses",
        }
   ]
}

Apesar de existir por padrão, a entidade virtual pode ser excluída. Por tanto é possível que este request retorne uma array vazia.

Neste passo, você deve armazenar o ID da entidade. No caso do exemplo, ID 5.

Recuperar status possíveis

A entidade virtual, assim como qualquer outra entidade, possui uma listagem. Essa listagem retorna todos os status possíveis da venda:

/api/virtual-entities/{ID da entidade virtual}/records

O request irá retornar uma array com os status já cadastrados:

{
    "data": [{
        "id": 1,
        "real_id": 5288,
        "tags": [],
        "nome_15_16": "Autorizada",
        "parent_id": null
    },
    {
        "id": 2,
        "real_id": 5289,
        "tags": [],
        "nome_15_16": "Cancelado",
        "parent_id": null
    }]
}

Assim como outras entidades, você pode criar, editar e excluir status.

Com a lista de status, você pode atualizar as vendas usando os IDs (utilize o id, não é para utilizar o real_id).

Lembrando que a venda está associada ao status através de um campo extra, então para identificá-lo é necessário usar o mapeamento de campo.

Dica: o nome do status também é um campo extra, você pode usar o mapeamento de campo na entidade virtual de status para recuperar o nome exato do campo de nome.

Adicionar status

Para adicionar um status, você deve usar o mesmo procedimento de outras entidades virtuais.

Basta fazer um POST para

 /api/virtual-entities/{ID da entidade virtual}/records

No caso, você deverá informar, ao menos o nome do status. Usando o mesmo exemplo anterior, o payload deveria ser algo assim:

{
    "nome_15_16": "Novo status"
}