| Interface | Description |
|---|---|
| DiscountValue |
Defines discount type with the corresponding value.
|
| ProductDiscountValue |
Defines discount type with the corresponding value.
|
| Class | Description |
|---|---|
| AbsoluteDiscount |
An absolute product discount with corresponding values of price reductions.
|
| AbsoluteProductDiscount | |
| Address |
Represents a postal address.
|
| Attribute |
Custom attribute of a
Product. |
| Attribute.Enum |
The value of a custom enum attribute.
|
| Cart |
A cart that exists in the backend.
|
| CartDiscount | |
| CartDiscountTargetPredicate | |
| CartUpdate |
CartUpdate is object used to update a
Cart in the backend. |
| Catalog |
A Catalog is a grouping of products from the master catalog for a certain
purpose or under a certain theme.
|
| Category |
Category of a
Product in the product catalog. |
| Channel | |
| ChannelUpdate | |
| Comment |
A comment on a product by a project customer.
|
| CommentUpdate |
CommentUpdate is used to update a
Comment in the backend. |
| Customer |
A customer that exists in the backend.
|
| CustomerGroup |
A
Customer can be a member of a customer group (e.g. |
| CustomerName |
Value object representing a name of a
customer. |
| CustomerToken |
A verification token with limited lifetime used when
resetting customer password and when
verifying customer email. |
| CustomerUpdate |
CustomerUpdate is used to update a customer in the backend.
|
| CustomLineItem |
A custom line item are used for line items that do not reference an existing product.
|
| Delivery |
A Delivery contains a shipment of line items or custom line items with an arbitrary number of parcels.
|
| DeliveryItem |
Represents a line item or a custom line item in a
Delivery. |
| Dimensions |
Product image dimensions (width and height).
|
| DiscountCode | |
| DiscountCodeWithState | |
| DiscountedLineItemPortion | |
| DiscountedLineItemPrice | |
| DiscountedPrice | |
| Image |
Image attached to a
Variant. |
| InventoryEntry |
Inventory information for a specific product variant in a catalog.
|
| InventoryEntryUpdate | |
| LineItem | |
| LineItemContainer | |
| LineItemsTargetPredicate | |
| LocalizableEnum | |
| Location |
The location represents a country or a country with a state.
|
| Order |
An order is the final state of a cart, usually created after a checkout process has been completed.
|
| OrderUpdate | |
| Parcel |
Represents a package to or from a customer within a
Delivery. |
| ParcelMeasurements |
Size and weight of a
Parcel. |
| Price |
Price of a product variant.
|
| Product |
Products are the sellable goods in an e-commerce project on Sphere.
|
| ProductDiscount | |
| ProductUpdate |
ProductUpdate is used to update a product in the backend.
|
| RelativeDiscount |
A relative discount with the corresponding basis point value.
|
| RelativeProductDiscount | |
| Review |
Review of a product by a project customer (anonymous reviews are currently not supported).
|
| ReviewRating |
Represents accumulated average review score of a
Product. |
| ReviewUpdate |
ReviewUpdate is used to update a
Review in the backend. |
| ScaledImage |
One specific size of an
Image. |
| ShippingInfo | |
| ShippingMethod |
A shipping method defines a specific way of shipping, with different rates for different geographic locations.
|
| ShippingRate |
A shipping rate defines the cost of shipping an order.
|
| ShippingTargetPredicate | |
| SyncInfo | |
| TaxCategory | |
| TaxedPrice |
The cart price with product tax rates applied.
|
| TaxPortion |
Represents the tax portion amount of a specific tax rate in a
TaxedPrice. |
| TaxRate |
A tax rate of a
LineItem. |
| TrackingData |
TrackingData is some info about the delivery (like a DHL tracking number) which is useful to keep an eye
on your delivery, view its status etc.
|
| TrackingData.Builder | |
| Variant |
Variant of a
product in a product catalog. |
| VariantAvailability |
Stock availability of a variant in a product catalog.
|
| VariantList |
List of variants of a
Product that supports filtering by various criteria. |
| Zone |
A Zone represents a set of geographical locations.
|
| ZoneRate |
ZoneRate defines shipping rates (prices) for a specific zone.
|
| Enum | Description |
|---|---|
| Cart.CartState |
Describes the state of a
Cart. |
| Cart.InventoryMode |
Defines the cart behavior regarding inventory management.
|
| ChannelRoles | |
| DiscountCodeState | |
| ImageSize |
Standard image sizes available for each
Image. |
| OrderState |
Describes the state of an
Order. |
| PaymentState |
Describes the payment state of an
Order. |
| ShipmentState |
Describes the shipment state of an
Order. |