Learning Center

Table schema and items / Export Items ​

This task allows to export items from a table in the XML format.

Task name:

Examples ​

json
{
  "name": "table-export-items",
  "taskReferenceName": "export_items",
  "description": "The business description of the task",
  "type": "SUB_WORKFLOW",
  "optional": false,
  "inputParameters": {
    "tableKey": "PRODUCTS",
    "mode": "USER_SELECTION",
    "maximum": 1000,
    "partitions": ["active", "archived"],
    "fileName": "items.xml"
  }
}
json
{
  "name": "table-export-items",
  "taskReferenceName": "export_items",
  "description": "The business description of the task",
  "type": "SUB_WORKFLOW",
  "optional": false,
  "inputParameters": {
    "tableKey": "PRODUCTS",
    "mode": "ALL",
    "maximum": 100,
    "partitions": ["active", "archived"],
    "fileName": "items.xml"
  }
}
json
{
  "name": "table-export-items",
  "taskReferenceName": "a",
  "description": "The business description of the task",
  "type": "SUB_WORKFLOW",
  "optional": false,
  "inputParameters": {
    "tableKey": "products",
    "mode": "REQUEST",
    "maximum": 100,
    "partitions": ["active", "archived"],
    "request": "file://assets/filter.xml",
    "fileName": "items.xml",
  }
}

Definition ​

PropertyTypeRequiredDescription
The name (or type) of the task
The unique name of the task in your job. It is used to reference this task in the workflow.
The functional description of this task in your job.
The type of the task. It must be SUB_WORKFLOW.
true: the job continues if there is an error on this task.
false: the job fails.
Input parameters of the task. See below

Inputs Parameters ​

PropertyTypeRequiredDescription
The key of the table from which items are exported.
Defines which items must be exported. You can choose between ALL | USER_SELECTION | REQUEST. ALL = all items, USER_SELECTION = items selected by the user, REQUEST = items are filtered by a request, in this case a request parameter must be added.
See below.
Defines the maximum items to be exported.
The list of partitions (key) from which items are exported. If none is set, items from all partitions are exported.
Defines name of the output file (without the file extension)
The account key of the partner owning the shared table.

WARNING

In case of multi-levels table item export, the maximum number of items exported is checked at each item declination.

  • If the total number of exported items is below the maximum set
    • Then the export continues with the next item declination
  • If the total number of exported items is higher or equals to the maximum set
    • Then the export stops
    • And the last exported item declination is ignored
    • And a warning message message is displayed to the user and in the report

ALL mode ​

This mode exports all items to all partitions of the target table.

USER_SELECTION mode ​

This mode exports all the items selected by a user when the job is launched.

Warning

This mode can only be used when the job is launched from the app.product-live.com application. A selection from the grid must be made by the user.

REQUEST mode ​

This mode allows you to export items based on a request. The request is an XML file that contains the filters to be applied when exporting items.

xml
<Items-Request>
    <Filters>
        <Filter-Field-Single-Select key="SEASON" operator="EQUALS">
            <Option>SPRING</Option>
            <Option>SUMMER</Option>>
        </Filter-Field-Single-Select>
        <Filter-Field-Single-Line-Text key="TITLE" operator="STARTS_WITH">
            <Value>DRESS</Value>
        </Filter-Field-Single-Line-Text>
        <Filter-Field-Number key="PRICE" operator="NOT_EMPTY" />
        <Filter-Classification key="TYPOLOGY" operator="EMPTY" />
    </Filters>
    <Properties>
        <Field key="PRICE" />
        <Field key="STOCK" />
    </Properties>
</Items-Request>

Input - request ​

Examples ​

xml
<Items-Request>
    <Filters>
        <Filter-Field-Single-Select key="SEASON" operator="EQUALS">
            <Option>SPRING</Option>
            <Option>SUMMER</Option>>
        </Filter-Field-Single-Select>
        <Filter-Field-Single-Line-Text key="TITLE" operator="STARTS_WITH">
            <Value>DRESS</Value>
        </Filter-Field-Single-Line-Text>
        <Filter-Field-Number key="PRICE" operator="NOT_EMPTY" />
        <Filter-Classification key="TYPOLOGY" operator="EMPTY" />
    </Filters>
    <Properties>
        <Field key="PRICE" />
        <Field key="STOCK" />
    </Properties>
</Items-Request>
xml
<!-- Filters available for created and last updated -->
<Filter-Created-At>
    <Start>2020-12-28</Start> <!-- included -->
    <End>2020-12-28</End> <!-- excluded -->
</Filter-Created-At>
<Filter-Updated-At>
    <Start>2020-12-28</Start> <!-- included -->
    <End>2020-12-28</End> <!-- excluded -->
</Filter-Updated-At>

<!-- Filters available on publications -->
<Items-Request>
    <Filters>
        <Filter-Sent sent="true" modified="true" /> <!-- If `sent` or `modified` are set: `never` and `rejected` cannot be set -->
    </Filters>
</Items-Request>
<Items-Request>
    <Filters>
        <Filter-Sent never="true" /> <!-- If `never` is set: `sent`, `modified` and `rejected` cannot be set -->
    </Filters>
</Items-Request>
<Items-Request>
    <Filters>
        <Filter-Sent rejected="true" /> <!-- If `rejected` is set: `sent`, `modified` and `never` cannot be set -->
    </Filters>
</Items-Request>

<!-- Filters available on suggestions -->
<Items-Request>
    <Filters>
        <Filter-Inbox new="true" suggestions="true" /> <!-- If `new` or `suggestions` are set, `empty` cannot be set (and vice versa) -->
            <Screen>ALL</Screen> <!-- Optional, filter on one to many suggestion screen key -->
    </Filters>
</Items-Request>
<Items-Request>
    <Filters>
        <Filter-Inbox empty="true" />
            <Screen>ALL</Screen> <!-- Optional, filter on one to many suggestion screen key -->
    </Filters>
</Items-Request>

<!-- Filters available for Identifiers -->
<Filter-Identifier key="EAN_13" operator="EQUALS">
    <Value>12345678901213</Value>
    <Value>81878628826682</Value>
</Filter-Identifier>
<Filter-Identifier key="EAN_13" operator="CONTAINS">
    <Value>123</Value>
</Filter-Identifier>
<Filter-Identifier key="EAN_13" operator="STARTS_WITH">
    <Value>123</Value>
</Filter-Identifier>
<Filter-Identifier key="EAN_13" operator="ENDS_WITH">
    <Value>456</Value>
</Filter-Identifier>
<Filter-Identifier key="EAN_13" operator="NOT_EMPTY" />
<Filter-Identifier key="EAN_13" operator="EMPTY" />

<!-- Filters available for Classifications -->
<Filter-Classification key="TYPOLOGY" operator="EQUALS"> 
    <Category>DRESS></Category> <!-- category key -->
    <Category>SHOES</Category>
