Create one pick wave

post

/fscmRestApi/resources/11.13.18.05/pickWaves

Request

Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Flexfields for Pick Waves
Type: array
Title: Flexfields for Pick Waves
The Flexfields for Pick Waves resource manages the descriptive flexfield context name for pick waves.
Show Source
Nested Schema : pickWaves-DFF-item-post-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : pickWaves-item-response
Type: object
Show Source
Nested Schema : Flexfields for Pick Waves
Type: array
Title: Flexfields for Pick Waves
The Flexfields for Pick Waves resource manages the descriptive flexfield context name for pick waves.
Show Source
Nested Schema : pickWaves-DFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to create one pick wave.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/pickWaves"

Example Request Body 1

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{            
	"SourceSystemName": "PIMDH",
	"BatchPrefix": "RESTL",
	"ReleaseRule": "M1 High Priority",
	"ShipFromOrganizationCode": "M1",                    
	"ReleaseSubinventory": "Stores",
	"ReleaseStatus": "Unreleased",
	"OrderType": "Sales order",
	"OrderNumber": "AAA_SO_3",
	"Customer": "Computer Service and Rentals",
	"PriorReservationsOnlyFlag": true,            
	"FromScheduledShipDate": "2018-10-24T00:00:00+05:30",
	"ToScheduledShipDate": "2018-10-25T00:00:00+05:30",            
	"FromRequestedDate": "2018-10-24T00:00:00+05:30",
	"ToRequestedDate": "2018-10-25T00:00:00+05:30",
	"CarrierPartyName": "Velog",
	"ModeOfTransport": "Air",
	"ServiceLevel": "Next day air",
	"ShipmentLine": 3641626,            
	"IncludeAssignedLinesFlag": true,
	"TransportationShipment": "A123",            
	"InitialDestinationId": 24256,
	"CatalogName": "Inventory",
	"CategoryName": "Flow Assembly",
	"ItemNumber": "AS54888",            
	"PickFromSubinventory": "CYCSUB01",
	"PickFromLocator": "CYC1.1.1",            
	"StagingSubinventory": "ABCSUB01",
	"StagingLocator": "ABC1.1.1",            
	"ReleaseSequenceRule": "All Standard Orders",
	"PickSlipGroupingRule": "Departure, Delivery",            
	"AutoPickConfirmFlag": true,
	"TradeComplianceMethod": "NONE",
	"ShipConfirmRule": "DOO-RT-AutoShipRule",
	"CreateShipmentsFlag": true,            
	"ShipmentCreationCriteria": "Across orders",
	"AutomaticallyPackFlag": true
}

Example Response Body 1

The following example includes the contents of the response body in JSON format:

