Shop importer script

A major topic at xentral is the connection and automatic processing of orders in online shops. Although many online stores already have a high degree of automation, new store systems and their connection always present us with challenges. Although almost every store has an interface, it often turns out that the interfaces to be connected are not compatible.

The importer acts as so-called middleware and translates the order data from the store into a format from which xentral can then create orders. Conversely, the importer is also responsible for transferring the order status, i.e. the information as to whether the order has been processed and shipped, as well as article data and stock figures to the store - a compact all-rounder, one might say.

The process within the importer always follows a fixed pattern. For example, if orders are to be retrieved from the store, the system first checks whether there is a connection to the store interface. Then it is determined whether, or how many, orders are to be picked up in the store. If there are orders to be picked up, they are imported and then marked as "In process" in the store. If items are imported from the store or exported to the store, the scheme looks similar. First, a check is made to see if there is a connection between xentral and the store. Then the data is transferred.

You do not need expert knowledge to write your own importer. Basic PHP knowledge is sufficient if you stick to the given structure. However, some things have to be clarified in advance:

After the basics for the importer are done, it now comes to the actual connection to Shopware. Of course, it is possible to outsource the complete communication to a separate class or, in the case of Shopware, to copy the class from the documentation. For the sake of simplicity, however, a short function that returns the response of the API is sufficient for this example:

protected function call($endpoint, $method, $data=array(),$params=array()){ $queryString = ''; if (!empty($params)) { $queryString = '?'.http_build_query($params); } $url = $this->apiUrl.$endpoint.$queryString; $dataString = json_encode($data);

$curl = curl_init(); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_FOLLOWLOCATION, false); curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC); curl_setopt($curl, CURLOPT_USERPWD, $this->apiUser . ':' . $this->apiKey); curl_setopt($curl, CURLOPT_HTTPHEADER, ['Content-Type: application/json; charset=utf-8']); curl_setopt($curl, CURLOPT_URL, $url); curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method); curl_setopt($curl, CURLOPT_POSTFIELDS, $dataString); return curl_exec($curl); }

Next, the ImportSendListLager() function is added. If the option for transferring stock numbers is activated in the import settings, the function ensures that the stocks in the store are synchronized with the stocks in xentral. In this example, this is done via the item number. Note that for this function, the data parameter of the Importer object must contain the data for the item to be updated.

public function ImportSendListLager() { $updatedArticles = 0; $tmp = $this->CatchRemoteCommand('data'); foreach ($tmp as $article){ $nummer = $article['nummer']; $lageranzahl = $article['anzahl_lager'];

$updateInStock = [
  'mainDetail' => [
    'inStock' => $lageranzahl
  ]
];

$params = [
  'useNumberAsId'=>true
];

$result = $this->call('articles/'.$nummer, 'PUT',$updateInStock, $params);
if($result['success']){
  $updatedArticles++;
}

} return $updatedArticles; }

The ImportSendList() function is basically an enhanced version of ImportSendListLager(). The function transfers items to the store - respectively updates their data. Which data and especially how they can be transferred depends on the respective store interface. This way, item properties or pictures can be transferred to the store. You should pay attention to the separation of the two functions, because ImportSendList is only called in two cases:

$articleData = [ 'name' => $name, 'lastStock' => $laststock, 'tax' => $tax, // alternativ 'taxId' => 1, 'supplier' => $supplier, // alternativ 'supplierId' => 2, 'description' => $description, 'descriptionLong' => $description_long, 'keywords' => $keywords, 'metaTitle' => $metatitle, 'highlight' => $topseller, 'mainDetail' => [ 'number' => $articleNumber, 'active' => $active, 'ean' => $ean, 'weight' => $weight, 'width' => $width, 'len' => $length, 'height' => $height, 'supplierNumber' => $supplierNumber, 'inStock' => $lageranzahl, 'prices' => $prices ] ];

This function determines how many open orders are available in the store and need to be picked up. It is conceivable to pick up via the status, from a certain order number or also via the order date. Depending on the store interface, not all options can be implemented.

public function ImportGetAuftraegeAnzahl() { $result = $this->getOrders($this->data);

return count($result['data']); }

The most important basic function of all importers is to fetch and translate the orders from the store to the shopping cart format of xentral. After the next order is fetched from the store API, the first step is to transfer the customer's address data to the shopping cart:

$cart['anrede'] = 'herr'; $cart['strasse'] = $order['data']['billing']['street']; $cart['plz'] = $order['data']['billing']['zipCode']; $cart['ort'] = $order['data']['billing']['city']; $cart['land'] = $order['data']['billing']['country']['iso']; $cart['email'] = $order['data']['customer']['email']; $cart['name'] = $order['data']['billing']['firstName'] . ' ' . $order['data']['billing']['lastName'];

If there is a different delivery address, this must logically also be transferred. In addition, the field different delivery address must be filled with true so that the order arrives at the correct recipient. Afterwards there is a whole series of important data, which are important for the further processing.

$cart['auftrag'] = $orderFromCollection['id']; $cart['gesamtsumme'] = $orderFromCollection['invoiceAmount']; $cart['transaktionsnummer'] = $orderFromCollection['transactionId']; $cart['onlinebestellnummer'] = $orderFromCollection['number']; ... $cart['zahlungsweise'] = $order['data']['payment']['name']; $cart['lieferung'] = $order['data']['dispatch']['name']; $cart['bestelldatum'] = substr($order['data']['orderTime'],0,10); $cart['versandkostennetto'] = $order['data']['invoiceShippingNet'];

foreach ($order['data']['details'] as $article) { $articlearray[] = [ 'articleid' => $article['articleNumber'], 'name' => $article['articleName'], 'price' => $article['price'], 'quantity' => $article['quantity'] ]; }

...

$orderData =[ 'id' => $cart['auftrag'], 'warenkorb' => base64_encode(serialize($cart)), 'warenkorbjson' => base64_encode(json_encode($cart)) ];

When the required basic order data has been transferred to the shopping cart, it is time to add the individual items to the shopping cart. The item number is transferred in the articleid field. The other fields contain their respective equivalent from the order item. After the shopping cart has been filled with all the data to be passed from the order, the function returns the data. Functions ImportDeleteOrder / ImportUpdateOrder The ImportDeleteOrder function, which for historical reasons has an inconvenient name, is not used to delete orders from the store. Instead, it is responsible for marking an open order as "In process". The partner function ImportUpdateAuftrag marks the order as "Shipped".

public function ImportDeleteAuftrag() { $orderId = $this->data['auftrag']; $update = [ 'orderStatusId' => 1 ];

$this->call('orders/'.$orderId, 'PUT',$update);

return true; }