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

Interface WarehouseTaskService

All Superinterfaces:

BatchService<WarehouseTaskServiceBatch>

All Known Implementing Classes:

DefaultWarehouseTaskService

public interface WarehouseTaskService
extends BatchService<WarehouseTaskServiceBatch>

In every API call, you can make use of the following operations: - You can retrieve warehouse orders and warehouse tasks. Apply any of the filters provided or retrieve all existing data. - For existing warehouse orders, you can update the corresponding warehouse tasks. - You can update existing warehouse tasks (confirm, confirm with exceptions, cancel). - You can update existing warehouse orders (assign or unassign warehouse order to warehouse resource)..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_WAREHOUSE_ORDER_TASK
API Version:	1
Communication Scenario:	Warehousing - Process Warehouse Task Integration (SAP_COM_0353)
Scope Items:	Resource Management in Warehousing (3W0)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	WarehouseOrder

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH 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
AssignWarehouseOrderFluentHelper	assignWarehouseOrder(String warehouse, String warehouseOrder, String warehouseResource) Creates a fluent helper for the AssignWarehouseOrder OData function import.
CancelWarehouseTaskFluentHelper	cancelWarehouseTask(String warehouse, String warehouseTask, String warehouseTaskItem) Creates a fluent helper for the CancelWarehouseTask OData function import.
ConfirmWarehouseTaskExactFluentHelper	confirmWarehouseTaskExact(String warehouse, String warehouseTask, String warehouseTaskItem) Creates a fluent helper for the ConfirmWarehouseTaskExact OData function import.
ConfirmWarehouseTaskHUFluentHelper	confirmWarehouseTaskHU(String warehouse, String warehouseTask, String warehouseTaskItem, String destinationStorageBin, String whseTaskExCodeDestStorageBin) Creates a fluent helper for the ConfirmWarehouseTaskHU OData function import.
ConfirmWarehouseTaskProductFluentHelper	confirmWarehouseTaskProduct(String warehouse, String warehouseTask, String warehouseTaskItem, String alternativeUnit, BigDecimal actualQuantityInAltvUnit, BigDecimal differenceQuantityInAltvUnit, String whseTaskExceptionCodeQtyDiff, String destinationStorageBin, String whseTaskExCodeDestStorageBin, String sourceHandlingUnit) Creates a fluent helper for the ConfirmWarehouseTaskProduct OData function import.
WarehouseOrderFluentHelper	getAllWarehouseOrder() Fetch multiple WarehouseOrder entities.
WarehouseTaskFluentHelper	getAllWarehouseTask() Fetch multiple WarehouseTask entities.
WarehouseTaskExceptionCodeFluentHelper	getAllWarehouseTaskExceptionCode() Fetch multiple WarehouseTaskExceptionCode entities.
WarehouseOrderByKeyFluentHelper	getWarehouseOrderByKey(String warehouse, String warehouseOrder) Fetch a single WarehouseOrder entity using key fields.
WarehouseTaskByKeyFluentHelper	getWarehouseTaskByKey(String warehouse, String warehouseTask, String warehouseTaskItem) Fetch a single WarehouseTask entity using key fields.
WarehouseTaskExceptionCodeByKeyFluentHelper	getWarehouseTaskExceptionCodeByKey(String warehouse, String warehouseTask, String warehouseTaskItem, String warehouseTaskExceptionCode, String businessContext, String businessContextExecutionStep) Fetch a single WarehouseTaskExceptionCode entity using key fields.
SetInProcessWarehouseOrderFluentHelper	setInProcessWarehouseOrder(String warehouse, String warehouseOrder) Creates a fluent helper for the SetInProcessWarehouseOrder OData function import.
UnassignWarehouseOrderFluentHelper	unassignWarehouseOrder(String warehouse, String warehouseOrder) Creates a fluent helper for the UnassignWarehouseOrder OData function import.
WarehouseTaskService	withServicePath(String servicePath) 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

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

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.

getAllWarehouseOrder