{
	"SourceSystemName": "PIMDH",
	"BatchPrefix": "RESTL",
	"BatchId": 5392106,
	"PickingBatchName": "RESTL-5392106",
	"ReleaseRuleId": 100000020219004,
	"ReleaseRule": "M1 High Priority",
	"ShipFromOrganizationId": 207,
	"ShipFromOrganizationCode": "M1",
	"ShipFromOrganizationName": null,
	"ReleaseSubinventory": "Stores",
	"ReleaseStatusCode": "E",
	"ReleaseStatus": "Unreleased",
	"OrderTypeCode": "SALES_ORDER",
	"OrderType": "Sales order",
	"OrderId": 408729,
	"OrderNumber": "AAA_SO_31",
	"CustomerId": 1006,
	"Customer": "Computer Service and Rentals",
	"ShipSetName": null,
	"DestinationTypeCode": "S",
	"DestinationType": "Ship to",
	"GeographyId": null,
	"Geography": null,
	"ShipToLocationId": null, 
	"ShipToNumber": null,
	"ShipToAddress1": null,
	"ShipToAddress2": null,
	"ShipToAddress3": null,
	"ShipToAddress4": null,
	"ShipToCity": null,
	"ShipToState": null,
	"ShipToCountry": null,
	"ShipToPostalCode": null,
	"ShipToRegion": null,
	"ShipToLocationCode": null,
	"ShipToLocation": null,
	"ZoneId": null,
	"Zone": null,
	"PriorReservationsOnlyFlag": "true",
	"FromScheduledShipDate": "2018-10-23T18:30:00+00:00",
	"ToScheduledShipDate": "2018-10-24T18:30:00+00:00",
	"FromRequestedDate": "2018-10-23T18:30:00+00:00",
	"ToRequestedDate": "2018-10-24T18:30:00+00:00",
	"CarrierPartyNumber": "21805",
	"CarrierPartyName": "Velog",
	"ModeOfTransportCode": "AIR",
	"ModeOfTransport": "Air",
	"ServiceLevelCode": "1DA",
	"ServiceLevel": "Next day air",
	"ShipMethodCode": "000001_Velog_A_1DA",
	"ShipMethod": "Velog-A123-Next day air",
	"ShipmentPriorityCode": null,
	"ShipmentPriority": null,
	"ShipmentId": null,
	"Shipment": null,
	"ShipmentLine": null,
	"PackingUnitId": null,
	"PackingUnit": null,
	"IncludeAssignedLinesFlag": "true",
	"TransportationShipment": "A123",
	"InitialDestinationId": 24256,
	"InitialDestinationAddress1": "Bandra Complex",
	"InitialDestinationAddress2": "Mumbai",
	"InitialDestinationAddress3": null,
	"InitialDestinationAddress4": null,
	"InitialDestinationCountry": "IN",
	"InitialDestinationCity": "Mumbai",
	"InitialDestinationPostalCode": null,
	"InitialDestinationState": "Maharastra",
	"InitialDestinationProvince": null,
	"InitialDestination": "Bandra Complex,Mumbai,MUMBAI,Maharastra,INDIA",
	"CatalogId": 1,
	"CatalogName": "Inventory",
	"CategoryId": 115,
	"CategoryName": "Flow Assembly",
	"InventoryItemId": 149,
	"ItemNumber": "AS54888",
	"ItemDescription": null,
	"PickFromSubinventory": "CYCSUB01",
	"PickFromLocatorId": 3136,
	"PickFromLocator": "CYC1.1.1",
	"StagingSubinventory": "ABCSUB01",
	"StagingLocatorId": 3134,
	"StagingLocator": "ABC1.1.1",
	"ReleaseSequenceRuleId": 1000,
	"ReleaseSequenceRule": "All Standard Orders",
	"PickSlipGroupingRuleId": 1201,
	"PickSlipGroupingRule": "Departure, Delivery",
	"AutoPickConfirmFlag": "true",
	"TradeComplianceMethod": "NONE",
	"ShipConfirmRuleId": 100000019815012,
	"ShipConfirmRule": "DOO-RT-AutoShipRule",
	"ActualShipDate": null,
	"CreateShipmentsFlag": "true",
	"ShipmentCreationCriteriaCode": "N",
	"ShipmentCreationCriteria": "Across orders",
	"AutomaticallyPackFlag": "true",
	"AppendShipmentsFlag": "false",
	"CreatedBy": "WHSE_MGR_M1",
	"CreationDate": "2018-11-12T12:52:09.058+00:00",
	"PickReleaseFlag": null,
	"ReleaseMode": null,
	"ReturnStatus": "S",
	"ReturnMessage": "The pick wave was created."
}

Example Request Body 2

The following example includes the contents of the request body in JSON format to create pick wave with release mode set to ONLINE. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"SourceSystemName": "PIMDH",
	"BatchPrefix": "RESTL",            
	"ShipFromOrganizationCode": "M1",  
	"ReleaseStatus": "Unreleased",
	"OrderType": "Sales order",
	"OrderNumber": "AAA_SO_40",
	"StagingSubinventory": "Stores",            
	"ReleaseSequenceRule": "All Standard Orders",
	"PickSlipGroupingRule": "Departure, Delivery",            
	"AutoPickConfirmFlag": true,
	"TradeComplianceMethod": "NONE",
	"ShipConfirmRule": "Auto Ship",            
	"CreateShipmentsFlag": "true",    
	"ShipmentCreationCriteria": "Within an order",
	"AutomaticallyPackFlag": "false",            
	"AppendShipmentsFlag": "false",
	"PickReleaseFlag": true,
	"ReleaseMode": "ONLINE"
}


Example Response Body 2

The following example includes the contents of the response body in JSON format:

