1 of 1

JSON Schnittstelle

Bestellungen ("orders"):

Aufbau:

"orders": array of `OrderObject`

OrderObject:

Beispiel:

{
  "orders": [
    {
      "id": "100000222",
      "created": "2019-05-22 07:30:50",
      "updated": "2019-05-22 07:31:25",
      "status": "processing",
      "shipping_method": {
        "type": "DHL",
        "description": "Versand über DHL"
      },
      "currency": "EUR",
      "comment": "Kommentar zur Bestellung vom Kunden",
      "taxmodel": "GROSS",
      "_payment": {
        "method": "CC",
        "cctype": "Visa"
      },
      "_lines": [
        {
          "type": "product",
          "is_line": true,
          "quantity": "1",
          "sku": "2113000016259",
          "name": "Product name",
          "unitprice": 19.99,
          "amount": 19.99,
          "discount_amount": 0,
          "tax_amount": 3.33,
          "taxclass": "REGULAR"
        },
        {
          "type": "shipping",
          "is_line": true,
          "amount": 4.9,
          "tax_amount": 0.82,
          "taxclass": "REGULAR"
        },
        {
          "type": "total",
          "is_line": false,
          "amount": 24.89,
          "tax_amount": 4.15
        }
      ],
      "_shipping": {
        "id": 2864,
        "salutation": "Herr",
        "firstname": "Stephan",
        "lastname": "Muster",
        "street": "Pottendorfer Straße 23",
        "zip": "1120",
        "city": "Wien",
        "country": "AT",
        "company": "ETRON",
        "email": "max.muster@muster.at",
        "phone": "+43 546 889797979",
        "vat_id": "ATU192853434"
      },
      "_billing": {
        "id": 2864,
        "salutation": "Herr",
        "firstname": "Stephan",
        "lastname": "Muster",
        "street": "Pottendorfer Straße 23",
        "zip": "1120",
        "city": "Wien",
        "country": "AT",
        "company": "ETRON",
        "email": "max.muster@muster.at",
        "phone": "+43 546 889797979",
        "vat_id": "ATU1928533434"
      }
    }
  ]
}

ShippingObject

OrderPaymentObject

OrderLineObject

OrderAddressObject

Mapping Tabelle, Anforderungen onRetail

OrderObject

OrderPaymentObject

OrderLineObject

OrderAddressObject

Bestellstatus "orderstatus"

Aufbau

"orderstatus": array of `OrderStatusObject`

OrderStatusObject

Mögliche Order Stati:

processing: Bestellung in Bearbeitung
complete: Bestellung wurde versendet
cancelled: Bestellung wurde storniert

Beispiel:

{
  "orderstatus": [
    {
      "id": "10000111",
      "status": "complete"
    },
    {
      "id": "10000112",
      "status": "cancelled"
    }
  ]
}

Mapping Tabelle, Anforderungen onRetail

OrderStatusObject

Kategorien („categories“):

Kategorien werden in allen konfigurierten Sprachen übertragen. Kategoriebilder liegen auf einem externen Bilderspeicher (SFTP oder Amazon S3). Als Bildangaben sind immer alle zum Basisordner relativen Pfadangaben anzugeben.

Beispiel für Kategorien in nur 1 Sprache (scopeId = "default"):

{
  "categories": {
    "default": [
      {
        "id": "1",
        "name": "Hauptkategorie",
        "parent_id": "0",
        "position": 1,
        "visible": true,
        "image": "http://cdnmax938.maxcdn.com/saalhsf/1.jpg",
        "description": "Beschreibung Hauptkategorie"
      },
      {
        "id": "2",
        "name": "Unterkategorie",
        "parent_id": "1",
        "position": 1,
        "visible": true
      },
      {
        "id": "3",
        "name": "Unterkategorie 2",
        "parent_id": "1",
        "position": 2,
        "visible": true
      }
    ]
  }
}

Beispiel für Kategorien in zwei Sprachen "de" (Deutsch) und "en" (Englisch) mit den gleichnamigen scopeIds:

{
  "categories": {
    "en": [
      {
        "id": "1",
        "name": "Main category",
        "parent_id": "0",
        "position": 1,
        "visible": true
      },
      {
        "id": "2",
        "name": "Sub category",
        "parent_id": "1",
        "position": 1,
        "visible": true
      },
      {
        "id": "3",
        "name": "Sub category 2",
        "parent_id": "1",
        "position": 2,
        "visible": true
      }
    ],
    "de": [
      {
        "id": "1",
        "name": "Hauptkategorie",
        "parent_id": "0",
        "position": 1,
        "visible": true
      },
      {
        "id": "2",
        "name": "Unterkategorie",
        "parent_id": "1",
        "position": 1,
        "visible": true
      },
      {
        "id": "3",
        "name": "Unterkategorie 2",
        "parent_id": "1",
        "position": 2,
        "visible": true
      }
    ]
  }
}

