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

Interface OutboundDeliveryService

All Superinterfaces:

BatchService<OutboundDeliveryServiceBatch>

All Known Implementing Classes:

DefaultOutboundDeliveryService

Deprecated.

The service and all its related classes are deprecated as of release 1911 (NOV-2019). Please use the successor API instead.

@Deprecated
public interface OutboundDeliveryService
extends BatchService<OutboundDeliveryServiceBatch>

This service enables you to create, read, update and delete outbound deliveries. It can be consumed in Fiori apps and on other user interfaces.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_OUTBOUND_DELIVERY_SRV
API Version:	1
Communication Scenario:	Delivery Processing Integration (SAP_COM_0106)
Scope Items:	Delivery Processing without Order Reference (1MI), Sell from Stock (BD9), Free of Charge Delivery (BDA), Accelerated Customer Returns (BKP), Procurement of Direct Materials (J45)
Authentication Methods:	Basic, x509

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH Deprecated. 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
ConfirmPickingAllItemsFluentHelper	confirmPickingAllItems(String deliveryDocument) Deprecated. Creates a fluent helper for the ConfirmPickingAllItems OData function import.
ConfirmPickingOneItemFluentHelper	confirmPickingOneItem(String deliveryDocumentItem, String deliveryDocument) Deprecated. Creates a fluent helper for the ConfirmPickingOneItem OData function import.
OutbDeliveryHeaderCreateFluentHelper	createOutbDeliveryHeader(OutbDeliveryHeader outbDeliveryHeader) Deprecated. Create a new OutbDeliveryHeader entity and save it to the S/4HANA system.
OutbDeliveryHeaderDeleteFluentHelper	deleteOutbDeliveryHeader(OutbDeliveryHeader outbDeliveryHeader) Deprecated. Deletes an existing OutbDeliveryHeader entity in the S/4HANA system.
OutbDeliveryItemDeleteFluentHelper	deleteOutbDeliveryItem(OutbDeliveryItem outbDeliveryItem) Deprecated. Deletes an existing OutbDeliveryItem entity in the S/4HANA system.
OutbDeliveryHeaderFluentHelper	getAllOutbDeliveryHeader() Deprecated. Fetch multiple OutbDeliveryHeader entities.
OutbDeliveryItemFluentHelper	getAllOutbDeliveryItem() Deprecated. Fetch multiple OutbDeliveryItem entities.
OutbDeliveryDocFlowByKeyFluentHelper	getOutbDeliveryDocFlowByKey(String precedingDocument, String precedingDocumentItem, String subsequentDocumentCategory) Deprecated. Fetch a single OutbDeliveryDocFlow entity using key fields.
OutbDeliveryHeaderByKeyFluentHelper	getOutbDeliveryHeaderByKey(String deliveryDocument) Deprecated. Fetch a single OutbDeliveryHeader entity using key fields.
OutbDeliveryItemByKeyFluentHelper	getOutbDeliveryItemByKey(String deliveryDocument, String deliveryDocumentItem) Deprecated. Fetch a single OutbDeliveryItem entity using key fields.
OutbDeliveryPartnerByKeyFluentHelper	getOutbDeliveryPartnerByKey(String partnerFunction, String sDDocument) Deprecated. Fetch a single OutbDeliveryPartner entity using key fields.
SerialNmbrDeliveryByKeyFluentHelper	getSerialNmbrDeliveryByKey(Integer maintenanceItemObjectList) Deprecated. Fetch a single SerialNmbrDelivery entity using key fields.
PickAllItemsFluentHelper	pickAllItems(String deliveryDocument) Deprecated. Creates a fluent helper for the PickAllItems OData function import.
PickOneItemFluentHelper	pickOneItem(String deliveryDocument, String deliveryDocumentItem) Deprecated. Creates a fluent helper for the PickOneItem OData function import.
PostGoodsIssueFluentHelper	postGoodsIssue(String deliveryDocument) Deprecated. Creates a fluent helper for the PostGoodsIssue OData function import.
ReverseGoodsIssueFluentHelper	reverseGoodsIssue(String deliveryDocument, LocalDateTime actualGoodsMovementDate) Deprecated. Creates a fluent helper for the ReverseGoodsIssue OData function import.
OutbDeliveryDocFlowUpdateFluentHelper	updateOutbDeliveryDocFlow(OutbDeliveryDocFlow outbDeliveryDocFlow) Deprecated. Update an existing OutbDeliveryDocFlow entity and save it to the S/4HANA system.
OutbDeliveryHeaderUpdateFluentHelper	updateOutbDeliveryHeader(OutbDeliveryHeader outbDeliveryHeader) Deprecated. Update an existing OutbDeliveryHeader entity and save it to the S/4HANA system.
OutbDeliveryItemUpdateFluentHelper	updateOutbDeliveryItem(OutbDeliveryItem outbDeliveryItem) Deprecated. Update an existing OutbDeliveryItem entity and save it to the S/4HANA system.
OutboundDeliveryService	withServicePath(String servicePath) Deprecated. 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

