Method Detail

• byId

  FetchRequest<Order> byId(java.lang.String id)

  Finds an order by an id.

• all

  @Deprecated
  QueryRequest<Order> all()

  Deprecated. since 0.49.0. Use query() instead.
  Queries all orders in current project.

• query

  QueryRequest<Order> query()

  Queries orders in current project.

• forCustomer

  QueryRequest<Order> forCustomer(java.lang.String customerId)

  Queries all orders of given customer.

• updatePaymentState

  @Deprecated
  CommandRequest<Order> updatePaymentState(VersionedId orderId,
                                                    PaymentState paymentState)

  Deprecated. since 0.51.0, use updateOrder(io.sphere.client.model.VersionedId, io.sphere.client.shop.model.OrderUpdate) instead, e.g. updateOrder(orderId, new OrderUpdate().setPaymentState(paymentState));.
  Sets the payment state of an order.

• updateShipmentState

  @Deprecated
  CommandRequest<Order> updateShipmentState(VersionedId orderId,
                                                     ShipmentState shipmentState)

  Deprecated. since 0.51.0, use updateOrder(io.sphere.client.model.VersionedId, io.sphere.client.shop.model.OrderUpdate) instead, e.g. updateOrder(orderId, new OrderUpdate().setShipmentState(shipmentState));.
  Sets the shipment state of an order.

• updateOrder

  CommandRequest<Order> updateOrder(VersionedId orderId,
                                  OrderUpdate orderUpdate)

  Updates the order, e.g. the payment state, the shipment state or the parcel tracking data.

  Parameters:

  orderId - the versioned id of the order to update

  orderUpdate - the changes to be applied

  Returns:

  a command that needs to be executed to perform the changes

• createOrder

  CommandRequest<Order> createOrder(VersionedId cartId)

  Creates an order based on a cart, and deletes the cart. The created order object has the same id as the cart it was created from.

  Returns:

  A command request which can fail with the following exceptions:

  • OutOfStockException if some of the products in the cart are not available anymore. This can only happen if the cart is in the ReserveOnOrder mode.
  • PriceChangedException if the price, tax or shipping of some line items changed since the items were added to the cart.

• createOrder

  CommandRequest<Order> createOrder(VersionedId cartId,
                                  PaymentState paymentState)

  Creates an order based on a cart, and deletes the cart. The created order object has the same id as the cart it was created from.

  Returns:

  A command request which can fail with the following exceptions:

  • OutOfStockException if some of the products in the cart are not available anymore. This can only happen if the cart is in the ReserveOnOrder mode.
  • PriceChangedException if the price, tax or shipping of some line items changed since the items were added to the cart.

• createOrder

  CommandRequest<Order> createOrder(CreateOrderBuilder builder)

  Creates an order based on a cart, and deletes the cart. The created order object has the same id as the cart it was created from.

  Returns:

  A command request which can fail with the following exceptions:

  • OutOfStockException if some of the products in the cart are not available anymore. This can only happen if the cart is in the ReserveOnOrder mode.
  • PriceChangedException if the price, tax or shipping of some line items changed since the items were added to the cart.