</Filter-Classification>
<Filter-Classification key="TYPOLOGY" operator="NOT_EMPTY" />
<Filter-Classification key="TYPOLOGY" operator="EMPTY" />
<Filter-Classification key="typology" operator="NOT_IN" >
    <Category>MAISON</Category>
</Filter-Classification>

<!-- Filters available for Conditional Formattings -->
<Filter-Conditional-Formatting key="COMPLIANCE">
    <Status>VALID</Status> <!-- status key -->
    <Status>UNVALID</Status>
</Filter-Conditional-Formatting>

<!-- Filters available for Fields SINGLE-LINE-TEXT | LONG-TEXT | HTML-TEXT -->
<Filter-Field-Single-Line-Text key="TITLE_EN" operator="EQUALS">
    <Value>Hello</Value>
    <Value>World</Value>
</Filter-Field-Single-Line-Text>
<Filter-Field-Single-Line-Text key="TITLE_EN" operator="CONTAINS">
    <Value>Hello</Value>
</Filter-Field-Single-Line-Text>
<Filter-Field-Single-Line-Text key="TITLE_EN" operator="STARTS_WITH">
    <Value>Hello</Value>
</Filter-Field-Single-Line-Text>
<Filter-Field-Single-Line-Text key="TITLE_EN" operator="ENDS_WITH">
    <Value>Hello</Value>
</Filter-Field-Single-Line-Text>
<Filter-Field-Single-Line-Text key="TITLE_EN" operator="NOT_EMPTY" />
<Filter-Field-Single-Line-Text key="TITLE_EN" operator="EMPTY" />

<!-- Filters available for fields SING-SELECT | MULTIPLE-SELECT | MULTIPLE-SELECT-QUANTIFIED | MULTIPLE-SELECT-QUANTIFIED-WITH-COMMENTS -->
<Filter-Field-Single-Select key="season" operator="EQUALS">
    <Option>spring</Option>
    <Option>summer</Option>
</Filter-Field-Single-Select>
<Filter-Field-Single-Select key="season" operator="NOT_EQUALS">
    <Option>fall</Option>
    <Option>winter</Option>
</Filter-Field-Single-Select>
<Filter-Field-Single-Select key="season" operator="EMPTY" />
<Filter-Field-Single-Select key="season" operator="NOT_EMPTY" />

<!-- Filters available for Fields NUMBER -->
<Filter-Field-Number key="PRICE" operator="RANGE">
    <!-- At least Min or Max must be filled  -->
    <Min>1</Min> <!-- included -->
    <Max>2</Max> <!-- included -->
</Filter-Field-Number>
<Filter-Field-Number key="PRICE" operator="EMPTY" />
<Filter-Field-Number key="PRICE" operator="NOT_EMPTY" />
<Filter-Field-Number key="PRICE" use="SUFFIX_KEY" operator="IN">
    <Suffix>EURO</Suffix>
    <Suffix>DOLLAR</Suffix>
</Filter-Field-Number>
<Filter-Field-Number key="PRICE" use="SUFFIX_KEY" operator="NOT_IN">
    <Suffix>EURO</Suffix>
    <Suffix>DOLLAR</Suffix>
</Filter-Field-Number>
<Filter-Field-Number key="PRICE" use="SUFFIX_KEY" operator="EMPTY" />
<Filter-Field-Number key="PRICE" use="SUFFIX_KEY" operator="NOT_EMPTY" />

<!-- Filters available for Fields DATE | DATE-TIME -->
<Filter-Field-Date key="START_DATE" operator="RANGE">
    <!-- At least Start or End must be filled  -->
    <Start>2020-12-28</Start> <!-- included -->
    <End>2020-12-28</End> <!-- excluded -->
</Filter-Field-Date>
<Filter-Field-Date key="START_DATE" operator="EMPTY" />
<Filter-Field-Date key="START_DATE" operator="NOT_EMPTY" />

<!-- Filters available for Fields ATTACHMENT -->
<Filter-Field-Attachment key="INSTRUCTIONS" operator="EQUALS">
  <Extension>pdf</Extension>
</Filter-Field-Attachment>
<Filter-Field-Attachment key="INSTRUCTIONS" operator="EMPTY"/>
<Filter-Field-Attachment key="INSTRUCTIONS" operator="NOT_EMPTY"/>

<!-- Filters available for Fields IMAGES -->
<Filter-Field-Image key="MAIN_IMAGE">
  <Height-Min-Px>100</Height-Min-Px>
  <Height-Max-Px>500</Height-Max-Px>
  <Width-Min-Px>100</Width-Min-Px>
  <Width-Max-Px>500</Width-Max-Px>
  <Extension>jpg</Extension>
  <Color-Space>RGB</Color-Space>
  <Color-Profile>NONE</Color-Profile>
</Filter-Field-Image>

<!-- Filters on sent suggestions, only on shared table items -->
<Filter-Sent sent="true" />
<Filter-Sent modified="true" />
<Filter-Sent never="true" />
<Filter-Sent rejected="true" />

<!-- Filters on comments -->
<Filter-Comment operator="EMPTY"/>
<Filter-Comment operator="NOT_EMPTY"/>
<Filter-Comment-Status>
    <Status>open</Status>
</Filter-Comment-Status>
<Filter-Comment-Status>
    <Status>closed</Status>
</Filter-Comment-Status>
<Filter-Comment-Assignee>
    <Assigned-to-my-account>false</Assigned-to-my-account>
</Filter-Comment-Assignee>
<Filter-Comment-Assignee>
    <Assigned-to-my-account>true</Assigned-to-my-account>
</Filter-Comment-Assignee>

File definition ​

XPathDescriptionOccurs
Items-RequestThe root element.1
Items-Request/FiltersThe filters to be applied.1
../Filter-Created-AtSee below0..1
../Filter-Updated-AtSee below0..1
../Filter-IdentifierSee below0..25
../Filter-ClassificationSee below0..*
../Filter-Conditional-FormattingSee below0..*
../Filter-Field-Long-TextSee below0..*
../Filter-Field-Html-TextSee below0..*
../Filter-Field-NumberSee below0..*
../Filter-Field-Single-SelectSee below0..*
../Filter-Field-Multiple-SelectSee below0..*
../Filter-Field-Multiple-Select-QuantifiedSee below0..*
../Filter-Field-Multiple-Select-Quantified-With-CommentsSee below0..*
../Filter-Field-DateSee below0..*
../Filter-Field-Date-TimeSee below0..*
../Filter-Field-AttachmentSee below0..*
../Filter-Field-ImageSee below0..*
../Filter-SentSee below0..*
../Filter-InboxSee below0..*
../Filter-CommentSee below0..*
../Filter-Comment-statusSee below0..*
../Filter-Comment-AssigneeSee below0..*
Items-Request/PropertiesThe properties to be exported. See below1
../FieldThe field to be exported.1..*
  • The proposed filter criteria are linked - as in the app.product-live.com application - by the AND operaor.
  • The Field tags within the Properties tag are used to select the fields made available in the generated XML file. Identifiers and classifications are always exported.
