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

Interface OutboundDeliveryService

All Known Implementing Classes:

DefaultOutboundDeliveryService

public interface OutboundDeliveryService

This service enables you to read, create, update and delete outbound deliveries in an API call. 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:	Free of Charge Delivery (BDA)

Method Summary

Modifier and Type	Method and Description
ConfirmPickingAllItemsFluentHelper	confirmPickingAllItems(String deliveryDocument) Creates a fluent helper for the ConfirmPickingAllItems OData function import.
ConfirmPickingOneItemFluentHelper	confirmPickingOneItem(String deliveryDocumentItem, String deliveryDocument) Creates a fluent helper for the ConfirmPickingOneItem OData function import.
OutbDeliveryHeaderCreateFluentHelper	createOutbDeliveryHeader(OutbDeliveryHeader outbDeliveryHeader) Create a new OutbDeliveryHeader entity and save it to the S/4HANA system.
OutbDeliveryHeaderDeleteFluentHelper	deleteOutbDeliveryHeader(OutbDeliveryHeader outbDeliveryHeader) Deletes an existing OutbDeliveryHeader entity in the S/4HANA system.
OutbDeliveryItemDeleteFluentHelper	deleteOutbDeliveryItem(OutbDeliveryItem outbDeliveryItem) Deletes an existing OutbDeliveryItem entity in the S/4HANA system.
OutbDeliveryDocFlowFluentHelper	getAllOutbDeliveryDocFlow() Fetch multiple OutbDeliveryDocFlow entities.
OutbDeliveryHeaderFluentHelper	getAllOutbDeliveryHeader() Fetch multiple OutbDeliveryHeader entities.
OutbDeliveryItemFluentHelper	getAllOutbDeliveryItem() Fetch multiple OutbDeliveryItem entities.
OutbDeliveryDocFlowByKeyFluentHelper	getOutbDeliveryDocFlowByKey(String precedingDocument, String precedingDocumentItem, String subsequentDocumentCategory) Fetch a single OutbDeliveryDocFlow entity using key fields.
OutbDeliveryHeaderByKeyFluentHelper	getOutbDeliveryHeaderByKey(String deliveryDocument) Fetch a single OutbDeliveryHeader entity using key fields.
OutbDeliveryItemByKeyFluentHelper	getOutbDeliveryItemByKey(String deliveryDocument, String deliveryDocumentItem) Fetch a single OutbDeliveryItem entity using key fields.
PickAllItemsFluentHelper	pickAllItems(String deliveryDocument) Creates a fluent helper for the PickAllItems OData function import.
PickOneItemFluentHelper	pickOneItem(String deliveryDocument, String deliveryDocumentItem) Creates a fluent helper for the PickOneItem OData function import.
PostGoodsIssueFluentHelper	postGoodsIssue(String deliveryDocument) Creates a fluent helper for the PostGoodsIssue OData function import.
ReverseGoodsIssueFluentHelper	reverseGoodsIssue(String deliveryDocument, Calendar actualGoodsMovementDate) Creates a fluent helper for the ReverseGoodsIssue OData function import.
OutbDeliveryDocFlowUpdateFluentHelper	updateOutbDeliveryDocFlow(OutbDeliveryDocFlow outbDeliveryDocFlow) Update an existing OutbDeliveryDocFlow entity and save it to the S/4HANA system.
OutbDeliveryItemUpdateFluentHelper	updateOutbDeliveryItem(OutbDeliveryItem outbDeliveryItem) Update an existing OutbDeliveryItem entity and save it to the S/4HANA system.

Method Detail

getAllOutbDeliveryItem

OutbDeliveryItemFluentHelper getAllOutbDeliveryItem()

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

OutbDeliveryItemByKeyFluentHelper getOutbDeliveryItemByKey(String deliveryDocument,
                                                           String deliveryDocumentItem)

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

OutbDeliveryItemUpdateFluentHelper updateOutbDeliveryItem(OutbDeliveryItem outbDeliveryItem)

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

OutbDeliveryItemDeleteFluentHelper deleteOutbDeliveryItem(OutbDeliveryItem outbDeliveryItem)

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

OutbDeliveryHeaderFluentHelper getAllOutbDeliveryHeader()

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

OutbDeliveryHeaderByKeyFluentHelper getOutbDeliveryHeaderByKey(String deliveryDocument)

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

OutbDeliveryHeaderCreateFluentHelper createOutbDeliveryHeader(OutbDeliveryHeader outbDeliveryHeader)

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.

deleteOutbDeliveryHeader

OutbDeliveryHeaderDeleteFluentHelper deleteOutbDeliveryHeader(OutbDeliveryHeader outbDeliveryHeader)

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.

getAllOutbDeliveryDocFlow

OutbDeliveryDocFlowFluentHelper getAllOutbDeliveryDocFlow()

Fetch multiple OutbDeliveryDocFlow entities.

Returns:

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

getOutbDeliveryDocFlowByKey

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

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

OutbDeliveryDocFlowUpdateFluentHelper updateOutbDeliveryDocFlow(OutbDeliveryDocFlow outbDeliveryDocFlow)

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.

postGoodsIssue

PostGoodsIssueFluentHelper postGoodsIssue(String deliveryDocument)

Creates a fluent helper for the PostGoodsIssue OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

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

ReverseGoodsIssueFluentHelper reverseGoodsIssue(String deliveryDocument,
                                                Calendar actualGoodsMovementDate)

Creates a fluent helper for the ReverseGoodsIssue OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

actualGoodsMovementDate - Actual GI Date

Constraints: Not nullable, Precision: 0

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

ConfirmPickingAllItemsFluentHelper confirmPickingAllItems(String deliveryDocument)

Creates a fluent helper for the ConfirmPickingAllItems OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

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

ConfirmPickingOneItemFluentHelper confirmPickingOneItem(String deliveryDocumentItem,
                                                        String deliveryDocument)

Creates a fluent helper for the ConfirmPickingOneItem OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

deliveryDocumentItem - Item

Constraints: Not nullable, Maximum length: 6

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

PickAllItemsFluentHelper pickAllItems(String deliveryDocument)

Creates a fluent helper for the PickAllItems OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

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

PickOneItemFluentHelper pickOneItem(String deliveryDocument,
                                    String deliveryDocumentItem)

Creates a fluent helper for the PickOneItem OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

deliveryDocumentItem - Item

Constraints: Not nullable, Maximum length: 6

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.