Shopware API Docs

List of API Resources

• Address
• Article
• Cache
• Categories
• Countries
• CustomerGroups
• Customer
• GenerateArticleImage
• Media
• Manufacturers
• Orders
• PropertyGroups
• Shops
• Translations
• Users
• Variants
• Version

API Reference

• Shopware
  • new Shopware([object])
  • .version([callback]) 🔀 Promise
  • .getArticles([callback]) 🔀 Promise
  • .getArticle(id, [callback]) 🔀 Promise
  • .getArticleByOrdernumber(ordernumber, [callback]) 🔀 Promise
  • .deleteArticle(id, [callback]) 🔀 Promise
  • .deleteArticles(ids, [callback]) 🔀 Promise
  • .createArticle(article, [callback]) 🔀 Promise
  • .updateArticle(id, article, [callback]) 🔀 Promise
  • .updateArticles(articles, [callback]) 🔀 Promise
  • .getCategories([callback]) 🔀 Promise
  • .getCategory(id, [callback]) 🔀 Promise
  • .createCategory(category, [callback]) 🔀 Promise
  • .updateCategory(id, category, [callback]) 🔀 Promise
  • .deleteCategory(id, [callback]) 🔀 Promise
  • .getVariants([callback]) 🔀 Promise
  • .getVariants([callback]) 🔀 Promise
  • .getVariant(id, [callback]) 🔀 Promise
  • .updateVariant(id, body, [callback]) 🔀 Promise
  • .createVariant(body, [callback]) 🔀 Promise
  • .deleteVariant(id, [callback]) 🔀 Promise
  • .deleteVariants(ids, [callback]) 🔀 Promise
  • .generateArticleImages(articleId, [callback]) 🔀 Promise
  • .listMedia([callback]) 🔀 Promise
  • .getMedia(id, [callback]) 🔀 Promise
  • .createMedia(body, [callback]) 🔀 Promise
  • .updateMedia(id, body, [callback]) 🔀 Promise
  • .deleteMedia(id, [callback]) 🔀 Promise
  • .getOrders([callback]) 🔀 Promise
  • .getOrder(id, [callback]) 🔀 Promise
  • .updateOrder(id, body, [callback]) 🔀 Promise
  • .getAddresses([callback]) 🔀 Promise
  • .getAddress(id, [callback]) 🔀 Promise
  • .createAddress(body, [callback]) 🔀 Promise
  • .updateAddress(id, body, [callback]) 🔀 Promise
  • .deleteAddress(id, [callback]) 🔀 Promise
  • .getCustomers([callback]) 🔀 Promise
  • .getCustomer(id, [callback]) 🔀 Promise
  • .createCustomer(body, [callback]) 🔀 Promise
  • .updateCustomer(id, body, [callback]) 🔀 Promise
  • .deleteCustomer(id, [callback]) 🔀 Promise
  • .getCaches([callback]) 🔀 Promise
  • .getCache(id, [callback]) 🔀 Promise
  • .deleteCache(id, [callback]) 🔀 Promise
  • .deleteCaches([callback]) 🔀 Promise
  • .getCountries([callback]) 🔀 Promise
  • .getCountry(id, [callback]) 🔀 Promise
  • .updateCountry(id, body, [callback]) 🔀 Promise
  • .createCountry(body, [callback]) 🔀 Promise
  • .deleteCountry(id, [callback]) 🔀 Promise
  • .getCustomerGroups([callback]) 🔀 Promise
  • .getCustomerGroup(id, [callback]) 🔀 Promise
  • .createCustomerGroup(body, [callback]) 🔀 Promise
  • .updateCustomerGroup(id, body, [callback]) 🔀 Promise
  • .deleteCustomerGroup(id, [callback]) 🔀 Promise
  • .getManufacturers([callback]) 🔀 Promise
  • .getManufacturer(id, [callback]) 🔀 Promise
  • .createManufacturer(body, [callback]) 🔀 Promise
  • .updateManufacturer(id, body, [callback]) 🔀 Promise
  • .deleteManufacturer(id, [callback]) 🔀 Promise
  • .getPropertyGroups([callback]) 🔀 Promise
  • .getPropertyGroup(id, [callback]) 🔀 Promise
  • .createPropertyGroup(body, [callback]) 🔀 Promise
  • .updatePropertyGroup(id, body, [callback]) 🔀 Promise
  • .deletePropertyGroup(id, [callback]) 🔀 Promise
  • .getShops([callback]) 🔀 Promise
  • .getShop(id, [callback]) 🔀 Promise
  • .createShop(body, [callback]) 🔀 Promise
  • .updateShop(id, body, [callback]) 🔀 Promise
  • .deleteShop(id, [callback]) 🔀 Promise
  • .getTranslations([callback]) 🔀 Promise
  • .getTranslation(id, [callback]) 🔀 Promise
  • .createTranslation(id, body, [callback]) 🔀 Promise
  • .updateTranslation(id, body, [callback]) 🔀 Promise
  • .deleteTranslation(id, [callback]) 🔀 Promise

Address

coming soon

Article

new Shopware([credentials])

Initializes the API. With given credentials. Host, User and API Key

Param	Type	Description
[credentials]	Object	Host, User, API Key.

shop.version([callback])

Returns shopware version and revision

Param	Type	Description
[callback]	function	Callback will be called with (err, version)

shop.getArticles([callback]) ⇒ Promise

Returns an array with all articles.

See: https://developers.shopware.com/developers-guide/rest-api/api-resource-article/

Param	Type	Description
[callback]	function	Callback will be called with (err, articles)

shop.getArticle(id, [callback]) ⇒ Promise

Returns an object with article data.

See: https://developers.shopware.com/developers-guide/rest-api/api-resource-article/

Param	Type	Description
id	string	Article id
[callback]	function	Callback will be called with (err, articles)

shop.getArticleByOrdernumber(ordernumber, [callback]) ⇒ Promise

Returns an object with article data.

See: https://developers.shopware.com/developers-guide/rest-api/api-resource-article/

Param	Type	Description
ordernumber	string	Article ordernumber
[callback]	function	Callback will be called with (err, articles)

shop.deleteArticle(id, [callback]) ⇒ Promise

Deletes an article and returns it's data.

See: https://developers.shopware.com/developers-guide/rest-api/api-resource-article/

Param	Type	Description
id	string	Article id
[callback]	function	Callback will be called with (err, success)

shop.deleteArticles(ids, [callback]) ⇒ Promise

Deletes a batch of articles and returns it's data.

See: https://developers.shopware.com/developers-guide/rest-api/api-resource-article/

Param	Type	Description
id	array	Article ids
[callback]	function	Callback will be called with (err, success)

shop.createArticles(article, [callback]) ⇒ Promise

Creates an article and returns its data.

See: https://developers.shopware.com/developers-guide/rest-api/api-resource-article/

Param	Type	Description
article	object	Shopware article model
[callback]	function	Callback will be called with (err, article)

shop.updateArticles(id, article, [callback]) ⇒ Promise

Updates data of an article.

See: https://developers.shopware.com/developers-guide/rest-api/api-resource-article/

Param	Type	Description
id	string	Target article id
article	object	Shopware article model
[callback]	function	Callback will be called with (err, article)

Cache

coming soon

Categories

coming soon

Countries

coming soon

CustomerGroups

coming soon

Customer

coming soon

GenerateArticleImage

coming soon

Media

coming soon

Manufacturers

coming soon

Orders

coming soon

PropertyGroups

coming soon

Shops

coming soon

Translations

coming soon

Users

coming soon

Variants

coming soon

Version

coming soon