com.liferay.headless.commerce.admin.shipment.resource.v1_0

Interface ShipmentResource

@Generated(value="")
 @ProviderType
public interface ShipmentResource

To access this resource, run: curl -u your@email.com:yourpassword -D - http://localhost:8080/o/headless-commerce-admin-shipment/v1.0

Generated:

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ShipmentResource.Builder
static interface	ShipmentResource.Factory
static class	ShipmentResource.FactoryHolder

Method Summary

Modifier and Type	Method and Description
static ShipmentResource.Builder	builder()
void	deleteShipment(java.lang.Long shipmentId)
javax.ws.rs.core.Response	deleteShipmentBatch(java.lang.String callbackURL, java.lang.Object object)
Shipment	getShipment(java.lang.Long shipmentId)
com.liferay.portal.vulcan.pagination.Page<Shipment>	getShipmentsPage(java.lang.String search, com.liferay.portal.kernel.search.filter.Filter filter, com.liferay.portal.vulcan.pagination.Pagination pagination, com.liferay.portal.kernel.search.Sort[] sorts)
Shipment	patchShipment(java.lang.Long shipmentId, Shipment shipment)
Shipment	postShipment(Shipment shipment)
javax.ws.rs.core.Response	postShipmentBatch(java.lang.String callbackURL, java.lang.Object object)
Shipment	postShipmentStatusDelivered(java.lang.Long shipmentId)
Shipment	postShipmentStatusFinishProcessing(java.lang.Long shipmentId)
Shipment	postShipmentStatusShipped(java.lang.Long shipmentId)
default void	setContextAcceptLanguage(com.liferay.portal.vulcan.accept.language.AcceptLanguage contextAcceptLanguage)
void	setContextCompany(com.liferay.portal.kernel.model.Company contextCompany)
default void	setContextHttpServletRequest(javax.servlet.http.HttpServletRequest contextHttpServletRequest)
default void	setContextHttpServletResponse(javax.servlet.http.HttpServletResponse contextHttpServletResponse)
default void	setContextUriInfo(javax.ws.rs.core.UriInfo contextUriInfo)
void	setContextUser(com.liferay.portal.kernel.model.User contextUser)
void	setExpressionConvert(com.liferay.portal.odata.filter.ExpressionConvert<com.liferay.portal.kernel.search.filter.Filter> expressionConvert)
void	setFilterParserProvider(com.liferay.portal.odata.filter.FilterParserProvider filterParserProvider)
void	setGroupLocalService(com.liferay.portal.kernel.service.GroupLocalService groupLocalService)
void	setResourceActionLocalService(com.liferay.portal.kernel.service.ResourceActionLocalService resourceActionLocalService)
void	setResourcePermissionLocalService(com.liferay.portal.kernel.service.ResourcePermissionLocalService resourcePermissionLocalService)
void	setRoleLocalService(com.liferay.portal.kernel.service.RoleLocalService roleLocalService)
default com.liferay.portal.kernel.search.filter.Filter	toFilter(java.lang.String filterString)
default com.liferay.portal.kernel.search.filter.Filter	toFilter(java.lang.String filterString, java.util.Map<java.lang.String,java.util.List<java.lang.String>> multivaluedMap)

Method Detail

builder

static ShipmentResource.Builder builder()

getShipmentsPage

com.liferay.portal.vulcan.pagination.Page<Shipment> getShipmentsPage(java.lang.String search,
                                                                     com.liferay.portal.kernel.search.filter.Filter filter,
                                                                     com.liferay.portal.vulcan.pagination.Pagination pagination,
                                                                     com.liferay.portal.kernel.search.Sort[] sorts)
                                                              throws java.lang.Exception

Throws:

java.lang.Exception

postShipment

Shipment postShipment(Shipment shipment)
               throws java.lang.Exception

Throws:

java.lang.Exception

postShipmentBatch

javax.ws.rs.core.Response postShipmentBatch(java.lang.String callbackURL,
                                            java.lang.Object object)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

deleteShipment

void deleteShipment(java.lang.Long shipmentId)
             throws java.lang.Exception

Throws:

java.lang.Exception

deleteShipmentBatch

javax.ws.rs.core.Response deleteShipmentBatch(java.lang.String callbackURL,
                                              java.lang.Object object)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getShipment

Shipment getShipment(java.lang.Long shipmentId)
              throws java.lang.Exception

Throws:

java.lang.Exception

patchShipment

Shipment patchShipment(java.lang.Long shipmentId,
                       Shipment shipment)
                throws java.lang.Exception

Throws:

java.lang.Exception

postShipmentStatusDelivered

Shipment postShipmentStatusDelivered(java.lang.Long shipmentId)
                              throws java.lang.Exception

Throws:

java.lang.Exception

postShipmentStatusFinishProcessing

Shipment postShipmentStatusFinishProcessing(java.lang.Long shipmentId)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

postShipmentStatusShipped

Shipment postShipmentStatusShipped(java.lang.Long shipmentId)
                            throws java.lang.Exception

Throws:

java.lang.Exception

setContextAcceptLanguage

default void setContextAcceptLanguage(com.liferay.portal.vulcan.accept.language.AcceptLanguage contextAcceptLanguage)

setContextCompany

void setContextCompany(com.liferay.portal.kernel.model.Company contextCompany)

setContextHttpServletRequest

default void setContextHttpServletRequest(javax.servlet.http.HttpServletRequest contextHttpServletRequest)

setContextHttpServletResponse

default void setContextHttpServletResponse(javax.servlet.http.HttpServletResponse contextHttpServletResponse)

setContextUriInfo

default void setContextUriInfo(javax.ws.rs.core.UriInfo contextUriInfo)

setContextUser

void setContextUser(com.liferay.portal.kernel.model.User contextUser)

setExpressionConvert

void setExpressionConvert(com.liferay.portal.odata.filter.ExpressionConvert<com.liferay.portal.kernel.search.filter.Filter> expressionConvert)

setFilterParserProvider

void setFilterParserProvider(com.liferay.portal.odata.filter.FilterParserProvider filterParserProvider)

setGroupLocalService

void setGroupLocalService(com.liferay.portal.kernel.service.GroupLocalService groupLocalService)

setResourceActionLocalService

void setResourceActionLocalService(com.liferay.portal.kernel.service.ResourceActionLocalService resourceActionLocalService)

setResourcePermissionLocalService

void setResourcePermissionLocalService(com.liferay.portal.kernel.service.ResourcePermissionLocalService resourcePermissionLocalService)

setRoleLocalService

void setRoleLocalService(com.liferay.portal.kernel.service.RoleLocalService roleLocalService)

toFilter

default com.liferay.portal.kernel.search.filter.Filter toFilter(java.lang.String filterString)

toFilter

default com.liferay.portal.kernel.search.filter.Filter toFilter(java.lang.String filterString,
                                                                java.util.Map<java.lang.String,java.util.List<java.lang.String>> multivaluedMap)