Predefinições de importação
Salva, lista, consulta, altera e apaga mapeamentos de colunas reutilizáveis para o assistente de importação.
Quem importa todo dia a planilha do mesmo ERP ou do mesmo fornecedor não quer remapear as colunas toda vez. Uma predefinição (preset) guarda um nome, o mapeamento de colunas e as opções, e você reaplica em cada envio: leia a predefinição, use o field_mapping e as options dela na validação e na execução.
Uma predefinição não executa nada. É só um cadastro de configuração, visível para todos os administradores da loja. Todas as rotas exigem manage_catalog.
/api/v1/admin/advanced-import/presetsAdminLista as predefinições de importação
Devolve uma lista simples (um array JSON, sem envelope de paginação) com todas as predefinições.
Parâmetros de consulta
object_typestringproducts, por exemplo)./api/v1/admin/advanced-import/presetsAdminCria uma predefinição
Cria a predefinição e devolve o registro com 201. O nome é obrigatório; espaços nas pontas são ignorados.
Corpo da requisição (JSON)
namestringobrigatórioobject_typestringproducts.field_mappingobject{"Código":"sku","Preço":"price"}.optionsobjectoptions da validação (strategy, skip_errors, price_format...). A plataforma guarda o objeto como está, sem conferir as chaves./api/v1/admin/advanced-import/presets/{id}AdminConsulta uma predefinição
Parâmetros de caminho
iduuidobrigatório/api/v1/admin/advanced-import/presets/{id}AdminAltera uma predefinição
Substitui o conteúdo. Mande o objeto completo: um campo omitido é gravado vazio. Em particular, um PUT sem options apaga as opções ({}).
Parâmetros de caminho
iduuidobrigatórioCorpo da requisição (JSON)
namestringobrigatóriofield_mappingobjectoptionsobject/api/v1/admin/advanced-import/presets/{id}AdminApaga uma predefinição
Remove a predefinição de forma definitiva. Importações anteriores que a usaram não são afetadas.
Parâmetros de caminho
iduuidobrigatórioExemplo de requisição
Resposta
Campos da resposta
iduuidnamestringobject_typestringfield_mappingobjectoptionsobjectcreated_byuuidcreated_atstringupdated_atstringErros
| 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_catalog | {"error":"insufficient privileges","required":"manage_catalog"} |
| 404 | GET de um id que não existe ou que não é UUID | {"error":"import preset not found","detail":"import preset not found: <id>"} |
| 500 | PUT ou DELETE de um id que não existe | {"error":"update import preset failed","detail":"import preset not found: <id>"} |