Dicionário: Compras v2 - SULTS Developers

API v2 Na v2, os estados são códigos de texto (mais legíveis que os numéricos da v1). Use Ctrl+F para achar qualquer valor.

Situação do pedido (`status`)

Valor	Significado
`OPEN`	Aberto, em andamento no fluxo de etapas
`CONCLUDED`	Concluído
`CANCELED`	Cancelado

Para listar pedidos cancelados, use o filtro canceled=true da listagem de pedidos: o filtro status aceita OPEN e CONCLUDED. Cada pedido traz também o campo booleano canceled.

Situação de venda do preço (`status`)

Valor	Significado
`ENABLED_SALE`	Habilitado para venda
`DISABLED_SALE`	Desabilitado para venda

Escopo do estoque (`inventoryScope`)

Valor	O estoque é controlado por
`ON_PRODUCT`	Produto
`ON_VARIANT`	Variante do produto
`ON_PRODUCT_ASSORTMENT`	Mix
`ON_PRODUCT_ASSORTMENT_VARIANT`	Mix e variante

Etapas do pedido

As etapas não são um conjunto fixo: cada operação configura o próprio fluxo na plataforma. Consulte as suas com o endpoint de listagem de etapas, que retorna código, nome, cor e posição de cada uma.

Próximos passos

Referência da API

Os 22 endpoints de Compras, com playground.

Listar pedidos

Os filtros e o retorno do endpoint, com playground.