@Nonnull
WarehouseOrderFluentHelper getAllWarehouseOrder()

Fetch multiple WarehouseOrder entities.

Returns:

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

getWarehouseOrderByKey

@Nonnull
WarehouseOrderByKeyFluentHelper getWarehouseOrderByKey(String warehouse,
                                                                String warehouseOrder)

Fetch a single WarehouseOrder entity using key fields.

Parameters:

warehouse - Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.

Constraints: Not nullable, Maximum length: 4

warehouseOrder - Warehouse Order Number

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllWarehouseTask

@Nonnull
WarehouseTaskFluentHelper getAllWarehouseTask()

Fetch multiple WarehouseTask entities.

Returns:

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

getWarehouseTaskByKey

@Nonnull
WarehouseTaskByKeyFluentHelper getWarehouseTaskByKey(String warehouse,
                                                              String warehouseTask,
                                                              String warehouseTaskItem)

Fetch a single WarehouseTask entity using key fields.

Parameters:

warehouseTaskItem - Uniquely identifes a movement within a warehouse task (WT)

Constraints: Not nullable, Maximum length: 4

warehouse - Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.

Constraints: Not nullable, Maximum length: 4

warehouseTask - Number that uniquely identifies the warehouse task within a warehouse.

Constraints: Not nullable, Maximum length: 12

Returns:

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

getAllWarehouseTaskExceptionCode

@Nonnull
WarehouseTaskExceptionCodeFluentHelper getAllWarehouseTaskExceptionCode()

Fetch multiple WarehouseTaskExceptionCode entities.

Returns:

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

getWarehouseTaskExceptionCodeByKey

@Nonnull
WarehouseTaskExceptionCodeByKeyFluentHelper getWarehouseTaskExceptionCodeByKey(String warehouse,
                                                                                        String warehouseTask,
                                                                                        String warehouseTaskItem,
                                                                                        String warehouseTaskExceptionCode,
                                                                                        String businessContext,
                                                                                        String businessContextExecutionStep)

Fetch a single WarehouseTaskExceptionCode entity using key fields.

Parameters:

businessContextExecutionStep - Execution Step in Business Context

Constraints: Not nullable, Maximum length: 2

warehouseTaskItem - Uniquely identifes a movement within a warehouse task (WT)

Constraints: Not nullable, Maximum length: 4

warehouseTaskExceptionCode - Code with which an exception situation in the warehouse can be documented.

Constraints: Not nullable, Maximum length: 4

businessContext - Context in which special exception codes can be made available.

Constraints: Not nullable, Maximum length: 3

warehouse - Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.

Constraints: Not nullable, Maximum length: 4

warehouseTask - Number that uniquely identifies the warehouse task within a warehouse.

Constraints: Not nullable, Maximum length: 12

Returns:

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

assignWarehouseOrder

@Nonnull
AssignWarehouseOrderFluentHelper assignWarehouseOrder(String warehouse,
                                                               String warehouseOrder,
                                                               String warehouseResource)

Creates a fluent helper for the AssignWarehouseOrder OData function import.

Parameters:

warehouseResource - Resource

Constraints: Nullable, Maximum length: 18

Original parameter name from the Odata EDM: WarehouseResource

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

warehouseOrder - Warehouse Order

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: WarehouseOrder

Returns:

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

setInProcessWarehouseOrder

@Nonnull
SetInProcessWarehouseOrderFluentHelper setInProcessWarehouseOrder(String warehouse,
                                                                           String warehouseOrder)

Creates a fluent helper for the SetInProcessWarehouseOrder OData function import.

Parameters:

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

warehouseOrder - Warehouse Order

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: WarehouseOrder

Returns:

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

unassignWarehouseOrder

@Nonnull
UnassignWarehouseOrderFluentHelper unassignWarehouseOrder(String warehouse,
                                                                   String warehouseOrder)

Creates a fluent helper for the UnassignWarehouseOrder OData function import.

Parameters:

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

warehouseOrder - Warehouse Order

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: WarehouseOrder

Returns:

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

cancelWarehouseTask

