@sap/cloud-sdk-vdm-warehouse-task-service

This package contains the OData VDM for the Warehouse Task Service of SAP S/4HANA Cloud. This service is part of the following communication scenarios: Warehousing - Process Warehouse Task Integration (SAP_COM_0353). You can find additional documentation for this service on help.sap.com.

Helpful Links

Index

Modules

DummyFunctionImportResult

Classes

Interfaces

Type aliases

Variables

defaultWarehouseTaskServicePath

Functions

Object literals

functionImports

Type aliases

ReadWarehouseTaskServiceRequestBuilder

ReadWarehouseTaskServiceRequestBuilder: GetAllRequestBuilder<WarehouseOrder> | GetAllRequestBuilder<WarehouseTask> | GetAllRequestBuilder<WarehouseTaskExceptionCode> | GetByKeyRequestBuilder<WarehouseOrder> | GetByKeyRequestBuilder<WarehouseTask> | GetByKeyRequestBuilder<WarehouseTaskExceptionCode>

WriteWarehouseTaskServiceRequestBuilder

WriteWarehouseTaskServiceRequestBuilder: CreateRequestBuilder<WarehouseOrder> | UpdateRequestBuilder<WarehouseOrder> | DeleteRequestBuilder<WarehouseOrder> | CreateRequestBuilder<WarehouseTask> | UpdateRequestBuilder<WarehouseTask> | DeleteRequestBuilder<WarehouseTask> | CreateRequestBuilder<WarehouseTaskExceptionCode> | UpdateRequestBuilder<WarehouseTaskExceptionCode> | DeleteRequestBuilder<WarehouseTaskExceptionCode>

Variables

Const defaultWarehouseTaskServicePath

defaultWarehouseTaskServicePath: "/sap/opu/odata/sap/cds_api_warehouse_order_task" = "/sap/opu/odata/sap/cds_api_warehouse_order_task"

Functions

assignWarehouseOrder

assignWarehouseOrder(parameters: AssignWarehouseOrderParameters): FunctionImportRequestBuilder<AssignWarehouseOrderParameters, DummyFunctionImportResult>

- Defined in vdm/warehouse-task-service/function-imports.ts:33
Invoke action AssignWarehouseOrder.

Parameters
- parameters: AssignWarehouseOrderParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<AssignWarehouseOrderParameters, DummyFunctionImportResult>

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

batch

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

- Defined in vdm/warehouse-task-service/BatchRequest.ts:13
Batch builder for operations supported on the Warehouse Task Service.

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

A request builder for batch.

cancelWarehouseTask

cancelWarehouseTask(parameters: CancelWarehouseTaskParameters): FunctionImportRequestBuilder<CancelWarehouseTaskParameters, DummyFunctionImportResult>

- Defined in vdm/warehouse-task-service/function-imports.ts:125
Invoke action CancelWarehouseTask.

Parameters
- parameters: CancelWarehouseTaskParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<CancelWarehouseTaskParameters, DummyFunctionImportResult>

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

changeset

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

- Defined in vdm/warehouse-task-service/BatchRequest.ts:22
Change set constructor consists of write operations supported on the Warehouse Task Service.

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

A change set for batch.

confirmWarehouseTaskExact

confirmWarehouseTaskExact(parameters: ConfirmWarehouseTaskExactParameters): FunctionImportRequestBuilder<ConfirmWarehouseTaskExactParameters, DummyFunctionImportResult>

- Defined in vdm/warehouse-task-service/function-imports.ts:159
Invoke action ConfirmWarehouseTaskExact.

Parameters
- parameters: ConfirmWarehouseTaskExactParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<ConfirmWarehouseTaskExactParameters, DummyFunctionImportResult>

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

confirmWarehouseTaskHu

confirmWarehouseTaskHu(parameters: ConfirmWarehouseTaskHuParameters): FunctionImportRequestBuilder<ConfirmWarehouseTaskHuParameters, DummyFunctionImportResult>

- Defined in vdm/warehouse-task-service/function-imports.ts:201
Invoke action ConfirmWarehouseTaskHU.

Parameters
- parameters: ConfirmWarehouseTaskHuParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<ConfirmWarehouseTaskHuParameters, DummyFunctionImportResult>

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

confirmWarehouseTaskProduct

confirmWarehouseTaskProduct(parameters: ConfirmWarehouseTaskProductParameters): FunctionImportRequestBuilder<ConfirmWarehouseTaskProductParameters, DummyFunctionImportResult>

- Defined in vdm/warehouse-task-service/function-imports.ts:265
Invoke action ConfirmWarehouseTaskProduct.

Parameters
- parameters: ConfirmWarehouseTaskProductParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<ConfirmWarehouseTaskProductParameters, DummyFunctionImportResult>

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

