@sap/cloud-sdk-vdm-outbound-delivery-service

This package contains the OData VDM for the Outbound Delivery Service of SAP S/4HANA Cloud. This service is part of the following communication scenarios: Delivery Processing Integration (SAP_COM_0106). You can find additional documentation for this service on help.sap.com.

Helpful Links

Index

Modules

Classes

Type aliases

Variables

defaultOutboundDeliveryServicePath

Functions

Object literals

functionImports

Type aliases

ReadOutboundDeliveryServiceRequestBuilder

ReadOutboundDeliveryServiceRequestBuilder: GetAllRequestBuilder<OutbDeliveryItem> | GetAllRequestBuilder<OutbDeliveryHeader> | GetAllRequestBuilder<OutbDeliveryDocFlow> | GetAllRequestBuilder<MaintenanceItemObject> | GetAllRequestBuilder<SerialNmbrDelivery> | GetAllRequestBuilder<OutbDeliveryPartner> | GetAllRequestBuilder<OutbDeliveryAddress> | GetByKeyRequestBuilder<OutbDeliveryItem> | GetByKeyRequestBuilder<OutbDeliveryHeader> | GetByKeyRequestBuilder<OutbDeliveryDocFlow> | GetByKeyRequestBuilder<MaintenanceItemObject> | GetByKeyRequestBuilder<SerialNmbrDelivery> | GetByKeyRequestBuilder<OutbDeliveryPartner> | GetByKeyRequestBuilder<OutbDeliveryAddress>

WriteOutboundDeliveryServiceRequestBuilder

WriteOutboundDeliveryServiceRequestBuilder: CreateRequestBuilder<OutbDeliveryItem> | UpdateRequestBuilder<OutbDeliveryItem> | DeleteRequestBuilder<OutbDeliveryItem> | CreateRequestBuilder<OutbDeliveryHeader> | UpdateRequestBuilder<OutbDeliveryHeader> | DeleteRequestBuilder<OutbDeliveryHeader> | CreateRequestBuilder<OutbDeliveryDocFlow> | UpdateRequestBuilder<OutbDeliveryDocFlow> | DeleteRequestBuilder<OutbDeliveryDocFlow> | CreateRequestBuilder<MaintenanceItemObject> | UpdateRequestBuilder<MaintenanceItemObject> | DeleteRequestBuilder<MaintenanceItemObject> | CreateRequestBuilder<SerialNmbrDelivery> | UpdateRequestBuilder<SerialNmbrDelivery> | DeleteRequestBuilder<SerialNmbrDelivery> | CreateRequestBuilder<OutbDeliveryPartner> | UpdateRequestBuilder<OutbDeliveryPartner> | DeleteRequestBuilder<OutbDeliveryPartner> | CreateRequestBuilder<OutbDeliveryAddress> | UpdateRequestBuilder<OutbDeliveryAddress> | DeleteRequestBuilder<OutbDeliveryAddress>

Variables

Const defaultOutboundDeliveryServicePath

defaultOutboundDeliveryServicePath: "/sap/opu/odata/sap/API_OUTBOUND_DELIVERY_SRV" = "/sap/opu/odata/sap/API_OUTBOUND_DELIVERY_SRV"

Functions

batch

batch(...requests: Array<ReadOutboundDeliveryServiceRequestBuilder | ODataBatchChangeSet<WriteOutboundDeliveryServiceRequestBuilder>>): ODataBatchRequestBuilder

- Defined in packages/vdm/outbound-delivery-service/BatchRequest.ts:14
Batch builder for operations supported on the Outbound Delivery Service.

Parameters
- Rest ...requests: Array<ReadOutboundDeliveryServiceRequestBuilder | ODataBatchChangeSet<WriteOutboundDeliveryServiceRequestBuilder>>
  
  The requests of the batch
Returns ODataBatchRequestBuilder

A request builder for batch.

changeset

changeset(...requests: WriteOutboundDeliveryServiceRequestBuilder[]): ODataBatchChangeSet<WriteOutboundDeliveryServiceRequestBuilder>

- Defined in packages/vdm/outbound-delivery-service/BatchRequest.ts:23
Change set constructor consists of write operations supported on the Outbound Delivery Service.

Parameters
- Rest ...requests: WriteOutboundDeliveryServiceRequestBuilder[]
  
  The requests of the change set
Returns ODataBatchChangeSet<WriteOutboundDeliveryServiceRequestBuilder>

A change set for batch.

confirmPickingAllItems

confirmPickingAllItems(parameters: ConfirmPickingAllItemsParameters): FunctionImportRequestBuilder<ConfirmPickingAllItemsParameters, PickingReport[]>

- Defined in packages/vdm/outbound-delivery-service/function-imports.ts:80
Invoke action ConfirmPickingAllItems.

Parameters
- parameters: ConfirmPickingAllItemsParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<ConfirmPickingAllItemsParameters, PickingReport[]>

A request builder that allows to overwrite some of the values and execute the resultng request.

confirmPickingOneItem

confirmPickingOneItem(parameters: ConfirmPickingOneItemParameters): FunctionImportRequestBuilder<ConfirmPickingOneItemParameters, PickingReport[]>

