Jump to

• Request
• Response
• Examples

Get all plans

get

/fscmRestApi/resources/11.13.18.05/replenishmentPlans

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 replenishment plans according to the plan identifier.
    Finder Variables
    • PlanId; integer; Value that uniquely identifies the plan.
• 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:
  

  • AggregateNonkeyCustomerData; integer; Contains one of the following values: 1 or 2. If 1, then use aggregated data for non-key customers. If 2, then don't use this data. If you aggregate data in a plan, then the application uses the predefined level for each member as the aggregated data. The default value is 2.
  • ArchivePlan; integer; Contains one of the following values: 1 or 2. If 1, then archive the plan before the next run starts. You can archive the plan only if you enable it for archiving. If 2, then don't archive. The default value is 2.
  • ArchiveTimeHierarchy; integer; Time hierarchy that the application uses to archive the plan.
  • ArchiveTimeLevel; integer; Time hierarchy level that the application uses to archive the plan. The ArchiveTimeHierarchy attribute determines the values that you can use for this attribute.
  • ArchiveVersionDays; integer; Number of days that the application retains the archive. The application deletes each archive that's older than the current date minus Most Recent Days to Keep. The application performs this deletion when it creates each new archive.
  • AssignmentSetName; string; Name of the assignment set that specifies the sourcing rules and bills of distribution to use for material flow in the supply chain when running the plan. You can use the Manage Assignment Sets page in one of the work areas for supply chain planning to set the values you can use with this attribute.
  • AutoRelease; integer; Contains one of the following values: 1 or 2. If 1, then release planning recommendations. If 2, then don't release. The default value is 2.
  • CalendarCode; string; Abbreviation that identifies the calendar.
  • Clusters; string; Name of the clusters for which inventory rebalancing is performed.
  • CreatedBy; string; User who created the plan.
  • CreationDate; string; Date when the user created the plan.
  • CutoffDate; string; End date of the planning horizon when planning no longer plans demand or supply.
  • DeleteArchive; integer; Contains one of the following values: 1 or 2. If 1, then delete plan archives that were created before the most recent days to keep during the next plan run. If 2, then don't delete plan archives. The default value is 2.
  • DemandPlanCompletionDate; string; Date and time when demand planning finished running the plan.
  • DemandPlanStartDate; string; Date and time when demand planning started running the plan.
  • Description; string; Description of the plan.
  • EnableArchive; integer; Contains one of the following values: 1 or 2. If 1, then archive the plan measures through the archive plan option. If 2, then don't archive measures. The default value is 2.
  • ExceptionSet; integer; Exception set that the plan references. The exception set determines the exception types that the plan creates.
  • ExcessLtMultiplier; number; Value by which item lead time is multiplied by to calculate the time window within which excess quantity is computed for item substitution or supersession.
  • ForecastOption; integer; Value that indicates whether to generate a forecast or not. Valid values are 1 or 2. If 1, then generate a forecast. If 2, then don't generate a forecast. The default value is 2.
  • ForecastProfiles; string; List of forecast profiles that the plan run uses. A comma separates each forecast profile name.
  • ForecastingTimeLevel; integer; Abbreviation that identifies the time bucket type for forecasting buckets. Valid values vary based on the forecasting calendar type. If the forecasting calendar type is 5, manufacturing calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_MFG. If the forecasting calendar type is 1, Gregorian calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_GREGORIAN. If the forecasting calendar type is 3, fiscal calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_FISCAL.
  • HasRun; integer; Abbreviation that identifies the time bucket type for forecasting buckets. Valid values vary based on the forecasting calendar type. If the forecasting calendar type is 5, manufacturing calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_MFG. If the forecasting calendar type is 1, Gregorian calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_GREGORIAN. If the forecasting calendar type is 3, fiscal calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_FISCAL.
  • IncludeTransferOrders; integer; Contains one of the following values: 1 or 2. If 1, then include transfer orders when loading sales order history. If 2, then don't include. The default value is 2.
  • IncrementalPlanningOption; integer; Value that indicates whether to enable a plan for incremental planning. Valid values are 1 or 2. If 1, then enable incremental planning. If 2, then disable incremental planning. The default value is 2.
  • InvRebIncludeSsOption; integer; Value that indicates whether to include safety stock in shortages computation. Valid values are 1 or 2. If 1, then include safety stock. If 2, then don't include safety stock. The default value is 2.
  • InvRebMoveExcessOption; integer; Value that indicates whether to move excess inventory to sweep location. Valid values are 1 or 2. If 1, then move excess inventory. If 2, then don't move excess inventory. The default value is 1.
  • InvRebalancePartialsOption; integer; Value that indicates whether to create partial orders from source location that doesn't have enough inventory to meet the entire destination location shortages. Valid values are 1 or 2. If 1, then don't create partial orders. If 2, then create partial orders. The default value is 1.
  • ItemListPrice; integer; This attribute isn't currently used.
  • LastUpdatedBy; string; User who performed the most recent update on the plan.
  • LastUpdatedDate; string; Date when the user most recently updated the plan.
  • LeadTimeMultiplier; integer; Item lead time that's multiplied by to calculate the lead time window within which all demands are considered.
  • MeasureCatalogForArchival; string; Measure catalog that the application uses to archive the plan.
  • NumberOfBuckets; integer; Number of planning buckets of the specified type used in the supply planning process.
  • PlanAccess; integer; Contains one of the following values: 1 or 2. If 1, then the plan is public. If 2, then the plan is private. Only the plan owner or users that the plan references can view a private plan. A list of accepted values is defined in the lookup type ORA_MSC_ACCESS. The default value is 1.
  • PlanDimensionCatalog; integer; Dimension catalog that the plan references. The dimension catalog determines the dimensions that you can use in each plan.
  • PlanHorizonStartDate; string; Date when the plan starts planning demand and supply.
  • PlanId; integer; Value that uniquely identifies the plan.
  • PlanMeasureCatalog; string; Measure catalog that the plan references. The measure catalog determines the measures that you can use in each plan.
  • PlanName; string; Name of the plan.
  • PlanOrganizationLevelMembers; string; List of level values in the organization hierarchy included in the scope of the plan. A comma separates each value.
  • PlanOwner; string; Name of the user who owns the plan.
  • PlanStatus; integer; Status of the plan run that most recently completed. Valid values include 0: completed, 1: processing, 2: error, or 3: warning. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE. This attribute doesn't have a default value.
  • PlanTimeLevel; integer; Time level used for aggregate planning. Valid values are Day, Week, Period, or Month. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_TIME_LEVEL.
  • PlanType; integer; Type of plan. Contains one of the following values. 1: demand plan, 2: supply plan, or 3: demand and supply plan. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_TYPE.
  • PlanningCalendar; string; Supply planning calendar used for aggregate planning. Review the values for this attribute using the Review Planning Calendars task.
  • PolicyAssignmentSetId; integer; Value that uniquely identifies the policy assignment set. Review and update the value for this attribute using the Manage Policy Assignment Sets task. This attribute is mandatory if CalculatePolicyParamFlag is true.
  • PolicyAssignmentSetName; string; Name of the policy assignment set. Review and update the value for this attribute using the Manage Policy Assignment Sets task. This attribute is mandatory if Calculate Policy Parameters is selected.
  • PolicyComparisonOption; integer; Value that indicates whether to enable a plan for policy comparison. Valid values are 1 or 2. If 1, then enable plan for policy comparison. If 2, then disable plan for policy comparison. The default value is 2.
  • PolicyComparisonThreshold; integer; Percent value of the threshold used in policy comparison.
  • PolicyParametersOption; integer; Value that indicates whether or not to calculate policy parameters. Valid values are 1 or 2. If 1, then calculate policy parameters. If 2, then don't calculate policy parameters. The default value is 2.
  • PriceLists; string; List of price lists to consider in the plan. A comma separates each value.
  • RelatedItemsSuppliesRules; string; Contains one of the following values: 1,2 or 3. If 1, then don't use related items. If 2, then maximize the use of related items to minimize new replenishment orders. If 3, then use related items only when necessary to avoid stockouts. The default value is 1.
  • ReplAggrPlannedOrders; integer; Contains one of the following values: 1 or 2. If 1, then aggregate the planned orders. If 2, then don't aggregate the planned orders. The default value is 1.
  • ReplInvRebalanceOption; integer; Value that indicates whether to perform inventory rebalancing. Valid values are 1 or 2. If 1, then perform inventory rebalancing. If 2, then don't perform inventory rebalancing. The default value is 2.
  • ReplSupplyCutoffDays; integer; Number of days after the plan end date during which the existing supplies are considered. The default value is 0.
  • ReplenishmentsOption; integer; Value that indicates whether to calculate replenishments. Valid values are 1 or 2. If 1, then calculate replenishments. If 2, then don't calculate replenishments. The default value is 1.
  • SegmentGroup; integer; Segment group that planning uses when the plan is run. Review and update the value for this attribute using the Manage Segment Groups task.
  • Segments; string; List of segments to consider in the plan. A comma separates each value. Review and update the value for this attribute using the Manage Segment Groups task.
  • ShortPlanId; integer; Value that uniquely identifies the plan.
  • SimulationSet; integer; Simulation set that planning uses when the plan runs. A simulation set is a set of adjustments that you make to inputs that affect the plan. You can use them to test different business scenarios, such as increasing the available resource capacity.
  • TimeHorizonForDemand; integer; Value that indicates the horizon within which the demand is considered. Valid values are 1: item lead time, or 2: none. The default value is 2.
• 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 : replenishmentPlans

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/replenishmentPlans-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SupplyChainPlanning",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object replenishmentPlans-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/replenishmentPlans-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 : replenishmentPlans-item-response

Type: object

Show Source

• AggregateNonkeyCustomerData: integer (int32)
  Contains one of the following values: 1 or 2. If 1, then use aggregated data for non-key customers. If 2, then don't use this data. If you aggregate data in a plan, then the application uses the predefined level for each member as the aggregated data. The default value is 2.
• ArchivePlan: integer
  Contains one of the following values: 1 or 2. If 1, then archive the plan before the next run starts. You can archive the plan only if you enable it for archiving. If 2, then don't archive. The default value is 2.
• ArchiveTimeHierarchy: integer (int64)
  Time hierarchy that the application uses to archive the plan.
• ArchiveTimeLevel: integer (int64)
  Time hierarchy level that the application uses to archive the plan. The ArchiveTimeHierarchy attribute determines the values that you can use for this attribute.
• ArchiveVersionDays: integer
  Number of days that the application retains the archive. The application deletes each archive that's older than the current date minus Most Recent Days to Keep. The application performs this deletion when it creates each new archive.
• AssignmentSetName: string
  Name of the assignment set that specifies the sourcing rules and bills of distribution to use for material flow in the supply chain when running the plan. You can use the Manage Assignment Sets page in one of the work areas for supply chain planning to set the values you can use with this attribute.
• AutoRelease: integer
  Contains one of the following values: 1 or 2. If 1, then release planning recommendations. If 2, then don't release. The default value is 2.
• CalendarCode: string
  Maximum Length: 22

  Abbreviation that identifies the calendar.
• Clusters: string
  Name of the clusters for which inventory rebalancing is performed.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the plan.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the plan.
• CutoffDate: string (date)
  End date of the planning horizon when planning no longer plans demand or supply.