Aufbau:

"categories": {
  "scopeId": **array of** `CategoryObject`,
  "scopeId": **array of** `CategoryObject`,...
}

CategoryObject:

onRetail Anforderungen

Mapping Tabelle, Anforderungen onRetail

CategoryObject:

Produkte ("products"):

Produkte und beim Produkt definierte Kategoriezuweisungen werden gemeinsam exportiert.

Vom Datenaustauschformat unterstützt werden einfache und konfigurierbare Produkte in einer und mehreren Sprachen, sowie optionale Unterstützung für Multistore (Price per Store)/Multi-Inventory (Inventory per Store).

Attribute wie weight, sku und status sind globale Attribute (d.h. sprach/store-unabhängig). Die Attribute _categories (Kategoriezuordnungen) und _images (Bildzuordnungen) sind optional und immer global (also sprach/store-unabhängig).

Ein Scope (Geltungsbereich) ist der Abschnitt, der sprach- bzw. storebezogene Produktdaten definiert (Preise, Produkttexte)

Produktbilder liegen auf einem externen Bilderspeicher (SFTP oder Amazon S3). Als Bildangaben sind immer alle zum Basisordner relativen Pfadangaben anzugeben.

Aufbau:

"products": array of `ProductObject`

ProductObject:

{
  "products": [
    {
      "sku": "SKU1",
      "weight": 0.1,
      "status": 1,
      "stock": 99,
      "manufacturer" : "Herstellername",
      "manufacturer_link": "www.hersteller.com/products/1"
      "_categories": [
        {
          "cat_id": 1
        },
        {
          "cat_id": 2
        },
        {
          "cat_id": 3
        }
      ],
      "_images": [
        {
          "url": "www.example.com/path/to/imagefile1.jpg" ,
          "position": 1
        },
        {
          "rel_path": "www.example.com/path/to/imagefile2.jpg",
          "position": 10
        }
      ],
      "_price": {
        "regular": 9.1583,
        "special": 8.325,
        "taxclass": "REGULAR",
        "_tiers": [
          {
            "pricelist_id": 1,
            "quantity": 10,
            "price": "8.99"
          },
          {
            "pricelist_id": 1,
            "quantity": 20,
            "price": "7.99"
          }
        ]
      },
      "_scopes": [
        {
          "scopeid": "de",
          "data": [
            {
              "field": "name",
              "data": "Produktname"
            },
            {
              "field": "short_description",
              "data": "Deutsche Kurzbeschreibung"
            },
            {
              "field": "description",
              "data": "Deutsche Langbeschreibung"
            }
          ]
        },
        {
          "socpeid": "en",
          "data": [
            {
              "field": "name",
              "data": "Product name"
            },
            {
              "field": "short_description",
              "data": "english short description"
            },
            {
              "field": "description",
              "data": "english description"
            }
          ]
        }
      ]
    }
  ]
}

ImageObject

PriceObject

PriceTierObject

ProductProperties

Liste aller übersetzten Felder eines Produktes

VariationObject

Beispiel: Konfigurierbares Produkt mit 2 Varianten (Farbe=Grün und Farbe=Blau). Farbvariante Blau kostet 13 € inkl. 20% MwSt, Farbvariante Grün kostet 12 € inkl. 20% MwSt..

{
  "products": [
    {
      "sku": "ConfigProduct1",
      "status": 1,
      "_categories": [
        {
          "cat_id": 1
        },
        {
          "cat_id": 2
        },
        {
          "cat_id": 3
        }
      ],
      "_variation_config": {
        "attributes": [
          "farbe"
        ],
        "children": [
          "child-sku-1",
          "child-sku-2"
        ]
      },
      "_images": [
        {
          "url": "www.example.com/path/to/imagefile1.jpg" ,
          "position": 1
        },
        {
          "rel_path": "www.example.com/path/to/imagefile2.jpg",
          "position": 10
        }
      ],
      "_scopes": [
        {
          "scopeid": "default",
          "data": [
            {
              "field": "name",
              "data": "Produktname"
            },
            {
              "field": "short_description",
              "data": "Kurzbeschreibung"
            },
            {
              "field": "description",
              "data": "Beschreibung"
            }
          ]
        }
      ]
    },
    {
      "sku": "child-sku-1",
      "weight": 1,
      "stock": 1,
      "status": 1,
      "_price": {
        "regular": 10.8333,
        "taxclass": "REGULAR"
      },
      "_scopes": [
        {
          "scopeid": "default",
          "data": [
            {
              "field": "name",
              "data": "Variante Blau"
            },
            {
              "field": "farbe",
              "data": "blau"
            }
          ]
        }
      ]
    },
    {
      "sku": "child-sku-2",
      "weight": 1,
      "stock": 1,
      "status": 1,
      "_price": {
        "regular": 10,
        "taxclass": "REGULAR"
      },
      "_scopes": [
        {
          "scopeid": "default",
          "data": [
            {
              "field": "name",
              "data": "Variante Grün"
            },
            {
              "field": "farbe",
              "data": "grün"
            }
          ]
        }
      ]
    }
  ]
}