Selecting exported properties ​

WARNING

Item identifiers and classifications are always exported.

  • If the Properties element is not specified, all the properties of an item are exported.
    • If the Properties element is present, only the properties of the item mentioned in it are exported.
    • If the Properties element is empty, only the item identifiers and classifications are exported.

Creation and update date filters ​

xml
<Filter-Created-At>
    <Start>2020-12-28T00:00:00Z</Start>
    <End>2020-12-29T00:00:00Z</End>  
</Filter-Created-At>
<Filter-Updated-At>
    <Start>2020-12-28</Start>
    <End>2020-12-29</End>
</Filter-Updated-At>
  • The format of the <Start> and <End> fields follows the ISO 8601standard
  • The date is mandatory
  • Time (hour, minutes, seconds) is optional
  • If the proposed date is invalid, the item export is not executed and ends in error.
Regarding the start date ​

The start boundary is included.

  • Example 1:

    • <Start>2020-12-28T00:00:00Z</Start>
    • Includes items created/updated at 2020-12-28 00:00:00.

  • Example 2: - <Start>2020-12-28</Start>

    • Includes items created/updated to 2020-12-28 00:00:00.
Regarding the end date ​

The provided end date is excluded.

  • Example 1:

    • <End>2020-12-29T00:00:00Z</End>
    • Excludes items created/updated to 2020-12-29 00:00:00, only items created/updated up to 2020-12-28 23:59:59 are included.

  • Example 2:

    • <End>2020-12-29</End>
    • Excludes items created/updated to 2020-12-29 00:00:00, only items created/updated to 2020-12-28 23:59:59 are included.
Behaviour when the time is not given ​

In this case, the time used implicitly will be: 00:00:00.

  • Examples:
    • <Start>2020-12-28</Start> = <Start>2020-12-28T00:00:00Z</Start>
    • <End>2020-12-29</End> = <End>2020-12-29T00:00:00Z</End>
Examples ​

To filter over a full day, you can filter in the following ways:

xml
<Filter-Created-At>
    <Start>2020-12-28</Start>
    <End>2020-12-29</End>
</Filter-Created-At>

or

xml
<Filter-Created-At>
    <Start>2020-12-28T00:00:00Z</Start>
    <End>2020-12-29T00:00:00Z</End>
</Filter-Created-At>
Specificity of the filter on creation and update dates in the case of a multi-level table ​

In the case of a multi-level table, the Filter-Created-At and Filter-Updated-At filters are applied to each item in the table. Once these items have been filtered, all their parents and children are also exported, even if they don't match the date filter.

In the example below, the filter applied is as follows:

xml
<Filter-Created-At>
    <Start>2022-01-03T00:00:00Z</Start>
</Filter-Created-At>
  • In the diagram above, the items are represented in the following way:
    • In green: the items that match the Filter-Created-At filter.
    • In blue: the parent and child items of the matching items also exported.
    • In grey, the items that are not exported
  • The items A-YELLOW, B-RED, B-RED-S and B-YELLOW-M match the Filter-Created-At filter.
  • The parent and child items of these items are also exported, even though they don't match the creation date criterion in question.

Important

A similar filter from the app.product-live.com application on a Model Color level screen (see example above) would only bring up two items: A-YELLOW and B-RED, both associated with the Model Color level.

Identifiers filters ​

xml
<Filter-Identifier key="ean" operator="EQUALS">
    <Value>12345678901213</Value>
    <Value>81878628826682</Value>
</Filter-Identifier>
<Filter-Identifier key="ean" operator="CONTAINS">
    <Value>123</Value>
</Filter-Identifier>
<Filter-Identifier key="ean" operator="STARTS_WITH">
    <Value>123</Value>
</Filter-Identifier>
<Filter-Identifier key="ean" operator="ENDS_WITH">
    <Value>456</Value>
</Filter-Identifier>
<Filter-Identifier key="ean" operator="NOT_EMPTY" />
<Filter-Identifier key="ean" operator="EMPTY" />
  • Only one filter criteria may be specified per identifier.
  • Up to 25 different identifiers can be specified (5 identifiers per level)
  • Available operators are:
    • EQUALS - As in the interface, items are selected whose value for the given identifier matches one of the values provided.
    • CONTAINS - Only one value allowed
    • STARTS_WITH - Only one value allowed
    • ENDS_WITH - Only one value allowed
    • NOT_EMPTY
    • EMPTY

Classifications filters ​

xml
<Filter-Classification key="typology" operator="EQUALS"> 
    <Category>dress></Category>
    <Category>shoes</Category>
</Filter-Classification>
<Filter-Classification key="typology" operator="NOT_EMPTY" />
<Filter-Classification key="typology" operator="EMPTY" />
<Filter-Classification key="typology" operator="NOT_IN" >
    <Category>HOME</Category>
</Filter-Classification>
  • Only one filter criteria can be specified per classification
  • Available operators are:
    • EQUALS - Only one value allowed
    • NOT_EMPTY
    • EMPTY
    • NOT_IN

Conditional formatting filters ​

xml
<Filter-Conditional-Formatting key="compliance">
    <Status>valid</Status> <!-- status key -->
    <Status>unvalid</Status>
</Filter-Conditional-Formatting>
  • Only one filter criteria can be specified per conditional formatting field.
  • The only operator available is EQUALS.

SINGLE-LINE-TEXT, LONG-TEXT and HTML-TEXT fields filters ​

xml
<Filter-Field-Single-Line-Text key="title" operator="EQUALS">
    <Value>12345678901213</Value>
    <Value>81878628826682</Value>
</Filter-Field-Single-Line-Text>
<Filter-Field-Single-Line-Text key="title" operator="CONTAINS">
    <Value>123</Value>
</Filter-Field-Single-Line-Text>
<Filter-Field-Single-Line-Text key="title" operator="STARTS_WITH">
    <Value>123</Value>
</Filter-Field-Single-Line-Text>
<Filter-Field-Single-Line-Text key="title" operator="ENDS_WITH">
    <Value>456</Value>
</Filter-Field-Single-Line-Text>
<Filter-Field-Single-Line-Text key="title" operator="NOT_EMPTY" />
<Filter-Field-Single-Line-Text key="title" operator="EMPTY" />

TIP

