Jump to

• Request
• Response
• Examples

Get all release rules

get

/fscmRestApi/resources/11.13.18.05/releaseRules

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the release rule with the specified primary key.
    Finder Variables
    • ReleaseRuleId; integer; Unique identifier of the release rule.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AppendShipmentsFlag; boolean; Contains one of the following values: true or false. If true, then add lines to the existing shipments. If false, then don't add lines to the existing shipments. 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 don't automatically confirm the pick transactions. 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 aren't packed automatically. The default value is false.
  • CatalogId; integer; Value that uniquely identifies the catalog.
  • CategoryId; integer; Value that uniquely identifies the item category.
  • 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 don't automatically assign released shipment lines to a shipment. The default value is false.
  • CreatedBy; string; User who created the release rule.
  • CreationDate; string; Date when the user created the release rule.
  • CustomerId; integer; Value that identifies the customer.
  • DocumentSetId; integer; Value that identifies the document job set that's used for printing documents during pick release.
  • EndDateActive; string; Date when the release rule becomes inactive.
  • EndRequestedDays; integer; Indicates the number of days in the past or future to use for the end date in a range of dates when the customer requested to ship the goods.
  • EndRequestedHours; integer; Indicates the time used for the end date when the customer requested to ship the goods.
  • EndScheduledShipDays; integer; Indicates the number of days in the past or future to use for the end date in a range of dates when the customer scheduled to ship the goods.
  • EndScheduledShipHours; integer; Indicates the time used for the end date when the customer scheduled to ship the goods.
  • FromRequestedDate; string; Start date and time in a range of dates when the customer requested to ship the goods.
  • FromScheduledShipDate; string; Start date and time in a range of dates when the customer scheduled to ship the goods.
  • GeographyId; integer; 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 when creating a pick wave. If false, then don't include lines already assigned to a shipment when creating a pick wave. The default value is false.
  • InitialDestinationId; integer; Value that uniquely identifies the destination location of the initial leg of the transportation planned to deliver the shipment to the final destination.
  • InventoryItemId; integer; Value that uniquely identifies the inventory Item.
  • LastUpdateDate; string; Date when the user most recently updated the release rule.
  • LastUpdatedBy; string; User who most recently updated the release rule.
  • OrderId; integer; Value that uniquely identifies the sales order, or transfer order, or transfer order return.
  • OrderTypeCode; string; Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type ORA_WSH_ORDER_LINE_TYPE.
  • PickFromLocatorId; integer; Value that uniquely identifies the locator from where to pick release.
  • PickFromSubinventory; string; Name of the subinventory from where to pick release or generate shipment request.
  • PickSlipGroupingRuleId; integer; Value that uniquely identifies the criteria to determine the grouping of picks into pick slips.
  • PriorReservationsFlag; boolean; Contains one of the following values: true or false. If true, then release existing reservations. If false, then don't release existing reservations. The default value is false.
  • ProjectCostingProjectId; integer; Value that uniquely identifies the project for standardized project cost collection.
  • ProjectCostingTaskId; integer; Value that uniquely identifies the task for standardized project cost collection.
  • ReleaseRule; string; Name of the release rule.
  • ReleaseRuleId; integer; Unique identifier of the release rule.
  • ReleaseSequenceRuleId; integer; Value that uniquely identifies the sequencing of shipment lines for pick release or generating shipment requests.
  • ReleaseStatusCode; string; Abbreviation that identifies the release status. A list of accepted values is defined in the lookup type WSH_BACKORDERS_FLAG.
  • ReleaseSubinventory; string; Name of the subinventory to source the material on shipment lines.
  • ShipConfirmRuleId; integer; Value that uniquely identifies the rules used on the shipment lines and shipment at ship confirmation.
  • ShipFromOrganizationId; integer; Value that uniquely identifies the originating organization of the goods that are shipped.
  • ShipMethodCode; string; Abbreviation that identifies the shipping method.
  • ShipSetName; string; Name of the shipment set to be selected for pick release or generating shipment request.
  • ShipToLocationId; integer; Value that uniquely identifies the customer location where a supplier sends shipments of goods and services.
  • ShipToLocationType; string; Indicates whether the ship-to location is internal or external.
  • ShipToPartyId; integer; Value that uniquely identifies the ship-to party.
  • ShipmentCreationCriteriaCode; string; 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.
  • ShipmentPriorityCode; string; Abbreviation that identifies the shipment priority. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY.
  • StagingLocatorId; integer; Value that uniquely identifies the default locator where picked lines are staged.
  • StagingSubinventory; string; Value that identifies the default subinventory where picked lines are staged.
  • StartDateActive; string; Date when the release rule becomes active.
  • StartRequestedDays; integer; Indicates the number of days in the past or future to use for the start date in a range of dates when the customer requested to ship the goods.
  • StartRequestedHours; integer; Indicates the time used for the start date when the customer requested to ship the goods.
  • StartScheduledShipDays; integer; Indicates the number of days in the past or future to use for the start date in a range of dates when the customer scheduled to ship the goods.
  • StartScheduledShipHours; integer; Indicates the time used for the start date when the customer scheduled to ship the goods.
  • ToRequestedDate; string; Last date and time in a range of dates when the customer requested to ship the goods.
  • ToScheduledShipDate; string; Last date and time in a range of dates when the customer scheduled to ship the goods.
  • TradeComplianceMethod; string; Abbreviation that identifies the method used for the line to be screened for trade compliance. A list of accepted values is defined in the lookup type ORA_WSH_TRD_COMP_SCRN_MTHD.
  • TransportationShipment; string; Value that indicates a shipment planned by the transportation management application.
  • ZoneId; integer; Value that uniquely identifies the geographic region, such as a country or a range of postal codes.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 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 : releaseRules

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/releaseRules-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object releaseRules-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/releaseRules-item-response"
    }
}

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 : releaseRules-item-response

