| Interface | Description |
|---|---|
| CommandRequest<T> |
Request that sends a commands to the Sphere backend.
|
| DeleteRequest<T> | |
| FetchRequest<T> |
Request that fetches a single object.
|
| QueryRequest<T> |
Request that uses a Sphere query API to fetch objects satisfying some conditions.
|
| SearchRequest<T> |
Request that uses a Sphere search API to fetch objects satisfying some conditions (including fulltext search)
and provide faceting functionality.
|
| Class | Description |
|---|---|
| AttributeProductSort | |
| Endpoints |
Centralizes construction of backend API urls.
|
| ProductSort |
Specifies how products are sorted in
SearchRequest.sort(io.sphere.client.ProductSort). |
| ProductSort.AttributeSorts | |
| ProductSort.AttributeSortsPreDirection | |
| ProductSort.Name |
Specifies sorting by name.
|
| ProductSort.NameSorts |
Specifies sorting by name, ascending or descending.
|
| ProductSort.Price |
Specifies sorting by price.
|
| ProductSort.PriceSorts |
Specifies sorting by price, ascending or descending.
|
| ProductSort.Relevance |
Specifies sorting by descending relevance (always from the most relevant products).
|
| ProjectEndpoints |
Centralizes knowledge of Sphere HTTP API endpoint structure.
|
| QueryParam |
Single HTTP query parameter.
|
| SphereError |
Individual error in
SphereBackendException. |
| SphereError.ConcurrentModification |
The request attempts to modify a resource that is out of date,
i.e.
|
| SphereError.DuplicateAttributesValue |
The CombinationUnique AttributeConstraint was violated.
|
| SphereError.DuplicateAttributeValue |
The Unique AttributeConstraint was violated.
|
| SphereError.DuplicateField |
A value for a field conflicts with an existing duplicate value.
|
| SphereError.DuplicatePriceScope |
A given price scope conflicts with an existing one.
|
| SphereError.DuplicateVariantValues |
A given combination of variant values conflicts with an existing one.
|
| SphereError.General |
A server-side problem occurred that is not further specified.
|
| SphereError.InvalidCredentials |
No customer was found for the given credentials.
|
| SphereError.InvalidCurrentPassword |
Indicated that the current password did not match the given password.
|
| SphereError.InvalidField |
A field has an invalid value.
|
| SphereError.InvalidInput |
Invalid input has been sent to the service.
|
| SphereError.InvalidJsonInput |
Invalid JSON has been sent to the service.
|
| SphereError.InvalidOperation |
The resource(s) involved in the request are not in a valid state for the operation.
|
| SphereError.InvalidSubject |
The resource addressed by the request URL does not exist.
|
| SphereError.OutOfStock |
Some of the ordered line items are out of stock at the time of placing the order.
|
| SphereError.OverCapacity |
The service is having trouble handling the load.
|
| SphereError.PendingOperation |
A previous conflicting operation is still pending and needs to finish before the request can succeed.
|
| SphereError.PriceChanged |
Some line items price or tax changed at the time of placing the order.
|
| SphereError.RequiredField |
A required field is missing a value.
|
| SphereError.ResourceNotFound |
The resource addressed by the request URL does not exist.
|
| SphereResult<T> |
Result of a request to the Sphere backend.
|
| Enum | Description |
|---|---|
| SortDirection |
Direction for sorting a list of objects by a certain property.
|
| Exception | Description |
|---|---|
| AuthorizationException |
Exception thrown when the Sphere authorization service responds with other status code than HTTP 200 OK.
|
| ReferenceException |
Exception thrown on attempt to access an object inside a non expanded
Reference. |
| SphereClientException |
Exception thrown by the Sphere Java client.
|