For LONG-TEXT and HTML-TEXT fields, the filter <Filter-Field-Single-Line-Text key="..." operator="..." /> must also be used.

  • Only one filter criteria can be specified per field.
  • Available operators are:
    • EQUALS - As in the interface, items are selected whose value for the given field matches one of the values provided.
    • CONTAINS - Only one value allowed
    • STARTS_WITH - Only one value allowed
    • ENDS_WITH - Only one value allowed
    • NOT_EMPTY
    • EMPTY

SINGLE-SELECT fields filters ​

xml
<Filter-Field-Single-Select key="season" operator="EQUALS">
    <Option>spring</Option>
    <Option>summer</Option>
</Filter-Field-Single-Select>
<Filter-Field-Single-Select key="season" operator="NOT_IN">
    <Option>fall</Option>
    <Option>winter</Option>
</Filter-Field-Single-Select>
<Filter-Field-Single-Select key="season" operator="EMPTY" />
<Filter-Field-Single-Select key="season" operator="NOT_EMPTY" />
OperatorDescription
EQUALSAllows filtering of items to be exported that have one of the values provided in <Option> for the specified key
Items without a value for the specified key are not filtered and are not exported
NOT_INAllows filtering of items to be exported which have none of the values provided in <Option> for the specified key
Items with no value for the specified key are also filtered and exported
EMPTYAllows you to filter out items to be exported that have no value for the specified key.
NOT_EMPTYAllows you to filter the items to be exported that have at least one value for the specified key.

For the EQUALS and NOT_IN operators, at least one non-empty <Option> is required.

  • If no <Option> is provided, then the filter is not applied, and the following error is returned to the user: Filter-Field-Single-Select MULTIPLE-SELECT no Option received.
  • If an <Option> has no value, then the filter is not applied, and the following error is returned to the user: Filter-Field-Single-Select SINGLE-SELECT no content for Option.
  • If an <Option> has a value corresponding to no existing option key for the field, then the filter is applied.
    • For the EQUALS operator, no items will be exported.
    • For the NOT_IN operator, all items will be exported.
  • If an <Option> has a value corresponding to an archived option, then the filter is archived anyway.
Details
#Value : [a]Value : [b]Value : [a,b]Value : []
filtrer EQUALS [a]1010
filter EQUALS [b]0110
filter EQUALS [a,b]1110
filter EQUALS []0000
#Value : [a]Value : [b]Value : [a,b]Value : []
filter NOT IN [a]0101
filter NOT IN [b]1001
filter NOT IN [a,b]0001
filter NOT IN []1111

MULTIPLE-SELECT fields filters ​

xml
<Filter-Field-Multiple-Select key="season" operator="EQUALS">
    <Option>spring</Option>
    <Option>summer</Option>
</Filter-Field-Multiple-Select>
<Filter-Field-Multiple-Select key="season" operator="NOT_EQUALS">
    <Option>fall</Option>
    <Option>winter</Option>
</Filter-Field-Multiple-Select>
<Filter-Field-Multiple-Select key="season" operator="EMPTY" />
<Filter-Field-Multiple-Select key="season" operator="NOT_EMPTY" />
OperatorDescription
EQUALSAllows filtering of items to be exported that have one of the values provided in <Option> for the specified key
Items without a value for the specified key are not filtered and are not exported
NOT_INAllows filtering of items to be exported which have none of the values provided in <Option> for the specified key
Items with no value for the specified key are also filtered and exported
EMPTYAllows you to filter out items to be exported that have no value for the specified key.
NOT_EMPTYAllows you to filter the items to be exported that have at least one value for the specified key.

For the EQUALS and NOT_IN operators, at least one non-empty <Option> is required.

  • If no <Option> is provided, then the filter is not applied, and the following error is returned to the user: Filter-Field-Single-Select MULTIPLE-SELECT no Option received.
  • If an <Option> has no value, then the filter is not applied, and the following error is returned to the user: Filter-Field-Single-Select SINGLE-SELECT no content for Option.
  • If an <Option> has a value corresponding to no existing option key for the field, then the filter is applied.
    • For the EQUALS operator, no items will be exported.
    • For the NOT_IN operator, all items will be exported.
Details
#Value : [a]Value : [b]Value : [a,b]Value : []
filtrer EQUALS [a]1010
filter EQUALS [b]0110
filter EQUALS [a,b]1110
filter EQUALS []0000
#Value : [a]Value : [b]Value : [a,b]Value : []
filter NOT IN [a]0101
filter NOT IN [b]1001
filter NOT IN [a,b]0001
filter NOT IN []1111

MULTIPLE-SELECT-QUANTIFIED fields filters ​

xml
<Filter-Field-Multiple-Select-Quantified key="season" operator="EQUALS">
    <Option>spring</Option>
    <Option>summer</Option>
</Filter-Field-Multiple-Select-Quantified>
<Filter-Field-Multiple-Select-Quantified key="season" operator="NOT_EQUALS">
    <Option>fall</Option>
    <Option>winter</Option>
</Filter-Field-Multiple-Select-Quantified>
<Filter-Field-Multiple-Select-Quantified key="season" operator="EMPTY" />
<Filter-Field-Multiple-Select-Quantified key="season" operator="NOT_EMPTY" />
OperatorDescription
EQUALSAllows filtering of items to be exported that have one of the values provided in <Option> for the specified key
Items without a value for the specified key are not filtered and are not exported
Only option values are selectable. Quantities** cannot be used to filter items.
NOT_INAllows filtering of items to be exported which have none of the values provided in <Option> for the specified key
Items with no value for the specified key are also filtered and exported
Only option values are selectable. Quantities** cannot be used to filter items.
EMPTYAllows you to filter out items to be exported that have no value for the specified key.
NOT_EMPTYAllows you to filter the items to be exported that have at least one value for the specified key.

For EQUALS and NOT_IN operators, at least one non-empty <Option> is required.

  • If no <Option> is provided, then the filter is not applied, and the following error is returned to the user: Filter-Field-Single-Select MULTIPLE-SELECT no Option received.
  • If an <Option> has no value, then the filter is not applied, and the following error is returned to the user: Filter-Field-Single-Select SINGLE-SELECT no content for Option.
  • If an <Option> has a value corresponding to no existing option key for the field, then the filter is applied.
    • For the EQUALS operator, no items will be exported.
    • For the NOT_IN operator, all items will be exported.
Details
#Value : [a]Value : [b]Value : [a,b]Value : []
filtrer EQUALS [a]1010
filter EQUALS [b]0110
filter EQUALS [a,b]1110
filter EQUALS []0000
#Value : [a]Value : [b]Value : [a,b]Value : []
filter NOT IN [a]0101
filter NOT IN [b]1001
filter NOT IN [a,b]0001
filter NOT IN []1111

MULTIPLE-SELECT-QUANTIFIED-WITH-COMMENTS fields filters ​