Type: object

Show Source

• AppendShipmentsFlag: boolean
  Title: Append shipments

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then add lines to the existing shipments. If false, then don't add lines to the existing shipments. The default value is false.
• AutomaticallyPackFlag: boolean
  Title: Automatically pack

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then shipment lines are packed automatically. If false, then shipment lines aren't packed automatically. The default value is false.
• AutoPickConfirmFlag: boolean
  Title: Autoconfirm picks

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then automatically confirm the pick transactions. If false, then don't automatically confirm the pick transactions. The default value is false.
• 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 release rule.
• CreateShipmentsFlag: boolean
  Title: Create shipments

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then automatically assign released shipment lines to a shipment. If false, then don't automatically assign released shipment lines to a shipment. The default value is false.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the release rule.
• Customer: string
  Maximum Length: 255

  Name of the customer.
• CustomerId: integer (int64)
  Title: Customer

  Value that identifies the customer.
• DestinationType: string
  Maximum Length: 255

  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

  Abbreviation that identifies the type of the destination. A list of accepted values is defined in the lookup type WSH_DESTINATION_TYPE_CODE.
• DocumentSetId: integer (int64)
  Value that identifies the document job set that's used for printing documents during pick release.
• EndDateActive: string (date-time)
  Title: End Date

  Date when the release rule becomes inactive.
• EndRequestedDays: integer
  Title: Days

  Indicates the number of days in the past or future to use for the end date in a range of dates when the customer requested to ship the goods.
• EndRequestedHours: integer
  Title: Time

  Indicates the time used for the end date when the customer requested to ship the goods.
• EndScheduledShipDays: integer
  Title: Days

  Indicates the number of days in the past or future to use for the end date in a range of dates when the customer scheduled to ship the goods.
• EndScheduledShipHours: integer
  Title: Time

  Indicates the time used for the end date when the customer scheduled to ship the goods.
• 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
  Maximum Length: 255

  Value that determines the predefined administrative regions or geographies such as cities or states, a specified district or territory.
• GeographyElement1: string
  Maximum Length: 255

  Name of the denormalized parent of the geography.
• GeographyElement2: string
  Maximum Length: 255

  Name of the denormalized parent of the geography.
• GeographyElement3: string
  Maximum Length: 255

  Name of the denormalized parent of the geography.
• GeographyElement4: string
  Maximum Length: 255

  Name of the denormalized parent of the geography.
• GeographyElement5: string
  Maximum Length: 255

  Name of the denormalized parent of the geography.
• GeographyElement6: string
  Maximum Length: 255

  Name of the denormalized parent of the geography.
• 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
  Title: Include assigned lines

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then include lines already assigned to a shipment when creating a pick wave. If false, then don't include lines already assigned to a shipment when creating a pick wave. The default value is false.
• InitialDestination: string
  Maximum Length: 255

  Name that identifies the destination location of the initial leg of the transportation planned to deliver the shipment to the final destination.
• InitialDestinationAddress1: string
  Maximum Length: 255

  First line of the initial destination address.
• InitialDestinationAddress2: string
  Maximum Length: 255

  Second line of the initial destination address.
• InitialDestinationAddress3: string
  Maximum Length: 255

  Third line of the initial destination address.
• InitialDestinationAddress4: string
  Maximum Length: 255

  Fourth line of the initial destination address.
• InitialDestinationCity: string
  Maximum Length: 255

  City of the initial destination address.
• InitialDestinationCountry: string
  Maximum Length: 255

  Country 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
  Maximum Length: 255

  Postal code of the initial destination address.
• InitialDestinationProvince: string
  Maximum Length: 255

  Province of the initial destination address.
• InitialDestinationState: string
  Maximum Length: 255

  State of the initial destination address.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory Item.
• ItemDescription: string
  Maximum Length: 255

  Description of the item.
• ItemNumber: string
  Maximum Length: 255

  Number that identifies the item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the release rule.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the release rule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrderId: integer (int64)
  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
  Maximum Length: 100

  Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type ORA_WSH_ORDER_LINE_TYPE.
• PickFromLocator: string
  Maximum Length: 255

  Name that identifies the locator from where to pick release.
• 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 or generate shipment request.
• PickSlipGroupingRule: string
  Maximum Length: 255

  Value of the criteria to determine the grouping of picks into pick slips.
