API atual/Referência completa/Ferramentas do catálogo do seller

Campos do importador

Lista os campos que o importador e o exportador de planilhas entendem para um tipo de registro, para montar o mapeamento de colunas.

Antes de importar uma planilha de produtos, a tela precisa saber quais colunas existem e quais são obrigatórias. Esta rota devolve essa lista, agrupada, em português e inglês. É uma lista fixa da plataforma, igual para todas as lojas, sem dado de cliente.

GET/api/v1/vendor/import-export/fields/{entity}Seller

Campos aceitos pelo importador

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário do painel do seller (lojista), obtido no login (veja Tokens).

Parâmetros de caminho

entitystringobrigatório

productscategoriesusersordersvendorsfeaturesbrandsqty_discounts

Tipo de registro.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/import-export/fields/$products" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Campos (trecho)

json

{
  "entity": "products",
  "groups": [
    {
      "key": "basic",
      "label": "Basic Information",
      "label_pt": "Informacoes Basicas",
      "fields": [
        {
          "key": "name",
          "label": "Product Name",
          "label_pt": "Nome do Produto",
          "group": "basic",
          "required": false,
          "db_column": "name",
          "field_type": "string"
        }
      ]
    }
  ],
  "fields": [
    {
      "key": "name",
      "label": "Product Name",
      "label_pt": "Nome do Produto",
      "group": "basic",
      "required": false,
      "db_column": "name",
      "field_type": "string"
    },
    {
      "key": "price",
      "label": "Price",
      "label_pt": "Preco",
      "group": "pricing",
      "required": true,
      "db_column": "price",
      "field_type": "money"
    }
  ],
  "entity_types": [
    "products",
    "categories",
    "users",
    "orders",
    "vendors",
    "features",
    "brands",
    "qty_discounts"
  ]
}

Campos da resposta

entitystring

O tipo pedido, repetido como veio.

entity_typesarray

Todos os tipos conhecidos.

groupsarray

Os campos agrupados para a tela: key, label, label_pt e fields.

fieldsarray

Lista plana dos campos.

fields[].keystring

Nome do campo na planilha e na importação.

fields[].labelstring

Rótulo em inglês.

fields[].label_ptstring

Rótulo em português.

fields[].groupstring

Grupo (para produtos: basic, pricing, inventory, shipping, content, seo, relationships, images, features, variations, timestamps).

fields[].requiredboolean

Se a coluna é obrigatória.

fields[].db_columnstring

Nome interno da coluna, para quem monta o mapeamento.

fields[].field_typestring

Tipo do valor: string, int, float, money, bool ou date. money é preço em reais com vírgula ou ponto na planilha.

fields[].default_valuestring

Valor assumido quando a coluna não vem. Ausente se não houver.

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` / `{"error":"invalid or expired token"}`
403	O token não é de um usuário seller (por exemplo, é de um administrador da loja).	`{"error":"insufficient permissions"}`
403	O cadastro do seller ainda está em análise (só a tela de cadastro funciona até a aprovação).	`{"error":"vendor_pending_review","message":"..."}`
403	O usuário tem papel de seller, mas não está ligado a nenhum seller.	`{"error":"no vendor account associated with this user"}`
403	O usuário da equipe do seller não tem nenhum dos privilégios exigidos: `vendor_import_products`, `vendor_manage_products`, `vendor_catalog`.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_import_products","vendor_manage_products","vendor_catalog"]}`