ProductLinkObject

Beispiel: Produkt mit Links

{
  "products": [
    {
      "sku": "SKU1",
      "weight": 0,
      "_categories": [
        {
          "cat_id": 1
        },
        {
          "cat_id": 2
        },
        {
          "cat_id": 3
        }
      ],
      "_images": [
        {
          "url": "www.example.com/path/to/imagefile1.jpg" ,
          "position": 1
        },
        {
          "rel_path": "www.example.com/path/to/imagefile2.jpg",
          "position": 10
        }
      ],
      "name": "Produktname",
      "short_description": ".....",
      "description": ".....",
      "status": 1,
      "stock": 1,
      "_price": {
        "regular": 9.1583,
        "special": 8.325,
        "taxclass": "REGULAR"
      },
      "_linked_skus": [
        {
            "type": "upsell",
            "skus": [
                "linked-upsell-sku-1",
                "linked-upsell-sku-2"
            ]
        },
        {
            "type": "crosssell",
            "skus": [
                "linked-upsell-sku-1",
                "linked-upsell-sku-2"
            ]
        },
        {
            "type": "related",
            "skus": [
                "linked-upsell-sku-1",
                "linked-upsell-sku-2"
            ]
        }
      }
    }
  ]
}

Mapping Tabelle, Anforderungen onRetail

ProductObject

ImageObject

PriceObject

Für die Preisverwaltung wird eine Preisliste für den Webshop bei der Installation angelegt die nicht gelöscht werden kann. Preislisteneinträge die eine Mengenangabe haben, werden als PriceTierObject exportiert. Einträge ohne Mengenangabe werden als special Preis exportiert. Bei mehrfachen anzuwendenden Preisen, wird der niedrigste Preis exportiert. Prio: Artikel > Kategorie > Global

PriceTierObject

ProductProperties (Üersetzungen)

Übersetzungen befinden sich im Model ir.translation Im Feld source steht die englische Übersetzung, die der anderen installierten Sprachen im Feld value

VariationObject

ProductLinkObject

JSON Schnittstelle

Bestellungen ("orders"):

Aufbau:

"orders": array of `OrderObject`

OrderObject:

Beispiel:

{
  "orders": [
    {
      "id": "100000222",
      "created": "2019-05-22 07:30:50",
      "updated": "2019-05-22 07:31:25",
      "status": "processing",
      "shipping_method": {
        "type": "DHL",
        "description": "Versand über DHL"
      },
      "currency": "EUR",
      "comment": "Kommentar zur Bestellung vom Kunden",
      "taxmodel": "GROSS",
      "_payment": {
        "method": "CC",
        "cctype": "Visa"
      },
      "_lines": [
        {
          "type": "product",
          "is_line": true,
          "quantity": "1",
          "sku": "2113000016259",
          "name": "Product name",
          "unitprice": 19.99,
          "amount": 19.99,
          "discount_amount": 0,
          "tax_amount": 3.33,
          "taxclass": "REGULAR"
        },
        {
          "type": "shipping",
          "is_line": true,
          "amount": 4.9,
          "tax_amount": 0.82,
          "taxclass": "REGULAR"
        },
        {
          "type": "total",
          "is_line": false,
          "amount": 24.89,
          "tax_amount": 4.15
        }
      ],
      "_shipping": {
        "id": 2864,
        "salutation": "Herr",
        "firstname": "Stephan",
        "lastname": "Muster",
        "street": "Pottendorfer Straße 23",
        "zip": "1120",
        "city": "Wien",
        "country": "AT",
        "company": "ETRON",
        "email": "max.muster@muster.at",
        "phone": "+43 546 889797979",
        "vat_id": "ATU192853434"
      },
      "_billing": {
        "id": 2864,
        "salutation": "Herr",
        "firstname": "Stephan",
        "lastname": "Muster",
        "street": "Pottendorfer Straße 23",
        "zip": "1120",
        "city": "Wien",
        "country": "AT",
        "company": "ETRON",
        "email": "max.muster@muster.at",
        "phone": "+43 546 889797979",
        "vat_id": "ATU1928533434"
      }
    }
  ]
}

