Padloper Docs

Import API: Tags

This API will import product tags to your shop.

Import Items Structure

$importItems

The array of $importItems should be structured as shown below. This should be passed to $padloper->import() as the first argument:

$importItems = [
  // wholesale tag
  [
    // @NOTE: IF MULTILINGUAL FIELD, WE EXPECT VALUE IS ARRAY; ELSE STRING
    // title @note: skipping finnish!
    'title' => ['default' => 'Wholesale', 'de' => 'Großhandel'],
  ],
  // MORE TAGS ...
];
1
2
3
4
5
6
7
8
9

$importType

The expected import type is tags. This should be passed to $padloper->import() as the second argument.

$importOptions

If required, the following import options can be passed to $padloper->import() as the third argument when importing tags. This must be an array.

$importOptions = [
   // @note: setting as unpublished!
  'is_unpublished' => true
];
1
2
3
4

Example Import

The following example shows how to import several tags into your shop. Please inspect the resultant array for import notifications.

// IMPORT ITEMS
$importItems = [
  // wholesale tag
  [
    // @NOTE: IF MULTILINGUAL FIELD, WE EXPECT VALUE IS ARRAY; ELSE STRING
    // title @note: skipping finnish!
    'title' => ['default' => 'Wholesale', 'de' => 'Großhandel'],
  ],
  // perishable tag
  [
    // title
    'title' => ['default' => 'Perishable', 'fi' => 'Pilaantuvat', 'de' => 'Verderblich'],
  ],
  // hot stepper tag
  [
    // title
    'title' => ['default' => 'Hot Stepper', 'fi' => 'Kuuma Stepperi', 'de' => 'Heißer Stepper'],
  ]
];

// IMPORT OPTIONS
$importOptions = [
  // @note: HERE WE ARE SETTING as unpublished; we will publish manually
  'is_unpublished' => true
];

/** @var array $importResult */
$importResult = $padloper->import($importItems, 'tags', $importOptions);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28