Deprecated.

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
OutboundDeliveryService withServicePath(@Nonnull
                                                 String servicePath)

Deprecated.

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.

getAllOutbDeliveryItem

@Nonnull
OutbDeliveryItemFluentHelper getAllOutbDeliveryItem()

Deprecated.

Fetch multiple OutbDeliveryItem entities.

Returns:

A fluent helper to fetch multiple OutbDeliveryItem 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.

getOutbDeliveryItemByKey

@Nonnull
OutbDeliveryItemByKeyFluentHelper getOutbDeliveryItemByKey(String deliveryDocument,
                                                                    String deliveryDocumentItem)

Deprecated.

Fetch a single OutbDeliveryItem entity using key fields.

Parameters:

deliveryDocument - The number that uniquely identifies the delivery.

Constraints: Not nullable, Maximum length: 10

deliveryDocumentItem - The number that uniquely identifies the item in a delivery.

Constraints: Not nullable, Maximum length: 6

Returns:

A fluent helper to fetch a single OutbDeliveryItem 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.

updateOutbDeliveryItem

@Nonnull
OutbDeliveryItemUpdateFluentHelper updateOutbDeliveryItem(@Nonnull
                                                                   OutbDeliveryItem outbDeliveryItem)

Deprecated.

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

Parameters:

outbDeliveryItem - OutbDeliveryItem entity object that will be updated in the S/4HANA system.

Returns:

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

deleteOutbDeliveryItem

@Nonnull
OutbDeliveryItemDeleteFluentHelper deleteOutbDeliveryItem(@Nonnull
                                                                   OutbDeliveryItem outbDeliveryItem)

Deprecated.

Deletes an existing OutbDeliveryItem entity in the S/4HANA system.

Parameters:

outbDeliveryItem - OutbDeliveryItem entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllOutbDeliveryHeader

@Nonnull
OutbDeliveryHeaderFluentHelper getAllOutbDeliveryHeader()

Deprecated.

Fetch multiple OutbDeliveryHeader entities.

Returns:

A fluent helper to fetch multiple OutbDeliveryHeader 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.

getOutbDeliveryHeaderByKey

@Nonnull
OutbDeliveryHeaderByKeyFluentHelper getOutbDeliveryHeaderByKey(String deliveryDocument)

Deprecated.

Fetch a single OutbDeliveryHeader entity using key fields.

Parameters:

deliveryDocument - The number that uniquely identifies the delivery.

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single OutbDeliveryHeader 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.

createOutbDeliveryHeader

@Nonnull
OutbDeliveryHeaderCreateFluentHelper createOutbDeliveryHeader(@Nonnull
                                                                       OutbDeliveryHeader outbDeliveryHeader)

Deprecated.

Create a new OutbDeliveryHeader entity and save it to the S/4HANA system.

Parameters:

outbDeliveryHeader - OutbDeliveryHeader entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new OutbDeliveryHeader entity. To perform execution, call the execute method on the fluent helper object.

updateOutbDeliveryHeader

@Nonnull
OutbDeliveryHeaderUpdateFluentHelper updateOutbDeliveryHeader(@Nonnull
                                                                       OutbDeliveryHeader outbDeliveryHeader)

Deprecated.

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

Parameters:

outbDeliveryHeader - OutbDeliveryHeader entity object that will be updated in the S/4HANA system.

Returns:

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

deleteOutbDeliveryHeader

@Nonnull
OutbDeliveryHeaderDeleteFluentHelper deleteOutbDeliveryHeader(@Nonnull
                                                                       OutbDeliveryHeader outbDeliveryHeader)

