Ecommerce API

Orders

Products

Customers

Stores

Shopware is a trendsetting ecommerce platform to power your online business. Our ecommerce solution offers the perfect combination of beauty & brains you need to build and customize a fully responsive online store.

connection

Shopware

Addresses

Company Name

The date and time when the object was created.

Created at (timestamp)

Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

Currency

UNKNOWN_CURRENCY

When custom mappings are configured on the resource, the result is included here.

An array of email addresses for the customer.

Email Addresses

First Name

Last Name

Full Name

LinkedEcommerceOrder

An array of phone numbers for the customer.

Phone Numbers

Customer status

The date and time when the object was last updated.

Updated at (timestamp)

critical

Product Description

Product Images

Inventory Quantity

The name of the product as it should be displayed to customers.

Product Name

Product Options

Product Price

Product SKU

The current status of the product (active or archived).

Product Status

Product Weight

The unit of measurement for the weight of the product.

Weight Unit

An object representing a shipping or billing address.

City

Country

Address line 1

Address line 2

Postal code

State

Ecommerce Address

Coupon discount

The ID of the customer this entity is linked to.

Customer ID

LinkedEcommerceCustomer

An object representing a discount applied to an ecommerce order or product.

Ecommerce Discount

Fulfillment status

A single line item of an ecommerce order, representing a product or variant with associated options, quantity, and pricing information.

Ecommerce Order Line Item

Note

Order number

Payment method

Payment status

Refunded amount

Ecommerce Order Refund

Shipping cost

Order Status

Sub-total amount

Indicates whether the order's monetary amounts are inclusive of tax.

Tax inclusive

Total amount

Total discount

Total tax

Represents the tracking information associated with an ecommerce order.

Ecommerce Order Tracking Item

Store Admin URL

Store name

Store URL

Shopware does not expose a native cross-page total record count in default list responses. `meta.total_count` will not appear. Surfacing the total requires setting `total-count-mode: 1` in the request criteria when calling the Shopware Admin search API — an extra requirement not currently implemented.


Shopware does not expose a native cross-page total record count in default list responses. `meta.total_count` will not appear. Surfacing the total requires setting `total-count-mode: 1` in the request criteria when calling the Shopware Admin search API — an extra requirement not currently implemented.

Shopware applies order-level promotions as separate `type: promotion` line items with negative `totalPrice`, rather than reducing the price on individual product lines. As a result, `line_items[].total_amount` reflects each product line's price before order-level promotion allocation. Use the top-level `discounts[]` array to access promotion codes and applied amounts.

Line items with `type` of `promotion`, `credit`, or `discount` are excluded from `line_items[]`. Items with a `null` or unknown `type` are retained.


Shopware applies order-level promotions as separate `type: promotion` line items with negative `totalPrice`, rather than reducing the price on individual product lines. As a result, `line_items[].total_amount` reflects each product line's price before order-level promotion allocation. Use the top-level `discounts[]` array to access promotion codes and applied amounts.

Line items with `type` of `promotion`, `credit`, or `discount` are excluded from `line_items[]`. Items with a `null` or unknown `type` are retained.


Shopware

Details