xml
<Filter-Field-Multiple-Select-Quantified-With-Comments key="season" operator="EQUALS">
    <Option>spring</Option>
    <Option>summer</Option>
</Filter-Field-Multiple-Select-Quantified-With-Comments>
<Filter-Field-Multiple-Select-Quantified key="season" operator="NOT_EQUALS">
    <Option>fall</Option>
    <Option>winter</Option>
</Filter-Field-Multiple-Select-Quantified-With-Comments>
<Filter-Field-Multiple-Select-Quantified-With-Comments key="season" operator="EMPTY" />
<Filter-Field-Multiple-Select-Quantified-With-Comments key="season" operator="NOT_EMPTY" />
OperatorDescription
EQUALSPractical examplesAllows you to filter the items to be exported which have one of the values provided in <Option> for the specified key
Items without a value for the specified key are not filtered and are not exported
Only option values can be selected. Quantities** and comments** cannot be used to filter items.
NOT_INUsed to filter items for export which have none of the values provided in <Option> for the specified key
Items with no value for the specified key are also filtered and exported
Only option values are selectable. Quantities** and comments** cannot be used to filter items.
EMPTYAllows you to filter the items to be exported which have no value for the specified key.
NOT_EMPTYAllows you to filter the items to be exported that have at least one value for the specified key.

For the EQUALS and NOT_IN operators, at least one non-empty <Option> is required.

  • If no <Option> is provided, then the filter is not applied, and the following error is returned to the user: Filter-Field-Single-Select MULTIPLE-SELECT no Option received.
  • If an ``Option‘’ has no value, then the filter is not applied, and the following error is returned to the user: Filter-Field-Single-Select SINGLE-SELECT no content for Option.
  • If an <Option> has a value which does not match any existing option key for the field, then the filter is applied.
    • For the EQUALS operator, no items will be exported.
    • For the NOT_IN operator, all items will be exported.
Details
#Value : [a]Value : [b]Value : [a,b]Value : []
filtrer EQUALS [a]1010
filter EQUALS [b]0110
filter EQUALS [a,b]1110
filter EQUALS []0000
#Value : [a]Value : [b]Value : [a,b]Value : []
filter NOT IN [a]0101
filter NOT IN [b]1001
filter NOT IN [a,b]0001
filter NOT IN []1111

NUMBER fields filters ​

xml
<Filter-Field-Number key="number" operator="RANGE">
    <Min>1</Min>
    <Max>2</Max>
</Filter-Field-Number>
<Filter-Field-Number key="number" operator="EMPTY" />
<Filter-Field-Number key="number" operator="NOT_EMPTY" />
  • Only on criteria on the field numerical value can be used within a same request
  • Available operators are:
    • RANGE - Min and Max ranges are included
    • NOT_EMPTY
    • EMPTY
Filter on Suffix of NUMBER type fields ​
xml
<Filter-Field-Number key="number" use="SUFFIX_KEY" operator="IN">
    <Suffix>cm</Suffix>
    <Suffix>m</Suffix>
</Filter-Field-Number>
<Filter-Field-Number key="number" use="SUFFIX_KEY" operator="NOT_IN">
    <Suffix>g</Suffix>
    <Suffix>kg</Suffix>
</Filter-Field-Number>
<Filter-Field-Number key="number" use="SUFFIX_KEY" operator="EMPTY" />
<Filter-Field-Number key="number" use="SUFFIX_KEY" operator="NOT_EMPTY" />

To filter on Suffix, the use of the attribute use is required with the value SUFFIX_KEY, while the key property is still the field key.

Archived suffixes are taken into account when filtering. However they are not exported. That behavior is made to comply with how users can filter in the interface.

Archived Suffix are displayed and when they filter on them they can see the items with the archived Suffix.

Details
#suffix : [a]suffix : [b]suffix : []suffix : [c] (archived)
filter IN [a]1000
filter IN [a,b]1100
filter IN [b]0100
filter IN [c]0001*
filter IN []0000
filter NOT IN [a]0111*
filter NOT IN [a,b]0011*
filter NOT IN [b]1011*
filter NOT IN [c]1110
filter NOT IN []1111*
filter EMPTY0010
filter NOT_EMPTY1101*

DATE and DATE-TIME fields filters ​

xml
<Filter-Field-Date key="date" operator="RANGE">
    <Start>2020-12-28</Start>
    <End>2020-12-28</End>
</Filter-Field-Date>
<Filter-Field-Date key="date" operator="EMPTY" />
<Filter-Field-Date key="date" operator="NOT_EMPTY" />
<Filter-Field-Date-Time key="date-time" operator="NOT_EMPTY" />
  • Only one filter criterion can be specified per field.
  • The behavior of the filter on the DATE and DATE-TIME fields follows the same rules as the filter on the creation and update dates.
  • Available operators are:
    • RANGE
    • NOT_EMPTY
    • EMPTY
  • In the case of DATE-TIME fields, time (hour, minutes, seconds) is optional.
  • The format of <Start> and <End> fields follows the ISO 8601 standard
  • If the proposed date is invalid, a log is added to the execution report, and the task leaves in error.

ATTACHMENT fields filters ​

xml
<Filter-Field-Attachment key="attachment" operator="EQUALS">
  <Extension>pdf</Extension>
</Filter-Field-Attachment>
  • Only one filter criteria can be specified per field**.
  • The Extension element is used to filter attachments by extension.
    • In this case, the operator must be EQUALS.
    • One value allowed.**
  • Available operators are:
    • EQUALS
    • NOT_EMPTY
    • EMPTY

IMAGE fields filters ​

xml
<Filter-Field-Image key="image" operator="EQUALS">
  <Height-Min-Px>100</Height-Min-Px>
  <Height-Max-Px>500</Height-Max-Px>
  <Width-Min-Px>100</Width-Min-Px>
  <Width-Max-Px>500</Width-Max-Px>
  <Extension>jpg</Extension>
  <Color-Space>RGB</Color-Space>
  <Color-Profile>NONE</Color-Profile>
</Filter-Field-Image>
  • Only one filter criterion can be specified per field**.
  • Available operators are:
    • EQUALS
      • In this case, the following criteria are available, each of which can be mentioned only once, with the selected items fulfilling all of these criteria
        • Height-Min-Px selects images whose height is higher than or equal to the given value
        • Height-Max-Px selects images whose height is less than or equal to the given value
        • Width-Min-Px selects images whose width is less than or equal to the given value
        • Width-Max-Px` selects images whose width is less than or equal to the given value
        • Extension selects images whose value is strictly equal to the given value
        • Color-Space` selects images whose value is strictly equal to the given value
        • Color-Profile selects images whose value is strictly equal to the given value
    • NOT_EMPTY
    • EMPTY

sent, modified, rejected and never properties filters ​