• DeleteArchive: integer (int32)
  Contains one of the following values: 1 or 2. If 1, then delete plan archives that were created before the most recent days to keep during the next plan run. If 2, then don't delete plan archives. The default value is 2.
• DemandPlanCompletionDate: string (date-time)
  Date and time when demand planning finished running the plan.
• DemandPlanStartDate: string (date-time)
  Date and time when demand planning started running the plan.
• Description: string
  Maximum Length: 100

  Description of the plan.
• EnableArchive: integer (int32)
  Contains one of the following values: 1 or 2. If 1, then archive the plan measures through the archive plan option. If 2, then don't archive measures. The default value is 2.
• ExceptionSet: integer (int64)
  Exception set that the plan references. The exception set determines the exception types that the plan creates.
• ExcessLtMultiplier: number
  Read Only: true

  Value by which item lead time is multiplied by to calculate the time window within which excess quantity is computed for item substitution or supersession.
• ForecastingTimeLevel: integer
  Abbreviation that identifies the time bucket type for forecasting buckets. Valid values vary based on the forecasting calendar type. If the forecasting calendar type is 5, manufacturing calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_MFG. If the forecasting calendar type is 1, Gregorian calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_GREGORIAN. If the forecasting calendar type is 3, fiscal calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_FISCAL.
• ForecastOption: integer
  Value that indicates whether to generate a forecast or not. Valid values are 1 or 2. If 1, then generate a forecast. If 2, then don't generate a forecast. The default value is 2.
• ForecastProfiles: string
  List of forecast profiles that the plan run uses. A comma separates each forecast profile name.
• HasRun: integer
  Abbreviation that identifies the time bucket type for forecasting buckets. Valid values vary based on the forecasting calendar type. If the forecasting calendar type is 5, manufacturing calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_MFG. If the forecasting calendar type is 1, Gregorian calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_GREGORIAN. If the forecasting calendar type is 3, fiscal calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_FISCAL.
• IncludeTransferOrders: integer (int32)
  Contains one of the following values: 1 or 2. If 1, then include transfer orders when loading sales order history. If 2, then don't include. The default value is 2.
• IncrementalPlanningOption: integer (int32)
  Value that indicates whether to enable a plan for incremental planning. Valid values are 1 or 2. If 1, then enable incremental planning. If 2, then disable incremental planning. The default value is 2.
• InvRebalancePartialsOption: integer (int32)
  Value that indicates whether to create partial orders from source location that doesn't have enough inventory to meet the entire destination location shortages. Valid values are 1 or 2. If 1, then don't create partial orders. If 2, then create partial orders. The default value is 1.
• InvRebIncludeSsOption: integer (int32)
  Read Only: true

  Value that indicates whether to include safety stock in shortages computation. Valid values are 1 or 2. If 1, then include safety stock. If 2, then don't include safety stock. The default value is 2.
• InvRebMoveExcessOption: integer (int32)
  Read Only: true

  Value that indicates whether to move excess inventory to sweep location. Valid values are 1 or 2. If 1, then move excess inventory. If 2, then don't move excess inventory. The default value is 1.
• ItemListPrice: integer (int32)
  This attribute isn't currently used.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who performed the most recent update on the plan.
• LastUpdatedDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the plan.
• LeadTimeMultiplier: integer (int32)
  Item lead time that's multiplied by to calculate the lead time window within which all demands are considered.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeasureCatalogForArchival: string
  Measure catalog that the application uses to archive the plan.
• NumberOfBuckets: integer
  Number of planning buckets of the specified type used in the supply planning process.
• PlanAccess: integer
  Default Value: 1

  Contains one of the following values: 1 or 2. If 1, then the plan is public. If 2, then the plan is private. Only the plan owner or users that the plan references can view a private plan. A list of accepted values is defined in the lookup type ORA_MSC_ACCESS. The default value is 1.
• PlanDimensionCatalog: integer (int64)
  Dimension catalog that the plan references. The dimension catalog determines the dimensions that you can use in each plan.
• PlanHorizonStartDate: string (date)
  Date when the plan starts planning demand and supply.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• PlanMeasureCatalog: string
  Measure catalog that the plan references. The measure catalog determines the measures that you can use in each plan.
• PlanName: string
  Title: Name

  Maximum Length: 30

  Name of the plan.
• PlanningCalendar: string
  Maximum Length: 22

  Supply planning calendar used for aggregate planning. Review the values for this attribute using the Review Planning Calendars task.
• PlanningDemands: array Planning Demands
  Title: Planning Demands

  The Planning Demands resource manages the demand orders and forecasts that are part of the plan.
• PlanningSupplies: array Planning Supplies
  Title: Planning Supplies

  The Planning Supplies resource manages the supply orders such as work orders and purchase orders that are part of the plan.
• PlanOrganizationLevelMembers: string
  List of level values in the organization hierarchy included in the scope of the plan. A comma separates each value.
• PlanOwner: string
  Maximum Length: 64

  Name of the user who owns the plan.
• PlanStatus: integer
  Status of the plan run that most recently completed. Valid values include 0: completed, 1: processing, 2: error, or 3: warning. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE. This attribute doesn't have a default value.
• PlanTimeLevel: integer
  Time level used for aggregate planning. Valid values are Day, Week, Period, or Month. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_TIME_LEVEL.
• PlanType: integer
  Type of plan. Contains one of the following values. 1: demand plan, 2: supply plan, or 3: demand and supply plan. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_TYPE.
• PolicyAssignmentSetId: integer (int64)
  Value that uniquely identifies the policy assignment set. Review and update the value for this attribute using the Manage Policy Assignment Sets task. This attribute is mandatory if CalculatePolicyParamFlag is true.
• PolicyAssignmentSetName: string
  Name of the policy assignment set. Review and update the value for this attribute using the Manage Policy Assignment Sets task. This attribute is mandatory if Calculate Policy Parameters is selected.
• PolicyComparisonOption: integer (int32)
  Value that indicates whether to enable a plan for policy comparison. Valid values are 1 or 2. If 1, then enable plan for policy comparison. If 2, then disable plan for policy comparison. The default value is 2.
• PolicyComparisonThreshold: integer (int32)
  Percent value of the threshold used in policy comparison.
• PolicyParametersOption: integer
  Value that indicates whether or not to calculate policy parameters. Valid values are 1 or 2. If 1, then calculate policy parameters. If 2, then don't calculate policy parameters. The default value is 2.
• PriceLists: string
  List of price lists to consider in the plan. A comma separates each value.
• RelatedItemsSuppliesRules: string
  Read Only: true

  Maximum Length: 4000

  Contains one of the following values: 1,2 or 3. If 1, then don't use related items. If 2, then maximize the use of related items to minimize new replenishment orders. If 3, then use related items only when necessary to avoid stockouts. The default value is 1.
• ReplAggrPlannedOrders: integer (int32)
  Contains one of the following values: 1 or 2. If 1, then aggregate the planned orders. If 2, then don't aggregate the planned orders. The default value is 1.
• ReplenishmentsOption: integer
  Value that indicates whether to calculate replenishments. Valid values are 1 or 2. If 1, then calculate replenishments. If 2, then don't calculate replenishments. The default value is 1.
• ReplInvRebalanceOption: integer (int32)
  Value that indicates whether to perform inventory rebalancing. Valid values are 1 or 2. If 1, then perform inventory rebalancing. If 2, then don't perform inventory rebalancing. The default value is 2.
• ReplSupplyCutoffDays: integer
  Number of days after the plan end date during which the existing supplies are considered. The default value is 0.
• Runs: array Runs
  Title: Runs

  The Runs resource manages the run details of the replenishment plan. You can use this resource to run replenishment plans.
• SegmentGroup: integer (int64)
  Segment group that planning uses when the plan is run. Review and update the value for this attribute using the Manage Segment Groups task.
• Segments: string
  List of segments to consider in the plan. A comma separates each value. Review and update the value for this attribute using the Manage Segment Groups task.
• ShortPlanId: integer
  Value that uniquely identifies the plan.
• SimulationSet: integer (int64)
  Simulation set that planning uses when the plan runs. A simulation set is a set of adjustments that you make to inputs that affect the plan. You can use them to test different business scenarios, such as increasing the available resource capacity.
• TimeHorizonForDemand: integer (int32)
  Value that indicates the horizon within which the demand is considered. Valid values are 1: item lead time, or 2: none. The default value is 2.