@Nonnull
CancelWarehouseTaskFluentHelper cancelWarehouseTask(String warehouse,
                                                             String warehouseTask,
                                                             String warehouseTaskItem)

Creates a fluent helper for the CancelWarehouseTask OData function import.

Parameters:

warehouseTaskItem - WT Item

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: WarehouseTaskItem

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

warehouseTask - Warehouse Task

Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: WarehouseTask

Returns:

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

confirmWarehouseTaskExact

@Nonnull
ConfirmWarehouseTaskExactFluentHelper confirmWarehouseTaskExact(String warehouse,
                                                                         String warehouseTask,
                                                                         String warehouseTaskItem)

Creates a fluent helper for the ConfirmWarehouseTaskExact OData function import.

Parameters:

warehouseTaskItem - WT Item

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: WarehouseTaskItem

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

warehouseTask - Warehouse Task

Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: WarehouseTask

Returns:

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

confirmWarehouseTaskHU

@Nonnull
ConfirmWarehouseTaskHUFluentHelper confirmWarehouseTaskHU(String warehouse,
                                                                   String warehouseTask,
                                                                   String warehouseTaskItem,
                                                                   String destinationStorageBin,
                                                                   String whseTaskExCodeDestStorageBin)

Creates a fluent helper for the ConfirmWarehouseTaskHU OData function import.

Parameters:

warehouseTaskItem - WT Item

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: WarehouseTaskItem

destinationStorageBin - Destination Bin

Constraints: Nullable, Maximum length: 18

Original parameter name from the Odata EDM: DestinationStorageBin

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

warehouseTask - Warehouse Task

Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: WarehouseTask

whseTaskExCodeDestStorageBin - Exception Code

Constraints: Nullable, Maximum length: 4

Original parameter name from the Odata EDM: WhseTaskExCodeDestStorageBin

Returns:

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

confirmWarehouseTaskProduct

@Nonnull
ConfirmWarehouseTaskProductFluentHelper confirmWarehouseTaskProduct(String warehouse,
                                                                             String warehouseTask,
                                                                             String warehouseTaskItem,
                                                                             String alternativeUnit,
                                                                             BigDecimal actualQuantityInAltvUnit,
                                                                             BigDecimal differenceQuantityInAltvUnit,
                                                                             String whseTaskExceptionCodeQtyDiff,
                                                                             String destinationStorageBin,
                                                                             String whseTaskExCodeDestStorageBin,
                                                                             String sourceHandlingUnit)

Creates a fluent helper for the ConfirmWarehouseTaskProduct OData function import.

Parameters:

sourceHandlingUnit - Source Handling Unit

Constraints: Nullable, Maximum length: 20

Original parameter name from the Odata EDM: SourceHandlingUnit

whseTaskExceptionCodeQtyDiff - Exception Code

Constraints: Nullable, Maximum length: 4

Original parameter name from the Odata EDM: WhseTaskExceptionCodeQtyDiff

warehouseTaskItem - WT Item

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: WarehouseTaskItem

destinationStorageBin - Destination Bin

Constraints: Nullable, Maximum length: 18

Original parameter name from the Odata EDM: DestinationStorageBin

alternativeUnit - Alt. Unit of Measure

Constraints: Nullable, Maximum length: 3

Original parameter name from the Odata EDM: AlternativeUnit

differenceQuantityInAltvUnit - Difference Quantity

Constraints: Nullable, Precision: 31, Scale: 14

Original parameter name from the Odata EDM: DifferenceQuantityInAltvUnit

actualQuantityInAltvUnit - Actual Quantity

Constraints: Nullable, Precision: 31, Scale: 14

Original parameter name from the Odata EDM: ActualQuantityInAltvUnit

warehouse - Warehouse Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Warehouse

warehouseTask - Warehouse Task

Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: WarehouseTask

whseTaskExCodeDestStorageBin - Exception Code

Constraints: Nullable, Maximum length: 4

Original parameter name from the Odata EDM: WhseTaskExCodeDestStorageBin

Returns:

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