be.feelio.mollie.handler

Class ShipmentHandler

java.lang.Object

be.feelio.mollie.handler.AbstractHandler

be.feelio.mollie.handler.ShipmentHandler

public class ShipmentHandler
extends AbstractHandler

Handles the shipments API Mollie docs

Author:

Wout Schoovaerts

Constructor Summary

Constructors

Constructor and Description
ShipmentHandler(String baseUrl)

Method Summary

Modifier and Type	Method and Description
ShipmentResponse	createShipment(String orderId, ShipmentRequest body) In addition to the Orders API, the create shipment endpoint can be used to ship order lines.
ShipmentResponse	createShipment(String orderId, ShipmentRequest body, QueryParams params) In addition to the Orders API, the create shipment endpoint can be used to ship order lines.
ShipmentResponse	getShipment(String orderId, String shipmentId) Retrieve a single shipment and the order lines shipped by a shipment’s ID.
ShipmentResponse	getShipment(String orderId, String shipmentId, QueryParams params) Retrieve a single shipment and the order lines shipped by a shipment’s ID.
Pagination<ShipmentListResponse>	getShipments(String orderId) Retrieve all shipments for an order.
Pagination<ShipmentListResponse>	getShipments(String orderId, QueryParams params) Retrieve all shipments for an order.
ShipmentResponse	updateShipment(String orderId, String shipmentId, ShipmentUpdateRequest body) This endpoint can be used to update the tracking information of a shipment.
ShipmentResponse	updateShipment(String orderId, String shipmentId, ShipmentUpdateRequest body, QueryParams params) This endpoint can be used to update the tracking information of a shipment.

Methods inherited from class be.feelio.mollie.handler.AbstractHandler

delete, delete, delete, get, get, patch, patch, post, post, postWithoutBody, validateResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShipmentHandler

public ShipmentHandler(String baseUrl)

Method Detail

createShipment

public ShipmentResponse createShipment(String orderId,
                                       ShipmentRequest body)
                                throws MollieException

In addition to the Orders API, the create shipment endpoint can be used to ship order lines.

When using Klarna Pay later and Klarna Slice it this is mandatory for the order amount to be captured. An capture will automatically be created for the shipment.

The word “shipping” is used in the figurative sense here. It can also mean that a service was provided or digital content was delivered.

Parameters:

orderId - An order ID

body - ShipmentRequest object

Returns:

ShipmentResponse object

Throws:

MollieException - when something went wrong

createShipment

public ShipmentResponse createShipment(String orderId,
                                       ShipmentRequest body,
                                       QueryParams params)
                                throws MollieException

In addition to the Orders API, the create shipment endpoint can be used to ship order lines.

When using Klarna Pay later and Klarna Slice it this is mandatory for the order amount to be captured. An capture will automatically be created for the shipment.

The word “shipping” is used in the figurative sense here. It can also mean that a service was provided or digital content was delivered.

Parameters:

orderId - An order ID

body - ShipmentRequest object

params - A map of query params

Returns:

ShipmentResponse object

Throws:

MollieException - when something went wrong

getShipment

public ShipmentResponse getShipment(String orderId,
                                    String shipmentId)
                             throws MollieException

Retrieve a single shipment and the order lines shipped by a shipment’s ID.

Parameters:

orderId - An order ID

shipmentId - A shipment ID

Returns:

ShipmentResponse object

Throws:

MollieException - when something went wrong

getShipment

public ShipmentResponse getShipment(String orderId,
                                    String shipmentId,
                                    QueryParams params)
                             throws MollieException

Retrieve a single shipment and the order lines shipped by a shipment’s ID.

Parameters:

orderId - An order ID

shipmentId - A shipment ID

params - a map of query params

Returns:

ShipmentResponse object

Throws:

MollieException - when something went wrong

getShipments

public Pagination<ShipmentListResponse> getShipments(String orderId)
                                              throws MollieException

Retrieve all shipments for an order.

Parameters:

orderId - An order ID

Returns:

Pagination object

Throws:

MollieException - when something went wrong

getShipments

public Pagination<ShipmentListResponse> getShipments(String orderId,
                                                     QueryParams params)
                                              throws MollieException

Retrieve all shipments for an order.

Parameters:

orderId - An order ID

params - a map of query params

Returns:

Pagination object

Throws:

MollieException - when something went wrong

updateShipment

public ShipmentResponse updateShipment(String orderId,
                                       String shipmentId,
                                       ShipmentUpdateRequest body)
                                throws MollieException

This endpoint can be used to update the tracking information of a shipment.

Parameters:

orderId - An order ID

body - ShipmentUpdateRequest object

Returns:

ShipmentResponse object

Throws:

MollieException - when something went wrong

updateShipment

public ShipmentResponse updateShipment(String orderId,
                                       String shipmentId,
                                       ShipmentUpdateRequest body,
                                       QueryParams params)
                                throws MollieException

This endpoint can be used to update the tracking information of a shipment.

Parameters:

orderId - An order ID

body - ShipmentUpdateRequest object

params - A map of query params

Returns:

ShipmentResponse object

Throws:

MollieException - when something went wrong