Ein Beispiel

This section is currently only available in german.

Im Folgenden sehen Sie ein kleines Beispiel zur Verwendung unserer API. Dazu zeigen wir Ihnen, wie Sie eine Liste Ihrer Bestellungen des aktuellen Monats erhalten. Die benötigte Methode ist ordersGetList. Aufgerufen wird sie wie folgt:

https://api.shopgate.com/shopgateway/api/orders_get_list

Sie müssen also nur die benötigte Methode an die Url https://api.shopgate.com/shopgateway/api/ anhängen. Per POST müssen noch folgende Parameter übergeben werden:

apikey
customer_number
shop_number
date_from

Ihren Apikey und Ihre Kundennummer können Sie im Bereich Stammdaten einsehen.
Die Shopnummer zum jeweiligen Shop können Sie zum Beispiel in der Übersicht sehen.

Weitere Parameter sind date_to, limit und page, die aber, wie date_from , optional sind. Für date_from nehmen Sie das Datum vom 1. des Monats im Format YYYY-MM-DD. date_to erhält automatisch das Datum des heutigen Tages, limit wird auf 50 und page auf 0 gesetzt. Im Erfolgsfall erhalten Sie eine JSON-codierte Antwort wie diese:

{
   "error":0,
   "error_text":"",
   "orders":[
      {
         "order_number":"1010000007",
         "shipping_approved":"0",
         "shipping_approved_time":"",
         "shipping_completed":"0",
         "shipping_completed_time":"",
         "amount_items":"11898",
         "amount_shipping":"0",
         "amount_complete":"11898",
         "customer":{
            "customer_number":"100046",
            "mail":"Max.Mustermann@googlemail.com",
            "first_name":"Max",
            "surname":"Mustermann",
            "company":"",
            "street":"Hauptstraße 3",
            "city":"Musterstadt",
            "zipcode":"9841",
            "country":"DE"
         },
         "invoice_address":{
            "first_name":"Max",
            "surname":"Mustermann",
            "company":"",
            "street":"Hauptstraße 3",
            "city":"Musterstadt",
            "zipcode":"9841",
            "country":"DE"
         },
         "delivery_address":{
            "first_name":"Max",
            "surname":"Mustermann",
            "company":"Shopgate GmbH",
            "street":"Hauptstraße",
            "city":"Musterstadt",
            "zipcode":"9841",
            "country":"DE"
         }
      },
      {
         "order_number":"1010000005",
         "shipping_approved":"0",
         "shipping_approved_time":"",
         "shipping_completed":"0",
         "shipping_completed_time":"",
         "amount_items":"11898",
         "amount_shipping":"0",
         "amount_complete":"11898",
         "customer":{
            "customer_number":"100046",
            "mail":"Max.Mustermann@googlemail.com",
            "first_name":"Max",
            "surname":"Mustermann",
            "company":"",
            "street":"Hauptstraße 3",
            "city":"Musterstadt",
            "zipcode":"9841",
            "country":"DE"
         },
         "invoice_address":{
            "first_name":"Max",
            "surname":"Mustermann",
            "company":"",
            "street":"Hauptstraße 3",
            "city":"Musterstadt",
            "zipcode":"9841",
            "country":"DE"
         },
         "delivery_address":{
            "first_name":"Max",
            "surname":"Mustermann",
            "company":"Shopgate GmbH",
            "street":"Hauptstraße",
            "city":"Musterstadt",
            "zipcode":"9841",
            "country":"DE"
         }
      },
      {
         "order_number":"1010000003",
         "shipping_approved":"0",
         "shipping_approved_time":"",
         "shipping_completed":"0",
         "shipping_completed_time":"",
         "amount_items":"11898",
         "amount_shipping":"0",
         "amount_complete":"11898",
         "customer":{
            "customer_number":"100046",
            "mail":"Max.Mustermann@googlemail.com",
            "first_name":"Max",
            "surname":"Mustermann",
            "company":"",
            "street":"Hauptstraße 3",
            "city":"Musterstadt",
            "zipcode":"9841",
            "country":"DE"
         },
         "invoice_address":{
            "first_name":"Max",
            "surname":"Mustermann",
            "company":"",
            "street":"Hauptstraße 3",
            "city":"Musterstadt",
            "zipcode":"9841",
            "country":"DE"
         },
         "delivery_address":{
            "first_name":"Max",
            "surname":"Mustermann",
            "company":"Shopgate GmbH",
            "street":"Hauptstraße",
            "city":"Musterstadt",
            "zipcode":"9841",
            "country":"DE"
         }
      },
      {
         "order_number":"1010000001",
         "shipping_approved":"0",
         "shipping_approved_time":"",
         "shipping_completed":"0",
         "shipping_completed_time":"",
         "amount_items":"11898",
         "amount_shipping":"0",
         "amount_complete":"11898",
         "customer":{
            "customer_number":"100046",
            "mail":"Max.Mustermann@googlemail.com",
            "first_name":"Max",
            "surname":"Mustermann",
            "company":"",
            "street":"Hauptstraße 3",
            "city":"Musterstadt",
            "zipcode":"9841",
            "country":"DE"
         },
         "invoice_address":{
            "first_name":"Max",
            "surname":"Mustermann",
            "company":"",
            "street":"Hauptstraße 3",
            "city":"Musterstadt",
            "zipcode":"9841",
            "country":"DE"
         },
         "delivery_address":{
            "first_name":"Max",
            "surname":"Mustermann",
            "company":"Shopgate GmbH",
            "street":"Hauptstraße",
            "city":"Musterstadt",
            "zipcode":"9841",
            "country":"DE"
         }
      }
   ],
   "limit":50,
   "page":0,
   "version":"1.0",
   "trace_id":"4530"
}

Die Antwort beginnt mit einer Meldung über evtl. aufgetretene Fehler (Fehlercode und Beschreibung), gefolgt von einer Liste der Bestellungen.

Die Felder limit und page am Schluss geben Ihnen Informationen darüber, wieviele Einträge zurückgeliefert werden und auf welcher Seite Sie sich befinden. In diesem Fall wurden maximal 50 Bestellungen ("limit":50) zurück geliefert und es wurde die erste Seite ("page":0) abgefragt.

Sind mehr als 50 Bestellungen vorhanden, ist es entweder möglich den Wert von limit auf max. 100 zu setzen, oder den Wert von page zu erhöhen und damit durch die Ergebnisse zu "blättern". Bei einem Wert von 1 würden die Bestellungen 51 - 100 zurück geliefert werden.

Das Feld version gibt Aufschluss über die Versionsnummer der API und die trace_id benötigen Sie, wenn Sie sich mit einem Fehler an den Support wenden wollen.