{
	"SourceSystemName": "PIMDH",
	"BatchPrefix": "RESTL",
	"BatchId": 5392109,
	"PickingBatchName": "RESTL-5392109",
	"ReleaseRuleId": 100000020219004,
	"ReleaseRule": "M1 High Priority",
	"ShipFromOrganizationId": 207,
	"ShipFromOrganizationCode": "M1",
	"ShipFromOrganizationName": null,
	"ReleaseSubinventory": "Stores",
	"ReleaseStatusCode": "E",
	"ReleaseStatus": "Unreleased",
	"OrderTypeCode": "SALES_ORDER",
	"OrderType": "Sales order",
	"OrderId": 408730,
	"OrderNumber": "AAA_SO_32",
	"CustomerId": 1006,
	"Customer": "Computer Service and Rentals",
	"ShipSetName": null,
	"DestinationTypeCode": "S",
	"DestinationType": "Ship to",
	"GeographyId": null,
	"Geography": null,
	"ShipToLocationId": null, 
	"ShipToAddress1": null,
	"ShipToAddress2": null,
	"ShipToAddress3": null,
	"ShipToAddress4": null,
	"ShipToCity": null,
	"ShipToState": null,
	"ShipToCountry": null,
	"ShipToPostalCode": null,
	"ShipToRegion": null,
	"ShipToLocationCode": null,
	"ShipToLocation": null,
	"ZoneId": null,
	"Zone": null,
	"PriorReservationsOnlyFlag": "true",
	"FromScheduledShipDate": "2018-10-23T18:30:00+00:00",
	"ToScheduledShipDate": "2018-10-24T18:30:00+00:00",
	"FromRequestedDate": "2018-10-23T18:30:00+00:00",
	"ToRequestedDate": "2018-10-24T18:30:00+00:00",
	"CarrierPartyNumber": "21805",
	"CarrierPartyName": "Velog",
	"ModeOfTransportCode": "AIR",
	"ModeOfTransport": "Air",
	"ServiceLevelCode": "1DA",
	"ServiceLevel": "Next day air",
	"ShipMethodCode": "000001_Velog_A_1DA",
	"ShipMethod": "Velog-A123-Next day air",
	"ShipmentPriorityCode": null,
	"ShipmentPriority": null,
	"ShipmentId": null,
	"Shipment": null,
	"ShipmentLine": null,
	"PackingUnitId": null,
	"PackingUnit": null,
	"IncludeAssignedLinesFlag": "true",
	"TransportationShipment": "A123",
	"InitialDestinationId": 24256,
	"InitialDestinationAddress1": "Bandra Complex",
	"InitialDestinationAddress2": "Mumbai",
	"InitialDestinationAddress3": null,
	"InitialDestinationAddress4": null,
	"InitialDestinationCountry": "IN",
	"InitialDestinationCity": "Mumbai",
	"InitialDestinationPostalCode": null,
	"InitialDestinationState": "Maharastra",
	"InitialDestinationProvince": null,
	"InitialDestination": "Bandra Complex,Mumbai,MUMBAI,Maharastra,INDIA",
	"CatalogId": 1,
	"CatalogName": "Inventory",
	"CategoryId": 115,
	"CategoryName": "Flow Assembly",
	"InventoryItemId": 149,
	"ItemNumber": "AS54888",
	"ItemDescription": null,
	"PickFromSubinventory": "CYCSUB01",
	"PickFromLocatorId": 3136,
	"PickFromLocator": "CYC1.1.1",
	"StagingSubinventory": "ABCSUB01",
	"StagingLocatorId": 3134,
	"StagingLocator": "ABC1.1.1",
	"ReleaseSequenceRuleId": 1000,
	"ReleaseSequenceRule": "All Standard Orders",
	"PickSlipGroupingRuleId": 1201,
	"PickSlipGroupingRule": "Departure, Delivery",
	"AutoPickConfirmFlag": "true",
	"TradeComplianceMethod": "NONE",
	"ShipConfirmRuleId": 100000019815012,
	"ShipConfirmRule": "DOO-RT-AutoShipRule",
	"ActualShipDate": null,
	"CreateShipmentsFlag": "true",
	"ShipmentCreationCriteriaCode": "N",
	"ShipmentCreationCriteria": "Across orders",
	"AutomaticallyPackFlag": "true",
	"AppendShipmentsFlag": "false",
	"CreatedBy": "WHSE_MGR_M1",
	"CreationDate": "2018-11-12T12:59:24.016+00:00",
	"PickReleaseFlag": null,
	"ReleaseMode": null,
	"ReturnStatus": "S",
	"ReturnMessage": "The pick wave was created."
}

Example Request Body 3

The following example includes the contents of the request body in JSON format to create pick wave with release mode set to CONCURRENT. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"SourceSystemName": "PIMDH",
	"BatchPrefix": "RESTL",            
	"ShipFromOrganizationCode": "M1",  
	"ReleaseStatus": "Unreleased",
	"OrderType": "Sales order",
	"OrderNumber": "AAA_SO_41",
	"StagingSubinventory": "Stores",            
	"ReleaseSequenceRule": "All Standard Orders",
	"PickSlipGroupingRule": "Departure, Delivery",            
	"AutoPickConfirmFlag": true,
	"TradeComplianceMethod": "NONE",
	"ShipConfirmRule": "Auto Ship",            
	"CreateShipmentsFlag": "true",    
	"ShipmentCreationCriteria": "Within an order",
	"AutomaticallyPackFlag": "false",            
	"AppendShipmentsFlag": "false",
	"PickReleaseFlag": true,
	"ReleaseMode": "CONCURRENT"
}



