Skip to main content
GET
/
inventory
/
export
Exportar estoque para CSV
curl --request GET \
  --url https://api.example.com/inventory/export

Query Parameters

warehouseId
string
Limita a exportação ao invés de buscar a base cross-company.
stockStatus
string
Busque apenas LOW_STOCK ou similar.

Response

Retorna o conteúdo do arquivo com formato text/csv.

Query Parameters

Busca por nome ou SKU

stockStatus
enum<string>

Filtrar por status de estoque

Available options:
ALL,
IN_STOCK,
LOW_STOCK,
OUT_OF_STOCK
warehouseId
string

Filtrar por depósito

category
string

Filtrar por categoria

productType
enum<string>

Filtrar por tipo de produto

Available options:
SIMPLE,
KIT,
MANUFACTURED
sortBy
string
default:name

Ordenar por: name, stock, value, updated

sortOrder
string
default:ASC

Direção da ordenação

cursor
number
default:0

Cursor de paginação (offset)

limit
number
default:50

Limite de itens por página

Response

200

Arquivo CSV de estoque