com.sap.cloud.sdk.s4hana.datamodel.odata.services

Class DefaultWarehouseOutboundDeliveryOrderService

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultWarehouseOutboundDeliveryOrderService

All Implemented Interfaces:

BatchService<WarehouseOutboundDeliveryOrderServiceBatch>, WarehouseOutboundDeliveryOrderService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultWarehouseOutboundDeliveryOrderService")
public class DefaultWarehouseOutboundDeliveryOrderService
extends Object
implements WarehouseOutboundDeliveryOrderService

In every API call, you can make use of the following operations: - You can retrieve header information for warehouse outbound delivery orders. - You can retrieve item information for warehouse outbound delivery orders. - You can change the carrier ID for a warehouse outbound delivery order at header level. - You can change the staging bay for a warehouse outbound delivery order, as well as the product quantity, at item level. - You can post goods issue. - You can reverse goods issue..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_WHSE_OUTB_DLV_ORDER
API Version:	1
Communication Scenario:	Warehousing - Process Outbound Delivery Order Integration (SAP_COM_0356)
Scope Items:	Warehouse Outbound Processing (3BS)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	WarehouseOutboundDeliveryOrder

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.WarehouseOutboundDeliveryOrderService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultWarehouseOutboundDeliveryOrderService() Creates a service using WarehouseOutboundDeliveryOrderService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
AdjustDeliveryItemQuantityFluentHelper	adjustDeliveryItemQuantity(String outboundDeliveryOrder, String outboundDeliveryOrderItem) Creates a fluent helper for the AdjustDeliveryItemQuantity OData function import.
DefaultWarehouseOutboundDeliveryOrderServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
WhseDeliveryDocumentAddressFluentHelper	getAllWhseDeliveryDocumentAddress() Fetch multiple WhseDeliveryDocumentAddress entities.
WhseOutboundDeliveryOrderHeadFluentHelper	getAllWhseOutboundDeliveryOrderHead() Fetch multiple WhseOutboundDeliveryOrderHead entities.
WhseOutboundDeliveryOrderItemFluentHelper	getAllWhseOutboundDeliveryOrderItem() Fetch multiple WhseOutboundDeliveryOrderItem entities.
WhseDeliveryDocumentAddressByKeyFluentHelper	getWhseDeliveryDocumentAddressByKey(String outboundDeliveryOrder, String outboundDeliveryOrderItem, String businessPartnerRole) Fetch a single WhseDeliveryDocumentAddress entity using key fields.
WhseOutboundDeliveryOrderHeadByKeyFluentHelper	getWhseOutboundDeliveryOrderHeadByKey(String outboundDeliveryOrder) Fetch a single WhseOutboundDeliveryOrderHead entity using key fields.
WhseOutboundDeliveryOrderItemByKeyFluentHelper	getWhseOutboundDeliveryOrderItemByKey(String outboundDeliveryOrder, String outboundDeliveryOrderItem) Fetch a single WhseOutboundDeliveryOrderItem entity using key fields.
PostGoodsIssueFluentHelper	postGoodsIssue(String outboundDeliveryOrder) Creates a fluent helper for the PostGoodsIssue OData function import.
ReverseGoodsIssueFluentHelper	reverseGoodsIssue(String outboundDeliveryOrder) Creates a fluent helper for the ReverseGoodsIssue OData function import.
WhseOutboundDeliveryOrderHeadUpdateFluentHelper	updateWhseOutboundDeliveryOrderHead(WhseOutboundDeliveryOrderHead whseOutboundDeliveryOrderHead) Update an existing WhseOutboundDeliveryOrderHead entity and save it to the S/4HANA system.
WhseOutboundDeliveryOrderItemUpdateFluentHelper	updateWhseOutboundDeliveryOrderItem(WhseOutboundDeliveryOrderItem whseOutboundDeliveryOrderItem) Update an existing WhseOutboundDeliveryOrderItem entity and save it to the S/4HANA system.
DefaultWarehouseOutboundDeliveryOrderService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWarehouseOutboundDeliveryOrderService

public DefaultWarehouseOutboundDeliveryOrderService()