• PickSlipGroupingRuleId: integer (int64)
  Value that uniquely identifies the criteria to determine the grouping of picks into pick slips.
• PriorReservationsFlag: boolean
  Title: Prior reservations only

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then release existing reservations. If false, then don't release existing reservations. The default value is false.
• ProjectCostingProjectId: integer (int64)
  Value that uniquely identifies the project for standardized project cost collection.
• ProjectCostingProjectName: string
  Name of the project for standardized project cost collection.
• ProjectCostingProjectNumber: string
  Title: Project Number

  Number that identifies the project for standardized project cost collection.
• ProjectCostingTaskId: integer (int64)
  Value that uniquely identifies the task for standardized project cost collection.
• ProjectCostingTaskName: string
  Name of the task for standardized project cost collection.
• ProjectCostingTaskNumber: string
  Title: Task Number

  Number that identifies the task for standardized project cost collection.
• ReleaseRule: string
  Title: Name

  Maximum Length: 60

  Name of the release rule.
• ReleaseRuleId: integer (int64)
  Unique identifier of the release rule.
• ReleaseSequenceRule: string
  Maximum Length: 255

  Value that determines the sequencing of shipment lines for pick release or generating shipment requests.
• ReleaseSequenceRuleId: integer (int64)
  Value that uniquely identifies the sequencing of shipment lines for pick release or generating shipment requests.
• 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

  Default Value: E

  Abbreviation 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.
• ShipConfirmRule: string
  Maximum Length: 255

  Value that identifies the rules used on the shipment lines and shipment during ship confirmation.
• ShipConfirmRuleId: integer (int64)
  Value that uniquely identifies the rules used on the shipment lines and shipment at ship confirmation.
• ShipFromOrganizationCode: string
  Maximum Length: 18

  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.
• 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.
• 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
  Maximum Length: 255

  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 shipment set to be selected for pick release or generating shipment request.
• ShipToAddress1: string
  Maximum Length: 255

  First line of the ship-to customer address.
• ShipToAddress2: string
  Maximum Length: 255

  Second line of the ship-to customer address.
• ShipToAddress3: string
  Maximum Length: 255

  Third line of the ship-to customer address.
• ShipToAddress4: string
  Maximum Length: 255

  Fourth line of the ship-to customer address.
• ShipToCity: string
  Maximum Length: 255

  City of the ship-to customer address.
• ShipToCountry: string
  Maximum Length: 255

  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
  Maximum Length: 255

  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.
• ShipToLocationType: string
  Maximum Length: 2

  Indicates whether the ship-to location is internal or external.
• ShipToNumber: string
  Maximum Length: 255

  Party site number of the ship-to customer address.
• ShipToPartyId: integer (int64)
  Title: Customer

  Value that uniquely identifies the ship-to party.
• ShipToPostalCode: string
  Maximum Length: 255

  Postal code of the ship-to customer address.
• ShipToRegion: string
  Maximum Length: 255

  Region of the ship-to customer address.
• ShipToState: string
  Maximum Length: 255

  State of the ship-to customer address.
• StagingLocator: string
  Maximum Length: 255

  Value that identifies the default locator where picked lines are staged.
• StagingLocatorId: integer (int64)
  Title: Staging Locator

  Value that uniquely 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.
• StartDateActive: string (date-time)
  Title: Start Date

  Date when the release rule becomes active.
• StartRequestedDays: integer
  Title: Days

  Indicates the number of days in the past or future to use for the start date in a range of dates when the customer requested to ship the goods.
• StartRequestedHours: integer
  Title: Time

  Indicates the time used for the start date when the customer requested to ship the goods.
• StartScheduledShipDays: integer
  Title: Days

  Indicates the number of days in the past or future to use for the start date in a range of dates when the customer scheduled to ship the goods.
• StartScheduledShipHours: integer
  Title: Time

  Indicates the time used for the start date when the customer scheduled to ship the goods.
• 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. A list of accepted values is defined in the lookup type ORA_WSH_TRD_COMP_SCRN_MTHD.
• TradeComplianceMethodMeaning: string
  Maximum Length: 255

  Value that indicates the method used for the line to be screened for trade compliance. A list of accepted values is defined in the lookup type ORA_WSH_TRD_COMP_SCRN_MTHD.
• 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.
• ZoneId: integer (int64)
  Title: Zone

  Value that uniquely identifies the geographic region, such as a country or a range of postal codes.