ShippingObject

OrderPaymentObject

OrderLineObject

OrderAddressObject

Mapping Tabelle, Anforderungen onRetail

OrderObject

OrderPaymentObject

OrderLineObject

OrderAddressObject

Bestellstatus "orderstatus"

Aufbau

"orderstatus": array of `OrderStatusObject`

OrderStatusObject

Mögliche Order Stati:

processing: Bestellung in Bearbeitung
complete: Bestellung wurde versendet
cancelled: Bestellung wurde storniert

Beispiel:

{
  "orderstatus": [
    {
      "id": "10000111",
      "status": "complete"
    },
    {
      "id": "10000112",
      "status": "cancelled"
    }
  ]
}

Mapping Tabelle, Anforderungen onRetail

OrderStatusObject

Kategorien („categories“):

Beispiel für Kategorien in nur 1 Sprache (scopeId = "default"):

{
  "categories": {
    "default": [
      {
        "id": "1",
        "name": "Hauptkategorie",
        "parent_id": "0",
        "position": 1,
        "visible": true,
        "image": "http://cdnmax938.maxcdn.com/saalhsf/1.jpg",
        "description": "Beschreibung Hauptkategorie"
      },
      {
        "id": "2",
        "name": "Unterkategorie",
        "parent_id": "1",
        "position": 1,
        "visible": true
      },
      {
        "id": "3",
        "name": "Unterkategorie 2",
        "parent_id": "1",
        "position": 2,
        "visible": true
      }
    ]
  }
}

Beispiel für Kategorien in zwei Sprachen "de" (Deutsch) und "en" (Englisch) mit den gleichnamigen scopeIds:

{
  "categories": {
    "en": [
      {
        "id": "1",
        "name": "Main category",
        "parent_id": "0",
        "position": 1,
        "visible": true
      },
      {
        "id": "2",
        "name": "Sub category",
        "parent_id": "1",
        "position": 1,
        "visible": true
      },
      {
        "id": "3",
        "name": "Sub category 2",
        "parent_id": "1",
        "position": 2,
        "visible": true
      }
    ],
    "de": [
      {
        "id": "1",
        "name": "Hauptkategorie",
        "parent_id": "0",
        "position": 1,
        "visible": true
      },
      {
        "id": "2",
        "name": "Unterkategorie",
        "parent_id": "1",
        "position": 1,
        "visible": true
      },
      {
        "id": "3",
        "name": "Unterkategorie 2",
        "parent_id": "1",
        "position": 2,
        "visible": true
      }
    ]
  }
}

Aufbau:

"categories": {
  "scopeId": **array of** `CategoryObject`,
  "scopeId": **array of** `CategoryObject`,...
}

CategoryObject:

onRetail Anforderungen

Mapping Tabelle, Anforderungen onRetail

CategoryObject:

Produkte ("products"):

Produkte und beim Produkt definierte Kategoriezuweisungen werden gemeinsam exportiert.

Ein Scope (Geltungsbereich) ist der Abschnitt, der sprach- bzw. storebezogene Produktdaten definiert (Preise, Produkttexte)

Produktbilder liegen auf einem externen Bilderspeicher (SFTP oder Amazon S3). Als Bildangaben sind immer alle zum Basisordner relativen Pfadangaben anzugeben.

Aufbau:

"products": array of `ProductObject`

ProductObject:

{
  "products": [
    {
      "sku": "SKU1",
      "weight": 0.1,
      "status": 1,
      "stock": 99,
      "manufacturer" : "Herstellername",
      "manufacturer_link": "www.hersteller.com/products/1"
      "_categories": [
        {
          "cat_id": 1
        },
        {
          "cat_id": 2
        },
        {
          "cat_id": 3
        }
      ],
      "_images": [
        {
          "url": "www.example.com/path/to/imagefile1.jpg" ,
          "position": 1
        },
        {
          "rel_path": "www.example.com/path/to/imagefile2.jpg",
          "position": 10
        }
      ],
      "_price": {
        "regular": 9.1583,
        "special": 8.325,
        "taxclass": "REGULAR",
        "_tiers": [
          {
            "pricelist_id": 1,
            "quantity": 10,
            "price": "8.99"
          },
          {
            "pricelist_id": 1,
            "quantity": 20,
            "price": "7.99"
          }
        ]
      },
      "_scopes": [
        {
          "scopeid": "de",
          "data": [
            {
              "field": "name",
              "data": "Produktname"
            },
            {
              "field": "short_description",
              "data": "Deutsche Kurzbeschreibung"
            },
            {
              "field": "description",
              "data": "Deutsche Langbeschreibung"
            }
          ]
        },
        {
          "socpeid": "en",
          "data": [
            {
              "field": "name",
              "data": "Product name"
            },
            {
              "field": "short_description",
              "data": "english short description"
            },
            {
              "field": "description",
              "data": "english description"
            }
          ]
        }
      ]
    }
  ]
}

