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

Interface WarehouseOutboundDeliveryOrderService

All Superinterfaces:

BatchService<WarehouseOutboundDeliveryOrderServiceBatch>

All Known Implementing Classes:

DefaultWarehouseOutboundDeliveryOrderService

public interface WarehouseOutboundDeliveryOrderService
extends BatchService<WarehouseOutboundDeliveryOrderServiceBatch>

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

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
AdjustDeliveryItemQuantityFluentHelper	adjustDeliveryItemQuantity(String outboundDeliveryOrder, String outboundDeliveryOrderItem) Creates a fluent helper for the AdjustDeliveryItemQuantity OData function import.
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.
WarehouseOutboundDeliveryOrderService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
WarehouseOutboundDeliveryOrderService withServicePath(@Nonnull
                                                               String servicePath)

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

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

getAllWhseDeliveryDocumentAddress

@Nonnull
WhseDeliveryDocumentAddressFluentHelper getAllWhseDeliveryDocumentAddress()

Fetch multiple WhseDeliveryDocumentAddress entities.

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
WhseDeliveryDocumentAddressByKeyFluentHelper getWhseDeliveryDocumentAddressByKey(String outboundDeliveryOrder,
                                                                                          String outboundDeliveryOrderItem,
                                                                                          String businessPartnerRole)

Fetch a single WhseDeliveryDocumentAddress entity using key fields.

Parameters:

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

Constraints: Not nullable, Maximum length: 6

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 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
WhseOutboundDeliveryOrderHeadFluentHelper getAllWhseOutboundDeliveryOrderHead()

Fetch multiple WhseOutboundDeliveryOrderHead entities.

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
WhseOutboundDeliveryOrderHeadByKeyFluentHelper getWhseOutboundDeliveryOrderHeadByKey(String outboundDeliveryOrder)

Fetch a single WhseOutboundDeliveryOrderHead entity using key fields.

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
WhseOutboundDeliveryOrderHeadUpdateFluentHelper updateWhseOutboundDeliveryOrderHead(@Nonnull
                                                                                             WhseOutboundDeliveryOrderHead whseOutboundDeliveryOrderHead)

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

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
WhseOutboundDeliveryOrderItemFluentHelper getAllWhseOutboundDeliveryOrderItem()

Fetch multiple WhseOutboundDeliveryOrderItem entities.

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
WhseOutboundDeliveryOrderItemByKeyFluentHelper getWhseOutboundDeliveryOrderItemByKey(String outboundDeliveryOrder,
                                                                                              String outboundDeliveryOrderItem)

Fetch a single WhseOutboundDeliveryOrderItem entity using key fields.

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
WhseOutboundDeliveryOrderItemUpdateFluentHelper updateWhseOutboundDeliveryOrderItem(@Nonnull
                                                                                             WhseOutboundDeliveryOrderItem whseOutboundDeliveryOrderItem)

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

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
PostGoodsIssueFluentHelper postGoodsIssue(String outboundDeliveryOrder)

Creates a fluent helper for the PostGoodsIssue OData function import.

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
ReverseGoodsIssueFluentHelper reverseGoodsIssue(String outboundDeliveryOrder)

Creates a fluent helper for the ReverseGoodsIssue OData function import.

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
AdjustDeliveryItemQuantityFluentHelper adjustDeliveryItemQuantity(String outboundDeliveryOrder,
                                                                           String outboundDeliveryOrderItem)

Creates a fluent helper for the AdjustDeliveryItemQuantity OData function import.

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.