{
    "type":"object",
    "properties":{
        "ReleaseRuleId":{
            "type":"integer",
            "description":"Unique identifier of the release rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ReleaseStatusCode":{
            "title":"Release Status",
            "maxLength":"1",
            "type":"string",
            "description":"Abbreviation that identifies the release status. A list of accepted values is defined in the lookup type WSH_BACKORDERS_FLAG.",
            "nullable":false,
            "default":"E",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the release rule.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriorReservationsFlag":{
            "title":"Prior reservations only",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then release existing reservations. If false, then don't release existing reservations. The default value is false.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "InitialDestinationProvince":{
            "maxLength":"255",
            "type":"string",
            "description":"Province of the initial destination address.",
            "nullable":true,
            "x-queryable":false
        },
        "Customer":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the customer.",
            "nullable":true,
            "x-queryable":false
        },
        "StartRequestedHours":{
            "title":"Time",
            "type":"integer",
            "description":"Indicates the time used for the start date when the customer requested to ship the goods.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StartRequestedDays"
                ]
            },
            "x-queryable":true
        },
        "ShipSetName":{
            "title":"Shipment Set",
            "maxLength":"150",
            "type":"string",
            "description":"Name of the shipment set to be selected for pick release or generating shipment request.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StartRequestedDays":{
            "title":"Days",
            "type":"integer",
            "description":"Indicates the number of days in the past or future to use for the start date in a range of dates when the customer requested to ship the goods.",
            "nullable":true,
            "x-hints":{
                "controlType":"number_edit"
            },
            "x-queryable":true
        },
        "OrderNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the sales order, or transfer order, or transfer order return.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToPartyId":{
            "title":"Customer",
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InitialDestinationState":{
            "maxLength":"255",
            "type":"string",
            "description":"State of the initial destination address.",
            "nullable":true,
            "x-queryable":false
        },
        "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":false
        },
        "AutoPickConfirmFlag":{
            "title":"Autoconfirm picks",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then automatically confirm the pick transactions. If false, then don't automatically confirm the pick transactions. The default value is false.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the release rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the release rule.",
            "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":false
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory Item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "PickFromLocator":{
            "maxLength":"255",
            "type":"string",
            "description":"Name that identifies the locator from where to pick release.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the shipping method.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "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
        },
        "ShipToLocationType":{
            "maxLength":"2",
            "type":"string",
            "description":"Indicates whether the ship-to location is internal or external.",
            "nullable":true,
            "x-queryable":true
        },
        "PickSlipGroupingRuleId":{
            "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":false
        },
        "ReleaseSubinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory to source the material on shipment lines.",
            "nullable":true,
            "x-queryable":true
        },
        "ReleaseSequenceRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sequencing of shipment lines for pick release or generating shipment requests.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipConfirmRuleId":{
            "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
        },
        "ShipToRegion":{
            "maxLength":"255",
            "type":"string",
            "description":"Region of the ship-to customer address.",
            "nullable":true,
            "x-queryable":false
        },
        "OrderTypeCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation 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":false
        },
        "ProjectCostingProjectNumber":{
            "title":"Project Number",
            "type":"string",
            "description":"Number that identifies the project for standardized project cost collection.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToCity":{
            "maxLength":"255",
            "type":"string",
            "description":"City of the ship-to customer address.",
            "nullable":true,
            "x-queryable":false
        },
        "StagingLocatorId":{
            "title":"Staging Locator",
            "type":"integer",
            "description":"Value that uniquely identifies the default locator where picked lines are staged.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "StagingSubinventory"
                ]
            },
            "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":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AutomaticallyPackFlag":{
            "title":"Automatically pack",
            "maxLength":"1",
            "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 aren't packed automatically. The default value is false.",
            "nullable":true,
            "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
        },
        "ReleaseSequenceRule":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that determines the sequencing of shipment lines for pick release or generating shipment requests.",
            "nullable":true,
            "x-queryable":false
        },
        "ProjectCostingProjectName":{
            "type":"string",
            "description":"Name of the project for standardized project cost collection.",
            "nullable":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":"Abbreviation that identifies the type of the destination. A list of accepted values is defined in the lookup type WSH_DESTINATION_TYPE_CODE.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ShipToCountry":{
            "maxLength":"255",
            "type":"string",
            "description":"Country of the ship-to customer address.",
            "nullable":true,
            "x-queryable":false
        },
        "InitialDestinationPostalCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Postal code of the initial destination address.",
            "nullable":true,
            "x-queryable":false
        },
        "PickFromSubinventory":{
            "title":"Pick-from Subinventory",
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory from where to pick release or generate shipment request.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ShipFromOrganizationId"
                ]
            },
            "x-queryable":true
        },
        "ShipToPostalCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Postal code of the ship-to customer address.",
            "nullable":true,
            "x-queryable":false
        },
        "GeographyElement1":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the denormalized parent of the geography.",
            "nullable":true,
            "x-queryable":false
        },
        "GeographyElement2":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the denormalized parent of the geography.",
            "nullable":true,
            "x-queryable":false
        },
        "CatalogName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name that determines the catalog.",
            "nullable":true,
            "x-queryable":false
        },
        "GeographyElement3":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the denormalized parent of the geography.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipFromOrganizationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the originating organization of the goods that are shipped.",
            "nullable":true,
            "x-queryable":false
        },
        "GeographyElement4":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the denormalized parent of the geography.",
            "nullable":true,
            "x-queryable":false
        },
        "InitialDestinationCity":{
            "maxLength":"255",
            "type":"string",
            "description":"City of the initial destination address.",
            "nullable":true,
            "x-queryable":false
        },
        "GeographyElement5":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the denormalized parent of the geography.",
            "nullable":true,
            "x-queryable":false
        },
        "GeographyElement6":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the denormalized parent of the geography.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the release rule.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Geography":{
            "maxLength":"255",
            "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":false
        },
        "ShipMethod":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the method of shipping.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ShipMethodCode"
                ]
            }
        },
        "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
        },
        "EndScheduledShipDays":{
            "title":"Days",
            "type":"integer",
            "description":"Indicates the number of days in the past or future to use for the end date in a range of dates when the customer scheduled to ship the goods.",
            "nullable":true,
            "x-hints":{
                "controlType":"number_edit"
            },
            "x-queryable":true
        },
        "IncludeAssignedLinesFlag":{
            "title":"Include assigned lines",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then include lines already assigned to a shipment when creating a pick wave. If false, then don't include lines already assigned to a shipment when creating a pick wave. The default value is false.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "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":false
        },
        "StartScheduledShipHours":{
            "title":"Time",
            "type":"integer",
            "description":"Indicates the time used for the start date when the customer scheduled to ship the goods.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StartScheduledShipDays"
                ]
            },
            "x-queryable":true
        },
        "ShipToState":{
            "maxLength":"255",
            "type":"string",
            "description":"State of the ship-to customer address.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProjectCostingProjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the project for standardized project cost collection.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReleaseRule":{
            "title":"Name",
            "maxLength":"60",
            "type":"string",
            "description":"Name of the release rule.",
            "nullable":false,
            "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
        },
        "EndRequestedDays":{
            "title":"Days",
            "type":"integer",
            "description":"Indicates the number of days in the past or future to use for the end date in a range of dates when the customer requested to ship the goods.",
            "nullable":true,
            "x-hints":{
                "controlType":"number_edit"
            },
            "x-queryable":true
        },
        "OrderId":{
            "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
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the release rule becomes inactive.",
            "format":"date-time",
            "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. A list of accepted values is defined in the lookup type ORA_WSH_TRD_COMP_SCRN_MTHD.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCostingTaskNumber":{
            "title":"Task Number",
            "type":"string",
            "description":"Number that identifies the task for standardized project cost collection.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ShipFromOrganizationId",
                    "ProjectCostingProjectId",
                    "ProjectCostingProjectNumber"
                ]
            }
        },
        "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
        },
        "ProjectCostingTaskName":{
            "type":"string",
            "description":"Name of the task for standardized project cost collection.",
            "nullable":true,
            "x-queryable":false
        },
        "CreateShipmentsFlag":{
            "title":"Create shipments",
            "maxLength":"1",
            "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 don't automatically assign released shipment lines to a shipment. The default value is false.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "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
        },
        "ProjectCostingTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task for standardized project cost collection.",
            "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":false
        },
        "EndScheduledShipHours":{
            "title":"Time",
            "type":"integer",
            "description":"Indicates the time used for the end date when the customer scheduled to ship the goods.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "EndScheduledShipDays"
                ]
            },
            "x-queryable":true
        },
        "AppendShipmentsFlag":{
            "title":"Append shipments",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then add lines to the existing shipments. If false, then don't add lines to the existing shipments. The default value is false.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box",
                "dependencies":[
                    "ShipmentCreationCriteriaCode",
                    "AutoPickConfirmFlag",
                    "CreateShipmentsFlag",
                    "ShipFromOrganizationId",
                    "ShipConfirmRuleId"
                ]
            },
            "x-queryable":true
        },
        "DestinationType":{
            "maxLength":"255",
            "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":false,
            "x-hints":{
                "dependencies":[
                    "DestinationTypeCode"
                ]
            }
        },
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the release rule becomes active.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentSetId":{
            "type":"integer",
            "description":"Value that identifies the document job set that's used for printing documents during pick release.",
            "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":false
        },
        "ShipToLocationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the ship-to location.",
            "nullable":true,
            "x-queryable":false
        },
        "PickSlipGroupingRule":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of the criteria to determine the grouping of picks into pick slips.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipFromOrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Value that identifies the originating organization of the goods that are shipped.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ShipFromOrganizationId"
                ]
            }
        },
        "ShipToAddress2":{
            "maxLength":"255",
            "type":"string",
            "description":"Second line of the ship-to customer address.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToAddress1":{
            "maxLength":"255",
            "type":"string",
            "description":"First line of the ship-to customer address.",
            "nullable":true,
            "x-queryable":false
        },
        "TradeComplianceMethodMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the method used for the line to be screened for trade compliance. A list of accepted values is defined in the lookup type ORA_WSH_TRD_COMP_SCRN_MTHD.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "TradeComplianceMethod"
                ]
            }
        },
        "ShipToAddress4":{
            "maxLength":"255",
            "type":"string",
            "description":"Fourth line of the ship-to customer address.",
            "nullable":true,
            "x-queryable":false
        },
        "InitialDestination":{
            "maxLength":"255",
            "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,
            "x-queryable":false
        },
        "ShipToAddress3":{
            "maxLength":"255",
            "type":"string",
            "description":"Third line of the ship-to customer address.",
            "nullable":true,
            "x-queryable":false
        },
        "EndRequestedHours":{
            "title":"Time",
            "type":"integer",
            "description":"Indicates the time used for the end date when the customer requested to ship the goods.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "EndRequestedDays"
                ]
            },
            "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
        },
        "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",
                "dependencies":[
                    "DestinationTypeCode"
                ]
            },
            "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.",
            "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":false
        },
        "Zone":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that determines the geographic region, such as a country or a range of postal codes.",
            "nullable":true,
            "x-queryable":false
        },
        "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":{
            "maxLength":"255",
            "type":"string",
            "description":"First line of the initial destination address.",
            "nullable":true,
            "x-queryable":false
        },
        "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":false
        },
        "InitialDestinationCountry":{
            "maxLength":"255",
            "type":"string",
            "description":"Country of the initial destination address.",
            "nullable":true,
            "x-queryable":false
        },
        "CategoryName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name that determines the item category.",
            "nullable":true,
            "x-queryable":false
        },
        "StartScheduledShipDays":{
            "title":"Days",
            "type":"integer",
            "description":"Indicates the number of days in the past or future to use for the start date in a range of dates when the customer scheduled to ship the goods.",
            "nullable":true,
            "x-hints":{
                "controlType":"number_edit"
            },
            "x-queryable":true
        },
        "InitialDestinationAddress4":{
            "maxLength":"255",
            "type":"string",
            "description":"Fourth line of the initial destination address.",
            "nullable":true,
            "x-queryable":false
        },
        "InitialDestinationAddress2":{
            "maxLength":"255",
            "type":"string",
            "description":"Second line of the initial destination address.",
            "nullable":true,
            "x-queryable":false
        },
        "InitialDestinationAddress3":{
            "maxLength":"255",
            "type":"string",
            "description":"Third line of the initial destination address.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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."
        }
    }
}