Example Response Body 3

The following example includes the contents of the response body in JSON format:

{
	"SourceSystemName": "PIMDH",
	"BatchPrefix": "RESTL",
	"BatchId": 5392115,
	"PickingBatchName": "RESTL-5392115",
	"ReleaseRuleId": null,
	"ReleaseRule": null,
	"ShipFromOrganizationId": 207,
	"ShipFromOrganizationCode": "M1",
	"ShipFromOrganizationName": null,
	"ReleaseSubinventory": null,
	"ReleaseStatusCode": "E",
	"ReleaseStatus": "Unreleased",
	"OrderTypeCode": "SALES_ORDER",
	"OrderType": "Sales order",
	"OrderId": 408732,
	"OrderNumber": "AAA_SO_41",
	"CustomerId": 1006,
	"Customer": null,
	"ShipSetName": null,
	"DestinationTypeCode": "S",
	"DestinationType": "Ship to",
	"GeographyId": null,
	"Geography": null,
	"ShipToLocationId": null,
	"ShipToAddress1": null,
	"ShipToAddress2": null,
	"ShipToAddress3": null,
	"ShipToAddress4": null,
	"ShipToCity": null,
	"ShipToState": null,
	"ShipToCountry": null,
	"ShipToPostalCode": null,
	"ShipToRegion": null,
	"ShipToLocationCode": null,
	"ShipToLocation": null,
	"ZoneId": null,
	"Zone": null,
	"PriorReservationsOnlyFlag": "false",
	"FromScheduledShipDate": null,
	"ToScheduledShipDate": null,
	"FromRequestedDate": null,
	"ToRequestedDate": null,
	"CarrierPartyNumber": null,
	"CarrierPartyName": null,
	"ModeOfTransportCode": null,
	"ModeOfTransport": null,
	"ServiceLevelCode": null,
	"ServiceLevel": null,
	"ShipMethodCode": null,
	"ShipMethod": null,
	"ShipmentPriorityCode": null,
	"ShipmentPriority": null,
	"ShipmentId": null,
	"Shipment": null,
	"ShipmentLine": null,
	"PackingUnitId": null,
	"PackingUnit": null,
	"IncludeAssignedLinesFlag": "false",
	"TransportationShipment": null,
	"InitialDestinationId": null,
	"InitialDestinationAddress1": null,
	"InitialDestinationAddress2": null,
	"InitialDestinationAddress3": null,
	"InitialDestinationAddress4": null,
	"InitialDestinationCountry": null,
	"InitialDestinationCity": null,
	"InitialDestinationPostalCode": null,
	"InitialDestinationState": null,
	"InitialDestinationProvince": null,
	"InitialDestination": null,
	"CatalogId": null,
	"CatalogName": null,
	"CategoryId": null,
	"CategoryName": null,
	"InventoryItemId": null,
	"ItemNumber": null,
	"ItemDescription": null,
	"PickFromSubinventory": null,
	"PickFromLocatorId": null,
	"PickFromLocator": null,
	"StagingSubinventory": "Stores",
	"StagingLocatorId": null,
	"StagingLocator": null,
	"ReleaseSequenceRuleId": 1000,
	"ReleaseSequenceRule": "All Standard Orders",
	"PickSlipGroupingRuleId": 1201,
	"PickSlipGroupingRule": "Departure, Delivery",
	"AutoPickConfirmFlag": "true",
	"TradeComplianceMethod": "NONE",
	"ShipConfirmRuleId": 1,
	"ShipConfirmRule": "Auto Ship",
	"ActualShipDate": null,
	"CreateShipmentsFlag": "true",
	"ShipmentCreationCriteriaCode": "Y",
	"ShipmentCreationCriteria": "Within an order",
	"AutomaticallyPackFlag": "false",
	"AppendShipmentsFlag": "false",
	"CreatedBy": "WHSE_MGR_M1",
	"CreationDate": "2018-11-12T13:21:22.025+00:00",
	"PickReleaseFlag": "true",
	"ReleaseMode": "CONCURRENT",
	"ReturnStatus": "S",
	"ReturnMessage": "Pick wave RESTL-5392115 was scheduled with request ID 6756789."
}
Back to Top