{
    "type":"object",
    "properties":{
        "LastUpdatedDate":{
            "type":"string",
            "description":"Date when the user most recently updated the plan.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the plan.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeTransferOrders":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then include transfer orders when loading sales order history. If 2, then don't include. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "PlanningSupplies":{
            "title":"Planning Supplies",
            "type":"array",
            "description":"The Planning Supplies resource manages the supply orders such as work orders and purchase orders that are part of the plan.",
            "items":{
                "$ref":"#/components/schemas/replenishmentPlans-PlanningSupplies-item-response"
            }
        },
        "PolicyAssignmentSetName":{
            "type":"string",
            "description":"Name of the policy assignment set. Review and update the value for this attribute using the Manage Policy Assignment Sets task. This attribute is mandatory if Calculate Policy Parameters is selected.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Segments":{
            "type":"string",
            "description":"List of segments to consider in the plan. A comma separates each value. Review and update the value for this attribute using the Manage Segment Groups task.",
            "nullable":true,
            "x-queryable":true
        },
        "IncrementalPlanningOption":{
            "type":"integer",
            "description":"Value that indicates whether to enable a plan for incremental planning. Valid values are 1 or 2. If 1, then enable incremental planning. If 2, then disable incremental planning. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "PlanOwner":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who owns the plan.",
            "nullable":true,
            "x-queryable":true
        },
        "PolicyAssignmentSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the policy assignment set. Review and update the value for this attribute using the Manage Policy Assignment Sets task. This attribute is mandatory if CalculatePolicyParamFlag is true.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InvRebMoveExcessOption":{
            "type":"integer",
            "description":"Value that indicates whether to move excess inventory to sweep location. Valid values are 1 or 2. If 1, then move excess inventory. If 2, then don't move excess inventory. The default value is 1.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "PlanAccess":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then the plan is public. If 2, then the plan is private. Only the plan owner or users that the plan references can view a private plan. A list of accepted values is defined in the lookup type ORA_MSC_ACCESS. The default value is 1.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "PlanType":{
            "type":"integer",
            "description":"Type of plan. Contains one of the following values. 1: demand plan, 2: supply plan, or 3: demand and supply plan. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "Clusters":{
            "type":"string",
            "description":"Name of the clusters for which inventory rebalancing is performed.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PolicyComparisonThreshold":{
            "type":"integer",
            "description":"Percent value of the threshold used in policy comparison.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "ReplInvRebalanceOption":{
            "type":"integer",
            "description":"Value that indicates whether to perform inventory rebalancing. Valid values are 1 or 2. If 1, then perform inventory rebalancing. If 2, then don't perform inventory rebalancing. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "ExcessLtMultiplier":{
            "type":"number",
            "description":"Value by which item lead time is multiplied by to calculate the time window within which excess quantity is computed for item substitution or supersession.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PolicyComparisonOption":{
            "type":"integer",
            "description":"Value that indicates whether to enable a plan for policy comparison. Valid values are 1 or 2. If 1, then enable plan for policy comparison. If 2, then disable plan for policy comparison. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who performed the most recent update on the plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandPlanCompletionDate":{
            "type":"string",
            "description":"Date and time when demand planning finished running the plan.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ReplenishmentsOption":{
            "type":"integer",
            "description":"Value that indicates whether to calculate replenishments. Valid values are 1 or 2. If 1, then calculate replenishments. If 2, then don't calculate replenishments. The default value is 1.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteArchive":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then delete plan archives that were created before the most recent days to keep during the next plan run. If 2, then don't delete plan archives. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "PlanDimensionCatalog":{
            "type":"integer",
            "description":"Dimension catalog that the plan references. The dimension catalog determines the dimensions that you can use in each plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DemandPlanStartDate":{
            "type":"string",
            "description":"Date and time when demand planning started running the plan.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCalendar":{
            "maxLength":"22",
            "type":"string",
            "description":"Supply planning calendar used for aggregate planning. Review the values for this attribute using the Review Planning Calendars task.",
            "nullable":true,
            "x-queryable":true
        },
        "AutoRelease":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then release planning recommendations. If 2, then don't release. The default value is 2.",
            "nullable":true,
            "x-queryable":true
        },
        "ForecastOption":{
            "type":"integer",
            "description":"Value that indicates whether to generate a forecast or not. Valid values are 1 or 2. If 1, then generate a forecast. If 2, then don't generate a forecast. The default value is 2.",
            "nullable":true,
            "x-queryable":true
        },
        "ArchiveTimeLevel":{
            "type":"integer",
            "description":"Time hierarchy level that the application uses to archive the plan. The ArchiveTimeHierarchy attribute determines the values that you can use for this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReplAggrPlannedOrders":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then aggregate the planned orders. If 2, then don't aggregate the planned orders. The default value is 1.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "RelatedItemsSuppliesRules":{
            "maxLength":"4000",
            "type":"string",
            "description":"Contains one of the following values: 1,2 or 3. If 1, then don't use related items. If 2, then maximize the use of related items to minimize new replenishment orders. If 3, then use related items only when necessary to avoid stockouts. The default value is 1.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"100",
            "type":"string",
            "description":"Description of the plan.",
            "nullable":true,
            "x-queryable":true
        },
        "ShortPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanTimeLevel":{
            "type":"integer",
            "description":"Time level used for aggregate planning. Valid values are Day, Week, Period, or Month. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_TIME_LEVEL.",
            "nullable":true,
            "x-queryable":true
        },
        "ReplSupplyCutoffDays":{
            "type":"integer",
            "description":"Number of days after the plan end date during which the existing supplies are considered. The default value is 0.",
            "nullable":true,
            "x-queryable":true
        },
        "InvRebIncludeSsOption":{
            "type":"integer",
            "description":"Value that indicates whether to include safety stock in shortages computation. Valid values are 1 or 2. If 1, then include safety stock. If 2, then don't include safety stock. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "PlanName":{
            "title":"Name",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the plan.",
            "nullable":false,
            "x-queryable":true
        },
        "InvRebalancePartialsOption":{
            "type":"integer",
            "description":"Value that indicates whether to create partial orders from source location that doesn't have enough inventory to meet the entire destination location shortages. Valid values are 1 or 2. If 1, then don't create partial orders. If 2, then create partial orders. The default value is 1.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "Runs":{
            "title":"Runs",
            "type":"array",
            "description":"The Runs resource manages the run details of the replenishment plan. You can use this resource to run replenishment plans.",
            "items":{
                "$ref":"#/components/schemas/replenishmentPlans-Runs-item-response"
            }
        },
        "PolicyParametersOption":{
            "type":"integer",
            "description":"Value that indicates whether or not to calculate policy parameters. Valid values are 1 or 2. If 1, then calculate policy parameters. If 2, then don't calculate policy parameters. The default value is 2.",
            "nullable":true,
            "x-queryable":true
        },
        "CalendarCode":{
            "maxLength":"22",
            "type":"string",
            "description":"Abbreviation that identifies the calendar.",
            "nullable":true,
            "x-queryable":true
        },
        "ForecastProfiles":{
            "type":"string",
            "description":"List of forecast profiles that the plan run uses. A comma separates each forecast profile name.",
            "nullable":true,
            "x-queryable":true
        },
        "HasRun":{
            "type":"integer",
            "description":"Abbreviation that identifies the time bucket type for forecasting buckets. Valid values vary based on the forecasting calendar type. If the forecasting calendar type is 5, manufacturing calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_MFG. If the forecasting calendar type is 1, Gregorian calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_GREGORIAN. If the forecasting calendar type is 3, fiscal calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_FISCAL.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanOrganizationLevelMembers":{
            "type":"string",
            "description":"List of level values in the organization hierarchy included in the scope of the plan. A comma separates each value.",
            "nullable":true,
            "x-queryable":true
        },
        "AggregateNonkeyCustomerData":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then use aggregated data for non-key customers. If 2, then don't use this data. If you aggregate data in a plan, then the application uses the predefined level for each member as the aggregated data. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "ItemListPrice":{
            "type":"integer",
            "description":"This attribute isn't currently used.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "ArchivePlan":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then archive the plan before the next run starts. You can archive the plan only if you enable it for archiving. If 2, then don't archive. The default value is 2.",
            "nullable":true,
            "x-queryable":true
        },
        "EnableArchive":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then archive the plan measures through the archive plan option. If 2, then don't archive measures. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "PlanStatus":{
            "type":"integer",
            "description":"Status of the plan run that most recently completed. Valid values include 0: completed, 1: processing, 2: error, or 3: warning. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "MeasureCatalogForArchival":{
            "type":"string",
            "description":"Measure catalog that the application uses to archive the plan.",
            "nullable":true,
            "x-queryable":true
        },
        "LeadTimeMultiplier":{
            "type":"integer",
            "description":"Item lead time that's multiplied by to calculate the lead time window within which all demands are considered.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "NumberOfBuckets":{
            "type":"integer",
            "description":"Number of planning buckets of the specified type used in the supply planning process.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PriceLists":{
            "type":"string",
            "description":"List of price lists to consider in the plan. A comma separates each value.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentSetName":{
            "type":"string",
            "description":"Name of the assignment set that specifies the sourcing rules and bills of distribution to use for material flow in the supply chain when running the plan. You can use the Manage Assignment Sets page in one of the work areas for supply chain planning to set the values you can use with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ArchiveVersionDays":{
            "type":"integer",
            "description":"Number of days that the application retains the archive. The application deletes each archive that's older than the current date minus Most Recent Days to Keep. The application performs this deletion when it creates each new archive.",
            "nullable":true,
            "x-queryable":true
        },
        "ArchiveTimeHierarchy":{
            "type":"integer",
            "description":"Time hierarchy that the application uses to archive the plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SimulationSet":{
            "type":"integer",
            "description":"Simulation set that planning uses when the plan runs. A simulation set is a set of adjustments that you make to inputs that affect the plan. You can use them to test different business scenarios, such as increasing the available resource capacity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TimeHorizonForDemand":{
            "type":"integer",
            "description":"Value that indicates the horizon within which the demand is considered. Valid values are 1: item lead time, or 2: none. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "ForecastingTimeLevel":{
            "type":"integer",
            "description":"Abbreviation that identifies the time bucket type for forecasting buckets. Valid values vary based on the forecasting calendar type. If the forecasting calendar type is 5, manufacturing calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_MFG. If the forecasting calendar type is 1, Gregorian calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_GREGORIAN. If the forecasting calendar type is 3, fiscal calendar, then a list of accepted values is defined in the lookup type ORA_MSC_TIME_LEVELS_FISCAL.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanHorizonStartDate":{
            "type":"string",
            "description":"Date when the plan starts planning demand and supply.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SegmentGroup":{
            "type":"integer",
            "description":"Segment group that planning uses when the plan is run. Review and update the value for this attribute using the Manage Segment Groups task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanningDemands":{
            "title":"Planning Demands",
            "type":"array",
            "description":"The Planning Demands resource manages the demand orders and forecasts that are part of the plan.",
            "items":{
                "$ref":"#/components/schemas/replenishmentPlans-PlanningDemands-item-response"
            }
        },
        "CutoffDate":{
            "type":"string",
            "description":"End date of the planning horizon when planning no longer plans demand or supply.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExceptionSet":{
            "type":"integer",
            "description":"Exception set that the plan references. The exception set determines the exception types that the plan creates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanMeasureCatalog":{
            "type":"string",
            "description":"Measure catalog that the plan references. The measure catalog determines the measures that you can use in each plan.",
            "nullable":true,
            "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 : Planning Demands

Type: array

Title: Planning Demands

The Planning Demands resource manages the demand orders and forecasts that are part of the plan.

Show Source

• Array of: object replenishmentPlans-PlanningDemands-item-response

{
    "title":"Planning Demands",
    "type":"array",
    "description":"The Planning Demands resource manages the demand orders and forecasts that are part of the plan.",
    "items":{
        "$ref":"#/components/schemas/replenishmentPlans-PlanningDemands-item-response"
    }
}

Nested Schema : Planning Supplies

Type: array

Title: Planning Supplies

The Planning Supplies resource manages the supply orders such as work orders and purchase orders that are part of the plan.

Show Source

• Array of: object replenishmentPlans-PlanningSupplies-item-response

{
    "title":"Planning Supplies",
    "type":"array",
    "description":"The Planning Supplies resource manages the supply orders such as work orders and purchase orders that are part of the plan.",
    "items":{
        "$ref":"#/components/schemas/replenishmentPlans-PlanningSupplies-item-response"
    }
}

Nested Schema : Runs

Type: array

Title: Runs

The Runs resource manages the run details of the replenishment plan. You can use this resource to run replenishment plans.

Show Source

• Array of: object replenishmentPlans-Runs-item-response

{
    "title":"Runs",
    "type":"array",
    "description":"The Runs resource manages the run details of the replenishment plan. You can use this resource to run replenishment plans.",
    "items":{
        "$ref":"#/components/schemas/replenishmentPlans-Runs-item-response"
    }
}

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

Nested Schema : replenishmentPlans-PlanningDemands-item-response

Type: object

Show Source

• Action: string
  Read Only: true

  Maximum Length: 80

  Value that indicates the type of recommended change made by the planning engine to the supply or demand. Valid values include None, Cancel, Reschedule in, Reschedule out, Release, Release reservation, and Reschedule and release reservation. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS.
• BucketType: string
  Title: Bucket Type

  Read Only: true

  Maximum Length: 7

  Time bucket used for forecast demands. Valid values include Day, Month, Period, or Week. A list of accepted values is defined in the lookup types ORA_MSC_TIME_LEVELS_GREGORIAN and ORA_MSC_TIME_LEVELS_MFG.
• Buyer: string
  Title: Buyer

  Read Only: true

  Name of the buyer associated with the item.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the order.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the order.
• Customer: string
  Title: Customer

  Maximum Length: 4000

  Name of the customer associated with the sales order or forecast.
• CustomerSite: string
  Title: Customer Site

  Maximum Length: 4000

  Code associated with a specific customer ship-to location.
• DemandClass: string
  Read Only: true

  Maximum Length: 34

  Classification of demand used to track and consume different types of demand. Review and update the value for this attribute using the Manage Demand Classes task.
• DemandClassCode: string
  Title: Demand Class

  Maximum Length: 400

  Code that identifies the demand class associated with the order. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is DEMAND_CLASS.
• DestinationTimeZone: string
  Title: Destination Time Zone

  Read Only: true

  Maximum Length: 100

  Time zone associated with the entity that's receiving the order. The destination entity can be a customer or an organization.
• DestOrgCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the destination organization of an order.
• FirmDate: string (date)
  Title: Firm Date

  Date when the demand is due. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.
• FirmPlannedType: integer (int32)
  Title: Firm Status

  Value that indicates whether the demand is firmed or not. Valid values are 1 or 2. If 1, then the demand is firm. If 2, then the demand isn't firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
• FirmQuantity: number
  Title: Firm Quantity

  Fixed quantity of demand. This attribute value can't be changed by planning and is only populated when the firm status is firm.
• FirmStatus: string
  Read Only: true

  Maximum Length: 200

  Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
• FulfillmentLine: integer
  Title: Fulfillment Line

  Read Only: true

  Fulfillment line number associated with a sales order.
• ImplementDate: string (date)
  Title: Implement Date

  Date when the order is implemented.
• ImplementDemandClass: string
  Title: Implement Demand Class

  Maximum Length: 30

  Demand class associated with the order that will be used when the order is released.
• ImplementedQuantity: number
  Title: Implemented Quantity

  Cumulative quantity that has been released to date.
• ImplementFirm: integer
  Title: Implement Firm

  Value that indicates whether the order is firm or not. Valid values are 1: Firm and 2: Not Firm. A list of accepted values is defined in the lookup type MSC_YES_NO.
• ImplementFirmOption: string
  Read Only: true

  Maximum Length: 200

  Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
• ImplementQuantity: number
  Title: Implement Quantity

  Order quantity for the released order.
• ImplementShipDate: string (date)
  Title: Implement Ship Date

  Date when the order is shipped.
• ImplementShipMethod: string
  Maximum Length: 30

  Value that identifies the shipping method used when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
• ImplementShippingMethod: string
  Title: Implement Shipping Method

  Maximum Length: 400

  Value that indicates the shipping method used to ship the order when the order is released, or is a concatenation of carrier name, method of transportation, and service level used when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
• ImplementSourceOrganization: string
  Title: Implement Source Organization

  Read Only: true

  Maximum Length: 100

  Source organization for the released order.
• Item: string
  Title: Item

  Maximum Length: 300

  Name of the item associated with the demand.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Description of the item associated with the demand.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the demand was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the demand.
• LatestAcceptableDate: string (date)
  Title: Latest Acceptable Date

  Read Only: true

  Date beyond which the demand line must not be promised.
• LineNumber: string
  Title: Line Number

  Read Only: true

  Maximum Length: 100

  Line number associated with the demand.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Lot: string
  Title: Lot

  Read Only: true

  Lot number associated with an expired on-hand lot.
• MakeOrBuy: string
  Read Only: true

  Maximum Length: 200

  Value that indicates whether the item is a manufactured item or a purchased item. Valid values include Make or Buy. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.
• MarkForReleaseOption: string
  Value that indicates the release status of the order. Valid values are 1: Marked For Release, 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute.
• MaterialAvailableDate: string (date)
  Title: Material Available Date

  Read Only: true

  Date when the total quantity is available.
• Message: string
  Read Only: true

  Text of the error message, if any, encountered when creating or updating a demand.
• NeedByDate: string (date)
  Title: Need-by Date

  Read Only: true

  Date by when the demand quantity is needed.
• OldDueDate: string (date)
  Title: Old Due Date

  Read Only: true

  Date when the demand quantity was originally due. This attribute value is extracted from the source application.
• OrderDateType: string
  Title: Order Date Type

  Read Only: true

  Maximum Length: 4000

  Value that indicates the date specified by the customer. This attribute applies only to sales orders. Valid values include Ship date or Arrival date. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_DATE_TYPE_CODE.
• OrderDateTypeCode: integer
  Read Only: true

  Value that indicates the date specified by the customer. This attribute applies only to sales orders. Valid values include: 1 where customer has specified a requested ship date or 2 where customer has specified a requested arrival date. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_DATE_TYPE_CODE.
• OrderNumber: string
  Title: Order Number

  Read Only: true

  Maximum Length: 4000

  Order number associated with the sales order.
• OrderQuantity: number
  Title: Order Quantity

  Read Only: true

  Quantity associated with the demand.
• OrderType: integer (int32)
  Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
• OrderTypeText: string
  Title: Order Type

  Maximum Length: 4000

  Value that indicates the type of order such as sales order or forecast. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
• Organization: string
  Title: Organization

  Maximum Length: 49

  Name of the organization associated with the order.
• OrganizationTimeZone: string
  Title: Organization Time Zone

  Read Only: true

  Maximum Length: 100

  Time zone of the organization associated with the demand.
• OrgCurrencyCode: string
  Read Only: true

  Maximum Length: 100

  Abbreviation that identifies the base currency of the organization.
• OriginalItemQuantity: number
  Title: Original Item Quantity

  Read Only: true

  Demand quantity of the original item, which may be different from the order quantity, if substitution is allowed.
• OriginalNeedByDate: string (date)
  Title: Original Need-by Date

  Read Only: true

  Date when the order is needed. This value is extracted from the source application.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• PlannedArrivalDate: string (date)
  Title: Planned Arrival Date

  Read Only: true

  Date when the item will arrive. The attribute value is calculated using the suggested ship date, carrier calendar, in-transit lead time, and the receiving calendar.
• Planner: string
  Title: Planner

  Read Only: true

  Maximum Length: 10

  Abbreviation that identifies the planner responsible for the item.
• PlannerDescription: string
  Title: Planner Description

  Read Only: true

  Maximum Length: 100

  Description of the planner responsible for the item.
• PlanningMakeBuyCode: integer
  Title: Make or Buy

  Read Only: true

  Abbreviation that indicates whether the item is manufactured or purchased. Valid values are 1 or 2. If 1, then the item is a manufactured item. If 2, then the item is a purchased item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.
• QuantityByDueDate: number
  Title: Quantity by Due Date

  Read Only: true

  Quantity that can be provided by the due date. For example, the order quantity may be 100 units, but only 50 units may be available by the due date.
• ReleaseErrors: string
  Read Only: true

  Maximum Length: 400

  Errors that are generated in the release process.
• ReleaseStatus: integer
  Title: Release Status

  Code that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.
• ReleaseStatusText: string
  Read Only: true

  Maximum Length: 80

  Value that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.
• RequestedItem: string
  Title: Requested Item

  Read Only: true

  Maximum Length: 4000

  Name of the item that was originally requested which, due to item substitution, can be different from the item used to fulfill the demand.
• ScheduledArrivalDate: string (date)
  Title: Scheduled Arrival Date

  Read Only: true

  Date when the demand has been scheduled to arrive at a customer site.
• ScheduledShipDate: string (date)
  Title: Scheduled Ship Date

  Read Only: true

  Date when the demand has been scheduled to be shipped.
• ScheduleName: string
  Title: Schedule Name

  Read Only: true

  Maximum Length: 4000

  Name of the supply or demand schedule associated with an order.
• SegmentName: string
  Title: Segment

  Read Only: true

  Maximum Length: 120

  Name of the segment used for a set of items.
• SellingPrice: number
  Read Only: true

  Selling price of an item on the order line.
• ShipCalendar: string
  Read Only: true

  Maximum Length: 15

  Shipping calendar associated with the order.
• ShipMethod: string
  Maximum Length: 30

  Value that indicates the shipping method associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
• ShippingMethod: string
  Title: Shipping Method

  Maximum Length: 4000

  Value that indicates the shipping method used to ship the order, or is a concatenation of carrier name, method of transportation, and service level associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
• ShipTo: string
  Title: Ship To

  Read Only: true

  Maximum Length: 4000

  Abbreviation that indicates the specific ship-to location.
• SimulationSetId: integer (int64)
  Value that uniquely identifies the simulation set used in the plan, if any.
• SourceOrder: string
  Title: Source Order

  Read Only: true

  Maximum Length: 50

  Value that identifies the order number in the source application against which fulfillment line has been created.
• SourceOrderLine: string
  Title: Source Order Line

  Read Only: true

  Maximum Length: 50

  Value that identifies the order line number in the source application against which fulfillment line has been created.
• SourceOrganization: string
  Title: Source Organization

  Maximum Length: 49

  Organization that will source the order.
• SourceTimeZone: string
  Title: Source Time Zone

  Read Only: true

  Maximum Length: 100

  Time zone associated with the entity that's sourcing the order. The sourcing entity can be a supplier or an organization.
• SuggestedDueDate: string (date)
  Title: Suggested Due Date

  Read Only: true

  Date when the demand is recommended to be completed.
• SuggestedOrderDate: string (date)
  Title: Suggested Order Date

  Read Only: true

  Date when the order is recommended to be placed.
• SuggestedShipDate: string (date)
  Title: Suggested Ship Date

  Read Only: true

  Date when the order is recommended to be shipped.
• Supplier: string
  Title: Supplier

  Maximum Length: 4000

  Name of the source supplier.
• SupplierSite: string
  Title: Supplier Site

  Maximum Length: 4000

  Abbreviation that indicates the specific supplier ship-from location.
• TransactionId: integer (int64)
  Value that uniquely identifies the demand. This value is internally generated by the application.
• TransitLeadTime: number
  Title: Transit Lead Time

  Read Only: true

  Number of days that the demand is in transit between two locations.
• UnitNumber: string
  Title: Unit Number

  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the bill of material to be used for building a specific model or unit number effectivity-controlled item. This attribute is also known as End Item Unit Number.
• UOM: string
  Read Only: true

  Maximum Length: 200

  Name of the unit of measure that's associated with the order quantity.
• UOMCode: string
  Title: UOM

  Read Only: true

  Abbreviation that identifies the unit of measure associated with the order quantity.
• UsingAssembly: string
  Title: Using Assembly

  Maximum Length: 4000

  For component demands, this field refers to the assembly item that uses this item as a component.
• Zone: string
  Title: Zone

  Read Only: true

  Maximum Length: 400

  Region or zone where the demand quantity is being shipped.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the order.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannedArrivalDate":{
            "title":"Planned Arrival Date",
            "type":"string",
            "description":"Date when the item will arrive. The attribute value is calculated using the suggested ship date, carrier calendar, in-transit lead time, and the receiving calendar.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the shipping method associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.",
            "nullable":true,
            "x-queryable":true
        },
        "ShippingMethod":{
            "title":"Shipping Method",
            "maxLength":"4000",
            "type":"string",
            "description":"Value that indicates the shipping method used to ship the order, or is a concatenation of carrier name, method of transportation, and service level associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.",
            "nullable":true,
            "x-queryable":true
        },
        "FirmDate":{
            "title":"Firm Date",
            "type":"string",
            "description":"Date when the demand is due. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Customer":{
            "title":"Customer",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the customer associated with the sales order or forecast.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduledShipDate":{
            "title":"Scheduled Ship Date",
            "type":"string",
            "description":"Date when the demand has been scheduled to be shipped.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedItem":{
            "title":"Requested Item",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the item that was originally requested which, due to item substitution, can be different from the item used to fulfill the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Order Number",
            "maxLength":"4000",
            "type":"string",
            "description":"Order number associated with the sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderTypeText":{
            "title":"Order Type",
            "maxLength":"4000",
            "type":"string",
            "description":"Value that indicates the type of order such as sales order or forecast. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "BucketType":{
            "title":"Bucket Type",
            "maxLength":"7",
            "type":"string",
            "description":"Time bucket used for forecast demands. Valid values include Day, Month, Period, or Week. A list of accepted values is defined in the lookup types ORA_MSC_TIME_LEVELS_GREGORIAN and ORA_MSC_TIME_LEVELS_MFG.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestOrgCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the destination organization of an order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaterialAvailableDate":{
            "title":"Material Available Date",
            "type":"string",
            "description":"Date when the total quantity is available.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSite":{
            "title":"Customer Site",
            "maxLength":"4000",
            "type":"string",
            "description":"Code associated with a specific customer ship-to location.",
            "nullable":true,
            "x-queryable":true
        },
        "Item":{
            "title":"Item",
            "maxLength":"300",
            "type":"string",
            "description":"Name of the item associated with the demand.",
            "nullable":true,
            "x-queryable":true
        },
        "ImplementShipDate":{
            "title":"Implement Ship Date",
            "type":"string",
            "description":"Date when the order is shipped.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OrderType":{
            "type":"integer",
            "description":"Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "DestinationTimeZone":{
            "title":"Destination Time Zone",
            "maxLength":"100",
            "type":"string",
            "description":"Time zone associated with the entity that's receiving the order. The destination entity can be a customer or an organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestedOrderDate":{
            "title":"Suggested Order Date",
            "type":"string",
            "description":"Date when the order is recommended to be placed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementFirm":{
            "title":"Implement Firm",
            "type":"integer",
            "description":"Value that indicates whether the order is firm or not. Valid values are 1: Firm and 2: Not Firm. A list of accepted values is defined in the lookup type MSC_YES_NO.",
            "nullable":true,
            "x-queryable":true
        },
        "ReleaseStatus":{
            "title":"Release Status",
            "type":"integer",
            "description":"Code that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReleaseErrors":{
            "maxLength":"400",
            "type":"string",
            "description":"Errors that are generated in the release process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledArrivalDate":{
            "title":"Scheduled Arrival Date",
            "type":"string",
            "description":"Date when the demand has been scheduled to arrive at a customer site.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementShippingMethod":{
            "title":"Implement Shipping Method",
            "maxLength":"400",
            "type":"string",
            "description":"Value that indicates the shipping method used to ship the order when the order is released, or is a concatenation of carrier name, method of transportation, and service level used when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure associated with the order quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LatestAcceptableDate":{
            "title":"Latest Acceptable Date",
            "type":"string",
            "description":"Date beyond which the demand line must not be promised.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementedQuantity":{
            "title":"Implemented Quantity",
            "type":"number",
            "description":"Cumulative quantity that has been released to date.",
            "nullable":true,
            "x-queryable":true
        },
        "UsingAssembly":{
            "title":"Using Assembly",
            "maxLength":"4000",
            "type":"string",
            "description":"For component demands, this field refers to the assembly item that uses this item as a component.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentName":{
            "title":"Segment",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the segment used for a set of items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementDate":{
            "title":"Implement Date",
            "type":"string",
            "description":"Date when the order is implemented.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrder":{
            "title":"Source Order",
            "maxLength":"50",
            "type":"string",
            "description":"Value that identifies the order number in the source application against which fulfillment line has been created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrderLine":{
            "title":"Source Order Line",
            "maxLength":"50",
            "type":"string",
            "description":"Value that identifies the order line number in the source application against which fulfillment line has been created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestedDueDate":{
            "title":"Suggested Due Date",
            "type":"string",
            "description":"Date when the demand is recommended to be completed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SellingPrice":{
            "type":"number",
            "description":"Selling price of an item on the order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand. This value is internally generated by the application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Lot":{
            "title":"Lot",
            "type":"string",
            "description":"Lot number associated with an expired on-hand lot.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ImplementSourceOrganization":{
            "title":"Implement Source Organization",
            "maxLength":"100",
            "type":"string",
            "description":"Source organization for the released order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementShipMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the shipping method used when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":"4000",
            "type":"string",
            "description":"Abbreviation that indicates the specific supplier ship-from location.",
            "nullable":true,
            "x-queryable":true
        },
        "MarkForReleaseOption":{
            "type":"string",
            "description":"Value that indicates the release status of the order. Valid values are 1: Marked For Release, 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "SuggestedShipDate":{
            "title":"Suggested Ship Date",
            "type":"string",
            "description":"Date when the order is recommended to be shipped.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SimulationSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the simulation set used in the plan, if any.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UnitNumber":{
            "title":"Unit Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number that uniquely identifies the bill of material to be used for building a specific model or unit number effectivity-controlled item. This attribute is also known as End Item Unit Number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningMakeBuyCode":{
            "title":"Make or Buy",
            "type":"integer",
            "description":"Abbreviation that indicates whether the item is manufactured or purchased. Valid values are 1 or 2. If 1, then the item is a manufactured item. If 2, then the item is a purchased item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MakeOrBuy":{
            "maxLength":"200",
            "type":"string",
            "description":"Value that indicates whether the item is a manufactured item or a purchased item. Valid values include Make or Buy. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Action":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that indicates the type of recommended change made by the planning engine to the supply or demand. Valid values include None, Cancel, Reschedule in, Reschedule out, Release, Release reservation, and Reschedule and release reservation. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "title":"Organization",
            "maxLength":"49",
            "type":"string",
            "description":"Name of the organization associated with the order.",
            "nullable":true,
            "x-queryable":true
        },
        "Message":{
            "type":"string",
            "description":"Text of the error message, if any, encountered when creating or updating a demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTimeZone":{
            "title":"Source Time Zone",
            "maxLength":"100",
            "type":"string",
            "description":"Time zone associated with the entity that's sourcing the order. The sourcing entity can be a supplier or an organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OldDueDate":{
            "title":"Old Due Date",
            "type":"string",
            "description":"Date when the demand quantity was originally due. This attribute value is extracted from the source application.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginalNeedByDate":{
            "title":"Original Need-by Date",
            "type":"string",
            "description":"Date when the order is needed. This value is extracted from the source application.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReleaseStatusText":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Buyer":{
            "title":"Buyer",
            "type":"string",
            "description":"Name of the buyer associated with the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item associated with the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line Number",
            "maxLength":"100",
            "type":"string",
            "description":"Line number associated with the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderQuantity":{
            "title":"Order Quantity",
            "type":"number",
            "description":"Quantity associated with the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementQuantity":{
            "title":"Implement Quantity",
            "type":"number",
            "description":"Order quantity for the released order.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrganization":{
            "title":"Source Organization",
            "maxLength":"49",
            "type":"string",
            "description":"Organization that will source the order.",
            "nullable":true,
            "x-queryable":true
        },
        "FirmStatus":{
            "maxLength":"200",
            "type":"string",
            "description":"Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FulfillmentLine":{
            "title":"Fulfillment Line",
            "type":"integer",
            "description":"Fulfillment line number associated with a sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the source supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalItemQuantity":{
            "title":"Original Item Quantity",
            "type":"number",
            "description":"Demand quantity of the original item, which may be different from the order quantity, if substitution is allowed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderDateType":{
            "title":"Order Date Type",
            "maxLength":"4000",
            "type":"string",
            "description":"Value that indicates the date specified by the customer. This attribute applies only to sales orders. Valid values include Ship date or Arrival date. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_DATE_TYPE_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgCurrencyCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation that identifies the base currency of the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransitLeadTime":{
            "title":"Transit Lead Time",
            "type":"number",
            "description":"Number of days that the demand is in transit between two locations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Zone":{
            "title":"Zone",
            "maxLength":"400",
            "type":"string",
            "description":"Region or zone where the demand quantity is being shipped.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmPlannedType":{
            "title":"Firm Status",
            "type":"integer",
            "description":"Value that indicates whether the demand is firmed or not. Valid values are 1 or 2. If 1, then the demand is firm. If 2, then the demand isn't firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlannerDescription":{
            "title":"Planner Description",
            "maxLength":"100",
            "type":"string",
            "description":"Description of the planner responsible for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandClass":{
            "maxLength":"34",
            "type":"string",
            "description":"Classification of demand used to track and consume different types of demand. Review and update the value for this attribute using the Manage Demand Classes task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementFirmOption":{
            "maxLength":"200",
            "type":"string",
            "description":"Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleName":{
            "title":"Schedule Name",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the supply or demand schedule associated with an order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipCalendar":{
            "maxLength":"15",
            "type":"string",
            "description":"Shipping calendar associated with the order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOM":{
            "maxLength":"200",
            "type":"string",
            "description":"Name of the unit of measure that's associated with the order quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderDateTypeCode":{
            "type":"integer",
            "description":"Value that indicates the date specified by the customer. This attribute applies only to sales orders. Valid values include: 1 where customer has specified a requested ship date or 2 where customer has specified a requested arrival date. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_DATE_TYPE_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmQuantity":{
            "title":"Firm Quantity",
            "type":"number",
            "description":"Fixed quantity of demand. This attribute value can't be changed by planning and is only populated when the firm status is firm.",
            "nullable":true,
            "x-queryable":true
        },
        "NeedByDate":{
            "title":"Need-by Date",
            "type":"string",
            "description":"Date by when the demand quantity is needed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationTimeZone":{
            "title":"Organization Time Zone",
            "maxLength":"100",
            "type":"string",
            "description":"Time zone of the organization associated with the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandClassCode":{
            "title":"Demand Class",
            "maxLength":"400",
            "type":"string",
            "description":"Code that identifies the demand class associated with the order. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is DEMAND_CLASS.",
            "nullable":true,
            "x-queryable":true
        },
        "Planner":{
            "title":"Planner",
            "maxLength":"10",
            "type":"string",
            "description":"Abbreviation that identifies the planner responsible for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipTo":{
            "title":"Ship To",
            "maxLength":"4000",
            "type":"string",
            "description":"Abbreviation that indicates the specific ship-to location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementDemandClass":{
            "title":"Implement Demand Class",
            "maxLength":"30",
            "type":"string",
            "description":"Demand class associated with the order that will be used when the order is released.",
            "nullable":true,
            "x-queryable":true
        },
        "QuantityByDueDate":{
            "title":"Quantity by Due Date",
            "type":"number",
            "description":"Quantity that can be provided by the due date. For example, the order quantity may be 100 units, but only 50 units may be available by the due date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the demand was most recently updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "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 : replenishmentPlans-PlanningSupplies-item-response

Type: object

Show Source

• Action: string
  Read Only: true

  Maximum Length: 80

  Value that indicates the action recommended by planning. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS.
• ActualStartDate: string (date)
  Title: Actual Start Date

  Read Only: true
• AssetNumber: string
  Title: Asset

  Read Only: true

  Maximum Length: 80

  Number that identifies the asset associated with a maintenance work order.
• BillSequenceId: integer (int64)
  Value that uniquely identifies the sequence in which a component is used within an operation.
• BmtOption: integer
  Title: Buyer-Managed Transportation

  Read Only: true

  Contains one of the following values: 1 or 2. If 1, then the buyer is responsible for the transportation of the purchased item. If 2, then the buyer isn't responsible for the transportation of the purchased item. This attribute applies only to purchased items.
• Buyer: string
  Title: Buyer

  Read Only: true

  Name of the buyer associated to the item.
• BuyerManagedTransportation: string
  Read Only: true

  Maximum Length: 200

  Contains one of the following values: Yes or No. If Yes, then the buyer is responsible for the transportation of the purchased item. If No, then the buyer isn't responsible for the transportation of the purchased item. This attribute applies only to purchased items.
• ClusterId: integer (int64)
  Value that uniquely identifies the cluster.
• ClusterName: string
  Name of the cluster.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the order.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the order.
• Customer: string
  Title: Customer

  Maximum Length: 4000

  Name of the customer associated with the drop ship purchase order.
• CustomerSite: string
  Title: Customer Site

  Maximum Length: 4000

  Code associated with a specific customer ship-to location.
• DaysPastDue: number
  Title: Days Past Due

  Read Only: true

  Number of days that the supply date is in the past.
• DestinationTimeZone: string
  Title: Destination Time Zone

  Read Only: true

  Maximum Length: 100

  Time zone associated with the entity that's receiving the order. The destination entity can be a customer or an organization.
• DestOrgCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the destination organization for an order.
• EarliestStartDate: string (date)
  Title: Earliest Start Date

  Read Only: true

  Earliest date on which a supply can start based on the lead times of all its upstream supplies, or its planning time-fence date, or based on the constrained capacity of a resource or supplier. This date is calculated by constraint-based plans
• ExcessReductionAtSrc: number
  Percentage value by which the inventory excess at the source location is reduced.
• ExpenseDestinationTransfer: string
  Read Only: true

  Maximum Length: 100

  Contains one of the following values: Yes or No. If Yes, then the transfer is to an expense destination. If No, then the transfer isn't to an expense destination.
• ExpirationDate: string (date)
  Title: Expiration Date

  Date when the existing lot associated with the supply expires.
• FirmDate: string (date)
  Title: Firm Date

  Date when supply is due. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.
• FirmPlannedType: integer (int32)
  Title: Firm Status

  Value that indicates whether the order is firmed or not. Valid values are 1 or 2. If 1, then the order is firm. If 2, then the order isn't firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
• FirmQuantity: number
  Title: Firm Quantity

  Fixed quantity of supply. This attribute value can't be changed by planning and is only populated when the firm status is firm.
• FirmStartDate: string (date)
  Date when supply begins. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.
• FirmStartQuantity: number
  Title: Firm Start Quantity

  User-specified start quantity of a supply. This attribute value can't be changed by planning and is only populated when the firm status is firm.
• FirmStatus: string
  Read Only: true

  Maximum Length: 200

  Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
• HoldDate: string (date)
  Title: Hold Date

  Read Only: true

  Date on which the on-hand inventory lot is no longer on hold.
• ImplementAs: integer
  Title: Implement Order Type

  Value that indicates the type of order to be implemented. Valid values are 1: None, 2: Purchase requisition, 3: Work order, or 5: Internal requisition. A list of accepted values is defined in the lookup type ORA_MSC_WORKBENCH_IMPLEMENT_AS.
• ImplementDate: string (date)
  Title: Implement Date

  Date when the order is released.
• ImplementDockDate: string (date)
  Title: Implement Dock Date

  Date when the material should be on the receiving dock when the order is released.
• ImplementedQuantity: number
  Title: Implemented Quantity

  Cumulative quantity that has been released to date.
• ImplementEmployeeId: integer (int64)
• ImplementFirm: integer
  Title: Implement Firm

  Value that indicates whether the order is firm or not. Valid values are 1: Firm and 2: Not Firm. A list of accepted values is defined in the lookup type MSC_YES_NO.
• ImplementFirmOption: string
  Read Only: true

  Maximum Length: 200

  Status to use when the order is released. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
• ImplementJobName: string
  Title: Implement Work Order Number

  Maximum Length: 120

  Job name of the work order to be created when the order is released.
• ImplementLocation: string
  Title: Implement Location

  Maximum Length: 400

  Value that identifies the deliver-to location to use when the order is released.
• ImplementOrderType: string
  Read Only: true

  Maximum Length: 4000

  Value that indicates the type of order to use when the order is released. A list of accepted values is defined in the lookup type ORA_MSC_WORKBENCH_IMPLEMENT_AS.
• ImplementQuantity: number
  Title: Implement Quantity

  Quantity of the order that's released.
• ImplementShipDate: string (date)
  Title: Implement Ship Date

  Date when the order is shipped.
• ImplementShipMethod: string
  Maximum Length: 30

  Value that indicates the shipping method to use when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
• ImplementShippingMethod: string
  Title: Implement Shipping Method

  Maximum Length: 400

  Value that indicates the shipping method to use when the order is released, or is a concatenation of carrier name, method of transportation, and service level to use when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
• ImplementSourceOrganization: string
  Title: Implement Source Organization

  Maximum Length: 100

  Source organization used for the order that's released.
• ImplementStatus: string
  Read Only: true

  Maximum Length: 200

  Status of the order to use when the order is released. Valid Values are Unreleased or Released.
• ImplementStatusCode: integer
  Title: Implement Status

  Abbreviation that identifies the status to use when the order is released. Valid values are 1 or 3. If 1, then the order isn't released. If 3, then the order is released.
• ImplementSupplier: string
  Title: Implement Supplier

  Maximum Length: 360

  Name of the supplier for the order that's released.
• ImplementSupplierSite: string
  Title: Implement Supplier Site

  Maximum Length: 300

  Abbreviation that indicates the specific supplier ship-from location to use when the order is released.
• InitExcessAtSource: number
  Initial excess quantity at the source location before inventory rebalancing.
• InitShortageAtDest: number
  Initial shortage quantity at the destination location before inventory rebalancing.
• Item: string
  Title: Item

  Maximum Length: 300

  Name of the item associated with the supply.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Description of the item that's associated with the supply.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the order was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the supply.
• LatestStartDate: string (date)
  Title: Latest Start Date

  Read Only: true

  Latest date on which a supply can start. This date is computed by offsetting the lead time of the supply from its need-by date. This date is calculated by constraint-based plans.
• LineNumber: string
  Title: Line Number

  Read Only: true

  Maximum Length: 100

  Number that identifies the order line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Lot: string
  Title: Lot

  Read Only: true

  Maximum Length: 80

  Number that identifies the lot of the on-hand supply.
• MakeOrBuy: string
  Read Only: true

  Maximum Length: 100

  Value that indicates whether the item is a manufactured item or a purchased item. Valid values include Make or Buy. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.
• MarkForReleaseOption: string
  Value that indicates the release status of the order. Valid values are 1: Marked For Release or 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute.
• Message: string
  Read Only: true

  Text of the error message, if any, encountered when creating or updating a supply.
• NeedByDate: string (date)
  Title: Need-by Date

  Read Only: true

  Date when the supply quantity is needed.
• OldDockDate: string (date)
  Title: Old Dock Date

  Read Only: true

  Date when the order was originally to arrive at the receiving dock. This attribute value is extracted from the source application.
• OldDueDate: string (date)
  Title: Old Due Date

  Read Only: true

  Date when the order was originally due. This attribute value is extracted from the source application.
• OrderNumber: string
  Title: Order Number

  Read Only: true

  Maximum Length: 4000

  Number that identifies the order associated with the supply.
• OrderQuantity: number
  Title: Order Quantity

  Read Only: true

  Quantity associated with the supply.
• OrderStatus: string
  Read Only: true

  Maximum Length: 200

  SCM Cloud transactional status of a work order, purchase order, or transfer order supplies that are referred to by the planning process.
• OrderType: integer (int32)
  Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
• OrderTypeText: string
  Title: Order Type

  Maximum Length: 4000

  Type of order such as on hand, purchase order, or work order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
• Organization: string
  Title: Organization

  Maximum Length: 49

  Name of the organization associated with the order.
• OrganizationTimeZone: string
  Title: Organization Time Zone

  Read Only: true

  Maximum Length: 100

  Time zone associated with an organization.
• OrgCurrencyCode: string
  Read Only: true

  Abbreviation that identifies the base currency of the organization.
• OriginalItemName: string
  Title: Requested Item

  Read Only: true

  Maximum Length: 4000

  Name of the requested item associated with the demand.
• OriginalNeedByDate: string (date)
  Title: Original Need-by Date

  Read Only: true

  Date when the order was originally needed. This value is extracted from the source application.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• Planner: string
  Title: Planner

  Read Only: true

  Maximum Length: 10

  Abbreviation that identifies the planner responsible for the item.
• PlannerDescription: string
  Title: Planner Description

  Read Only: true

  Maximum Length: 100

  Description of the planner responsible for the item.
• PlanningMakeBuyCode: integer
  Title: Make or Buy

  Read Only: true

  Abbreviation that indicates whether the item is manufactured or purchased. Valid values are 1 or 2. If 1, then the item is a manufactured item. If 2, then the item is a purchased item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.
• ReleaseErrors: string
  Read Only: true

  Maximum Length: 400

  Errors that are generated in the release process.
• ReleaseStatus: integer
  Title: Release Status

  Code that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.
• ReleaseStatusText: string
  Read Only: true

  Maximum Length: 80

  Value that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.
• ReleaseTimeFenceCode: integer
  Read Only: true

  Abbreviation that identifies the point in time inside which planned orders with certain criteria are automatically released as work orders or purchase orders. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.
• ReplInvRebalanceFlag: integer
  Indicates whether or not the planned order is created by inventory rebalancing.
• ScheduledShipDate: string (date)
  Title: Scheduled Ship Date

  Read Only: true

  Date when the order is scheduled to be shipped.
• ScheduleName: string
  Title: Schedule Name

  Read Only: true

  Name of the supply schedule associated with an order.
• SegmentName: string
  Title: Segment

  Read Only: true

  Maximum Length: 120

  Name of the segment used for a set of items.
• SellingPrice: number
  Read Only: true

  Selling price of an item on the order line.
• ShipCalendar: string
  Read Only: true

  Maximum Length: 15

  Shipping calendar associated with the order.
• ShipMethod: string
  Maximum Length: 30

  Value that indicates the shipping method used to ship the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
• ShippingMethod: string
  Title: Shipping Method

  Maximum Length: 4000

  Value that indicates the shipping method used to ship the order, or is a concatenation of carrier name, method of transportation, and service level associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
• ShipTo: string
  Title: Ship To

  Read Only: true

  Maximum Length: 4000

  Abbreviation that identifies the specific ship-to location.
• ShortageReductionAtDest: number
  Percentage value by which the inventory shortage at the destination location is reduced.
• SimulationSetId: integer (int64)
  Value that uniquely identifies the simulation set used in the plan, if any.
• SourceOrganization: string
  Title: Source Organization

  Maximum Length: 49

  Organization that will source the order.
• SourceTimeZone: string
  Title: Source Time Zone

  Read Only: true

  Maximum Length: 100

  Time zone associated with the entity that's sourcing the order. The sourcing entity can be a supplier or an organization.
• SourceType: integer
  Value that identifies the type of planned order to be created. Valid values are 1, 2, or 3. If 1, then a planned make order is created. If 2, then a planned buy order is created. If 3, then a planned transfer order is created.
• Subinventory: string
  Title: Subinventory

  Read Only: true

  Maximum Length: 40

  Subinventory code associated with the supply.
• SuggestedDockDate: string (date)
  Title: Suggested Dock Date

  Read Only: true

  Date when the order is recommended to arrive at the receiving dock.
• SuggestedDueDate: string (date)
  Title: Suggested Due Date

  Read Only: true

  Date when a supply is expected to be completed.
• SuggestedOrderDate: string (date)
  Title: Suggested Order Date

  Read Only: true

  Date when an order is recommended to be placed.
• SuggestedShipDate: string (date)
  Title: Suggested Ship Date

  Read Only: true

  Date when the order is recommended to be shipped.
• SuggestedStartDate: string (date)
  Title: Suggested Start Date

  Read Only: true

  Date when work on the order is recommended to begin.
• Supplier: string
  Title: Supplier

  Maximum Length: 4000

  Name of the source supplier.
• SupplierSite: string
  Title: Supplier Site

  Maximum Length: 4000

  Abbreviation that indicates the specific supplier location from where the item is being sourced.
• TransactionId: integer (int64)
  Value that uniquely identifies the supply transaction. This value is internally generated by the application.
• TransitLeadTime: number
  Title: Transit Lead Time

  Read Only: true

  Number of days that the supply is in transit between two locations.
• UOM: string
  Read Only: true

  Maximum Length: 200

  Name of the unit of measure associated with the order quantity.
• UOMCode: string
  Title: UOM

  Read Only: true

  Abbreviation that identifies the unit of measure associated with the order quantity.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the order.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Customer":{
            "title":"Customer",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the customer associated with the drop ship purchase order.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduledShipDate":{
            "title":"Scheduled Ship Date",
            "type":"string",
            "description":"Date when the order is scheduled to be shipped.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestedDockDate":{
            "title":"Suggested Dock Date",
            "type":"string",
            "description":"Date when the order is recommended to arrive at the receiving dock.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Order Number",
            "maxLength":"4000",
            "type":"string",
            "description":"Number that identifies the order associated with the supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderTypeText":{
            "title":"Order Type",
            "maxLength":"4000",
            "type":"string",
            "description":"Type of order such as on hand, purchase order, or work order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "ActualStartDate":{
            "title":"Actual Start Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OriginalItemName":{
            "title":"Requested Item",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the requested item associated with the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestOrgCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the destination organization for an order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSite":{
            "title":"Customer Site",
            "maxLength":"4000",
            "type":"string",
            "description":"Code associated with a specific customer ship-to location.",
            "nullable":true,
            "x-queryable":true
        },
        "Item":{
            "title":"Item",
            "maxLength":"300",
            "type":"string",
            "description":"Name of the item associated with the supply.",
            "nullable":true,
            "x-queryable":true
        },
        "ImplementShipDate":{
            "title":"Implement Ship Date",
            "type":"string",
            "description":"Date when the order is shipped.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ImplementFirm":{
            "title":"Implement Firm",
            "type":"integer",
            "description":"Value that indicates whether the order is firm or not. Valid values are 1: Firm and 2: Not Firm. A list of accepted values is defined in the lookup type MSC_YES_NO.",
            "nullable":true,
            "x-queryable":true
        },
        "ReleaseStatus":{
            "title":"Release Status",
            "type":"integer",
            "description":"Code that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure associated with the order quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementSupplier":{
            "title":"Implement Supplier",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the supplier for the order that's released.",
            "nullable":true,
            "x-queryable":true
        },
        "DaysPastDue":{
            "title":"Days Past Due",
            "type":"number",
            "description":"Number of days that the supply date is in the past.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sequence in which a component is used within an operation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestedDueDate":{
            "title":"Suggested Due Date",
            "type":"string",
            "description":"Date when a supply is expected to be completed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply transaction. This value is internally generated by the application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Lot":{
            "title":"Lot",
            "maxLength":"80",
            "type":"string",
            "description":"Number that identifies the lot of the on-hand supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExcessReductionAtSrc":{
            "type":"number",
            "description":"Percentage value by which the inventory excess at the source location is reduced.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "InitExcessAtSource":{
            "type":"number",
            "description":"Initial excess quantity at the source location before inventory rebalancing.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":"4000",
            "type":"string",
            "description":"Abbreviation that indicates the specific supplier location from where the item is being sourced.",
            "nullable":true,
            "x-queryable":true
        },
        "HoldDate":{
            "title":"Hold Date",
            "type":"string",
            "description":"Date on which the on-hand inventory lot is no longer on hold.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BmtOption":{
            "title":"Buyer-Managed Transportation",
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then the buyer is responsible for the transportation of the purchased item. If 2, then the buyer isn't responsible for the transportation of the purchased item. This attribute applies only to purchased items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestedShipDate":{
            "title":"Suggested Ship Date",
            "type":"string",
            "description":"Date when the order is recommended to be shipped.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SimulationSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the simulation set used in the plan, if any.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MakeOrBuy":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates whether the item is a manufactured item or a purchased item. Valid values include Make or Buy. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShortageReductionAtDest":{
            "type":"number",
            "description":"Percentage value by which the inventory shortage at the destination location is reduced.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FirmStartDate":{
            "type":"string",
            "description":"Date when supply begins. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SuggestedStartDate":{
            "title":"Suggested Start Date",
            "type":"string",
            "description":"Date when work on the order is recommended to begin.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InitShortageAtDest":{
            "type":"number",
            "description":"Initial shortage quantity at the destination location before inventory rebalancing.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Organization":{
            "title":"Organization",
            "maxLength":"49",
            "type":"string",
            "description":"Name of the organization associated with the order.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTimeZone":{
            "title":"Source Time Zone",
            "maxLength":"100",
            "type":"string",
            "description":"Time zone associated with the entity that's sourcing the order. The sourcing entity can be a supplier or an organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OldDueDate":{
            "title":"Old Due Date",
            "type":"string",
            "description":"Date when the order was originally due. This attribute value is extracted from the source application.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReplInvRebalanceFlag":{
            "type":"integer",
            "description":"Indicates whether or not the planned order is created by inventory rebalancing.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OldDockDate":{
            "title":"Old Dock Date",
            "type":"string",
            "description":"Date when the order was originally to arrive at the receiving dock. This attribute value is extracted from the source application.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmStartQuantity":{
            "title":"Firm Start Quantity",
            "type":"number",
            "description":"User-specified start quantity of a supply. This attribute value can't be changed by planning and is only populated when the firm status is firm.",
            "nullable":true,
            "x-queryable":true
        },
        "Buyer":{
            "title":"Buyer",
            "type":"string",
            "description":"Name of the buyer associated to the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line Number",
            "maxLength":"100",
            "type":"string",
            "description":"Number that identifies the order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderQuantity":{
            "title":"Order Quantity",
            "type":"number",
            "description":"Quantity associated with the supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarliestStartDate":{
            "title":"Earliest Start Date",
            "type":"string",
            "description":"Earliest date on which a supply can start based on the lead times of all its upstream supplies, or its planning time-fence date, or based on the constrained capacity of a resource or supplier. This date is calculated by constraint-based plans",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderStatus":{
            "maxLength":"200",
            "type":"string",
            "description":"SCM Cloud transactional status of a work order, purchase order, or transfer order supplies that are referred to by the planning process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmStatus":{
            "maxLength":"200",
            "type":"string",
            "description":"Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the source supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "OrgCurrencyCode":{
            "type":"string",
            "description":"Abbreviation that identifies the base currency of the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransitLeadTime":{
            "title":"Transit Lead Time",
            "type":"number",
            "description":"Number of days that the supply is in transit between two locations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClusterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cluster.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PlannerDescription":{
            "title":"Planner Description",
            "maxLength":"100",
            "type":"string",
            "description":"Description of the planner responsible for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LatestStartDate":{
            "title":"Latest Start Date",
            "type":"string",
            "description":"Latest date on which a supply can start. This date is computed by offsetting the lead time of the supply from its need-by date. This date is calculated by constraint-based plans.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementFirmOption":{
            "maxLength":"200",
            "type":"string",
            "description":"Status to use when the order is released. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipCalendar":{
            "maxLength":"15",
            "type":"string",
            "description":"Shipping calendar associated with the order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmQuantity":{
            "title":"Firm Quantity",
            "type":"number",
            "description":"Fixed quantity of supply. This attribute value can't be changed by planning and is only populated when the firm status is firm.",
            "nullable":true,
            "x-queryable":true
        },
        "NeedByDate":{
            "title":"Need-by Date",
            "type":"string",
            "description":"Date when the supply quantity is needed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the existing lot associated with the supply expires.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ImplementDockDate":{
            "title":"Implement Dock Date",
            "type":"string",
            "description":"Date when the material should be on the receiving dock when the order is released.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Planner":{
            "title":"Planner",
            "maxLength":"10",
            "type":"string",
            "description":"Abbreviation that identifies the planner responsible for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipTo":{
            "title":"Ship To",
            "maxLength":"4000",
            "type":"string",
            "description":"Abbreviation that identifies the specific ship-to location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the order was most recently updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the shipping method used to ship the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.",
            "nullable":true,
            "x-queryable":true
        },
        "ShippingMethod":{
            "title":"Shipping Method",
            "maxLength":"4000",
            "type":"string",
            "description":"Value that indicates the shipping method used to ship the order, or is a concatenation of carrier name, method of transportation, and service level associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.",
            "nullable":true,
            "x-queryable":true
        },
        "FirmDate":{
            "title":"Firm Date",
            "type":"string",
            "description":"Date when supply is due. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SourceType":{
            "type":"integer",
            "description":"Value that identifies the type of planned order to be created. Valid values are 1, 2, or 3. If 1, then a planned make order is created. If 2, then a planned buy order is created. If 3, then a planned transfer order is created.",
            "nullable":true,
            "x-queryable":true
        },
        "ReleaseTimeFenceCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the point in time inside which planned orders with certain criteria are automatically released as work orders or purchase orders. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementSupplierSite":{
            "title":"Implement Supplier Site",
            "maxLength":"300",
            "type":"string",
            "description":"Abbreviation that indicates the specific supplier ship-from location to use when the order is released.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset",
            "maxLength":"80",
            "type":"string",
            "description":"Number that identifies the asset associated with a maintenance work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementAs":{
            "title":"Implement Order Type",
            "type":"integer",
            "description":"Value that indicates the type of order to be implemented. Valid values are 1: None, 2: Purchase requisition, 3: Work order, or 5: Internal requisition. A list of accepted values is defined in the lookup type ORA_MSC_WORKBENCH_IMPLEMENT_AS.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderType":{
            "type":"integer",
            "description":"Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "DestinationTimeZone":{
            "title":"Destination Time Zone",
            "maxLength":"100",
            "type":"string",
            "description":"Time zone associated with the entity that's receiving the order. The destination entity can be a customer or an organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestedOrderDate":{
            "title":"Suggested Order Date",
            "type":"string",
            "description":"Date when an order is recommended to be placed.",
            "format":"date",
            "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"
            }
        },
        "ReleaseErrors":{
            "maxLength":"400",
            "type":"string",
            "description":"Errors that are generated in the release process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementShippingMethod":{
            "title":"Implement Shipping Method",
            "maxLength":"400",
            "type":"string",
            "description":"Value that indicates the shipping method to use when the order is released, or is a concatenation of carrier name, method of transportation, and service level to use when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.",
            "nullable":true,
            "x-queryable":true
        },
        "ImplementedQuantity":{
            "title":"Implemented Quantity",
            "type":"number",
            "description":"Cumulative quantity that has been released to date.",
            "nullable":true,
            "x-queryable":true
        },
        "SegmentName":{
            "title":"Segment",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the segment used for a set of items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpenseDestinationTransfer":{
            "maxLength":"100",
            "type":"string",
            "description":"Contains one of the following values: Yes or No. If Yes, then the transfer is to an expense destination. If No, then the transfer isn't to an expense destination.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementStatusCode":{
            "title":"Implement Status",
            "type":"integer",
            "description":"Abbreviation that identifies the status to use when the order is released. Valid values are 1 or 3. If 1, then the order isn't released. If 3, then the order is released.",
            "nullable":true,
            "x-queryable":true
        },
        "ImplementDate":{
            "title":"Implement Date",
            "type":"string",
            "description":"Date when the order is released.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SellingPrice":{
            "type":"number",
            "description":"Selling price of an item on the order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuyerManagedTransportation":{
            "maxLength":"200",
            "type":"string",
            "description":"Contains one of the following values: Yes or No. If Yes, then the buyer is responsible for the transportation of the purchased item. If No, then the buyer isn't responsible for the transportation of the purchased item. This attribute applies only to purchased items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementShipMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the shipping method to use when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.",
            "nullable":true,
            "x-queryable":true
        },
        "ImplementSourceOrganization":{
            "title":"Implement Source Organization",
            "maxLength":"100",
            "type":"string",
            "description":"Source organization used for the order that's released.",
            "nullable":true,
            "x-queryable":true
        },
        "ImplementOrderType":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that indicates the type of order to use when the order is released. A list of accepted values is defined in the lookup type ORA_MSC_WORKBENCH_IMPLEMENT_AS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MarkForReleaseOption":{
            "type":"string",
            "description":"Value that indicates the release status of the order. Valid values are 1: Marked For Release or 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningMakeBuyCode":{
            "title":"Make or Buy",
            "type":"integer",
            "description":"Abbreviation that indicates whether the item is manufactured or purchased. Valid values are 1 or 2. If 1, then the item is a manufactured item. If 2, then the item is a purchased item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementLocation":{
            "title":"Implement Location",
            "maxLength":"400",
            "type":"string",
            "description":"Value that identifies the deliver-to location to use when the order is released.",
            "nullable":true,
            "x-queryable":true
        },
        "Action":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that indicates the action recommended by planning. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Message":{
            "type":"string",
            "description":"Text of the error message, if any, encountered when creating or updating a supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementEmployeeId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OriginalNeedByDate":{
            "title":"Original Need-by Date",
            "type":"string",
            "description":"Date when the order was originally needed. This value is extracted from the source application.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReleaseStatusText":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item that's associated with the supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementQuantity":{
            "title":"Implement Quantity",
            "type":"number",
            "description":"Quantity of the order that's released.",
            "nullable":true,
            "x-queryable":true
        },
        "ImplementJobName":{
            "title":"Implement Work Order Number",
            "maxLength":"120",
            "type":"string",
            "description":"Job name of the work order to be created when the order is released.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrganization":{
            "title":"Source Organization",
            "maxLength":"49",
            "type":"string",
            "description":"Organization that will source the order.",
            "nullable":true,
            "x-queryable":true
        },
        "ClusterName":{
            "type":"string",
            "description":"Name of the cluster.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ImplementStatus":{
            "maxLength":"200",
            "type":"string",
            "description":"Status of the order to use when the order is released. Valid Values are Unreleased or Released.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmPlannedType":{
            "title":"Firm Status",
            "type":"integer",
            "description":"Value that indicates whether the order is firmed or not. Valid values are 1 or 2. If 1, then the order is firm. If 2, then the order isn't firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ScheduleName":{
            "title":"Schedule Name",
            "type":"string",
            "description":"Name of the supply schedule associated with an order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "UOM":{
            "maxLength":"200",
            "type":"string",
            "description":"Name of the unit of measure associated with the order quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationTimeZone":{
            "title":"Organization Time Zone",
            "maxLength":"100",
            "type":"string",
            "description":"Time zone associated with an organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subinventory":{
            "title":"Subinventory",
            "maxLength":"40",
            "type":"string",
            "description":"Subinventory code associated with the supply.",
            "nullable":true,
            "readOnly":true,
            "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 : replenishmentPlans-Runs-item-response

Type: object

Show Source

• ArchivePlanFlag: boolean
  Contains one of the following values: true or false. If true, then archive the plan before the next plan is run. If false, then don't archive. You can archive a plan only if you enable it for archiving. The default value is false.
• BuyerPlanningFlag: boolean
  Contains one of the following values: true or false. If true, then the Prepare for Buyer Planning scheduled process is executed after the run plan scheduled process completes. If false, then the Prepare for Buyer Planning scheduled process isn't executed. The default value is false.
• CalculatePolicyParametersFlag: boolean
  Contains one of the following values: true or false. If true, then calculate policy parameters. If false, then don't calculate policy parameters. The default value is false.
• CalculateReplenishmentsFlag: boolean
  Contains one of the following values: true or false. If true, then calculate replenishments. If false, then don't calculate replenishments. The default value is true.
• EndDate: string (date-time)
  Date and time when the plan run completed.
• ExecutionId: integer (int64)
  Value that uniquely identifies the process.
• ExecutionUser: string
  Maximum Length: 64

  Login that the user used when launching the process.
• ForceRunFlag: boolean
  Contains one of the following values: true or false. If true, then run the plan regardless of the current plan status. If false, then run the plan only if the plan is ready to run. The default value is false.
• ForecastProfiles: string
  List of forecast profiles that the plan run uses. A comma separates each forecast profile name.
• GenerateForecastFlag: boolean
  Contains one of the following values: true or false. If true, then generate a forecast. If false, then don't generate a forecast. The default value is false.
• JobId: integer (int64)
  Value that uniquely identifies the scheduled process.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Text of the error messages, if any, that occurred when running the scheduled process.
• Mode: string
  Specifies whether data is to be refreshed or not. Valid values are 1 or 3. If 1, then all data is refreshed. If 3, then data isn't refreshed. The default value is 1.
• PlanId: integer
  Value that uniquely identifies the plan.
• ReplInventoryRebalanceFlag: boolean
  Contains one of the following values: 1 or 2. If 1, then perform inventory rebalancing. If 2, then don't perform inventory rebalancing. The default value is 2.
• StartDate: string (date-time)
  Date and time to start the scheduled process.
• StatusCode: integer (int32)
  Status of the plan run. Contains one of the following values. 0: completed, 1: processing, 2: error, or 3: warning. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE.

{
    "type":"object",
    "properties":{
        "Message":{
            "type":"string",
            "description":"Text of the error messages, if any, that occurred when running the scheduled process.",
            "nullable":true,
            "x-queryable":true
        },
        "GenerateForecastFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then generate a forecast. If false, then don't generate a forecast. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "nullable":false,
            "x-queryable":true
        },
        "Mode":{
            "type":"string",
            "description":"Specifies whether data is to be refreshed or not. Valid values are 1 or 3. If 1, then all data is refreshed. If 3, then data isn't refreshed. The default value is 1.",
            "nullable":true,
            "x-queryable":true
        },
        "BuyerPlanningFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the Prepare for Buyer Planning scheduled process is executed after the run plan scheduled process completes. If false, then the Prepare for Buyer Planning scheduled process isn't executed. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "type":"integer",
            "description":"Status of the plan run. Contains one of the following values. 0: completed, 1: processing, 2: error, or 3: warning. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date and time when the plan run completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date and time to start the scheduled process.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CalculateReplenishmentsFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then calculate replenishments. If false, then don't calculate replenishments. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "ExecutionUser":{
            "maxLength":"64",
            "type":"string",
            "description":"Login that the user used when launching the process.",
            "nullable":false,
            "x-queryable":true
        },
        "ForecastProfiles":{
            "type":"string",
            "description":"List of forecast profiles that the plan run uses. A comma separates each forecast profile name.",
            "nullable":true,
            "x-queryable":true
        },
        "ForceRunFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then run the plan regardless of the current plan status. If false, then run the plan only if the plan is ready to run. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "ReplInventoryRebalanceFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: 1 or 2. If 1, then perform inventory rebalancing. If 2, then don't perform inventory rebalancing. The default value is 2.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CalculatePolicyParametersFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then calculate policy parameters. If false, then don't calculate policy parameters. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "ArchivePlanFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then archive the plan before the next plan is run. If false, then don't archive. You can archive a plan only if you enable it for archiving. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "JobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the scheduled process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExecutionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the process.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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"
    }
}

Back to Top

Examples

This example describes how to get all plans.

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/replenishmentPlans"

Example Response Body

The following shows an example of the response body in JSON format.

"items": [
{
	"AggregateNonkeyCustomerData": null,
	"ArchiveTimeHierarchy": null,
	"ArchiveTimeLevel": null,
	"ArchivePlan": null,
	"MeasureCatalogForArchival": 1934,
	"ArchiveVersionDays": null,
	"PlanName": "REPL-MG2",
	"CreatedBy": "REPL_USER",
	"CreationDate": "2019-10-29T08:06:40.001+00:00",
	"CutoffDate": "2030-02-03",
	"CalendarCode": "10002",
	"DeleteArchive": 4,
	"Description": "REPL-MG2",
	"DemandPlanStartDate": null,
	"DemandPlanCompletionDate": null,
	"EnableArchive": 2,
	"ExceptionSet": null,
	"PlanningCalendar": "10002",
	"ForecastingTimeLevel": 1,
	"HasRun": 1,
	"IncludeTransferOrders": 1,
	"ItemListPrice": 1,
	"LastUpdatedDate": "2019-11-07T10:45:42.561+00:00",
	"LastUpdatedBy": "APS_ALL",
	"PlanDimensionCatalog": 104,
	"NumberOfBuckets": 31,
	"PlanId": 300100181500814,
	"PlanMeasureCatalog": 1933,
	"PlanOwner": "300100176248504",
	"PlanHorizonStartDate": "2030-01-04",
	"PlanType": 5,
	"PolicyAssignmentSetId": 300100181500739,
	"PlanAccess": 1,
	"SimulationSet": null,
	"PlanStatus": 0,
	"ShortPlanId": 168425,
	"AutoRelease": 2,
	"ForecastOption": 1,
	"PolicyParametersOption": 1,
	"ReplenishmentsOption": 1,
	"IncrementalPlanningOption": 2,
	"LeadTimeMultiplier": null,
	"PolicyComparisonOption": 2,
	"PolicyComparisonThreshold": null,
	"TimeHorizonForDemand": 2,
	"PlanTimeLevel": 1,
	"SegmentGroup": 300100181500544,
	"Segments": "Seg5,Seg2,Seg1,Seg6,Seg3,Seg4",
	"PlanOrganizationLevelMembers": "M1,D1,M3,M2",
	"PriceLists": "",
	"ForecastProfiles": "(Forecast Shipments,Final Shipments History,Shipments Forecast,,730,2027-09-06,2030-01-03,26,0,2030-02-02) ",
	"AssignmentSetName": "YM-ASSGN-REPL1",
	"PolicyAssignmentSetName": "MG-AUTO",
	"ReplSupplyCutoffDays": null,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/replenishmentPlans/300100181500814",
		"name": "replenishmentPlans",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/replenishmentPlans/300100181500814",
		"name": "replenishmentPlans",
		"kind": "item"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/replenishmentPlans/300100181500814/lov/PolicyAssignmentSetVO",
		"name": "PolicyAssignmentSetVO",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/replenishmentPlans/300100181500814/child/Runs",
		"name": "Runs",
		"kind": "collection"
	}

	

Back to Top