@sap/cloud-sdk-vdm-customer-returns-delivery-service

This package contains the OData VDM for the Customer Returns 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

Interfaces

Type aliases

Variables

defaultCustomerReturnsDeliveryServicePath

Functions

Object literals

functionImports

Type aliases

ReadCustomerReturnsDeliveryServiceRequestBuilder

ReadCustomerReturnsDeliveryServiceRequestBuilder: GetAllRequestBuilder<ReturnsDeliveryAddress> | GetAllRequestBuilder<ReturnsDeliveryDocFlow> | GetAllRequestBuilder<ReturnsDeliveryHeader> | GetAllRequestBuilder<ReturnsDeliveryItem> | GetAllRequestBuilder<ReturnsDeliveryMaintObj> | GetAllRequestBuilder<ReturnsDeliveryPartner> | GetAllRequestBuilder<ReturnsDeliverySrlNmbr> | GetByKeyRequestBuilder<ReturnsDeliveryAddress> | GetByKeyRequestBuilder<ReturnsDeliveryDocFlow> | GetByKeyRequestBuilder<ReturnsDeliveryHeader> | GetByKeyRequestBuilder<ReturnsDeliveryItem> | GetByKeyRequestBuilder<ReturnsDeliveryMaintObj> | GetByKeyRequestBuilder<ReturnsDeliveryPartner> | GetByKeyRequestBuilder<ReturnsDeliverySrlNmbr>

WriteCustomerReturnsDeliveryServiceRequestBuilder

WriteCustomerReturnsDeliveryServiceRequestBuilder: CreateRequestBuilder<ReturnsDeliveryAddress> | UpdateRequestBuilder<ReturnsDeliveryAddress> | DeleteRequestBuilder<ReturnsDeliveryAddress> | CreateRequestBuilder<ReturnsDeliveryDocFlow> | UpdateRequestBuilder<ReturnsDeliveryDocFlow> | DeleteRequestBuilder<ReturnsDeliveryDocFlow> | CreateRequestBuilder<ReturnsDeliveryHeader> | UpdateRequestBuilder<ReturnsDeliveryHeader> | DeleteRequestBuilder<ReturnsDeliveryHeader> | CreateRequestBuilder<ReturnsDeliveryItem> | UpdateRequestBuilder<ReturnsDeliveryItem> | DeleteRequestBuilder<ReturnsDeliveryItem> | CreateRequestBuilder<ReturnsDeliveryMaintObj> | UpdateRequestBuilder<ReturnsDeliveryMaintObj> | DeleteRequestBuilder<ReturnsDeliveryMaintObj> | CreateRequestBuilder<ReturnsDeliveryPartner> | UpdateRequestBuilder<ReturnsDeliveryPartner> | DeleteRequestBuilder<ReturnsDeliveryPartner> | CreateRequestBuilder<ReturnsDeliverySrlNmbr> | UpdateRequestBuilder<ReturnsDeliverySrlNmbr> | DeleteRequestBuilder<ReturnsDeliverySrlNmbr>

Variables

Const defaultCustomerReturnsDeliveryServicePath

defaultCustomerReturnsDeliveryServicePath: "/sap/opu/odata/sap/API_CUSTOMER_RETURNS_DELIVERY_SRV" = "/sap/opu/odata/sap/API_CUSTOMER_RETURNS_DELIVERY_SRV"

Functions

batch

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

- Defined in vdm/customer-returns-delivery-service/BatchRequest.ts:13
Batch builder for operations supported on the [[CustomerReturnsDeliveryService]] service.

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

A request builder for batch.

changeset

changeset(...requests: WriteCustomerReturnsDeliveryServiceRequestBuilder[]): ODataBatchChangeSet

- Defined in vdm/customer-returns-delivery-service/BatchRequest.ts:22
Change set constructor consists of write operations supported on the [[CustomerReturnsDeliveryService]] service.

Parameters
- Rest ...requests: WriteCustomerReturnsDeliveryServiceRequestBuilder[]
  
  The requests of the change set
Returns ODataBatchChangeSet

A change set for batch.

confirmPutawayAllItems

confirmPutawayAllItems(parameters: ConfirmPutawayAllItemsParameters): FunctionImportRequestBuilder<ConfirmPutawayAllItemsParameters, PutawayReport[]>

- Defined in vdm/customer-returns-delivery-service/function-imports.ts:79
Invoke action ConfirmPutawayAllItems.

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

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

confirmPutawayOneItem

confirmPutawayOneItem(parameters: ConfirmPutawayOneItemParameters): FunctionImportRequestBuilder<ConfirmPutawayOneItemParameters, PutawayReport[]>

- Defined in vdm/customer-returns-delivery-service/function-imports.ts:107
Invoke action ConfirmPutawayOneItem.

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

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

