Get one pick wave
get
/fscmRestApi/resources/11.13.18.05/pickWaves/{BatchId}
Request
Path Parameters
-
BatchId(required): integer(int64)
Value that uniquely identifies the pick wave.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : pickWaves-item-response
Type:
Show Source
object
-
ActualShipDate: string
(date-time)
Title:
Actual Ship Date
Date with time when the shipment was actually sent. -
AppendShipmentsFlag: boolean
Contains one of the following values: true or false. If true, then add lines to the existing shipments. If false, then do not add lines to the existing shipments. The default value is false.
-
AutomaticallyPackFlag: boolean
Contains one of the following values: true or false. If true, then shipment lines are packed automatically. If false, then shipment lines are not packed automatically. The default value is false.
-
AutoPickConfirmFlag: boolean
Contains one of the following values: true or false. If true, then automatically confirm the pick transactions. If false, then do not automatically confirm the pick transactions. The default value is false.
-
BatchId: integer
(int64)
Read Only:
true
Value that uniquely identifies the pick wave. -
BatchPrefix: string
Prefix attached in front of the pick wave number.
-
CarrierPartyName: string
Maximum Length:
255
Name of the carrier. -
CarrierPartyNumber: string
Number that uniquely identifies the carrier.
-
CatalogId: integer
(int64)
Value that uniquely identifies the catalog.
-
CatalogName: string
Maximum Length:
255
Name that determines the catalog. -
CategoryId: integer
(int64)
Value that uniquely identifies the item category.
-
CategoryName: string
Maximum Length:
255
Name that determines the item category. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the pick wave. -
CreateShipmentsFlag: boolean
Contains one of the following values: true or false. If true, then automatically assign released shipment lines to a shipment. If false, then do not automatically assign released shipment lines to a shipment. The default value is false.
-
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the pick wave. -
Customer: string
Maximum Length:
255
Name of the customer. -
CustomerId: integer
(int64)
Title:
Customer
Value that identifies the customer. -
DestinationType: string
Value that determines the type of the destination. A list of accepted values is defined in the lookup type WSH_DESTINATION_TYPE_CODE.
-
DestinationTypeCode: string
Title:
Destination Type
Default Value:S
Value that identifies the type of the destination. A list of accepted values is defined in the lookup type WSH_DESTINATION_TYPE_CODE. -
DFF: array
Flexfields for Pick Waves
Title:
Flexfields for Pick Waves
The Flexfields for Pick Waves resource manages the descriptive flexfield context name for pick waves. -
FromRequestedDate: string
(date-time)
Title:
From Requested Date
Start date and time in a range of dates when the customer requested to ship the goods. -
FromScheduledShipDate: string
(date-time)
Title:
From Scheduled Ship Date
Start date and time in a range of dates when the customer scheduled to ship the goods. -
Geography: string
Value that determines the predefined administrative regions or geographies such as cities or states, a specified district or territory.
-
GeographyId: integer
(int64)
Title:
Geography
Value that uniquely identifies the predefined administrative regions or geographies such as cities or states, a specified district or territory. -
IncludeAssignedLinesFlag: boolean
Contains one of the following values: true or false. If true, then include lines already assigned to a shipment in the pick wave. If false, then do not include lines already assigned to a shipment in the pick wave. The default value is false.
-
InitialDestination: string
Read Only:
true
Name that identifies the destination location of the initial leg of the transportation planned to deliver the shipment to the final destination. -
InitialDestinationAddress1: string
First line of the initial destination address.
-
InitialDestinationAddress2: string
Second line of the initial destination address.
-
InitialDestinationAddress3: string
Third line of the initial destination address.
-
InitialDestinationAddress4: string
Fourth line of the initial destination address.
-
InitialDestinationCity: string
City of the initial destination address.
-
InitialDestinationCountry: string
County of the initial destination address.
-
InitialDestinationId: integer
(int64)
Value that uniquely identifies the destination location of the initial leg of the transportation planned to deliver the shipment to the final destination.
-
InitialDestinationPostalCode: string
Postal code of the initial destination address.
-
InitialDestinationProvince: string
Province of the initial destination address.
-
InitialDestinationState: string
State of the initial destination address.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory Item.
-
ItemDescription: string
Read Only:
true
Maximum Length:255
Description of the item. -
ItemNumber: string
Maximum Length:
255
Number that identifies the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModeOfTransport: string
Maximum Length:
255
Value that determines the mode of transportation used for the movement of goods. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. -
ModeOfTransportCode: string
Abbreviation that identifies the mode of transportation used for the movement of goods. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT.
-
OrderId: integer
(int64)
Title:
Order
Value that uniquely identifies the sales order, or transfer order, or transfer order return. -
OrderNumber: string
Maximum Length:
255
Number that identifies the sales order, or transfer order, or transfer order return. -
OrderType: string
Maximum Length:
255
Value that determines the type of order. A list of accepted values is defined in the lookup type ORA_WSH_ORDER_LINE_TYPE. -
OrderTypeCode: string
Title:
Order Type
Maximum Length:100
Value that identifies the type of order. A list of accepted values is defined in the lookup type ORA_WSH_ORDER_LINE_TYPE. -
PackingUnit: string
Maximum Length:
255
Value that determines the packing unit. -
PackingUnitId: integer
Title:
Packing Unit
Value that uniquely identifies the packing unit. -
PickFromLocator: string
Maximum Length:
255
Name that identifies the locator from where to pick on a pick wave. -
PickFromLocatorId: integer
(int64)
Title:
Pick-from Locator
Value that uniquely identifies the locator from where to pick release. -
PickFromSubinventory: string
Title:
Pick-from Subinventory
Maximum Length:10
Name of the subinventory from where to pick release. -
PickingBatchName: string
Title:
Pick Wave
Read Only:true
Maximum Length:30
Name of the pick wave. -
PickReleaseFlag: boolean
Contains one of the following values: true or false. If true, then release the pick wave along with the pick wave creation. If false, then do not pick release the pick wave. The default value is false.
-
PickSlipGroupingRule: string
Maximum Length:
255
Value of the criteria to determine the grouping of picks into pick slips. -
PickSlipGroupingRuleId: integer
(int64)
Title:
Pick Slip Grouping Rule
Value that uniquely identifies the criteria to determine the grouping of picks into pick slips. -
PriorReservationsOnlyFlag: boolean
Contains one of the following values: true or false. If true, then release existing reservations. If false, then do not release existing reservations. The default value is false.
-
ProjectCostingProjectId: integer
(int64)
Value that uniquely identifies the project for standardized project cost collection. This attribute is not currently used.
-
ProjectCostingProjectName: string
Read Only:
true
Maximum Length:240
Name of the project for standardized project cost collection. This attribute is not currently used. -
ProjectCostingProjectNumber: string
Maximum Length:
255
Number that identifies the project for standardized project cost collection. This attribute is not currently used. -
ProjectCostingTaskId: integer
(int64)
Value that uniquely identifies the task for standardized project cost collection. This attribute is not currently used.
-
ProjectCostingTaskName: string
Read Only:
true
Maximum Length:255
Name of the task for standardized project cost collection. This attribute is not currently used. -
ProjectCostingTaskNumber: string
Maximum Length:
255
Number that identifies the task for standardized project cost collection. This attribute is not currently used. -
ReleaseMode: string
Value that determines whether to release pick wave immediately or add it to a release schedule. Valid values are ONLINE and CONCURRENT.
-
ReleaseRule: string
Maximum Length:
255
Name of the pick wave release rule that determines which shipment lines are selected for a pick wave. -
ReleaseRuleId: integer
(int64)
Title:
Release Rule
Value that uniquely identifies the pick wave release rule used to determine the shipment lines and processing details for the pick wave. -
ReleaseSequenceRule: string
Maximum Length:
255
Value that determines the sequencing of shipment lines for pick release. -
ReleaseSequenceRuleId: integer
(int64)
Title:
Release Sequence Rule
Value that uniquely identifies the sequencing of shipment lines for pick release. -
ReleaseStatus: string
Maximum Length:
255
Value that determines the release status. A list of accepted values is defined in the lookup type WSH_BACKORDERS_FLAG. -
ReleaseStatusCode: string
Title:
Release Status
Maximum Length:1
Value that identifies the release status. A list of accepted values is defined in the lookup type WSH_BACKORDERS_FLAG. -
ReleaseSubinventory: string
Maximum Length:
10
Name of the subinventory to source the material on shipment lines. -
ReturnMessage: string
Read Only:
true
Text of the return message when processing the request. -
ReturnStatus: string
Read Only:
true
Status of the current service call. -
ServiceLevel: string
Maximum Length:
255
Value that determines the priority of transportation that affects how quickly goods are transported. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. -
ServiceLevelCode: string
Abbreviation that identifies the priority of transportation that affects how quickly goods are transported. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS.
-
ShipConfirmRule: string
Maximum Length:
255
Value that identifies the rules used on the shipment lines and shipment during ship confirmation. -
ShipConfirmRuleId: integer
(int64)
Title:
Ship Confirm Rule
Value that uniquely identifies the rules used on the shipment lines and shipment at ship confirmation. -
ShipFromOrganizationCode: string
Maximum Length:
255
Value that identifies the originating organization of the goods that are shipped. -
ShipFromOrganizationId: integer
(int64)
Title:
Ship-from Organization
Value that uniquely identifies the originating organization of the goods that are shipped. -
ShipFromOrganizationName: string
Maximum Length:
255
Name of the originating organization of the goods that are shipped. -
Shipment: string
Maximum Length:
255
Value that determines the shipment to pick release. -
ShipmentCreationCriteria: string
Maximum Length:
255
Value that determines the criteria for grouping shipment lines into shipments. A list of accepted values is defined in the lookup type WSH_AC_DEL_CRITERIA. -
ShipmentCreationCriteriaCode: string
Title:
Shipment Creation Criteria
Maximum Length:2
Abbreviation that identifies the criteria for grouping shipment lines into shipments. A list of accepted values is defined in the lookup type WSH_AC_DEL_CRITERIA. -
ShipmentId: integer
(int64)
Title:
Shipment
Value that uniquely identifies the shipment to pick release. -
ShipmentLine: integer
(int64)
Title:
Shipment Line
Value that identifies the shipment to pick release. -
ShipmentPriority: string
Maximum Length:
255
Value that indicates the priority of the shipment. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. -
ShipmentPriorityCode: string
Title:
Shipping Priority
Maximum Length:30
Abbreviation that identifies the shipment priority. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. -
ShipMethod: string
Value that indicates the method of shipping.
-
ShipMethodCode: string
Maximum Length:
30
Abbreviation that identifies the shipping method. -
ShipSetName: string
Title:
Shipment Set
Maximum Length:150
Name of the ship set to be picked. -
ShipToAddress1: string
Read Only:
true
First line of the ship-to customer address. -
ShipToAddress2: string
Read Only:
true
Second line of the ship-to customer address. -
ShipToAddress3: string
Read Only:
true
Third line of the ship-to customer address. -
ShipToAddress4: string
Read Only:
true
Fourth line of the ship-to customer address. -
ShipToCity: string
Read Only:
true
City of the ship-to customer address. -
ShipToCountry: string
Read Only:
true
Country of the ship-to customer address. -
ShipToLocation: string
Maximum Length:
255
Value that determines the customer location where a supplier sends shipments of goods and services. -
ShipToLocationCode: string
Abbreviation that identifies the ship-to location.
-
ShipToLocationId: integer
(int64)
Title:
Ship-to Location
Value that uniquely identifies the customer location where a supplier sends shipments of goods and services. -
ShipToNumber: string
Maximum Length:
255
Party site number of the ship-to customer address. -
ShipToPostalCode: string
Read Only:
true
Postal code of the ship-to customer address. -
ShipToRegion: string
Read Only:
true
Region of the ship-to customer address. -
ShipToState: string
Read Only:
true
State of the ship-to customer address. -
SourceSystemName: string
Name of source application.
-
StagingLocator: string
Maximum Length:
255
Value that identifies the default locator where picked lines are staged. -
StagingLocatorId: integer
(int64)
Title:
Staging Locator
Value that identifies the default locator where picked lines are staged. -
StagingSubinventory: string
Title:
Staging Subinventory
Maximum Length:10
Value that identifies the default subinventory where picked lines are staged. -
ToRequestedDate: string
(date-time)
Title:
To Requested Date
Last date and time in a range of dates when the customer requested to ship the goods. -
ToScheduledShipDate: string
(date-time)
Title:
To Scheduled Ship Date
Last date and time in a range of dates when the customer scheduled to ship the goods. -
TradeComplianceMethod: string
Title:
Trade Compliance Screening Method
Maximum Length:30
Abbreviation that identifies the method used for the line to be screened for trade compliance. -
TransportationShipment: string
Title:
Transportation Shipment
Maximum Length:101
Value that indicates a shipment planned by the transportation management application. -
Zone: string
Maximum Length:
255
Value that determines the geographic region, such as a country or a range of postal codes. For example, a carrier may define a zone Western Europe that includes France, Italy, and England. -
ZoneId: integer
(int64)
Title:
Zone
Value that uniquely identifies the geographic region, such as a country or a range of postal codes. For example, a carrier may define a zone Western Europe that includes France, Italy, and England.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : pickWaves-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield for context name for pick waves. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
BatchId: integer
(int64)
Value that uniquely identifies the pick wave.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- DFF
-
Parameters:
- BatchId:
$request.path.BatchId
The Flexfields for Pick Waves resource manages the descriptive flexfield context name for pick waves. - BatchId:
Examples
This example describes how to get one pick wave.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/pickWaves/BatchId"
For example, the following command gets one pick wave:
curl -u username:password "https://servername/fscmRestApi/resources/version/pickWaves/5391361"
Example Response Body
The following shows an example of the response body in JSON format.
{ "SourceSystemName": "PIMDH", "BatchPrefix": null, "BatchId": 5391361, "PickingBatchName": "5391361", "ReleaseRuleId": 100000020219004, "ReleaseRule": "M1 High Priority", "ShipFromOrganizationId": 207, "ShipFromOrganizationCode": "M1", "ShipFromOrganizationName": "Tall Manufacturing", "ReleaseSubinventory": "ABCSUB01", "ReleaseStatusCode": "E", "ReleaseStatus": "Unreleased", "OrderTypeCode": "SALES_ORDER", "OrderType": "Sales order", "OrderId": 407903, "OrderNumber": "AAA_SO_1", "CustomerId": 1006, "Customer": "Computer Service and Rentals", "ShipSetName": null, "DestinationTypeCode": "S", "DestinationType": "Ship to", "GeographyId": null, "Geography": null, "ShipToLocationId": 1092, "ShipToNumber": "1036", "ShipToAddress1": "0000002164 Broadway", "ShipToAddress2": null, "ShipToAddress3": null, "ShipToAddress4": null, "ShipToCity": "Tempe", "ShipToState": "AZ", "ShipToCountry": "US", "ShipToPostalCode": "85282", "ShipToRegion": null, "ShipToLocationCode": null, "ShipToLocation": "0000002164 Broadway,TEMPE, AZ 85282", "ZoneId": null, "Zone": null, "PriorReservationsOnlyFlag": "false", "FromScheduledShipDate": "2018-11-08T08:39:00+00:00", "ToScheduledShipDate": "2018-11-09T23:59:00+00:00", "FromRequestedDate": "2018-11-08T08:39:00+00:00", "ToRequestedDate": "2018-11-09T23:59:00+00:00", "CarrierPartyNumber": "27400", "CarrierPartyName": "FEDEX Canada", "ModeOfTransportCode": "AIR", "ModeOfTransport": "Air", "ServiceLevelCode": "2FX", "ServiceLevel": "FedEx 2day", "ShipMethodCode": "000001_FEDEX - Ca_A_2FX", "ShipMethod": "FEDEX Canada-Air-FedEx 2day", "ShipmentPriorityCode": "HIGH", "ShipmentPriority": "High", "ShipmentId": null, "Shipment": null, "ShipmentLine": 3641627, "PackingUnitId": null, "PackingUnit": null, "IncludeAssignedLinesFlag": "true", "TransportationShipment": "TS-OTMSO14-1107204229", "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": 85, "CategoryName": "Hardware_85", "InventoryItemId": 663913, "ItemNumber": "INV-100", "ItemDescription": "Plain Item", "PickFromSubinventory": null, "PickFromLocatorId": null, "PickFromLocator": null, "StagingSubinventory": "Staging1", "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": "2018-11-08T08:39:07+00:00", "CreateShipmentsFlag": "true", "ShipmentCreationCriteriaCode": "Y", "ShipmentCreationCriteria": "Within an order", "AutomaticallyPackFlag": "true", "AppendShipmentsFlag": "false", "CreatedBy": "WHSE_MGR_ALL_INV_ORGS", "CreationDate": "2018-11-08T08:18:44.001+00:00", "PickReleaseFlag": null, "ReleaseMode": null, "ReturnStatus": null, "ReturnMessage": null }