To use on shared tables to filter items depending on the existence of a rejected or successfully sent suggestion and if the item has been modified since the last suggestion.

  • If sent or modified are set: never and rejected cannot be set
  • If never is set: sent, modified and rejected cannot be set
  • If rejected is set: sent, modified and never cannot be set
xml
<Items-Request>
    <Filters>
        <Filter-Sent sent="true" modified="true" />
    </Filters>
</Items-Request>
<Items-Request>
    <Filters>
        <Filter-Sent never="true" />
    </Filters>
</Items-Request>
<Items-Request>
    <Filters>
        <Filter-Sent rejected="true" />
    </Filters>
</Items-Request>

new and suggestions properties filters ​

  • If new or suggestions are set, empty cannot be set (and vice versa).
xml
<!-- Filter items having suggestions either `new` or `suggestion` whatever the suggestion screen -->
<Items-Request>
    <Filters>
        <Filter-Inbox new="true" suggestions="true" />
    </Filters>
</Items-Request>
<!-- Filter items having suggestions either `new` or `suggestion` on specific screens (identified by screen key) -->
<Items-Request>
    <Filters>
        <Filter-Inbox new="true" suggestions="true" />
            <Screen>ALL</Screen>
            <Screen>MEDIA</Screen>
            <Screen>SUPPLIER</Screen>
    </Filters>
</Items-Request>
<!-- Filter items having no suggestions whatever the suggestion screen -->
<Items-Request>
    <Filters>
        <Filter-Inbox empty="true" />
    </Filters>
</Items-Request>
<!-- Filter items having no suggestions on a specific screen (identified by screen key) -->
<Items-Request>
    <Filters>
        <Filter-Inbox empty="true" />
            <Screen>ALL</Screen>
            <Screen>MEDIA</Screen>
            <Screen>SUPPLIER</Screen>
    </Filters>
</Items-Request>

Comments filters ​

The behavior of filters on comments in Data Factory is identical to the behavior of the app.product-live.com application.

This filter allow to:

  • filter items according to the existence of thread comments on item suggestions.
  • filter items according to the status of comment threads on the item's suggestions. If there is an open/closed comment thread on an item suggestion, this item will be brought up in the results.
  • filter items according to the assigned comment threads on the item's suggestions. If there is a comment thread assigned to the account or to a partner on an item suggestion, this item will be brought up in the results.
xml
<Items-Request>
    <Filters>
        <Filter-Comment operator="EMPTY"/>
        <Filter-Comment operator="NOT_EMPTY"/>

        <Filter-Comment-Status>
            <Status>open</Status>
        </Filter-Comment-Status>
        <Filter-Comment-Status>
            <Status>closed</Status>
        </Filter-Comment-Status>

        <Filter-Comment-Assigned>
            <Assigned-to-my-account>false</Assigned-to-my-account>
        </Filter-Comment-Assignee>
        <Filter-Comment-Assignee>
            <Assigned-to-my-account>true</Assigned-to-my-account>
        </Filter-Comment-Assignee>
    </Filters>
</Items-Request>

Outputs ​

PropertyTypeDescription
Items in the XML format described below.
YES: at least one item has been found. NO: no items have been found.
An XML file containing information regarding the generated file.

Output - file ​

This file contains the items exported in XML format.

Reminder

By default, only values associated with items (identifier/classification/field) that are not archived are exported.

Examples ​

xml
<Table key="products">
    <Items>
        <Item partition="active" created="2022-01-01T00:00:00.000Z" updated="2022-01-01T00:00:00.000Z">
            <Identifier key="ean">1234567890123</Identifier>
            <Classification key="taxonomy">phone</Classification>
            <Conditional-Formatting key="compliance">valid</Conditional-Formatting>
            <Field key="titleEn">Phone X</Field>
            <Field key="price">999.9</Field>
            <Field key="frontImage" width-px="2000" height-px="2000" size-kb="2456" original-file-name="1234567890123_front.jpg" file-hash="0CMqLzPax2h9W/zAdG2x0g==" color-space="RGB" color-profile="NONE">https://asset.stage.product-live.com/(...)</Field>
        </Item>
        <Item partition="active" created="2022-01-01T00:00:00.000Z" updated="2022-01-01T00:00:00.000Z">
            <Identifier key="ean">1234567890124</Identifier>
            <Classification key="taxonomy">phone</Classification>
            <Conditional-Formatting key="compliance">unvalid</Conditional-Formatting>
            <Field key="titleEn">Phone S10</Field>
            <Field key="price">890.9</Field>
            <Field key="frontImage" width-px="2000" height-px="2000" size-kb="2456" original-file-name="1234567890124_front.jpg" file-hash="0CMqLzPax2h9W/zAdG2x9g==" color-space="RGB" color-profile="NONE">https://asset.stage.product-live.com/(...)</Field>
        </Item>
    </Items>
</Table>
xml
<Table key="products">
    <Items>
        <Item partition="active" created="2022-01-01T00:00:00.000Z" updated="2022-01-01T00:00:00.000Z">
            <Identifier key="reference">00034</Identifier>
            <Classification key="taxonomy">dress</Classification>
            <Field key="titleEn">Black women's lapel collar button down dress</Field>
            <Item created="2022-01-01T00:00:00.000Z" updated="2022-01-01T00:00:00.000Z">
                <Identifier key="referenceColor">00034-red</Identifier>
                <Field key="color">red</Field>
                <Field key="frontImage" width-px="2000" height-px="2000" size-kb="2456" original-file-name="00034-red_front.jpg" file-hash="0CMqLzPax2h9W/zAdG2x0g==" color-space="RGB" color-profile="NONE">https://asset.stage.product-live.com/.../00034-red_front.jpg</Field>
                <Item created="2022-01-01T00:00:00.000Z" updated="2022-01-01T00:00:00.000Z">
                    <Identifier key="sku">00034-red-34</Identifier>
                    <Identifier key="ean">1234567890123</Identifier>
                    <Field key="size">34</Field>
                    <Field key="price">19.9</Field>
                    <Field key="stock">320</Field>
                </Item>
                <Item created="2022-01-01T00:00:00.000Z" updated="2022-01-01T00:00:00.000Z">
                    <Identifier key="sku">00034-red-36</Identifier>
                    <Identifier key="ean">1234567890124</Identifier>
                    <Field key="size">36</Field>
                    <Field key="price">19.9</Field>
                    <Field key="stock">218</Field>
                </Item>
            </Item>
            <Item created="2022-01-01T00:00:00.000Z" updated="2022-01-01T00:00:00.000Z">
                <Identifier key="referenceColor">00034-green</Identifier>
                <Field key="color">green</Field>
                <Field key="frontImage" width-px="2000" height-px="2000" size-kb="2456" original-file-name="00034-green_front.jpg" file-hash="V5kecFJ7Vc861B+FXs6JXw==" color-space="RGB" color-profile="NONE">https://asset.stage.product-live.com/.../00034-green_front.jpg</Field>
                <Item created="2022-01-01T00:00:00.000Z" updated="2022-01-01T00:00:00.000Z">
                    <Identifier key="sku">00034-green-34</Identifier>
                    <Identifier key="ean">1234567890125</Identifier>
                    <Field key="size">34</Field>
                    <Field key="price">80.9</Field>
                    <Field key="stock">114</Field>
                </Item>
                <Item created="2022-01-01T00:00:00.000Z" updated="2022-01-01T00:00:00.000Z">
                    <Identifier key="sku">00034-green-36</Identifier>
                    <Identifier key="ean">1234567890126</Identifier>
                    <Field key="size">36</Field>
                    <Field key="price">80.9</Field>
                    <Field key="stock">136</Field>
                </Item>
            </Item>        
        </Item>
    </Items>