- Defined in packages/vdm/outbound-delivery-service/function-imports.ts:108
Invoke action ConfirmPickingOneItem.

Parameters
- parameters: ConfirmPickingOneItemParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<ConfirmPickingOneItemParameters, PickingReport[]>

A request builder that allows to overwrite some of the values and execute the resultng request.

createPickingReport

createPickingReport(json: any): PickingReport

- Defined in packages/vdm/outbound-delivery-service/PickingReport.ts:99
deprecated

since v1.6.0. Use PickingReport.build instead.

Parameters
- json: any
Returns PickingReport

createReturn

createReturn(json: any): Return

- Defined in packages/vdm/outbound-delivery-service/Return.ts:92
deprecated

since v1.6.0. Use Return.build instead.

Parameters
- json: any
Returns Return

pickAllItems

pickAllItems(parameters: PickAllItemsParameters): FunctionImportRequestBuilder<PickAllItemsParameters, PickingReport[]>

- Defined in packages/vdm/outbound-delivery-service/function-imports.ts:133
Invoke action PickAllItems.

Parameters
- parameters: PickAllItemsParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<PickAllItemsParameters, PickingReport[]>

A request builder that allows to overwrite some of the values and execute the resultng request.

pickOneItem

pickOneItem(parameters: PickOneItemParameters): FunctionImportRequestBuilder<PickOneItemParameters, PickingReport[]>

- Defined in packages/vdm/outbound-delivery-service/function-imports.ts:161
Invoke action PickOneItem.

Parameters
- parameters: PickOneItemParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<PickOneItemParameters, PickingReport[]>

A request builder that allows to overwrite some of the values and execute the resultng request.

postGoodsIssue

postGoodsIssue(parameters: PostGoodsIssueParameters): FunctionImportRequestBuilder<PostGoodsIssueParameters, PickingReport[]>

- Defined in packages/vdm/outbound-delivery-service/function-imports.ts:27
Invoke action PostGoodsIssue.

Parameters
- parameters: PostGoodsIssueParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<PostGoodsIssueParameters, PickingReport[]>

A request builder that allows to overwrite some of the values and execute the resultng request.

reverseGoodsIssue

reverseGoodsIssue(parameters: ReverseGoodsIssueParameters): FunctionImportRequestBuilder<ReverseGoodsIssueParameters, Return[]>

- Defined in packages/vdm/outbound-delivery-service/function-imports.ts:55
Invoke action ReverseGoodsIssue.

Parameters
- parameters: ReverseGoodsIssueParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<ReverseGoodsIssueParameters, Return[]>

A request builder that allows to overwrite some of the values and execute the resultng request.

Object literals

Const functionImports

functionImports: object

confirmPickingAllItems

confirmPickingAllItems: confirmPickingAllItems

confirmPickingOneItem

confirmPickingOneItem: confirmPickingOneItem

pickAllItems

pickAllItems: pickAllItems

pickOneItem

pickOneItem: pickOneItem

postGoodsIssue

postGoodsIssue: postGoodsIssue

reverseGoodsIssue

reverseGoodsIssue: reverseGoodsIssue

@sap/cloud-sdk-vdm-outbound-delivery-service

Helpful Links

Index

Modules

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ReadOutboundDeliveryServiceRequestBuilder

WriteOutboundDeliveryServiceRequestBuilder

Variables

Const defaultOutboundDeliveryServicePath

Functions

batch

Parameters

Rest ...requests: Array<ReadOutboundDeliveryServiceRequestBuilder | ODataBatchChangeSet<WriteOutboundDeliveryServiceRequestBuilder>>

Returns ODataBatchRequestBuilder

changeset

Parameters

Rest ...requests: WriteOutboundDeliveryServiceRequestBuilder[]

Returns ODataBatchChangeSet<WriteOutboundDeliveryServiceRequestBuilder>

confirmPickingAllItems

Parameters

parameters: ConfirmPickingAllItemsParameters

Returns FunctionImportRequestBuilder<ConfirmPickingAllItemsParameters, PickingReport[]>

confirmPickingOneItem

Parameters

parameters: ConfirmPickingOneItemParameters

Returns FunctionImportRequestBuilder<ConfirmPickingOneItemParameters, PickingReport[]>

createPickingReport

Parameters

json: any

Returns PickingReport

createReturn

Parameters

json: any

Returns Return

pickAllItems

Parameters

parameters: PickAllItemsParameters

Returns FunctionImportRequestBuilder<PickAllItemsParameters, PickingReport[]>

pickOneItem

Parameters

parameters: PickOneItemParameters

Returns FunctionImportRequestBuilder<PickOneItemParameters, PickingReport[]>

postGoodsIssue

Parameters

parameters: PostGoodsIssueParameters

Returns FunctionImportRequestBuilder<PostGoodsIssueParameters, PickingReport[]>

reverseGoodsIssue

Parameters

parameters: ReverseGoodsIssueParameters

Returns FunctionImportRequestBuilder<ReverseGoodsIssueParameters, Return[]>

Object literals

Const functionImports

confirmPickingAllItems

confirmPickingOneItem

pickAllItems

pickOneItem

postGoodsIssue

reverseGoodsIssue