API atual/Referência completa/Importação avançada

Predefinições de exportação

Salva, lista, consulta e apaga seleções de campos reutilizáveis para a exportação avançada.

Se você exporta sempre as mesmas colunas (por exemplo, SKU, nome, preço e estoque para o financeiro), salve a seleção como uma predefinição e reaplique: leia a predefinição e use os fields dela na exportação avançada. A predefinição é só um cadastro; ela não gera arquivo nenhum.

Não existe rota de alteração: para mudar uma predefinição, apague e crie outra. Todas as rotas exigem manage_settings.

GET/api/v1/admin/advanced-export/presetsAdmin

Lista as predefinições de exportação

Devolve uma lista simples (array JSON, sem paginação).

Parâmetros de consulta

object_typestring

Só as predefinições deste tipo de registro (products, por exemplo).

POST/api/v1/admin/advanced-export/presetsAdmin

Cria uma predefinição de exportação

Cria e devolve o registro com 201. O nome é obrigatório; espaços nas pontas são ignorados.

Corpo da requisição (JSON)

namestringobrigatório

Nome da predefinição.

object_typestring

Tipo de registro, normalmente products.

fieldsarray

Chaves dos campos, na ordem das colunas. Veja Exportação avançada para a lista de chaves.

optionsobject

Opções extras de formato, guardadas como estão (por exemplo {"delimiter":";"}).

GET/api/v1/admin/advanced-export/presets/{id}Admin

Consulta uma predefinição de exportação

Parâmetros de caminho

iduuidobrigatório

Id da predefinição.

DELETE/api/v1/admin/advanced-export/presets/{id}Admin

Apaga uma predefinição de exportação

Remove a predefinição de forma definitiva.

Parâmetros de caminho

iduuidobrigatório

Id da predefinição.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/advanced-export/presets" \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d '{
    "name": "Preços para o financeiro",
    "object_type": "products",
    "fields": ["sku", "name", "price", "quantity"],
    "options": {"delimiter": ";"}
  }'

Resposta

201Predefinição criada

json

{
  "id": "bc924427-acc8-479f-87e8-02dad34b989f",
  "name": "Preços para o financeiro",
  "object_type": "products",
  "fields": ["sku", "name", "price", "quantity"],
  "options": { "delimiter": ";" },
  "created_by": "d4613dde-ac7a-431c-9232-50d8cd6ad5fc",
  "created_at": "2026-10-11T21:17:50.438964Z",
  "updated_at": "2026-10-11T21:17:50.438964Z"
}

200Predefinição apagada

json

{ "status": "deleted" }

Campos da resposta

iduuid

Id da predefinição.

namestring

Nome.

object_typestring

Tipo de registro.

fieldsarray

Chaves de campo, na ordem das colunas.

optionsobject

Opções guardadas.

created_byuuid

Usuário que criou.

created_atstring

Criação, RFC 3339 em UTC.

updated_atstring

Última alteração, RFC 3339 em UTC.

Erros

Status	Quando	Corpo de exemplo
400	`POST` sem `name` (ou só espaços)	`{"error":"name is required"}`
400	Corpo que não é JSON	`{"error":"invalid request body","detail":"..."}`
401	Token ausente ou expirado	`{"error":"invalid or expired token"}`
403	Falta `manage_settings`	`{"error":"insufficient privileges","required":"manage_settings"}`
404	`GET` ou `DELETE` de um id que não existe	`{"error":"export preset not found","detail":"export preset not found: <id>"}`

Veja também

Predefinições de exportação

Salva, lista, consulta e apaga seleções de campos reutilizáveis para a exportação avançada.

Não existe rota de alteração: para mudar uma predefinição, apague e crie outra. Todas as rotas exigem manage_settings.

GET/api/v1/admin/advanced-export/presetsAdmin

Lista as predefinições de exportação

Devolve uma lista simples (array JSON, sem paginação).

Parâmetros de consulta

object_typestring

Só as predefinições deste tipo de registro (products, por exemplo).

POST/api/v1/admin/advanced-export/presetsAdmin

Cria uma predefinição de exportação

Cria e devolve o registro com 201. O nome é obrigatório; espaços nas pontas são ignorados.

Corpo da requisição (JSON)

namestringobrigatório

Nome da predefinição.

object_typestring

Tipo de registro, normalmente products.

fieldsarray

Chaves dos campos, na ordem das colunas. Veja Exportação avançada para a lista de chaves.

optionsobject

Opções extras de formato, guardadas como estão (por exemplo {"delimiter":";"}).

GET/api/v1/admin/advanced-export/presets/{id}Admin

Consulta uma predefinição de exportação

Parâmetros de caminho

iduuidobrigatório

Id da predefinição.

DELETE/api/v1/admin/advanced-export/presets/{id}Admin

Apaga uma predefinição de exportação

Remove a predefinição de forma definitiva.

Parâmetros de caminho

iduuidobrigatório

Id da predefinição.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/advanced-export/presets" \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d '{
    "name": "Preços para o financeiro",
    "object_type": "products",
    "fields": ["sku", "name", "price", "quantity"],
    "options": {"delimiter": ";"}
  }'

Resposta

201Predefinição criada

json

{
  "id": "bc924427-acc8-479f-87e8-02dad34b989f",
  "name": "Preços para o financeiro",
  "object_type": "products",
  "fields": ["sku", "name", "price", "quantity"],
  "options": { "delimiter": ";" },
  "created_by": "d4613dde-ac7a-431c-9232-50d8cd6ad5fc",
  "created_at": "2026-10-11T21:17:50.438964Z",
  "updated_at": "2026-10-11T21:17:50.438964Z"
}

200Predefinição apagada

json

{ "status": "deleted" }

Campos da resposta

iduuid

Id da predefinição.

namestring

Nome.

object_typestring

Tipo de registro.

fieldsarray

Chaves de campo, na ordem das colunas.

optionsobject

Opções guardadas.

created_byuuid

Usuário que criou.

created_atstring

Criação, RFC 3339 em UTC.

updated_atstring

Última alteração, RFC 3339 em UTC.

Erros

Status	Quando	Corpo de exemplo
400	`POST` sem `name` (ou só espaços)	`{"error":"name is required"}`
400	Corpo que não é JSON	`{"error":"invalid request body","detail":"..."}`
401	Token ausente ou expirado	`{"error":"invalid or expired token"}`
403	Falta `manage_settings`	`{"error":"insufficient privileges","required":"manage_settings"}`
404	`GET` ou `DELETE` de um id que não existe	`{"error":"export preset not found","detail":"export preset not found: <id>"}`