Feed Me 6.x

Appearance

Field Types ​

Feed Me supports all native Craft Fields, and even some third-party ones.

Assets ​

Accepts single or multiple values, each one being…

  • …a filename (excluding any path segments) to match from an existing asset;
  • …a fully-qualified URL (for new, remote assets);

Additional Options ​

  • Upload remote asset (choose how to handle existing assets — Replace/Keep/Ignore)
  • Inner-element fields
xml
<Asset>my_filename.jpg</Asset>

// Or
<Assets>
    <Asset>my_filename.jpg</Asset>
    <Asset>my_other_filename.jpg</Asset>
</Assets>

//
// When selecting upload
//
<Asset>http://mydomain.com/my_filename.jpg</Asset>

// Or
<Assets>
    <Asset>http://mydomain.com/my_filename.jpg</Asset>
    <Asset>http://mydomain.com/my_other_filename.jpg</Asset>
</Assets>
json
{
    "Asset": "my_filename.jpg"
}

// Or
{
    "Assets": [
        "my_filename.jpg",
        "my_other_filename.jpg"
    ]
}

//
// When selecting upload
//
{
    "Asset": "http://mydomain.com/my_filename.jpg"
}

// Or
{
    "Assets": [
        "http://mydomain.com/my_filename.jpg",
        "http://mydomain.com/my_other_filename.jpg"
    ]
}

Categories ​

Accepts single or multiple values.

Additional Options ​

xml
<Category>My Category</Category>

// Or
<Categories>
    <Category>My Category</Category>
    <Category>Another Category</Category>
</Categories>
json
{
    "Category": "My Category"
}

// Or
{
    "Categories": [
        "My Category",
        "Another Category"
    ]
}

Checkboxes ​

Accepts single or multiple values. You must provide the Value of the option to check, not the Label.

xml
<Checkbox>option1</Checkbox>

// Or
<Checkboxes>
    <Option>option1</Option>
    <Option>option2</Option>
</Checkboxes>
json
{
    "Checkbox": "option1"
}

// Or
{
    "Checkboxes": [
        "option1",
        "option2"
    ]
}

Color ​

Accepts a single valid Colour value - usually in Hexadecimal.

xml
<Color>#ffffff</Color>
json
{
    "Color": "#ffffff"
}

Date/Time ​

Accepts a single valid date and time string. Supports many different formats, using PHP's date_parse function.

xml
<Date>Tue, 24 Feb 2015 09:00:53 +0000</Date>
<Date>2015-02-24 09:00:53</Date>
<Date>02/24/2015</Date>
json
{
    "Date": "Tue, 24 Feb 2015 09:00:53 +0000"
}

{
    "Date": "2015-02-24 09:00:53"
}

{
    "Date": "02/24/2015"
}

Accepts a single value. You must provide the Value of the option to select, not the Label.

xml
<Dropdown>option2</Dropdown>
json
{
    "Dropdown": "option2"
}

Entries ​

Accepts single or multiple values.

Additional Options ​

xml
<Entry>My Entry</Entry>

// Or
<Entries>
    <Entry>My Entry</Entry>
    <Entry>Another Entry</Entry>
</Entries>
json
{
    "Entry": "My Entry"
}

// Or
{
    "Entries": [
        "My Entry",
        "Another Entry"
    ]
}

Lightswitch ​

Accepts a single value. Can be provided as any boolean-like string.

xml
// 1/0
<Lightswitch>1</Lightswitch>

// true/false
<Lightswitch>true</Lightswitch>

// Yes/No
<Lightswitch>Yes</Lightswitch>
json
// 1/0
{
    "Lightswitch": "1"
}

// true/false
{
    "Lightswitch": "true"
}

// Yes/No
{
    "Lightswitch": "Yes"
}

Matrix ​

Check out Importing into Matrix for a more comprehensive guide.

Money ​

Accepts a single value.

xml
<Money>10</Money>
json
{
    "Money": "10"
}

Multi-select ​

Accepts single or multiple values. You must provide the Value of the option to select, not the Label.

xml
<MultiSelect>option1</MultiSelect>

// Or
<MultiSelects>
    <MultiSelect>option1</MultiSelect>
    <MultiSelect>option2</MultiSelect>
</MultiSelects>
json
{
    "MultiSelect": "option1"
}

// Or
{
    "MultiSelects": [
        "option1",
        "option2"
    ]
}

Number ​

Accepts a single value.

xml
<Number>10</Number>
json
{
    "Number": "10"
}

Plain Text ​

Accepts a single value.

xml
<PlainText>Lorem ipsum dolor sit amet</PlainText>
json
{
    "PlainText": "Lorem ipsum dolor sit amet"
}

Radio Buttons ​

Accepts a single value. You must provide the Value of the option to select, not the Label.

xml
<Radio>option2</Radio>
json
{
    "Radio": "option2"
}

Table ​

Each Table field row has multiple columns, so you map each field value to a column, rather than the entire Table field. You also group your columns into rows, as shown below.

xml
<Table>
    <Row>
        <ColumnOne>Content</ColumnOne>
        <ColumnTwo>For</ColumnTwo>
    </Row>

    <Row>
        <ColumnOne>Table</ColumnOne>
        <ColumnTwo>Field</ColumnTwo>
    </Row>
</Table>
json
{
    "Table": [{
        "ColumnOne": "Content",
        "ColumnTwo": "For"
    },{
        "ColumnOne": "Table",
        "ColumnTwo": "Field"
    }]
}

Tags ​

Accepts single or multiple values.

Additional Options ​

xml
<Tag>My Tag</Tag>

// Or
<Tags>
    <Tag>First Tag</Tag>
    <Tag>Second Tag</Tag>
</Tags>
json
{
    "Tag": "My Tag"
}

// Or
{
    "Tags": [
        "First Tag",
        "Second Tag"
    ]
}

Users ​

Accepts single or multiple values.

Additional Options ​

xml
<User>123@nothing.com</User>

// Or
<Users>
    <User>123@nothing.com</User>
    <User>123@something.com</User>
</Users>
json
{
    "User": "123@nothing.com"
}

// Or
{
    "Users": [
        "123@nothing.com",
        "123@something.com"
    ]
}

Third Party ​

The following third-party fields are supported, out-of-the-box:

TIP

Additional field types may be supported by their developers!

Element Attributes ​

For element fields (assets, categories, entries, tags and users), you'll want to check against any existing elements. Feed Me gives you the flexibility to choose how to match against existing elements. These will depend on what element it is, but will often be slug or title.

In practice, this means that your feed data can provide the ID, Title, or Slug of an entry; or the ID, Username, Name or Email for a user; and so on.

For instance, look at the following example feed data we want to import into a categories field:

xml
// Title provided
<Category>My Category</Category>

// Slug provided
<Category>my-category</Category>

// ID provided
<Category>23</Category>
json
// Title provided
{
    "Category": "My Category"
}

// Slug provided
{
    "Category": "my-category"
}

// ID provided
{
    "Category": "23"
}

Depending on what data your feed contains, you'll need to select the appropriate attribute to tell Feed Me how to deal with your data.

WARNING

You can also match based on custom field values! If you are importing data from a legacy system, consider capturing the external ID in a custom field so you can definitively match up records again, later.

Inner-Element Fields ​

As each related element can have custom fields themselves, Feed Me gives you the chance to map nested data to those fields, as well. They'll appear under any row when mapping to a relational field.

See the introduction to field mapping for more information on setting up nested fields.