Exports

Build and manage exports from the PIM system

Create an export

get

#Available from v.3.10.12

Authorizations
AuthorizationstringRequired
Path parameters
entityTypeinteger · enumRequired

Enum representing each supported entity type in enrichment insights engine

  • 10 = Category: Category reference
  • 20 = Product: Product reference
  • 30 = Variant: Variant reference
  • 50 = VariantGroup: Variant group reference
Possible values:
Responses
200

OK

application/json
get
/v1/exports/fields/{entityType}
GET /v1/exports/fields/{entityType} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "Uid": "PIM.InternalId",
    "Name": "Internal id"
  },
  {
    "Uid": "Product#95821967-e799-4100-b3a3-6ec6ae07e0f0_1_NA",
    "Name": "Name (en-GB)"
  },
  {
    "Uid": "Product#95821967-e799-4100-b3a3-6ec6ae07e0f0_2_NA",
    "Name": "Name (da-DK)"
  }
]

Create an export

post

#Available from v.3.10.12

Authorizations
AuthorizationstringRequired
Body

Model defining export to build

EntityTypeinteger · enumOptional

Enum representing each supported entity type in enrichment insights engine

  • 10 = Category: Category reference
  • 20 = Product: Product reference
  • 30 = Variant: Variant reference
  • 50 = VariantGroup: Variant group reference
Possible values:
EntityIdsinteger · int32[] | nullableOptional

The ids to export data for

Responses
200

OK

application/json
post
/v1/exports/buildexport
POST /v1/exports/buildexport HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 489

{
  "EntityType": {},
  "EntityIds": [
    1000,
    10001,
    10002
  ],
  "ExportSettings": {
    "Fields": [
      {
        "FieldUid": "PIM.InternalId",
        "ColumnName": "Id",
        "UseFixedValue": false,
        "FixedValue": ""
      },
      {
        "FieldUid": "Product#95821967-e799-4100-b3a3-6ec6ae07e0f0_1_NA",
        "ColumnName": "Name (en-GB)",
        "UseFixedValue": false,
        "FixedValue": ""
      },
      {
        "FieldUid": "Product#95821967-e799-4100-b3a3-6ec6ae07e0f0_2_NA",
        "ColumnName": "Name (da-DK)",
        "UseFixedValue": false,
        "FixedValue": ""
      }
    ],
    "TemplateInfo": null,
    "ExportSettingsType": "ExcelExportSettings"
  }
}
200

OK

{
  "FileBytes": [
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {}
  ],
  "FileName": "Product export",
  "FileExtension": "xlsx",
  "MimeType": "application/vnd.ms-excel"
}
PreviousEnrichmentInsightSetupsNextGlobalLists

Last updated