</Table>

File definition ​

XPathDescriptionOccurs
Table1
Table/@keyTable key1
Table/@accountThe account key that owns the table.1
Table/Items1
Table/Items/Item0..*
Table/Items/Item/@partitionThe key of the partition1
Table/Items/Item/@createdCreation date in UTC format1
Table/Items/Item/@updatedLast modification date in UTC format1
Table/Items/Item/@newSee below0..1
Table/Items/Item/@suggestionsSee below0..1
Table/Items/Item/@sentSee below0..1
Table/Items/Item/IdentifierThe value of the given identifier0..5
Table/Items/Item/Identifier/@keyThe key of the given identifier1
Table/Items/Item/ClassificationThe value of the given classification - The key of the selected category0..5
Table/Items/Item/Classification/@keyThe key of the given classification1
Table/Items/Item/Conditional-FormattingThe value of the given confitionnal formating field - The key of the current option0..5
Table/Items/Item/Conditional-Formatting/@keyThe key of the given conditional formatting field1
Table/Items/Item/FieldThe value of the given field0..*
Table/Items/Item/Field/@keyThe key of the given field1
Table/Items/Item/ItemsThe items belonging to the current item on the next level0..*

item attributes ​

created and updated attributes ​

These are the item's creation and update dates.

new and suggestions ​

WARNING

As the publish/collect mechanisms are not available on multi-level tables, none of these properties will be present on multi-level table items.

xml
<?xml version="1.0" encoding="utf-8"?>
<Table key="PRODUCTS">
  <Items>
    <Item partition="ALL_PRODUCTS" created="2021-04-13T09:12:09.000Z" updated="2021-04-28T19:22:33.000Z" new="2021-04-13T09:12:09.000Z" suggestions="2021-04-13T09:12:07.000Z" >
      <Identifier key="EAN">3228857000852</Identifier>
      <Classification key="Hierarchy">Chargeur pour téléphone mobile-1</Classification>
      <Conditional-Formatting key="commonConformity">INVALID</Conditional-Formatting>
      <Conditional-Formatting key="supplierConformity">INVALID</Conditional-Formatting>
      <Field key="CODIC_COMPAT_LINK">a</Field>
      <Field key="SUPPLIER_REF">a</Field>
      <Field key="COLOR">SLYEL</Field>
      <Field key="DEEE_SCALE">9178977</Field>
      <Field key="BRAND_CODE">02CO</Field>
      <Field key="TVA_CODE_GUPT">01</Field>
      <Field key="CUSTOM_CODE">01012100</Field>
      <Field key="SUPPLIER_CODE">03383</Field>
    </Item>
  </Items>
</Table>