createDeliveryMessage

createDeliveryMessage(json: object): DeliveryMessage

- Defined in vdm/customer-returns-delivery-service/DeliveryMessage.ts:91
deprecated

since v1.6.0. Use DeliveryMessage.build instead.

Parameters
- json: object
  - [keys: string]: FieldType
Returns DeliveryMessage

createPutawayReport

createPutawayReport(json: object): PutawayReport

- Defined in vdm/customer-returns-delivery-service/PutawayReport.ts:98
deprecated

since v1.6.0. Use PutawayReport.build instead.

Parameters
- json: object
  - [keys: string]: FieldType
Returns PutawayReport

postGoodsReceipt

postGoodsReceipt(parameters: PostGoodsReceiptParameters): FunctionImportRequestBuilder<PostGoodsReceiptParameters, PutawayReport[]>

- Defined in vdm/customer-returns-delivery-service/function-imports.ts:55
Invoke action PostGoodsReceipt.

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

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

putawayAllItems

putawayAllItems(parameters: PutawayAllItemsParameters): FunctionImportRequestBuilder<PutawayAllItemsParameters, PutawayReport[]>

- Defined in vdm/customer-returns-delivery-service/function-imports.ts:132
Invoke action PutawayAllItems.

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

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

putawayOneItem

putawayOneItem(parameters: PutawayOneItemParameters): FunctionImportRequestBuilder<PutawayOneItemParameters, PutawayReport[]>

- Defined in vdm/customer-returns-delivery-service/function-imports.ts:160
Invoke action PutawayOneItem.

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

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

reverseGoodsReceipt

reverseGoodsReceipt(parameters: ReverseGoodsReceiptParameters): FunctionImportRequestBuilder<ReverseGoodsReceiptParameters, DeliveryMessage[]>

- Defined in vdm/customer-returns-delivery-service/function-imports.ts:30
Invoke action ReverseGoodsReceipt.

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

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

Object literals

Const functionImports

functionImports: object

confirmPutawayAllItems

confirmPutawayAllItems: confirmPutawayAllItems

confirmPutawayOneItem

confirmPutawayOneItem: confirmPutawayOneItem

postGoodsReceipt

postGoodsReceipt: postGoodsReceipt

putawayAllItems

putawayAllItems: putawayAllItems

putawayOneItem

putawayOneItem: putawayOneItem

reverseGoodsReceipt

reverseGoodsReceipt: reverseGoodsReceipt

@sap/cloud-sdk-vdm-customer-returns-delivery-service

Helpful Links

Index

Modules

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ReadCustomerReturnsDeliveryServiceRequestBuilder

WriteCustomerReturnsDeliveryServiceRequestBuilder

Variables

Const defaultCustomerReturnsDeliveryServicePath

Functions

batch

Parameters

Rest ...requests: Array<ReadCustomerReturnsDeliveryServiceRequestBuilder | ODataBatchChangeSet>

Returns ODataBatchRequestBuilder

changeset

Parameters

Rest ...requests: WriteCustomerReturnsDeliveryServiceRequestBuilder[]

Returns ODataBatchChangeSet

confirmPutawayAllItems

Parameters

parameters: ConfirmPutawayAllItemsParameters

Returns FunctionImportRequestBuilder<ConfirmPutawayAllItemsParameters, PutawayReport[]>

confirmPutawayOneItem

Parameters

parameters: ConfirmPutawayOneItemParameters

Returns FunctionImportRequestBuilder<ConfirmPutawayOneItemParameters, PutawayReport[]>

createDeliveryMessage

Parameters

json: object

[keys: string]: FieldType

Returns DeliveryMessage

createPutawayReport

Parameters

json: object

[keys: string]: FieldType

Returns PutawayReport

postGoodsReceipt

Parameters

parameters: PostGoodsReceiptParameters

Returns FunctionImportRequestBuilder<PostGoodsReceiptParameters, PutawayReport[]>

putawayAllItems

Parameters

parameters: PutawayAllItemsParameters

Returns FunctionImportRequestBuilder<PutawayAllItemsParameters, PutawayReport[]>

putawayOneItem

Parameters

parameters: PutawayOneItemParameters

Returns FunctionImportRequestBuilder<PutawayOneItemParameters, PutawayReport[]>

reverseGoodsReceipt

Parameters

parameters: ReverseGoodsReceiptParameters

Returns FunctionImportRequestBuilder<ReverseGoodsReceiptParameters, DeliveryMessage[]>

Object literals

Const functionImports

confirmPutawayAllItems

confirmPutawayOneItem

postGoodsReceipt

putawayAllItems

putawayOneItem

reverseGoodsReceipt