Jump to

• Request
• Response

Get all supplies

get

/fscmRestApi/resources/11.13.18.05/replenishmentPlans/{PlanId}/child/PlanningSupplies

Request

Path Parameters

• PlanId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the supply according to the value that identifies the supply.
    Finder Variables
    • PlanId; integer; Value that uniquely identifies the plan associated with the supply.
    • SimulationSetId; integer; Value that uniquely identifies the simulation set associated with the supply.
    • SourceTablePrimary; string; Name of the table where the supply is stored. This value is always MSC_SUPPLIES.
    • TransactionId; integer; Value that uniquely identifies a supply.
  • TransactionIdFinder Finds a specific supply in the plan.
    Finder Variables
    • TransactionId; integer; Value that identifies the supply.
• 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:
  

  • Action; string; Value that indicates the action recommended by planning. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS.
  • ActualStartDate; string
  • AssetNumber; string; Number that identifies the asset associated with a maintenance work order.
  • BillSequenceId; integer; Value that uniquely identifies the sequence in which a component is used within an operation.
  • BmtOption; integer; 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; Name of the buyer associated to the item.
  • BuyerManagedTransportation; string; 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; Value that uniquely identifies the cluster.
  • ClusterName; string; Name of the cluster.
  • CreatedBy; string; User who created the order.
  • CreationDate; string; Date when the user created the order.
  • Customer; string; Name of the customer associated with the drop ship purchase order.
  • CustomerSite; string; Code associated with a specific customer ship-to location.
  • DaysPastDue; number; Number of days that the supply date is in the past.
  • DestOrgCode; string; Abbreviation that identifies the destination organization for an order.
  • DestinationTimeZone; string; Time zone associated with the entity that's receiving the order. The destination entity can be a customer or an organization.
  • EarliestStartDate; string; 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; 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 when the existing lot associated with the supply expires.
  • FirmDate; string; 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; 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; 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 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; 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; 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 on which the on-hand inventory lot is no longer on hold.
  • ImplementAs; integer; 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 when the order is released.
  • ImplementDockDate; string; Date when the material should be on the receiving dock when the order is released.
  • ImplementEmployeeId; integer
  • ImplementFirm; integer; 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; 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; Job name of the work order to be created when the order is released.
  • ImplementLocation; string; Value that identifies the deliver-to location to use when the order is released.
  • ImplementOrderType; string; 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; Quantity of the order that's released.
  • ImplementShipDate; string; Date when the order is shipped.
  • ImplementShipMethod; string; 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; 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; Source organization used for the order that's released.
  • ImplementStatus; string; Status of the order to use when the order is released. Valid Values are Unreleased or Released.
  • ImplementStatusCode; integer; 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; Name of the supplier for the order that's released.
  • ImplementSupplierSite; string; Abbreviation that indicates the specific supplier ship-from location to use when the order is released.
  • ImplementedQuantity; number; Cumulative quantity that has been released to date.
  • 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; Name of the item associated with the supply.
  • ItemDescription; string; Description of the item that's associated with the supply.
  • LastUpdateDate; string; Date when the order was most recently updated.
  • LastUpdatedBy; string; User who most recently updated the supply.
  • LatestStartDate; string; 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; Number that identifies the order line.
  • Lot; string; Number that identifies the lot of the on-hand supply.
  • MakeOrBuy; string; 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; Text of the error message, if any, encountered when creating or updating a supply.
  • NeedByDate; string; Date when the supply quantity is needed.
  • OldDockDate; string; Date when the order was originally to arrive at the receiving dock. This attribute value is extracted from the source application.
  • OldDueDate; string; Date when the order was originally due. This attribute value is extracted from the source application.
  • OrderNumber; string; Number that identifies the order associated with the supply.
  • OrderQuantity; number; Quantity associated with the supply.
  • OrderStatus; string; SCM Cloud transactional status of a work order, purchase order, or transfer order supplies that are referred to by the planning process.
  • OrderType; integer; Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
  • OrderTypeText; string; 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.
  • OrgCurrencyCode; string; Abbreviation that identifies the base currency of the organization.
  • Organization; string; Name of the organization associated with the order.
  • OrganizationTimeZone; string; Time zone associated with an organization.
  • OriginalItemName; string; Name of the requested item associated with the demand.
  • OriginalNeedByDate; string; Date when the order was originally needed. This value is extracted from the source application.
  • PlanId; integer; Value that uniquely identifies the plan.
  • Planner; string; Abbreviation that identifies the planner responsible for the item.
  • PlannerDescription; string; Description of the planner responsible for the item.
  • PlanningMakeBuyCode; integer; 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; Errors that are generated in the release process.
  • ReleaseStatus; integer; 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; 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; 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.
  • ScheduleName; string; Name of the supply schedule associated with an order.
  • ScheduledShipDate; string; Date when the order is scheduled to be shipped.
  • SegmentName; string; Name of the segment used for a set of items.
  • SellingPrice; number; Selling price of an item on the order line.
  • ShipCalendar; string; Shipping calendar associated with the order.
  • ShipMethod; string; 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.
  • ShipTo; string; Abbreviation that identifies the specific ship-to location.
  • ShippingMethod; string; 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.
  • ShortageReductionAtDest; number; Percentage value by which the inventory shortage at the destination location is reduced.
  • SimulationSetId; integer; Value that uniquely identifies the simulation set used in the plan, if any.
  • SourceOrganization; string; Organization that will source the order.
  • SourceTimeZone; string; 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; Subinventory code associated with the supply.
  • SuggestedDockDate; string; Date when the order is recommended to arrive at the receiving dock.
  • SuggestedDueDate; string; Date when a supply is expected to be completed.
  • SuggestedOrderDate; string; Date when an order is recommended to be placed.
  • SuggestedShipDate; string; Date when the order is recommended to be shipped.
  • SuggestedStartDate; string; Date when work on the order is recommended to begin.
  • Supplier; string; Name of the source supplier.
  • SupplierSite; string; Abbreviation that indicates the specific supplier location from where the item is being sourced.
  • TransactionId; integer; Value that uniquely identifies the supply transaction. This value is internally generated by the application.
  • TransitLeadTime; number; Number of days that the supply is in transit between two locations.
  • UOM; string; Name of the unit of measure associated with the order quantity.
  • UOMCode; string; Abbreviation that identifies the unit of measure associated with the order quantity.
• 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-PlanningSupplies

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-PlanningSupplies-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

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

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top