Back to Top

Examples

This example describes how to get all the release rules.

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/releaseRules?onlyData=true"

Example Response Body

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

{
    "items": [
        {
            "ShipmentCreationCriteriaCode": "Y",
            "AppendShipmentsFlag": null,
            "AutoPickConfirmFlag": true,
            "CreateShipmentsFlag": true,
            "AutomaticallyPackFlag": false,
            "ReleaseStatusCode": "E",
            "CategoryId": null,
            "CreatedBy": "SCM_USER29A",
            "CreationDate": "2010-10-26T09:24:58.657+00:00",
            "StagingLocatorId": null,
            "StagingSubinventory": "Staging1",
            "DestinationTypeCode": "S",
            "DocumentSetId": null,
            "EndDateActive": null,
            "PriorReservationsFlag": null,
            "FromRequestedDate": null,
            "FromScheduledShipDate": null,
            "IncludeAssignedLinesFlag": null,
            "InventoryItemId": null,
            "LastUpdateDate": "2010-10-27T06:38:59.362+00:00",
            "LastUpdatedBy": "SHIPPING_MANAGER_M1_SEATTLE_MANUFACTURING",
            "ShipFromOrganizationCode": "M1",
            "ShipFromOrganizationId": 207,
            "PickFromLocatorId": null,
            "PickFromSubinventory": null,
            "ReleaseRuleId": 100000020219004,
            "ReleaseRule": "M1 High Priority",
            "ProjectCostingProjectName": null,
            "ProjectCostingProjectNumber": null,
            "ProjectCostingTaskName": null,
            "ProjectCostingTaskNumber": null,
            "GeographyId": null,
            "GeographyElement1": null,
            "GeographyElement2": null,
            "GeographyElement3": null,
            "GeographyElement4": null,
            "GeographyElement5": null,
            "GeographyElement6": null,
            "ShipConfirmRuleId": 1,
            "ShipMethodCode": null,
            "ShipSetName": null,
            "ShipToLocationId": null,
            "ShipToLocationType": null,
            "CustomerId": null,
            "ShipmentPriorityCode": "HIGH",
            "StartDateActive": "2010-10-26T00:00:00+00:00",
            "ToRequestedDate": null,
            "ToScheduledShipDate": null,
            "TransportationShipment": null,
            "TradeComplianceMethod": null,
            "ZoneId": null,
            "ReleaseSubinventory": null,
            "ReleaseStatus": "Unreleased",
            "OrderTypeCode": null,
            "OrderType": null,
            "OrderId": null,
            "OrderNumber": null,
            "Customer": null,
            "ProjectCostingProjectId": null,
            "ProjectCostingTaskId": null,
            "ShipmentPriority": "High",
            "ShipMethod": null,
            "InitialDestinationId": null,
            "InitialDestination": null,
            "CatalogId": null,
            "CatalogName": null,
            "CategoryName": null,
            "ItemNumber": null,
            "ItemDescription": null,
            "ShipFromOrganizationName": "Seattle Manufacturing",
            "PickFromLocator": null,
            "StagingLocator": null,
            "ReleaseSequenceRuleId": 1000,
            "ReleaseSequenceRule": "All Standard Orders",
            "PickSlipGroupingRuleId": 1201,
            "PickSlipGroupingRule": "Departure, Delivery",
            "ShipmentCreationCriteria": "Within an order",
            "ShipConfirmRule": "Auto Ship",
            "DestinationType": "Ship to",
            "ShipToNumber": null,
            "ShipToAddress1": null,
            "ShipToAddress2": null,
            "ShipToAddress3": null,
            "ShipToAddress4": null,
            "ShipToCity": null,
            "ShipToState": null,
            "ShipToCountry": null,
            "ShipToPostalCode": null,
            "ShipToRegion": null,
            "ShipToLocation": null,
            "ShipToLocationCode": null,
            "InitialDestinationAddress1": null,
            "InitialDestinationAddress2": null,
            "InitialDestinationAddress3": null,
            "InitialDestinationAddress4": null,
            "InitialDestinationCountry": null,
            "InitialDestinationCity": null,
            "InitialDestinationPostalCode": null,
            "InitialDestinationState": null,
            "InitialDestinationProvince": null,
            "Geography": null,
            "Zone": null,
            "EndScheduledShipDays": null,
            "EndScheduledShipHours": null,
            "StartScheduledShipDays": null,
            "StartScheduledShipHours": null,
            "EndRequestedDays": null,
            "EndRequestedHours": null,
            "StartRequestedDays": null,
            "StartRequestedHours": null,
            "TradeComplianceMethodMeaning": null,
            "ShipToPartyId": null
        },
        {
            "ShipmentCreationCriteriaCode": null,
            "AppendShipmentsFlag": null,
            "AutoPickConfirmFlag": true,
            "CreateShipmentsFlag": true,
            "AutomaticallyPackFlag": false,
            "ReleaseStatusCode": "E",
            "CategoryId": null,
            "CreatedBy": "1068",
            "CreationDate": "1997-08-22T11:10:31+00:00",
            "StagingLocatorId": null,
            "StagingSubinventory": null,
            "DestinationTypeCode": "S",
            "DocumentSetId": null,
            "EndDateActive": null,
            "PriorReservationsFlag": false,
            "FromRequestedDate": null,
            "FromScheduledShipDate": null,
            "IncludeAssignedLinesFlag": false,
            "InventoryItemId": null,
            "LastUpdateDate": "2000-06-15T13:27:25+00:00",
            "LastUpdatedBy": "1000049",
            "ShipFromOrganizationCode": "M1",
            "ShipFromOrganizationId": 207,
            "PickFromLocatorId": null,
            "PickFromSubinventory": null,
            "ReleaseRuleId": 1,
            "ReleaseRule": "Internal",
            "ProjectCostingProjectName": null,
            "ProjectCostingProjectNumber": null,
            "ProjectCostingTaskName": null,
            "ProjectCostingTaskNumber": null,
            "GeographyId": null,
            "GeographyElement1": null,
            "GeographyElement2": null,
            "GeographyElement3": null,
            "GeographyElement4": null,
            "GeographyElement5": null,
            "GeographyElement6": null,
            "ShipConfirmRuleId": null,
            "ShipMethodCode": null,
            "ShipSetName": null,
            "ShipToLocationId": null,
            "ShipToLocationType": null,
            "CustomerId": null,
            "ShipmentPriorityCode": null,
            "StartDateActive": "1997-08-22T00:00:00+00:00",
            "ToRequestedDate": null,
            "ToScheduledShipDate": null,
            "TransportationShipment": null,
            "TradeComplianceMethod": null,
            "ZoneId": null,
            "ReleaseSubinventory": null,
            "ReleaseStatus": "Unreleased",
            "OrderTypeCode": null,
            "OrderType": null,
            "OrderId": null,
            "OrderNumber": null,
            "Customer": null,
            "ProjectCostingProjectId": null,
            "ProjectCostingTaskId": null,
            "ShipmentPriority": null,
            "ShipMethod": null,
            "InitialDestinationId": null,
            "InitialDestination": null,
            "CatalogId": null,
            "CatalogName": null,
            "CategoryName": null,
            "ItemNumber": null,
            "ItemDescription": null,
            "ShipFromOrganizationName": "Seattle Manufacturing",
            "PickFromLocator": null,
            "StagingLocator": null,
            "ReleaseSequenceRuleId": 1103,
            "ReleaseSequenceRule": "Departure Date",
            "PickSlipGroupingRuleId": 1202,
            "PickSlipGroupingRule": "Subinventory",
            "ShipmentCreationCriteria": null,
            "ShipConfirmRule": null,
            "DestinationType": "Ship to",
            "ShipToNumber": null,
            "ShipToAddress1": null,
            "ShipToAddress2": null,
            "ShipToAddress3": null,
            "ShipToAddress4": null,
            "ShipToCity": null,
            "ShipToState": null,
            "ShipToCountry": null,
            "ShipToPostalCode": null,
            "ShipToRegion": null,
            "ShipToLocation": null,
            "ShipToLocationCode": null,
            "InitialDestinationAddress1": null,
            "InitialDestinationAddress2": null,
            "InitialDestinationAddress3": null,
            "InitialDestinationAddress4": null,
            "InitialDestinationCountry": null,
            "InitialDestinationCity": null,
            "InitialDestinationPostalCode": null,
            "InitialDestinationState": null,
            "InitialDestinationProvince": null,
            "Geography": null,
            "Zone": null,
            "EndScheduledShipDays": null,
            "EndScheduledShipHours": null,
            "StartScheduledShipDays": null,
            "StartScheduledShipHours": null,
            "EndRequestedDays": null,
            "EndRequestedHours": null,
            "StartRequestedDays": null,
            "StartRequestedHours": null,
            "TradeComplianceMethodMeaning": null,
            "ShipToPartyId": null
        },
        {
            "ShipmentCreationCriteriaCode": null,
            "AppendShipmentsFlag": null,
            "AutoPickConfirmFlag": true,
            "CreateShipmentsFlag": true,
            "AutomaticallyPackFlag": false,
            "ReleaseStatusCode": "E",
            "CategoryId": null,
            "CreatedBy": "1068",
            "CreationDate": "1997-08-22T11:11:01+00:00",
            "StagingLocatorId": null,
            "StagingSubinventory": null,
            "DestinationTypeCode": "S",
            "DocumentSetId": 7,
            "EndDateActive": null,
            "PriorReservationsFlag": false,
            "FromRequestedDate": null,
            "FromScheduledShipDate": null,
            "IncludeAssignedLinesFlag": false,
            "InventoryItemId": null,
            "LastUpdateDate": "2001-03-01T06:39:14+00:00",
            "LastUpdatedBy": "1000049",
            "ShipFromOrganizationCode": "M1",
            "ShipFromOrganizationId": 207,
            "PickFromLocatorId": null,
            "PickFromSubinventory": null,
            "ReleaseRuleId": 2,
            "ReleaseRule": "Standard",
            "ProjectCostingProjectName": null,
            "ProjectCostingProjectNumber": null,
            "ProjectCostingTaskName": null,
            "ProjectCostingTaskNumber": null,
            "GeographyId": null,
            "GeographyElement1": null,
            "GeographyElement2": null,
            "GeographyElement3": null,
            "GeographyElement4": null,
            "GeographyElement5": null,
            "GeographyElement6": null,
            "ShipConfirmRuleId": null,
            "ShipMethodCode": null,
            "ShipSetName": null,
            "ShipToLocationId": null,
            "ShipToLocationType": null,
            "CustomerId": null,
            "ShipmentPriorityCode": null,
            "StartDateActive": "1997-08-22T00:00:00+00:00",
            "ToRequestedDate": null,
            "ToScheduledShipDate": null,
            "TransportationShipment": null,
            "TradeComplianceMethod": null,
            "ZoneId": null,
            "ReleaseSubinventory": null,
            "ReleaseStatus": "Unreleased",
            "OrderTypeCode": null,
            "OrderType": null,
            "OrderId": null,
            "OrderNumber": null,
            "Customer": null,
            "ProjectCostingProjectId": null,
            "ProjectCostingTaskId": null,
            "ShipmentPriority": null,
            "ShipMethod": null,
            "InitialDestinationId": null,
            "InitialDestination": null,
            "CatalogId": null,
            "CatalogName": null,
            "CategoryName": null,
            "ItemNumber": null,
            "ItemDescription": null,
            "ShipFromOrganizationName": "Seattle Manufacturing",
            "PickFromLocator": null,
            "StagingLocator": null,
            "ReleaseSequenceRuleId": 1000,
            "ReleaseSequenceRule": "All Standard Orders",
            "PickSlipGroupingRuleId": 1100,
            "PickSlipGroupingRule": "Customer,Ship To, Carrier",
            "ShipmentCreationCriteria": null,
            "ShipConfirmRule": null,
            "DestinationType": "Ship to",
            "ShipToNumber": null,
            "ShipToAddress1": null,
            "ShipToAddress2": null,
            "ShipToAddress3": null,
            "ShipToAddress4": null,
            "ShipToCity": null,
            "ShipToState": null,
            "ShipToCountry": null,
            "ShipToPostalCode": null,
            "ShipToRegion": null,
            "ShipToLocation": null,
            "ShipToLocationCode": null,
            "InitialDestinationAddress1": null,
            "InitialDestinationAddress2": null,
            "InitialDestinationAddress3": null,
            "InitialDestinationAddress4": null,
            "InitialDestinationCountry": null,
            "InitialDestinationCity": null,
            "InitialDestinationPostalCode": null,
            "InitialDestinationState": null,
            "InitialDestinationProvince": null,
            "Geography": null,
            "Zone": null,
            "EndScheduledShipDays": null,
            "EndScheduledShipHours": null,
            "StartScheduledShipDays": null,
            "StartScheduledShipHours": null,
            "EndRequestedDays": null,
            "EndRequestedHours": null,
            "StartRequestedDays": null,
            "StartRequestedHours": null,
            "TradeComplianceMethodMeaning": null,
            "ShipToPartyId": null
        }
    ],
    "count": 3,
    "hasMore": true,
    "limit": 3,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/releaseRules",
            "name": "releaseRules",
            "kind": "collection"
        }
    ]
}

Back to Top