Jump to

• Request
• Response
• Examples

Release one pick wave

patch

/fscmRestApi/resources/11.13.18.05/pickWaves/{BatchId}

Request

Path Parameters

• BatchId(required): integer(int64)
  Value that uniquely identifies the pick wave.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.
• ReleaseMode: string
  Value that determines whether to release pick wave immediately or add it to a release schedule. Valid values are ONLINE and CONCURRENT.

{
    "type":"object",
    "properties":{
        "ReleaseMode":{
            "type":"string",
            "description":"Value that determines whether to release pick wave immediately or add it to a release schedule. Valid values are ONLINE and CONCURRENT.",
            "nullable":true,
            "x-queryable":false
        },
        "PickReleaseFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "DFF":{
            "title":"Flexfields for Pick Waves",
            "type":"array",
            "description":"The Flexfields for Pick Waves resource manages the descriptive flexfield context name for pick waves.",
            "items":{
                "$ref":"#/components/schemas/pickWaves-DFF-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

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

• Array of: object pickWaves-DFF-item-patch-request

{
    "title":"Flexfields for Pick Waves",
    "type":"array",
    "description":"The Flexfields for Pick Waves resource manages the descriptive flexfield context name for pick waves.",
    "items":{
        "$ref":"#/components/schemas/pickWaves-DFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : pickWaves-DFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield for context name for pick waves.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield for context name for pick waves.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : pickWaves-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ReleaseRuleId":{
            "title":"Release Rule",
            "type":"integer",
            "description":"Value that uniquely identifies the pick wave release rule used to determine the shipment lines and processing details for the pick wave.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReleaseStatusCode":{
            "title":"Release Status",
            "maxLength":"1",
            "type":"string",
            "description":"Value that identifies the release status. A list of accepted values is defined in the lookup type WSH_BACKORDERS_FLAG.",
            "nullable":false,
            "x-queryable":true
        },
        "ShipmentId":{
            "title":"Shipment",
            "type":"integer",
            "description":"Value that uniquely identifies the shipment to pick release.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the pick wave.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InitialDestinationProvince":{
            "type":"string",
            "description":"Province of the initial destination address.",
            "nullable":true,
            "x-queryable":true
        },
        "Customer":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the customer.",
            "nullable":true,
            "x-queryable":true
        },
        "DFF":{
            "title":"Flexfields for Pick Waves",
            "type":"array",
            "description":"The Flexfields for Pick Waves resource manages the descriptive flexfield context name for pick waves.",
            "items":{
                "$ref":"#/components/schemas/pickWaves-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "PickingBatchName":{
            "title":"Pick Wave",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the pick wave.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipSetName":{
            "title":"Shipment Set",
            "maxLength":"150",
            "type":"string",
            "description":"Name of the ship set to be picked.",
            "nullable":true,
            "x-queryable":true
        },
        "ReturnMessage":{
            "type":"string",
            "description":"Text of the return message when processing the request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the sales order, or transfer order, or transfer order return.",
            "nullable":true,
            "x-queryable":true
        },
        "PackingUnitId":{
            "title":"Packing Unit",
            "type":"integer",
            "description":"Value that uniquely identifies the packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "InitialDestinationState":{
            "type":"string",
            "description":"State of the initial destination address.",
            "nullable":true,
            "x-queryable":true
        },
        "ReleaseStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that determines the release status. A list of accepted values is defined in the lookup type WSH_BACKORDERS_FLAG.",
            "nullable":true,
            "x-queryable":true
        },
        "AutoPickConfirmFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the pick wave.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Party site number of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory Item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PickFromLocator":{
            "maxLength":"255",
            "type":"string",
            "description":"Name that identifies the locator from where to pick on a pick wave.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the shipping method.",
            "nullable":true,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"SHIPMENT_PRIORITY1"
            },
            "x-queryable":true
        },
        "CustomerId":{
            "title":"Customer",
            "type":"integer",
            "description":"Value that identifies the customer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BatchPrefix":{
            "type":"string",
            "description":"Prefix attached in front of the pick wave number.",
            "nullable":true,
            "x-queryable":false
        },
        "ModeOfTransportCode":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "PickSlipGroupingRuleId":{
            "title":"Pick Slip Grouping Rule",
            "type":"integer",
            "description":"Value that uniquely identifies the criteria to determine the grouping of picks into pick slips.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipToLocation":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that determines the customer location where a supplier sends shipments of goods and services.",
            "nullable":true,
            "x-queryable":true
        },
        "ReleaseMode":{
            "type":"string",
            "description":"Value that determines whether to release pick wave immediately or add it to a release schedule. Valid values are ONLINE and CONCURRENT.",
            "nullable":true,
            "x-queryable":false
        },
        "ModeOfTransport":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ReleaseSubinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory to source the material on shipment lines.",
            "nullable":true,
            "x-queryable":true
        },
        "ReleaseSequenceRuleId":{
            "title":"Release Sequence Rule",
            "type":"integer",
            "description":"Value that uniquely identifies the sequencing of shipment lines for pick release.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipToRegion":{
            "type":"string",
            "description":"Region of the ship-to customer address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipConfirmRuleId":{
            "title":"Ship Confirm Rule",
            "type":"integer",
            "description":"Value that uniquely identifies the rules used on the shipment lines and shipment at ship confirmation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrderTypeCode":{
            "title":"Order Type",
            "maxLength":"100",
            "type":"string",
            "description":"Value that identifies the type of order. A list of accepted values is defined in the lookup type ORA_WSH_ORDER_LINE_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipConfirmRule":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the rules used on the shipment lines and shipment during ship confirmation.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCostingProjectNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the project for standardized project cost collection.\nThis attribute is not currently used.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToCity":{
            "type":"string",
            "description":"City of the ship-to customer address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StagingLocatorId":{
            "title":"Staging Locator",
            "type":"integer",
            "description":"Value that identifies the default locator where picked lines are staged.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "StagingSubinventory"
                ]
            },
            "x-queryable":true
        },
        "ShipmentLine":{
            "title":"Shipment Line",
            "type":"integer",
            "description":"Value that identifies the shipment to pick release.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipmentPriorityCode":{
            "title":"Shipping Priority",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the shipment priority. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY.",
            "nullable":true,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"SHIPMENT_PRIORITY1",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"665"
            },
            "x-queryable":true
        },
        "ToRequestedDate":{
            "title":"To Requested Date",
            "type":"string",
            "description":"Last date and time in a range of dates when the customer requested to ship the goods.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AutomaticallyPackFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ReleaseSequenceRule":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that determines the sequencing of shipment lines for pick release.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCostingProjectName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project for standardized project cost collection.\nThis attribute is not currently used.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TransportationShipment":{
            "title":"Transportation Shipment",
            "maxLength":"101",
            "type":"string",
            "description":"Value that indicates a shipment planned by the transportation management application.",
            "nullable":true,
            "x-queryable":true
        },
        "DestinationTypeCode":{
            "title":"Destination Type",
            "type":"string",
            "description":"Value that identifies the type of the destination. A list of accepted values is defined in the lookup type WSH_DESTINATION_TYPE_CODE.",
            "nullable":true,
            "default":"S",
            "x-queryable":false
        },
        "PriorReservationsOnlyFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipmentCreationCriteriaCode":{
            "title":"Shipment Creation Criteria",
            "maxLength":"2",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"WSH_AC_DEL_CRITERIA",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"665"
            },
            "x-queryable":true
        },
        "ShipToCountry":{
            "type":"string",
            "description":"Country of the ship-to customer address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InitialDestinationPostalCode":{
            "type":"string",
            "description":"Postal code of the initial destination address.",
            "nullable":true,
            "x-queryable":true
        },
        "ActualShipDate":{
            "title":"Actual Ship Date",
            "type":"string",
            "description":"Date with time when the shipment was actually sent.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PickFromSubinventory":{
            "title":"Pick-from Subinventory",
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory from where to pick release.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ShipFromOrganizationId"
                ]
            },
            "x-queryable":true
        },
        "ShipToPostalCode":{
            "type":"string",
            "description":"Postal code of the ship-to customer address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReturnStatus":{
            "type":"string",
            "description":"Status of the current service call.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CatalogName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name that determines the catalog.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipFromOrganizationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the originating organization of the goods that are shipped.",
            "nullable":true,
            "x-queryable":true
        },
        "InitialDestinationCity":{
            "type":"string",
            "description":"City of the initial destination address.",
            "nullable":true,
            "x-queryable":true
        },
        "Geography":{
            "type":"string",
            "description":"Value that determines the predefined administrative regions or geographies such as cities or states, a specified district or territory.",
            "nullable":true,
            "x-queryable":true
        },
        "CarrierPartyNumber":{
            "type":"string",
            "description":"Number that uniquely identifies the carrier.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipMethod":{
            "type":"string",
            "description":"Value that indicates the method of shipping.",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceLevelCode":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "GeographyId":{
            "title":"Geography",
            "type":"integer",
            "description":"Value that uniquely identifies the predefined administrative regions or geographies such as cities or states, a specified district or territory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IncludeAssignedLinesFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "FromRequestedDate":{
            "title":"From Requested Date",
            "type":"string",
            "description":"Start date and time in a range of dates when the customer requested to ship the goods.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "InitialDestinationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the destination location of the initial leg of the transportation planned to deliver the shipment to the final destination.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrderType":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that determines the type of order. A list of accepted values is defined in the lookup type ORA_WSH_ORDER_LINE_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToState":{
            "type":"string",
            "description":"State of the ship-to customer address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PickReleaseFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ProjectCostingProjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the project for standardized project cost collection.\nThis attribute is not currently used.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReleaseRule":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the pick wave release rule that determines which shipment lines are selected for a pick wave.",
            "nullable":true,
            "x-queryable":true
        },
        "ToScheduledShipDate":{
            "title":"To Scheduled Ship Date",
            "type":"string",
            "description":"Last date and time in a range of dates when the customer scheduled to ship the goods.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "BatchId":{
            "type":"integer",
            "description":"Value that uniquely identifies the pick wave.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Shipment":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that determines the shipment to pick release.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderId":{
            "title":"Order",
            "type":"integer",
            "description":"Value that uniquely identifies the sales order, or transfer order, or transfer order return.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CarrierPartyName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the carrier.",
            "nullable":true,
            "x-queryable":true
        },
        "TradeComplianceMethod":{
            "title":"Trade Compliance Screening Method",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the method used for the line to be screened for trade compliance.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCostingTaskNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the task for standardized project cost collection.\nThis attribute is not currently used.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCostingTaskName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the task for standardized project cost collection.\nThis attribute is not currently used.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FromScheduledShipDate":{
            "title":"From Scheduled Ship Date",
            "type":"string",
            "description":"Start date and time in a range of dates when the customer scheduled to ship the goods.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceLevel":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "CatalogId"
                ]
            },
            "x-queryable":true
        },
        "CreateShipmentsFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCostingTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task for standardized project cost collection.\nThis attribute is not currently used.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipmentCreationCriteria":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemName":{
            "type":"string",
            "description":"Name of source application.",
            "nullable":true,
            "x-queryable":false
        },
        "AppendShipmentsFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "DestinationType":{
            "type":"string",
            "description":"Value that determines the type of the destination. A list of accepted values is defined in the lookup type WSH_DESTINATION_TYPE_CODE.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipFromOrganizationId":{
            "title":"Ship-from Organization",
            "type":"integer",
            "description":"Value that uniquely identifies the originating organization of the goods that are shipped.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToLocationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the ship-to location.",
            "nullable":true,
            "x-queryable":true
        },
        "PickSlipGroupingRule":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of the criteria to determine the grouping of picks into pick slips.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToAddress2":{
            "type":"string",
            "description":"Second line of the ship-to customer address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipFromOrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the originating organization of the goods that are shipped.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToAddress1":{
            "type":"string",
            "description":"First line of the ship-to customer address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToAddress4":{
            "type":"string",
            "description":"Fourth line of the ship-to customer address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToAddress3":{
            "type":"string",
            "description":"Third line of the ship-to customer address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InitialDestination":{
            "type":"string",
            "description":"Name that identifies the destination location of the initial leg of the transportation planned to deliver the shipment to the final destination.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToLocationId":{
            "title":"Ship-to Location",
            "type":"integer",
            "description":"Value that uniquely identifies the customer location where a supplier sends shipments of goods and services.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StagingSubinventory":{
            "title":"Staging Subinventory",
            "maxLength":"10",
            "type":"string",
            "description":"Value that identifies the default subinventory where picked lines are staged.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ShipFromOrganizationId"
                ]
            },
            "x-queryable":true
        },
        "ZoneId":{
            "title":"Zone",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StagingLocator":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the default locator where picked lines are staged.",
            "nullable":true,
            "x-queryable":true
        },
        "Zone":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PickFromLocatorId":{
            "title":"Pick-from Locator",
            "type":"integer",
            "description":"Value that uniquely identifies the locator from where to pick release.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "PickFromSubinventory"
                ]
            },
            "x-queryable":true
        },
        "InitialDestinationAddress1":{
            "type":"string",
            "description":"First line of the initial destination address.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipmentPriority":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the priority of the shipment. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY.",
            "nullable":true,
            "x-queryable":true
        },
        "InitialDestinationCountry":{
            "type":"string",
            "description":"County of the initial destination address.",
            "nullable":true,
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name that determines the item category.",
            "nullable":true,
            "x-queryable":true
        },
        "PackingUnit":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that determines the packing unit.",
            "nullable":true,
            "x-queryable":true
        },
        "InitialDestinationAddress4":{
            "type":"string",
            "description":"Fourth line of the initial destination address.",
            "nullable":true,
            "x-queryable":true
        },
        "InitialDestinationAddress2":{
            "type":"string",
            "description":"Second line of the initial destination address.",
            "nullable":true,
            "x-queryable":true
        },
        "InitialDestinationAddress3":{
            "type":"string",
            "description":"Third line of the initial destination address.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object pickWaves-DFF-item-response

{
    "title":"Flexfields for Pick Waves",
    "type":"array",
    "description":"The Flexfields for Pick Waves resource manages the descriptive flexfield context name for pick waves.",
    "items":{
        "$ref":"#/components/schemas/pickWaves-DFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : pickWaves-DFF-item-response

Type: object

Show Source

• __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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "BatchId":{
            "type":"integer",
            "description":"Value that uniquely identifies the pick wave.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield for context name for pick waves.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

DFF

Operation: /fscmRestApi/resources/11.13.18.05/pickWaves/{BatchId}/child/DFF

Parameters:

• BatchId: $request.path.BatchId

The Flexfields for Pick Waves resource manages the descriptive flexfield context name for pick waves.

Back to Top

Examples

This example describes how to release one pick wave.

Example cURL Command

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

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

Example Request Body 1

The following example includes the contents of the request body in JSON format for 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 updates.

{
	"PickReleaseFlag": true,
	"ReleaseMode": "ONLINE"
}

Example Response Body 1

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

{
	"SourceSystemName": "PIMDH",
	"BatchPrefix": "RESTL",
	"BatchId": 5392119,
	"PickingBatchName": "RESTL-5392119",
	"ReleaseRuleId": null,
	"ReleaseRule": null,
	"ShipFromOrganizationId": 207,
	"ShipFromOrganizationCode": "M1",
	"ShipFromOrganizationName": "Tall Manufacturing",
	"ReleaseSubinventory": null,
	"ReleaseStatusCode": "E",
	"ReleaseStatus": "Unreleased",
	"OrderTypeCode": "SALES_ORDER",
	"OrderType": "Sales order",
	"OrderId": 408733,
	"OrderNumber": "AAA_SO_42",
	"CustomerId": 1006,
	"Customer": "Computer Service and Rentals",
	"ShipSetName": null,
	"DestinationTypeCode": null,
	"DestinationType": null,
	"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": "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:23:02.026+00:00",
	"PickReleaseFlag": "true",
	"ReleaseMode": "ONLINE",
	"ReturnStatus": "S",
	"ReturnMessage": "Pick wave RESTL-5392119 was released. Number of pick slips: 1. Number of picks: 1."
}

Example Request Body 2

The following example includes the contents of the request body in JSON format for 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 updates.

{
    "PickReleaseFlag": true,
    "ReleaseMode": "CONCURRENT"
    }

Example Response Body 2

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

{
    "SourceSystemName": "PIMDH",
    "BatchPrefix": "RESTL",
    "BatchId": 5392123
    "PickingBatchName": "RESTL-5392123
    "ReleaseRuleId": null,
    "ReleaseRule": null,
    "ShipFromOrganizationId": 207,
    "ShipFromOrganizationCode": "M1",
    "ShipFromOrganizationName": "Tall Manufacturing",
    "ReleaseSubinventory": null,
    "ReleaseStatusCode": "E",
    "ReleaseStatus": "Unreleased",
    "OrderTypeCode": "SALES_ORDER",
    "OrderType": "Sales order",
    "OrderId": 408733,
    "OrderNumber": "AAA_SO_42",
    "CustomerId": 1006,
    "Customer": "Computer Service and Rentals",
    "ShipSetName": null,
    "DestinationTypeCode": null,
    "DestinationType": null,
    "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": "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:23:02.026+00:00",
    "PickReleaseFlag": "true",
    "ReleaseMode": "CONCURRENT",
    "ReturnStatus": "S",
    "ReturnMessage": "Pick wave RESTL-5392123 was scheduled with request ID 63456789."
 }

Back to Top