createDummyFunctionImportResult

createDummyFunctionImportResult(json: object): DummyFunctionImportResult

- Defined in vdm/warehouse-task-service/DummyFunctionImportResult.ts:21
deprecated

since v1.6.0. Use DummyFunctionImportResult.build instead.

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

setInProcessWarehouseOrder

setInProcessWarehouseOrder(parameters: SetInProcessWarehouseOrderParameters): FunctionImportRequestBuilder<SetInProcessWarehouseOrderParameters, DummyFunctionImportResult>

- Defined in vdm/warehouse-task-service/function-imports.ts:63
Invoke action SetInProcessWarehouseOrder.

Parameters
- parameters: SetInProcessWarehouseOrderParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<SetInProcessWarehouseOrderParameters, DummyFunctionImportResult>

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

unassignWarehouseOrder

unassignWarehouseOrder(parameters: UnassignWarehouseOrderParameters): FunctionImportRequestBuilder<UnassignWarehouseOrderParameters, DummyFunctionImportResult>

- Defined in vdm/warehouse-task-service/function-imports.ts:92
Invoke action UnassignWarehouseOrder.

Parameters
- parameters: UnassignWarehouseOrderParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<UnassignWarehouseOrderParameters, DummyFunctionImportResult>

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

Object literals

Const functionImports

functionImports: object

assignWarehouseOrder

assignWarehouseOrder: assignWarehouseOrder

cancelWarehouseTask

cancelWarehouseTask: cancelWarehouseTask

confirmWarehouseTaskExact

confirmWarehouseTaskExact: confirmWarehouseTaskExact

confirmWarehouseTaskHu

confirmWarehouseTaskHu: confirmWarehouseTaskHu

confirmWarehouseTaskProduct

confirmWarehouseTaskProduct: confirmWarehouseTaskProduct

setInProcessWarehouseOrder

setInProcessWarehouseOrder: setInProcessWarehouseOrder

unassignWarehouseOrder

unassignWarehouseOrder: unassignWarehouseOrder

@sap/cloud-sdk-vdm-warehouse-task-service

Helpful Links

Index

Modules

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ReadWarehouseTaskServiceRequestBuilder

WriteWarehouseTaskServiceRequestBuilder

Variables

Const defaultWarehouseTaskServicePath

Functions

assignWarehouseOrder

Parameters

parameters: AssignWarehouseOrderParameters

Returns FunctionImportRequestBuilder<AssignWarehouseOrderParameters, DummyFunctionImportResult>

batch

Parameters

Rest ...requests: Array<ReadWarehouseTaskServiceRequestBuilder | ODataBatchChangeSet<WriteWarehouseTaskServiceRequestBuilder>>

Returns ODataBatchRequestBuilder

cancelWarehouseTask

Parameters

parameters: CancelWarehouseTaskParameters

Returns FunctionImportRequestBuilder<CancelWarehouseTaskParameters, DummyFunctionImportResult>

changeset

Parameters

Rest ...requests: WriteWarehouseTaskServiceRequestBuilder[]

Returns ODataBatchChangeSet<WriteWarehouseTaskServiceRequestBuilder>

confirmWarehouseTaskExact

Parameters

parameters: ConfirmWarehouseTaskExactParameters

Returns FunctionImportRequestBuilder<ConfirmWarehouseTaskExactParameters, DummyFunctionImportResult>

confirmWarehouseTaskHu

Parameters

parameters: ConfirmWarehouseTaskHuParameters

Returns FunctionImportRequestBuilder<ConfirmWarehouseTaskHuParameters, DummyFunctionImportResult>

confirmWarehouseTaskProduct

Parameters

parameters: ConfirmWarehouseTaskProductParameters

Returns FunctionImportRequestBuilder<ConfirmWarehouseTaskProductParameters, DummyFunctionImportResult>

createDummyFunctionImportResult

Parameters

json: object

[keys: string]: FieldType

Returns DummyFunctionImportResult

setInProcessWarehouseOrder

Parameters

parameters: SetInProcessWarehouseOrderParameters

Returns FunctionImportRequestBuilder<SetInProcessWarehouseOrderParameters, DummyFunctionImportResult>

unassignWarehouseOrder

Parameters

parameters: UnassignWarehouseOrderParameters

Returns FunctionImportRequestBuilder<UnassignWarehouseOrderParameters, DummyFunctionImportResult>

Object literals

Const functionImports

assignWarehouseOrder

cancelWarehouseTask

confirmWarehouseTaskExact

confirmWarehouseTaskHu

confirmWarehouseTaskProduct

setInProcessWarehouseOrder

unassignWarehouseOrder