Creates a service using WarehouseOutboundDeliveryOrderService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultWarehouseOutboundDeliveryOrderService withServicePath(@Nonnull
                                                                             String servicePath)

Description copied from interface: WarehouseOutboundDeliveryOrderService

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Specified by:

withServicePath in interface WarehouseOutboundDeliveryOrderService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultWarehouseOutboundDeliveryOrderServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<WarehouseOutboundDeliveryOrderServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllWhseDeliveryDocumentAddress

@Nonnull
public WhseDeliveryDocumentAddressFluentHelper getAllWhseDeliveryDocumentAddress()

Description copied from interface: WarehouseOutboundDeliveryOrderService

Fetch multiple WhseDeliveryDocumentAddress entities.

Specified by:

getAllWhseDeliveryDocumentAddress in interface WarehouseOutboundDeliveryOrderService

Returns:

A fluent helper to fetch multiple WhseDeliveryDocumentAddress entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getWhseDeliveryDocumentAddressByKey

@Nonnull
public WhseDeliveryDocumentAddressByKeyFluentHelper getWhseDeliveryDocumentAddressByKey(String outboundDeliveryOrder,
                                                                                                 String outboundDeliveryOrderItem,
                                                                                                 String businessPartnerRole)

Description copied from interface: WarehouseOutboundDeliveryOrderService

Fetch a single WhseDeliveryDocumentAddress entity using key fields.

Specified by:

getWhseDeliveryDocumentAddressByKey in interface WarehouseOutboundDeliveryOrderService

Parameters:

outboundDeliveryOrder - Document Number

Constraints: Not nullable, Maximum length: 35

outboundDeliveryOrderItem - Item Number

Constraints: Not nullable, Maximum length: 10

businessPartnerRole - Describes the role or function of a partner in the business process.

Constraints: Not nullable, Maximum length: 6

Returns:

A fluent helper to fetch a single WhseDeliveryDocumentAddress entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getAllWhseOutboundDeliveryOrderHead

@Nonnull
public WhseOutboundDeliveryOrderHeadFluentHelper getAllWhseOutboundDeliveryOrderHead()

Description copied from interface: WarehouseOutboundDeliveryOrderService

Fetch multiple WhseOutboundDeliveryOrderHead entities.

Specified by:

getAllWhseOutboundDeliveryOrderHead in interface WarehouseOutboundDeliveryOrderService

Returns:

A fluent helper to fetch multiple WhseOutboundDeliveryOrderHead entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getWhseOutboundDeliveryOrderHeadByKey

@Nonnull
public WhseOutboundDeliveryOrderHeadByKeyFluentHelper getWhseOutboundDeliveryOrderHeadByKey(String outboundDeliveryOrder)

Description copied from interface: WarehouseOutboundDeliveryOrderService

Fetch a single WhseOutboundDeliveryOrderHead entity using key fields.

Specified by:

getWhseOutboundDeliveryOrderHeadByKey in interface WarehouseOutboundDeliveryOrderService

Parameters:

outboundDeliveryOrder - Document Number

Constraints: Not nullable, Maximum length: 35

Returns:

A fluent helper to fetch a single WhseOutboundDeliveryOrderHead entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

updateWhseOutboundDeliveryOrderHead

@Nonnull
public WhseOutboundDeliveryOrderHeadUpdateFluentHelper updateWhseOutboundDeliveryOrderHead(@Nonnull
                                                                                                    WhseOutboundDeliveryOrderHead whseOutboundDeliveryOrderHead)

Description copied from interface: WarehouseOutboundDeliveryOrderService

Update an existing WhseOutboundDeliveryOrderHead entity and save it to the S/4HANA system.

Specified by:

updateWhseOutboundDeliveryOrderHead in interface WarehouseOutboundDeliveryOrderService

Parameters:

whseOutboundDeliveryOrderHead - WhseOutboundDeliveryOrderHead entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing WhseOutboundDeliveryOrderHead entity. To perform execution, call the execute method on the fluent helper object.

getAllWhseOutboundDeliveryOrderItem

