Exportações

Aqui estão as informações sobre exportações de dados do PIM.

Dicionário de exportações

Field	Type	Description	optional	Searchable
file_name	string	Nome do arquivo.	not required	true
file_key	string	Chave do arquivo.	required	false
report_type	enum	Tipo do relatório. existem 3 tipos de relatórios: GENERAL = 'general' ELIGIBILITY_SERVICES = 'eligibility_services' PER_ATTRIBUTES = 'per_attributes'	not required	false
file_type	enum	Tipo do arquivo. existem 2 tipos de arquivos: CSV = 'csv', XLSX = 'xlsx'	required	false
created_by_name	string	Nome do usuário que criou o export.	required	false
status	enum	Status do export. existem 4 tipos de status: PENDING = 'pending', INPROGRESS = 'in_progress', FAILED = 'failed', COMPLETED = 'completed'	required	false
filters +	object	Filtros do export.	not required	false
headers	array	Cabeçalhos do export. requer três keys: label: string - required value: string - not required isAttribute: boolean - required	not required	false
products	array(ObjectId)	Produtos do export.	not required	false
downloaded_by	array(ObjectId)	Usuário que baixou o export.	not required	false

Exemplo em JSON

{
  "file_name": "relatorio_exportacao.csv",
  "file_key": "export_2025_01",
  "report_type": "SALES", 
  "file_type": "CSV",
  "created_by_name": "Mateus Martins",
  "status": "IN_PROGRESS",
  "filters": {
    "enabled": true,
    "_id_in": "64f1b3d4e5d987654321cdef",
    "_search": "promoção",
    "attr_control": [
      {
        "attribute_item": {
          "id": "64f1b3d4e5d987654321aaaa"
        },
        "attributes": {
          "key": "color",
          "name": "Cor"
        }
      }
    ],
    "brands": [
      "64f1b3d4e5d987654321bbbb",
      "64f1b3d4e5d987654321bbbc"
    ],
    "catalog": "64f1b3d4e5d987654321cccc",
    "categories": [
      "64f1b3d4e5d987654321dddd",
      "64f1b3d4e5d987654321ddde"
    ],
    "families": [
      "64f1b3d4e5d987654321eeee"
    ],
    "category_trees": [
      "64f1b3d4e5d987654321ffff"
    ],
    "custom_period": ["2025-01-01", "2025-01-31"],
    "workflow_approval": "64f1b3d4e5d987654321aaaa",
    "workflow_approval_status": "APPROVED",
    "fulfilled": false
  },
  "headers": [
    {
      "label": "Produto",
      "value": "product_name",
      "isAttribute": false
    },
    {
      "label": "Preço",
      "value": "price",
      "isAttribute": true
    }
  ],
  "metadata": {
    "total_products": 100,
    "total_field_failed": 2,
    "total_item_failed": 1
  }
}