newandsuggestions` are properties used to retrieve information from the publication/collect mechanism. This information is not present if the current item has not collected any suggestions.

  1. new
  • this is the date of the “NEW” suggestion for the current item.
  • If no “NEW” suggestion is linked to this item, or if it has been marked as “read”, this attribute is not proposed in the XML document.
  • The new attribute can only appear on items whose associated table belongs to the current account (since publication takes place from the account that receives the table to the account that owns the table).
  1. suggestions

WARNING

As publication/collection mechanisms are not available on tables with multiple levels, this property cannot be found on items linked to index levels 1.

  • this is the date of the “SUGGESTION” suggestion (which resulted in an update proposal for an existing item) the oldest not “read ” for the current item.
  • If no “SUGGESTION” suggestions are linked to this item, or if they have all been marked as “read”, this attribute is not proposed in the XML document.
  • As with the new attribute, the suggestions attribute can only appear on items whose associated table belongs to the current account.

sent ​

WARNING

The publication/collect is only available on single level tables. These properties are not present on multi-levels items.

xml
<?xml version="1.0" encoding="utf-8"?>
<Table key="PRODUCTS">
  <Items>
    <Item partition="ALL_PRODUCTS" created="2021-04-13T09:12:09.000Z" updated="2021-04-28T19:22:33.000Z" sent="2021-05-04T08:50:46.000Z">
      <Identifier key="EAN">3228857000852</Identifier>
      <Classification key="Hierarchy">Chargeur pour téléphone mobile-1</Classification>
      <Conditional-Formatting key="commonConformity">INVALID</Conditional-Formatting>
      <Conditional-Formatting key="supplierConformity">INVALID</Conditional-Formatting>
      <Field key="CODIC_COMPAT_LINK">a</Field>
      <Field key="SUPPLIER_REF">a</Field>
      <Field key="COLOR">SLYEL</Field>
      <Field key="DEEE_SCALE">9178977</Field>
      <Field key="BRAND_CODE">02CO</Field>
      <Field key="TVA_CODE_GUPT">01</Field>
      <Field key="CUSTOM_CODE">01012100</Field>
      <Field key="SUPPLIER_CODE">03383</Field>
    </Item>
  </Items>
</Table>

sent is the property used to raise information on the date of the latest published suggestions from an item. This property is absent if no suggestion has been sent.

lastSentSuggestionStatus ​

xml
<?xml version="1.0" encoding="utf-8"?>
<Table key="PRODUCTS">
  <Items>
    <Item partition="ALL_PRODUCTS" created="2021-04-13T09:12:09.000Z" updated="2021-04-28T19:22:33.000Z" sent="2021-05-04T08:50:46.000Z" lastSentSuggestionStatus="acknowledged">
      <Identifier key="EAN">3228857000852</Identifier>
      <Classification key="Hierarchy">Chargeur pour téléphone mobile-1</Classification>
      <Conditional-Formatting key="commonConformity">INVALID</Conditional-Formatting>
      <Conditional-Formatting key="supplierConformity">INVALID</Conditional-Formatting>
      <Field key="CODIC_COMPAT_LINK">a</Field>
      <Field key="SUPPLIER_REF">a</Field>
      <Field key="COLOR">SLYEL</Field>
      <Field key="DEEE_SCALE">9178977</Field>
      <Field key="BRAND_CODE">02CO</Field>
      <Field key="TVA_CODE_GUPT">01</Field>
      <Field key="CUSTOM_CODE">01012100</Field>
      <Field key="SUPPLIER_CODE">03383</Field>
    </Item>
  </Items>
</Table>

lastSentSuggestionStatus is the property used to raise information on the status of the latest published suggestions from an item, either sent, received, acknowledged or rejected. This property is absent if no suggestion has been sent.

id ​

Feature in alpha stage

This property is not generally available. Please contact your Product-Live contact to get more information.

xml
<Table key="products">
  <Items>
      <Item partition="active" id="1">
            <Identifier key="ean">1234567890123</Identifier>
      </Item>
  </Items>
</Table>

Conditional formatting fields ​

xml
<Table key="products">
  <Items>
      <Item partition="active">
          <Conditional-Formatting key="compliance">VALID</Conditional-Formatting>
      </Item>
  </Items>
</Table>
XPathDescriptionOccurs
Conditional-FormattingValue for conditional formatting field0..5
Conditional-Formatting@keyKey for conditional formatting field1
Conditional-Formatting@calculationInProgressIndicates whether the conditional formatting field is currently being calculated (true or absent)0..1
  • property key corresponds to the key of the conditional formatting field
  • The value VALID in the above example, corresponds to the key of the valid conditional formatting status for the current item.
  • If no value is defined for the current item - if the value is currently being calculated by our systems - we set the calculationInProgress attribute to true (see example below).
    • In this case, no value (no status) is set for the current conditional formatting field.
xml
<Table key="products">
  <Items>
      <Item partition="active">
          <Conditional-Formatting calculationInProgress="true" />
      </Item>
  </Items>
</Table>

NUMBER type fields ​

xml
<Table key="products">
  <Items>
      <Item partition="active">
          <Field key="price">12.9</Field>
      </Item>
  </Items>
</Table>
xml
<Table key="products">
  <Items>
      <Item partition="active">
          <Field key="cameraResolution" suffix="unece.unit.E37">15</Field>
      </Item>
  </Items>
</Table>
  • Numeric values for the NUMBER field type are as described in item import task documentation.

HTML-TEXT fields ​

xml
<Table key="products">
    <Items>
        <Item partition="active">
x            <Field key="descriptionFr">&lt;b&gt;Composition&lt;b&gt;&lt;ul&gt;&lt;li&gt;Cotton&lt;/li&gt;&lt;li&gt;Polyester&lt;/li&gt;&lt;/ul&gt;</Field>
        </Item>
    </Items>
</Table>

MULTIPLE-SELECT fields ​

xml
<Table key="products">
    <Items>
        <Item partition="active">
            <Field key="connectors">USB</Field>
            <Field key="connectors">HDMI</Field>
        </Item>
    </Items>
</Table>

MULTIPLE-SELECT-QUANTIFIED fields ​

xml
<Table key="products">
    <Items>
        <Item partition="active">
            <Identifier key="ean">1234567890123</Identifier>
            <Field key="connectors" quantity="3">USB</Field>
            <Field key="connectors" quantity="2">HDMI</Field>
        </Item>
    </Items>
</Table>

MULTIPLE-SELECT-QUANTIFIED-WITH-COMMENTS fields ​

xml
<Table key="products">
    <Items>
        <Item partition="active">
            <Identifier key="ean">1234567890123</Identifier>
            <Field key="connectors" quantity="3" comment="1 USB-C et 2 USB-2">USB</Field>
            <Field key="connectors" quantity="2" comment="1 HDMI4.1 &gt; 1 HDMI2.0">HDMI</Field>
        </Item>
    </Items>
</Table>

DATE fields ​

xml
<Table key="products">
    <Items>
        <Item partition="active">
            <Identifier key="ean">1234567890123</Identifier>
            <Field key="publication">2020-04-10Z</Field>
        </Item>
    </Items>
</Table>

DATE-TIME fields ​

xml
<Table key="products">
    <Items>
        <Item partition="active">
            <Identifier key="ean">1234567890123</Identifier>
            <Field key="publication">2020-04-10T00:00:00.000ZZ</Field>
        </Item>
    </Items>
</Table>

IMAGE fields ​

xml
<Table key="products">
    <Items>
        <Item partition="active">
            <Field key="photo" width-px="3000" height-px="3000" size-kb="3254" file-hash="35cca78ae8b60f7bc818e95fd9f78762a53e758b59a1c7181954e817d4f2f68a" original-file-name="photo.jpg" color-space="RGB" color-profile="NONE" >https://asset.prod.product-live.com/file-map/example_documents/redirect/example</Field>
        </Item>
    </Items>
</Table>
XPathDescriptionOccurs
@width-pxWidth in px1
@height-pxHeight in px1
@size-kbFile size in Kb1
@file-hashThe file hash. The hash generated is of type sha2561
@file-keyThe file key property can be used to identified an image, and thus prevent an image from being downloaded again if it has not been modified.0..1
@original-file-nameThe original name of the file1
@color-space1
@color-profile1
@mime-typeThe MIME type of the resource0..1

MIME types

A media type (also known as a Multipurpose Internet Mail Extensions or MIME type) indicates the nature and format of a document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838.

A simplest MIME type consists of a type and a subtype. A MIME type comprises these strings concatenated with a slash (/). No whitespace is allowed in a MIME type:

type/subtype

The type represents the general category into which the data type falls, such as video or text.

The subtype identifies the exact kind of data of the specified type the MIME type represents. For example, for the MIME type text, the subtype might be plain (plain text), html (HTML source code), or calendar (for iCalendar/.ics) files.

-- MDN Documentation

ATTACHMENT fields ​

xml
<Table key="products">
    <Items>
        <Item partition="active">
            <Field key="document_pdf_3" size-kb="4323" file-hash="6cc8542347035a528e18538445293eb66ed0f4c05c0be8ccd49d496c2e550b15" original-file-name="NOTICE_2020.pdf">https://asset.prod.product-live.com/file-map/example_documents/redirect/example</Field>
        </Item>
    </Items>
</Table>
XPathDescriptionOccurs
@size-kbFile size in Kb1
@file-hashThe file hash. The hash generated is of type sha2561
@file-keyThe file key property can be used to identified an attachment, and thus prevent the file from being downloaded again if it has not been modified.0..1
@original-file-nameThe original name of the file1

Limits and additional notes ​

  • The maximum number of items that may be exported in a single export is set to 200 000. If you need to export more items in a single export, our team will be happy to help you.
  • Item export only exports information that is not archived. In other words:
    • Active identifiers
    • Active classifications and categories
    • Fields which have an active (non-archived) link in matrix
    • Active options
    • Active suffixes