Deprecated.

Deletes an existing OutbDeliveryHeader entity in the S/4HANA system.

Parameters:

outbDeliveryHeader - OutbDeliveryHeader entity object that will be deleted in the S/4HANA system.

Returns:

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

getOutbDeliveryDocFlowByKey

@Nonnull
OutbDeliveryDocFlowByKeyFluentHelper getOutbDeliveryDocFlowByKey(String precedingDocument,
                                                                          String precedingDocumentItem,
                                                                          String subsequentDocumentCategory)

Deprecated.

Fetch a single OutbDeliveryDocFlow entity using key fields.

Parameters:

precedingDocument - Number that uniquely identifies the preceding sales, delivery, or billing document (for example, the quotation from which you created a sales order).

Constraints: Not nullable, Maximum length: 10

precedingDocumentItem - Preceding Item of an SD Document

Constraints: Not nullable, Maximum length: 6

subsequentDocumentCategory - The document category of the sales document that you have created from a preceding document (for example, a delivery note that has been created from a sales order).

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single OutbDeliveryDocFlow 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.

updateOutbDeliveryDocFlow

@Nonnull
OutbDeliveryDocFlowUpdateFluentHelper updateOutbDeliveryDocFlow(@Nonnull
                                                                         OutbDeliveryDocFlow outbDeliveryDocFlow)

Deprecated.

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

Parameters:

outbDeliveryDocFlow - OutbDeliveryDocFlow entity object that will be updated in the S/4HANA system.

Returns:

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

getSerialNmbrDeliveryByKey

@Nonnull
SerialNmbrDeliveryByKeyFluentHelper getSerialNmbrDeliveryByKey(Integer maintenanceItemObjectList)

Deprecated.

Fetch a single SerialNmbrDelivery entity using key fields.

Parameters:

maintenanceItemObjectList -

Returns:

A fluent helper to fetch a single SerialNmbrDelivery 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.

getOutbDeliveryPartnerByKey

@Nonnull
OutbDeliveryPartnerByKeyFluentHelper getOutbDeliveryPartnerByKey(String partnerFunction,
                                                                          String sDDocument)

Deprecated.

Fetch a single OutbDeliveryPartner entity using key fields.

Parameters:

partnerFunction - The abbreviated form of the name that identifies the partner function.

Constraints: Not nullable, Maximum length: 2

sDDocument - The number that uniquely identifies the sales, delivery, or billing document.

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single OutbDeliveryPartner 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.

postGoodsIssue

@Nonnull
PostGoodsIssueFluentHelper postGoodsIssue(String deliveryDocument)

Deprecated.

Creates a fluent helper for the PostGoodsIssue OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

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 deliveryDocument,
                                                         LocalDateTime actualGoodsMovementDate)

Deprecated.

Creates a fluent helper for the ReverseGoodsIssue OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

actualGoodsMovementDate - Actual GI Date

Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: ActualGoodsMovementDate

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.

confirmPickingAllItems

@Nonnull
ConfirmPickingAllItemsFluentHelper confirmPickingAllItems(String deliveryDocument)

Deprecated.

Creates a fluent helper for the ConfirmPickingAllItems OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

Returns:

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

confirmPickingOneItem

@Nonnull
ConfirmPickingOneItemFluentHelper confirmPickingOneItem(String deliveryDocumentItem,
                                                                 String deliveryDocument)

Deprecated.

Creates a fluent helper for the ConfirmPickingOneItem OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

deliveryDocumentItem - Item

Constraints: Not nullable, Maximum length: 6

Original parameter name from the Odata EDM: DeliveryDocumentItem

Returns:

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

pickAllItems

@Nonnull
PickAllItemsFluentHelper pickAllItems(String deliveryDocument)

Deprecated.

Creates a fluent helper for the PickAllItems OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

Returns:

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

pickOneItem

@Nonnull
PickOneItemFluentHelper pickOneItem(String deliveryDocument,
                                             String deliveryDocumentItem)

Deprecated.

Creates a fluent helper for the PickOneItem OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

deliveryDocumentItem - Item

Constraints: Not nullable, Maximum length: 6

Original parameter name from the Odata EDM: DeliveryDocumentItem

Returns:

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