Padloper Docs

Import API: Categories

This API will import product categories 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 = [
  // fridges category
  [
    // @NOTE: IF MULTILINGUAL FIELD, WE EXPECT VALUE IS ARRAY; ELSE STRING
    // title
    'title' => ['default' => 'Fridge', 'fi' => 'Jääkaappi', 'de' => 'Kühlschrank'],
    // @NOTE: IF MULTILINGUAL FIELD, WE EXPECT VALUE IS ARRAY; ELSE STRING
    // description
    'padloper_description' => [
      // default -> english
      'default' => "From integrated and freestanding fridges to under counter models and larder fridges, we've got a great range for sale. Free or next day delivery available.",
      // finnish
      'fi' => "Integroiduista ja vapaasti seisovista jääkaapeista pöytämalleihin ja ruokakaappijääkaappiin, meillä on myynnissä laaja valikoima. Ilmainen tai seuraavan päivän toimitus saatavilla.",
      // german
      'de' => "Von integrierten und freistehenden Kühlschränken bis hin zu Unterthekenmodellen und Vorratskühlschränken haben wir eine große Auswahl im Angebot. Kostenlose Lieferung oder Lieferung am nächsten Tag möglich.",
    ],
  ],
  // MORE CATEGORIES ...
];
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

$importType

The expected import type is categories. 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 categories. 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 categories into your shop. Please inspect the resultant array for import notifications.

// IMPORT ITEMS
$importItems = [
  // men category
  [
    // @NOTE: IF MULTILINGUAL FIELD, WE EXPECT VALUE IS ARRAY; ELSE STRING
    // title
    'title' => ['default' => 'Men', 'fi' => 'Miehet', 'de' => 'Männer'],
    // @NOTE: IF MULTILINGUAL FIELD, WE EXPECT VALUE IS ARRAY; ELSE STRING
    // description
    'padloper_description' => [
      // default -> english
      'default' => "<p>Latest styles in men's clothing featuring on-trend men's fashion and clothing, a summer inspired range. Next day delivery & free returns available.</p>",
      // finnish
      'fi' => "<p>Uusimmat tyylit miesten vaatteissa trendikkäillä miesten muodilla ja vaatteilla, kesän inspiroima mallisto. Seuraavan päivän toimitus ja ilmainen palautus saatavilla.</p>",
      // german
      'de' => "<p>Neueste Styles in der Herrenbekleidung mit trendiger Herrenmode und -kleidung, ein vom Sommer inspiriertes Sortiment. Lieferung am nächsten Tag und kostenlose Rücksendung möglich.</p>",
    ],

  ],
  // fridges category
  [
    // title
    'title' => ['default' => 'Fridge', 'fi' => 'Jääkaappi', 'de' => 'Kühlschrank'],
    // description
    'padloper_description' => [
      // default -> english
      'default' => "<p>From integrated and freestanding fridges to under counter models and larder fridges, we've got a great range for sale. Free or next day delivery available.</p>",
      // finnish
      'fi' => "<p>Integroiduista ja vapaasti seisovista jääkaapeista pöytämalleihin ja ruokakaappijääkaappiin, meillä on myynnissä laaja valikoima. Ilmainen tai seuraavan päivän toimitus saatavilla.</p>",
      // german
      'de' => "<p>Von integrierten und freistehenden Kühlschränken bis hin zu Unterthekenmodellen und Vorratskühlschränken haben wir eine große Auswahl im Angebot. Kostenlose Lieferung oder Lieferung am nächsten Tag möglich.</p>",
    ],
  ],
  // beauty category
  [
    // title
    'title' => ['default' => 'Beauty', 'fi' => 'Kauneus', 'de' => 'Schönheit'],
    // description
    'padloper_description' => [
      // default -> english
      'default' => "Discover Nuxt Beauty with over 200 designer beauty brands. Next day delivery and free returns available.",
      // finnish @note: NOT SET
      // 'fi' => "Löydä Nuxt Beauty yli 200 suunnittelijan kauneusbrändin kanssa. Seuraavan päivän toimitus ja ilmainen palautus saatavilla.",
      // german
      'de' => "<p>Entdecken Sie Nuxt Beauty mit über 200 Designer-Beauty-Marken. Lieferung am nächsten Tag und kostenlose Rücksendung möglich.</p>",
    ],
  ]
];

// IMPORT OPTIONS
// not passing any in this example

/** @var array $importResult */
$importResult = $padloper->import($importItems, 'categories');
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54