ImageObject

PriceObject

PriceTierObject

ProductProperties

Liste aller übersetzten Felder eines Produktes

VariationObject

Beispiel: Konfigurierbares Produkt mit 2 Varianten (Farbe=Grün und Farbe=Blau). Farbvariante Blau kostet 13 € inkl. 20% MwSt, Farbvariante Grün kostet 12 € inkl. 20% MwSt..

{
  "products": [
    {
      "sku": "ConfigProduct1",
      "status": 1,
      "_categories": [
        {
          "cat_id": 1
        },
        {
          "cat_id": 2
        },
        {
          "cat_id": 3
        }
      ],
      "_variation_config": {
        "attributes": [
          "farbe"
        ],
        "children": [
          "child-sku-1",
          "child-sku-2"
        ]
      },
      "_images": [
        {
          "url": "www.example.com/path/to/imagefile1.jpg" ,
          "position": 1
        },
        {
          "rel_path": "www.example.com/path/to/imagefile2.jpg",
          "position": 10
        }
      ],
      "_scopes": [
        {
          "scopeid": "default",
          "data": [
            {
              "field": "name",
              "data": "Produktname"
            },
            {
              "field": "short_description",
              "data": "Kurzbeschreibung"
            },
            {
              "field": "description",
              "data": "Beschreibung"
            }
          ]
        }
      ]
    },
    {
      "sku": "child-sku-1",
      "weight": 1,
      "stock": 1,
      "status": 1,
      "_price": {
        "regular": 10.8333,
        "taxclass": "REGULAR"
      },
      "_scopes": [
        {
          "scopeid": "default",
          "data": [
            {
              "field": "name",
              "data": "Variante Blau"
            },
            {
              "field": "farbe",
              "data": "blau"
            }
          ]
        }
      ]
    },
    {
      "sku": "child-sku-2",
      "weight": 1,
      "stock": 1,
      "status": 1,
      "_price": {
        "regular": 10,
        "taxclass": "REGULAR"
      },
      "_scopes": [
        {
          "scopeid": "default",
          "data": [
            {
              "field": "name",
              "data": "Variante Grün"
            },
            {
              "field": "farbe",
              "data": "grün"
            }
          ]
        }
      ]
    }
  ]
}

ProductLinkObject

Beispiel: Produkt mit Links

{
  "products": [
    {
      "sku": "SKU1",
      "weight": 0,
      "_categories": [
        {
          "cat_id": 1
        },
        {
          "cat_id": 2
        },
        {
          "cat_id": 3
        }
      ],
      "_images": [
        {
          "url": "www.example.com/path/to/imagefile1.jpg" ,
          "position": 1
        },
        {
          "rel_path": "www.example.com/path/to/imagefile2.jpg",
          "position": 10
        }
      ],
      "name": "Produktname",
      "short_description": ".....",
      "description": ".....",
      "status": 1,
      "stock": 1,
      "_price": {
        "regular": 9.1583,
        "special": 8.325,
        "taxclass": "REGULAR"
      },
      "_linked_skus": [
        {
            "type": "upsell",
            "skus": [
                "linked-upsell-sku-1",
                "linked-upsell-sku-2"
            ]
        },
        {
            "type": "crosssell",
            "skus": [
                "linked-upsell-sku-1",
                "linked-upsell-sku-2"
            ]
        },
        {
            "type": "related",
            "skus": [
                "linked-upsell-sku-1",
                "linked-upsell-sku-2"
            ]
        }
      }
    }
  ]
}

Mapping Tabelle, Anforderungen onRetail

ProductObject

ImageObject

PriceObject

PriceTierObject

ProductProperties (Üersetzungen)

Übersetzungen befinden sich im Model ir.translation Im Feld source steht die englische Übersetzung, die der anderen installierten Sprachen im Feld value