@Nonnull
public WhseOutboundDeliveryOrderItemFluentHelper getAllWhseOutboundDeliveryOrderItem()

Description copied from interface: WarehouseOutboundDeliveryOrderService

Fetch multiple WhseOutboundDeliveryOrderItem entities.

Specified by:

getAllWhseOutboundDeliveryOrderItem in interface WarehouseOutboundDeliveryOrderService

Returns:

A fluent helper to fetch multiple WhseOutboundDeliveryOrderItem entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getWhseOutboundDeliveryOrderItemByKey

@Nonnull
public WhseOutboundDeliveryOrderItemByKeyFluentHelper getWhseOutboundDeliveryOrderItemByKey(String outboundDeliveryOrder,
                                                                                                     String outboundDeliveryOrderItem)

Description copied from interface: WarehouseOutboundDeliveryOrderService

Fetch a single WhseOutboundDeliveryOrderItem entity using key fields.

Specified by:

getWhseOutboundDeliveryOrderItemByKey in interface WarehouseOutboundDeliveryOrderService

Parameters:

outboundDeliveryOrder - Document Number

Constraints: Not nullable, Maximum length: 35

outboundDeliveryOrderItem - Item Number

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single WhseOutboundDeliveryOrderItem entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

updateWhseOutboundDeliveryOrderItem

@Nonnull
public WhseOutboundDeliveryOrderItemUpdateFluentHelper updateWhseOutboundDeliveryOrderItem(@Nonnull
                                                                                                    WhseOutboundDeliveryOrderItem whseOutboundDeliveryOrderItem)

Description copied from interface: WarehouseOutboundDeliveryOrderService

Update an existing WhseOutboundDeliveryOrderItem entity and save it to the S/4HANA system.

Specified by:

updateWhseOutboundDeliveryOrderItem in interface WarehouseOutboundDeliveryOrderService

Parameters:

whseOutboundDeliveryOrderItem - WhseOutboundDeliveryOrderItem entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing WhseOutboundDeliveryOrderItem entity. To perform execution, call the execute method on the fluent helper object.

postGoodsIssue

@Nonnull
public PostGoodsIssueFluentHelper postGoodsIssue(String outboundDeliveryOrder)

Description copied from interface: WarehouseOutboundDeliveryOrderService

Creates a fluent helper for the PostGoodsIssue OData function import.

Specified by:

postGoodsIssue in interface WarehouseOutboundDeliveryOrderService

Parameters:

outboundDeliveryOrder - Document Number

Constraints: Not nullable, Maximum length: 35

Original parameter name from the Odata EDM: OutboundDeliveryOrder

Returns:

A fluent helper object that will execute the PostGoodsIssue OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

reverseGoodsIssue

@Nonnull
public ReverseGoodsIssueFluentHelper reverseGoodsIssue(String outboundDeliveryOrder)

Description copied from interface: WarehouseOutboundDeliveryOrderService

Creates a fluent helper for the ReverseGoodsIssue OData function import.

Specified by:

reverseGoodsIssue in interface WarehouseOutboundDeliveryOrderService

Parameters:

outboundDeliveryOrder - Document Number

Constraints: Not nullable, Maximum length: 35

Original parameter name from the Odata EDM: OutboundDeliveryOrder

Returns:

A fluent helper object that will execute the ReverseGoodsIssue OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

adjustDeliveryItemQuantity

@Nonnull
public AdjustDeliveryItemQuantityFluentHelper adjustDeliveryItemQuantity(String outboundDeliveryOrder,
                                                                                  String outboundDeliveryOrderItem)

Description copied from interface: WarehouseOutboundDeliveryOrderService

Creates a fluent helper for the AdjustDeliveryItemQuantity OData function import.

Specified by:

adjustDeliveryItemQuantity in interface WarehouseOutboundDeliveryOrderService

Parameters:

outboundDeliveryOrder - Document Number

Constraints: Not nullable, Maximum length: 35

Original parameter name from the Odata EDM: OutboundDeliveryOrder

outboundDeliveryOrderItem - Item Number

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: OutboundDeliveryOrderItem

Returns:

A fluent helper object that will execute the AdjustDeliveryItemQuantity OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.