Jump to

• Request
• Response
• Examples

Get all orders for a plan, supplier, supplier site, and organization

get

/fscmRestApi/resources/11.13.18.05/buyerPlanningSupplies/buyerPlanningSupplies

To retrieve orders using buyerPlanningSupplies, the q parameter with specified PlanId, SupplierId, SupplierSiteId, and OrganizationId is required. For example, /fscmRestApi/scp/buyerPlanningSupplies?q=PlanId= and SupplierId= and SupplierSiteId= and OrganizationId=.

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 are 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 are 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 are considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework only returns 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 is filtered 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 is 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
• totalResults: boolean
  The resource collection representation includes the "estimated row count" when "?totalResults=true", otherwise the count isn't 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 doesn't specify this header in the request the server picks a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.resourcecollection+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 doesn't specify this header in the request the server picks a default version for the API.

Body ()

Root Schema : buyerPlanningSupplies-getAll

Match All

Show Source

• object buyerPlanningSupplies-getAll-allOf[0]
• object CollectionProperties

{
    "allOf":[
        {
            "type":"object",
            "properties":{
                "items":{
                    "title":"Items",
                    "type":"array",
                    "description":"The items in the collection.",
                    "items":{
                        "$ref":"#/components/schemas/buyerPlanningSupplies-getAll-item-response"
                    }
                }
            }
        },
        {
            "$ref":"#/components/schemas/CollectionProperties"
        }
    ],
    "x-hints":{
        "group":"SCM",
        "subgroup":"SupplyChainPlanning",
        "usage":"BusinessObject"
    }
}

Nested Schema : buyerPlanningSupplies-getAll-allOf[0]

Type: object

Show Source

• items: array Items
  Title: Items

  The items in the collection.

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

Nested Schema : CollectionProperties

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: buyerPlanningSupplies-getAll-item-response

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

Nested Schema : buyerPlanningSupplies-getAll-item-response

Match All

Show Source

• object buyerPlanningSupplies-getAll-response
• object ItemProperties
• object buyerPlanningSupplies-getAll-item-response-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/buyerPlanningSupplies-getAll-response"
        },
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : buyerPlanningSupplies-getAll-response

Type: object

Show Source

• CarryingCost: integer (int64)
  Percent of the item's cost that represents the inventory carrying cost.
• ConsolidatedFlag: boolean
  Title: Consolidated Flag

  Indicates whether or not the order is consolidated. If the value is true, then the order is consolidated.
• ConsolidationTransactionId: integer (int64)
  Value that uniquely identifies associated consolidated orders.
• CreatedBy: string
  Title: Created By

  User who created the order.
• CreationDate: string (date)
  Title: Creation Date

  Date when the user created the order.
• EmployeeId: integer (int64)
  Value that uniquely identifies the planner associdate to the order as an employee.
• 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.
• FirmQuantity: integer (int64)
  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.
• FirmStatus: string
  Title: Firm Status

  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.
• FirmStatusCode: integer (int64)
  Title: Firm Status Code

  Abbreviation for a status that identifies 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.
• FixedDaysOfSupply: integer (int64)
  Number of days to use to modify the size and timing of each planned order quantity.
• FixedLotMultiplier: integer (int64)
  Multiplier to use, in units for each day, for each fixed lot quantity or each repetitive rate.
• FixedOrderQuantity: integer (int64)
  Quantity to use to modify the size of each planned order quantity or each repetitive daily rate.
• HasPriceBreakFlag: boolean
  Title: Has Price Break Flag

  Indicates whether or not the order is associated to a purchase agreement with a price break. If the value is true, then there is an existing price break on the associated purchase agreement.
• 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.
• ImplementFirm: integer (int64)
  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.
• ImplementQuantity: integer (int64)
  Title: Implement Quantity

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

  Date when the order is shipped.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the item associated with the supply.
• Item: string
  Title: Item Name Code

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

  Description of the item that's associated with the supply.
• ItemPlanner: string
  Title: Item Planner

  Abbreviation that identifies the planner responsible for the item.
• LastUpdateDate: string (date)
  Title: Last Update Date

  Date when the order was most recently updated.
• LastUpdatedBy: string
  Title: Last Update dBy

  User who most recently updated the supply.
• ListPrice: integer (int64)
  Value that indicates the list price of an item in primary unit of measure.
• MappedItemId: integer (int64)
  Value that uniquely identifies the mapped fusion item associated with the supply.
• MappedOrganizationId: integer (int64)
  Value that uniquely identifies the mapped fusion organization associated with the order.
• MappedSupplierId: string
  Title: Mapped Supplier Id

  Value that uniquely identifies the mapped fusion source supplier.
• MarkForReleaseOption: integer (int64)
  Title: Mark For Release Option

  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.
• MaximumOrderQuantity: integer (int64)
  Maximum order quantity of the item.
• MinimumOrderQuantity: integer (int64)
  Minimum order quantity of the item.
• NewDockDate: string (date)
  Title: New Dock Date

  Date when the order is recommended to arrive at the receiving dock.
• NewOrderQuantity: integer (int64)
  Value that identifies the order quantity in buyer planning in primary unit of measure.
• NewShipDate: string (date)
  Title: New Ship Date

  Date when the order was originally to arrive at the receiving dock.
• ObjectVersionNumber: string
  Title: Object Version Number

  Number of times the supply row was updated. This attribute is used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• OldDockDate: string (date)
  Title: Old Dock Date

  Date when the order is recommended to be shipped.
• OldOrderQuantity: integer (int64)
  Value that identifies the original order quantity in buyer planning in primary unit of measure.
• OldShipDate: string (date)
  Title: Old Ship Date

  Date when the order was originally to be shipped.
• OrderCost: integer (int64)
  Value that indicates the cost of placing an order.
• OrderNumber: string
  Title: Order Number

  Number that identifies the order associated with the supply.
• OrderType: string
  Title: Order Type Name

  Type??of??order??such??as??planned??order,??purchase??order,??or??purchase??requisition.??A??list??of??accepted??values??is??defined??in??the??lookup??type??MSC_ORDER_TYPE.
• OrderTypeCode: integer (int64)
  Title: Order Type Code

  Code that indicates the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
• Organization: string
  Title: Organization Name

  Name of the organization associated with the order.
• OrganizationCalendarCode: string
  Title: Organization Calendar Code

  Abbreviation that indicates the organization's calendar.
• OrganizationCode: string
  Title: Organization Code

  Abbreviation that indicates the organization associated with the order.
• OrganizationCurrency: string
  Title: Organization Currency

  Value that indicates the organization's default currency.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization associated with the order.
• PartKey1: string
  Value that uniquely identifies the order based on planId, transactionID and a system generated part key.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• PlanName: string
  Title: Plan Name

  Name of the plan.
• PlannerCode: string
  Title: Planner Code

  Abbreviation that indicates the planner associdate to the order.
• PlanningTimeFenceDays: integer (int64)
  Time horizon, in number of days, in which supply orders aren't scheduled to be due.
• PoLineId: string
  Title: Po Line Id

  Value that uniquely identifies the purchase order line.
• PoLineLocationId: integer (int64)
  Value that uniquely identifies the purchase order line location.
• PostProcessingLeadTime: integer (int64)
  Number of days required to make an item available in inventory once the supply is complete.
• PriceSavings: number (float)
  Value that indicates the amount of savings realized from actions taken against the order in buyer planning.
• PrimaryUom: string
  Title: Primary Uom

  Name of the primary unit of measure associated with the order quantity.
• PrimaryUomCode: string
  Title: Primary Uom Code

  Abbreviation that identifies the primary unit of measure associated with the order quantity.
• ProcessingLeadTime: integer (int64)
  Number of days required to procure or manufacture an item.
• RangeFilterDate: string (date)
  Title: Range Filter Date

  Date range used to filter orders.
• ReleaseGroupCode: string
  Title: Release Group Code

  Abbreviation??that??identifies??a??custom??grouping??created??in??buyer??planning??used??by??procurement??in??the??purchase??order??creation??process.
• ReleaseStatus: string
  Title: Release Status

  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.
• ReleaseStatusCode: string
  Title: Release Status Code

  Release status of the order such as ready for release, marked for release or released. A list of accepted values is defined in the lookup type ORA_MSC_BP_RELEASE_STATUS.
• SegmentId: integer (int64)
  Value that uniquely identifies the segment.
• SegmentName: string
  Title: Segment Name

  Name of the segment used for a set of items.
• SourceUom: string
  Title: Source Uom

  Unit of measure for items sourced from planning.
• SourceUomCode: string
  Title: Source Uom Code

  Abbreviation that identifies the unit of measure for items sourced from planning.
• SrInstanceId: integer (int64)
  Value that uniquely identifies the source system of the order.
• StandardCost: integer (int64)
  Value that indicates the standard cost of an item in primary unit of measure.
• SubinventoryCode: string
  Title: Subinventory Code

  Subinventory code associated with the supply.
• Supplier: string
  Title: Supplier Name

  Name of the source supplier.
• SupplierId: integer (int64)
  Value that uniquely identifies the source supplier.
• SupplierSite: string
  Title: Supplier Site Code

  Abbreviation that indicates the specific supplier site from where the item is being sourced.
• SupplierSiteId: integer (int64)
  Value that uniquely identifies the specific supplier site 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.
• UnitVolume: integer (int64)
  Volume of one item.
• UnitWeight: integer (int64)
  Weight of one item.
• VolumeUom: string
  Title: Volume Uom

  Unit of measure to use for the item volume.
• VolumeUomCode: string
  Title: Volume Uom Code

  Code that indicates the unit of measure to use for the item volume.
• WeightUom: string
  Title: Weight Uom

  Unit of measure to use for the item weight.
• WeightUomCode: string
  Title: Weight Uom Code

  Abbreviation that identifies the unit of measure to use for the item weight.

{
    "type":"object",
    "properties":{
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64"
        },
        "PlanName":{
            "title":"Plan Name",
            "type":"string",
            "description":"Name of the plan."
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply transaction. This value is internally generated by the application.",
            "format":"int64"
        },
        "ConsolidatedFlag":{
            "title":"Consolidated Flag",
            "type":"boolean",
            "description":"Indicates whether or not the order is consolidated. If the value is true, then the order is consolidated."
        },
        "ConsolidationTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies associated consolidated orders.",
            "format":"int64"
        },
        "PartKey1":{
            "type":"string",
            "description":"Value that uniquely identifies the order based on planId, transactionID and a system generated part key."
        },
        "SrInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source system of the order.",
            "format":"int64"
        },
        "OrderTypeCode":{
            "title":"Order Type Code",
            "type":"integer",
            "description":"Code that indicates the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.",
            "format":"int64"
        },
        "OrderType":{
            "title":"Order Type Name",
            "type":"string",
            "description":"Type??of??order??such??as??planned??order,??purchase??order,??or??purchase??requisition.??A??list??of??accepted??values??is??defined??in??the??lookup??type??MSC_ORDER_TYPE."
        },
        "OrderNumber":{
            "title":"Order Number",
            "type":"string",
            "description":"Number that identifies the order associated with the supply."
        },
        "ReleaseStatusCode":{
            "title":"Release Status Code",
            "type":"string",
            "description":"Release status of the order such as ready for release, marked for release or released. A list of accepted values is defined in the lookup type ORA_MSC_BP_RELEASE_STATUS."
        },
        "ReleaseStatus":{
            "title":"Release Status",
            "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."
        },
        "MarkForReleaseOption":{
            "title":"Mark For Release Option",
            "type":"integer",
            "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.",
            "format":"int64"
        },
        "SegmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment.",
            "format":"int64"
        },
        "SegmentName":{
            "title":"Segment Name",
            "type":"string",
            "description":"Name of the segment used for a set of items."
        },
        "ReleaseGroupCode":{
            "title":"Release Group Code",
            "type":"string",
            "description":"Abbreviation??that??identifies??a??custom??grouping??created??in??buyer??planning??used??by??procurement??in??the??purchase??order??creation??process."
        },
        "MappedSupplierId":{
            "title":"Mapped Supplier Id",
            "type":"string",
            "description":"Value that uniquely identifies the mapped fusion source supplier."
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source supplier.",
            "format":"int64"
        },
        "Supplier":{
            "title":"Supplier Name",
            "type":"string",
            "description":"Name of the source supplier."
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the specific supplier site from where the item is being sourced.",
            "format":"int64"
        },
        "SupplierSite":{
            "title":"Supplier Site Code",
            "type":"string",
            "description":"Abbreviation that indicates the specific supplier site from where the item is being sourced."
        },
        "MappedOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the mapped fusion organization associated with the order.",
            "format":"int64"
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization associated with the order.",
            "format":"int64"
        },
        "Organization":{
            "title":"Organization Name",
            "type":"string",
            "description":"Name of the organization associated with the order."
        },
        "OrganizationCode":{
            "title":"Organization Code",
            "type":"string",
            "description":"Abbreviation that indicates  the organization associated with the order."
        },
        "OrganizationCalendarCode":{
            "title":"Organization Calendar Code",
            "type":"string",
            "description":"Abbreviation that indicates  the organization's calendar."
        },
        "SubinventoryCode":{
            "title":"Subinventory Code",
            "type":"string",
            "description":"Subinventory code associated with the supply."
        },
        "MappedItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the mapped fusion item associated with the supply.",
            "format":"int64"
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item associated with the supply.",
            "format":"int64"
        },
        "Item":{
            "title":"Item Name Code",
            "type":"string",
            "description":"Name of the item associated with the supply."
        },
        "ItemDescription":{
            "title":"Item Description Code",
            "type":"string",
            "description":"Description of the item that's associated with the supply."
        },
        "NewOrderQuantity":{
            "type":"integer",
            "description":"Value that identifies the order quantity in buyer planning in primary unit of measure.",
            "format":"int64"
        },
        "OldOrderQuantity":{
            "type":"integer",
            "description":"Value that identifies the original order quantity in buyer planning in primary unit of measure.",
            "format":"int64"
        },
        "NewDockDate":{
            "title":"New Dock Date",
            "type":"string",
            "description":"Date when the order is recommended to arrive at the receiving dock.",
            "format":"date"
        },
        "OldDockDate":{
            "title":"Old Dock Date",
            "type":"string",
            "description":"Date when the order is recommended to be shipped.",
            "format":"date"
        },
        "NewShipDate":{
            "title":"New Ship Date",
            "type":"string",
            "description":"Date when the order was originally to arrive at the receiving dock.",
            "format":"date"
        },
        "OldShipDate":{
            "title":"Old Ship Date",
            "type":"string",
            "description":"Date when the order was originally to be shipped.",
            "format":"date"
        },
        "FirmStatusCode":{
            "title":"Firm Status Code",
            "type":"integer",
            "description":"Abbreviation for a status that identifies 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.",
            "format":"int64"
        },
        "FirmStatus":{
            "title":"Firm Status",
            "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."
        },
        "FirmQuantity":{
            "title":"Firm Quantity",
            "type":"integer",
            "description":"Fixed quantity of supply. This attribute value can't be changed by planning and is only populated when the firm status is firm.",
            "format":"int64"
        },
        "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"
        },
        "ImplementQuantity":{
            "title":"Implement Quantity",
            "type":"integer",
            "description":"Quantity of the order that's released.",
            "format":"int64"
        },
        "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"
        },
        "ImplementShipDate":{
            "title":"Implement Ship Date",
            "type":"string",
            "description":"Date when the order is shipped.",
            "format":"date"
        },
        "ImplementDate":{
            "title":"Implement Date",
            "type":"string",
            "description":"Date when the order is released.",
            "format":"date"
        },
        "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.",
            "format":"int64"
        },
        "PrimaryUomCode":{
            "title":"Primary Uom Code",
            "type":"string",
            "description":"Abbreviation that identifies the primary unit of measure associated with the order quantity."
        },
        "PrimaryUom":{
            "title":"Primary Uom",
            "type":"string",
            "description":"Name of the primary unit of measure associated with the order quantity."
        },
        "SourceUomCode":{
            "title":"Source Uom Code",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for items sourced from planning."
        },
        "SourceUom":{
            "title":"Source Uom",
            "type":"string",
            "description":"Unit of measure for items sourced from planning."
        },
        "UnitVolume":{
            "type":"integer",
            "description":"Volume of one item.",
            "format":"int64"
        },
        "VolumeUomCode":{
            "title":"Volume Uom Code",
            "type":"string",
            "description":"Code that indicates the unit of measure to use for the item volume."
        },
        "VolumeUom":{
            "title":"Volume Uom",
            "type":"string",
            "description":"Unit of measure to use for the item volume."
        },
        "UnitWeight":{
            "type":"integer",
            "description":"Weight of one item.",
            "format":"int64"
        },
        "WeightUomCode":{
            "title":"Weight Uom Code",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure to use for the item weight."
        },
        "WeightUom":{
            "title":"Weight Uom",
            "type":"string",
            "description":"Unit of measure to use for the item weight."
        },
        "CarryingCost":{
            "type":"integer",
            "description":"Percent of the item's cost that represents the inventory carrying cost.",
            "format":"int64"
        },
        "HasPriceBreakFlag":{
            "title":"Has Price Break Flag",
            "type":"boolean",
            "description":"Indicates whether or not the order is associated to a purchase agreement with a price break. If the value is true, then there is an existing price break on the associated purchase agreement."
        },
        "ListPrice":{
            "type":"integer",
            "description":"Value that indicates the list price of an item in primary unit of measure.",
            "format":"int64"
        },
        "OrderCost":{
            "type":"integer",
            "description":"Value that indicates the cost of placing an order.",
            "format":"int64"
        },
        "StandardCost":{
            "type":"integer",
            "description":"Value that indicates the standard cost of an item in primary unit of measure.",
            "format":"int64"
        },
        "PriceSavings":{
            "type":"number",
            "description":"Value that indicates the amount of savings realized from actions taken against the order in buyer planning.",
            "format":"float"
        },
        "OrganizationCurrency":{
            "title":"Organization Currency",
            "type":"string",
            "description":"Value that indicates the organization's default currency."
        },
        "FixedDaysOfSupply":{
            "type":"integer",
            "description":"Number of days to use to modify the size and timing of each planned order quantity.",
            "format":"int64"
        },
        "FixedLotMultiplier":{
            "type":"integer",
            "description":"Multiplier to use, in units for each day, for each fixed lot quantity or each repetitive rate.",
            "format":"int64"
        },
        "FixedOrderQuantity":{
            "type":"integer",
            "description":"Quantity to use to modify the size of each planned order quantity or each repetitive daily rate.",
            "format":"int64"
        },
        "MaximumOrderQuantity":{
            "type":"integer",
            "description":"Maximum order quantity of the item.",
            "format":"int64"
        },
        "MinimumOrderQuantity":{
            "type":"integer",
            "description":"Minimum order quantity of the item.",
            "format":"int64"
        },
        "PlanningTimeFenceDays":{
            "type":"integer",
            "description":"Time horizon, in number of days, in which supply orders aren't scheduled to be due.",
            "format":"int64"
        },
        "ProcessingLeadTime":{
            "type":"integer",
            "description":"Number of days required to procure or manufacture an item.",
            "format":"int64"
        },
        "PostProcessingLeadTime":{
            "type":"integer",
            "description":"Number of days required to make an item available in inventory once the supply is complete.",
            "format":"int64"
        },
        "ItemPlanner":{
            "title":"Item Planner",
            "type":"string",
            "description":"Abbreviation that identifies the planner responsible for the item."
        },
        "EmployeeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planner associdate to the order as an employee.",
            "format":"int64"
        },
        "PoLineId":{
            "title":"Po Line Id",
            "type":"string",
            "description":"Value that uniquely identifies the purchase order line."
        },
        "PoLineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order line location.",
            "format":"int64"
        },
        "RangeFilterDate":{
            "title":"Range Filter Date",
            "type":"string",
            "description":"Date range used to filter orders.",
            "format":"date"
        },
        "PlannerCode":{
            "title":"Planner Code",
            "type":"string",
            "description":"Abbreviation that indicates the planner associdate to the order."
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"string",
            "description":"Number of times the supply row was updated. This attribute is used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried."
        },
        "CreatedBy":{
            "title":"Created By",
            "type":"string",
            "description":"User who created the order."
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the order.",
            "format":"date"
        },
        "LastUpdatedBy":{
            "title":"Last Update dBy",
            "type":"string",
            "description":"User who most recently updated the supply."
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the order was most recently updated.",
            "format":"date"
        }
    }
}

Nested Schema : ItemProperties

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.

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

Nested Schema : buyerPlanningSupplies-getAll-item-response-allOf[2]

Type: object

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

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

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

Example 1

This example shows how to get one order for a plan, supplier, supplier site, and organization.

Example 1 cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/buyerPlanningSupplies?q=PlanId=PlanId and SupplierId=SupplierId and SupplierSiteId=SupplierSiteId and OrganizationId=OrganizationId and TransactionId=TransactionId"

Example 1 Response Body

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

{
    "items": [
        {
            "PlanId": "300100583717750",
            "PlanName": "BP_SCC_PLAN1",
            "TransactionId": "99965425",
            "ConsolidatedFlag": false,
            "ConsolidationTransactionId": null,
            "PartKey1": "999999999999999999",
            "SrInstanceId": "100010026240309",
            "OrderTypeCode": 5,
            "OrderType": "Planned order",
            "OrderNumber": "99965425",
            "ReleaseStatusCode": 14,
            "ReleaseStatus": "Marked for release",
            "MarkForReleaseOption": null,
            "SegmentId": "300100570073440",
            "SegmentName": "SCC QA Segment2",
            "ReleaseGroupCode": "test2",
            "MappedSupplierId": "300100569166970",
            "SupplierId": "2736180",
            "Supplier": "SCC-AllMeds",
            "SupplierSiteId": "7463779",
            "SupplierSite": "Boulder-Site1",
            "MappedOrganizationId": "300100569182022",
            "OrganizationId": "147202",
            "Organization": "BP2",
            "OrganizationCode": "BP2",
            "OrganizationCalendarCode": "10002",
            "SubinventoryCode": null,
            "MappedItemId": "-1",
            "InventoryItemId": "26563124",
            "Item": "BP-Syringe-02",
            "ItemDescription": "BP-Syringe-02",
            "NewOrderQuantity": 128,
            "OldOrderQuantity": null,
            "NewDockDate": "2024-01-10",
            "OldDockDate": null,
            "NewShipDate": "2024-01-10",
            "OldShipDate": null,
            "FirmStatusCode": 2,
            "FirmStatus": "Not firm",
            "FirmQuantity": null,
            "FirmDate": null,
            "ImplementQuantity": 128,
            "ImplementDockDate": "2024-01-10",
            "ImplementShipDate": "2024-01-10",
            "ImplementDate": "2024-01-12",
            "ImplementFirm": 2,
            "PrimaryUomCode": "Ea",
            "PrimaryUom": "Each",
            "SourceUomCode": null,
            "SourceUom": null,
            "UnitVolume": 110,
            "VolumeUomCode": "M3",
            "VolumeUom": "Cubic meter",
            "UnitWeight": 110,
            "WeightUomCode": "G",
            "WeightUom": "Gram",
            "CarryingCost": null,
            "HasPriceBreakFlag": false,
            "ListPrice": 10,
            "OrderCost": null,
            "StandardCost": null,
            "PriceSavings": null,
            "OrganizationCurrency": "USD",
            "FixedDaysOfSupply": null,
            "FixedLotMultiplier": 10,
            "FixedOrderQuantity": null,
            "MaximumOrderQuantity": 1000,
            "MinimumOrderQuantity": 1,
            "PlanningTimeFenceDays": 1,
            "ProcessingLeadTime": 2,
            "PostProcessingLeadTime": 2,
            "ItemPlanner": "Smith, Elizabeth",
            "EmployeeId": "280",
            "PoLineId": null,
            "PoLineLocationId": null,
            "RangeFilterDate": "2024-01-10",
            "PlannerCode": "BP_PLAN1",
            "ObjectVersionNumber": 4,
            "CreatedBy": "COLLABPLANNER",
            "CreationDate": "2023-07-31",
            "LastUpdatedBy": "COLLABPLANNER",
            "LastUpdateDate": "2023-08-02",
            "links": [
                {
                   . . .
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offSet": 0
}

Example 2

This example shows how to get all orders for a plan, supplier, supplier site, and organization.

Example 2 cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/buyerPlanningSupplies?q=PlanId=PlanId and SupplierId=SupplierId and SupplierSiteId=SupplierSiteId and OrganizationId=OrganizationId"

Example 2 Response Body

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

{
    "items": [
        {
            "PlanId": "300100583717750",
            "PlanName": "BP_SCC_PLAN1",
            "TransactionId": "99489498",
            "ConsolidatedFlag": false,
            "ConsolidationTransactionId": null,
            "PartKey1": "999999999999999999",
            "SrInstanceId": "100010026240309",
            "OrderTypeCode": 1,
            "OrderType": "Purchase order",
            "OrderNumber": "PO-201()(1)(1)",
            "ReleaseStatusCode": 6,
            "ReleaseStatus": "Ineligible",
            "MarkForReleaseOption": null,
            "SegmentId": "300100570073440",
            "SegmentName": "SCC QA Segment2",
            "ReleaseGroupCode": null,
            "MappedSupplierId": "300100569166970",
            "SupplierId": "2736180",
            "Supplier": "SCC-AllMeds",
            "SupplierSiteId": "7463779",
            "SupplierSite": "Boulder-Site1",
            "MappedOrganizationId": "300100569182022",
            "OrganizationId": "147202",
            "OrganizationCode": "BP2",
            "Organization": "BP2",
            "OrganizationCalendarCode": "10002",
            "SubinventoryCode": null,
            "MappedItemId": "-1",
            "InventoryItemId": "26563124",
            "Item": "BP-Syringe-02",
            "ItemDescription": "BP-Syringe-02",
            "NewOrderQuantity": 11,
            "OldOrderQuantity": null,
            "NewDockDate": "2024-01-15",
            "OldDockDate": null,
            "NewShipDate": "2024-01-15",
            "OldShipDate": null,
            "FirmStatusCode": 2,
            "FirmStatus": "Not firm",
            "FirmQuantity": null,
            "FirmDate": null,
            "ImplementQuantity": null,
            "ImplementDockDate": null,
            "ImplementShipDate": null,
            "ImplementDate": null,
            "ImplementFirm": null,
            "PrimaryUomCode": "Ea",
            "PrimaryUom": "Each",
            "SourceUomCode": null,
            "SourceUom": null,
            "UnitVolume": 110,
            "VolumeUomCode": "M3",
            "VolumeUom": "Cubic meter",
            "UnitWeight": 110,
            "WeightUomCode": "G",
            "WeightUom": "Gram",
            "CarryingCost": null,
            "HasPriceBreakFlag": false,
            "ListPrice": 10,
            "OrderCost": null,
            "StandardCost": null,
            "PriceSavings": null,
            "OrganizationCurrency": "USD",
            "FixedDaysOfSupply": null,
            "FixedLotMultiplier": 10,
            "FixedOrderQuantity": null,
            "MaximumOrderQuantity": 1000,
            "MinimumOrderQuantity": 1,
            "PlanningTimeFenceDays": 1,
            "ProcessingLeadTime": 2,
            "PostProcessingLeadTime": 2,
            "ItemPlanner": "Smith, Elizabeth",
            "EmployeeId": "280",
            "PoLineId": null,
            "PoLineLocationId": "-999",
            "RangeFilterDate": "2024-01-15",
            "PlannerCode": "BP_PLAN1",
            "ObjectVersionNumber": 1,
            "CreatedBy": "COLLABPLANNER",
            "CreationDate": "2023-07-31",
            "LastUpdatedBy": "COLLABPLANNER",
            "LastUpdateDate": "2023-07-31",
            "links": [
                {
                    . . .
                }
            ]
        },
        {
            "PlanId": "300100583717750",
            "PlanName": "BP_SCC_PLAN1",
            "TransactionId": "99486641",
            "ConsolidatedFlag": false,
            "ConsolidationTransactionId": null,
            "PartKey1": "999999999999999999",
            "SrInstanceId": "100010026240309",
            "OrderTypeCode": 2,
            "OrderType": "Purchase requisition",
            "OrderNumber": "PR-202",
            "ReleaseStatusCode": 6,
            "ReleaseStatus": "Ineligible",
            "MarkForReleaseOption": null,
            "SegmentId": "300100570073440",
            "SegmentName": "SCC QA Segment2",
            "ReleaseGroupCode": null,
            "MappedSupplierId": "300100569166970",
            "SupplierId": "2736180",
            "Supplier": "SCC-AllMeds",
            "SupplierSiteId": "7463779",
            "SupplierSite": "Boulder-Site1",
            "MappedOrganizationId": "300100569182022",
            "OrganizationId": "147202",
            "OrganizationCode": "BP2",
            "Organization": "BP2",
            "OrganizationCalendarCode": "10002",
            "SubinventoryCode": null,
            "MappedItemId": "-1",
            "InventoryItemId": "26563124",
            "Item": "BP-Syringe-02",
            "ItemDescription": "BP-Syringe-02",
            "NewOrderQuantity": 19,
            "OldOrderQuantity": null,
            "NewDockDate": "2024-01-15",
            "OldDockDate": null,
            "NewShipDate": "2024-01-15",
            "OldShipDate": null,
            "FirmStatusCode": 2,
            "FirmStatus": "Not firm",
            "FirmQuantity": null,
            "FirmDate": null,
            "ImplementQuantity": null,
            "ImplementDockDate": null,
            "ImplementShipDate": null,
            "ImplementDate": null,
            "ImplementFirm": null,
            "PrimaryUomCode": "Ea",
            "PrimaryUom": "Each",
            "SourceUomCode": null,
            "SourceUom": null,
            "UnitVolume": 110,
            "VolumeUomCode": "M3",
            "VolumeUom": "Cubic meter",
            "UnitWeight": 110,
            "WeightUomCode": "G",
            "WeightUom": "Gram",
            "CarryingCost": null,
            "HasPriceBreakFlag": false,
            "ListPrice": 10,
            "OrderCost": null,
            "StandardCost": null,
            "PriceSavings": null,
            "OrganizationCurrency": "USD",
            "FixedDaysOfSupply": null,
            "FixedLotMultiplier": 10,
            "FixedOrderQuantity": null,
            "MaximumOrderQuantity": 1000,
            "MinimumOrderQuantity": 1,
            "PlanningTimeFenceDays": 1,
            "ProcessingLeadTime": 2,
            "PostProcessingLeadTime": 2,
            "ItemPlanner": "Smith, Elizabeth",
            "EmployeeId": "280",
            "PoLineId": "PR-202:1",
            "PoLineLocationId": null,
            "RangeFilterDate": "2024-01-15",
            "PlannerCode": "BP_PLAN1",
            "ObjectVersionNumber": 1,
            "CreatedBy": "COLLABPLANNER",
            "CreationDate": "2023-07-31",
            "LastUpdatedBy": "COLLABPLANNER",
            "LastUpdateDate": "2023-07-31",
            "links": [
                {
                    . . .
                }
            ]
        },
        {
            "PlanId": "300100583717750",
            "PlanName": "BP_SCC_PLAN1",
            "TransactionId": "99965425",
            "ConsolidatedFlag": false,
            "ConsolidationTransactionId": null,
            "PartKey1": "999999999999999999",
            "SrInstanceId": "100010026240309",
            "OrderTypeCode": 5,
            "OrderType": "Planned order",
            "OrderNumber": "99965425",
            "ReleaseStatusCode": 14,
            "ReleaseStatus": "Marked for release",
            "MarkForReleaseOption": null,
            "SegmentId": "300100570073440",
            "SegmentName": "SCC QA Segment2",
            "ReleaseGroupCode": "test2",
            "MappedSupplierId": "300100569166970",
            "SupplierId": "2736180",
            "Supplier": "SCC-AllMeds",
            "SupplierSiteId": "7463779",
            "SupplierSite": "Boulder-Site1",
            "MappedOrganizationId": "300100569182022",
            "OrganizationId": "147202",
            "OrganizationCode": "BP2",
            "Organization": "BP2",
            "OrganizationCalendarCode": "10002",
            "SubinventoryCode": null,
            "MappedItemId": "-1",
            "InventoryItemId": "26563124",
            "Item": "BP-Syringe-02",
            "ItemDescription": "BP-Syringe-02",
            "NewOrderQuantity": 128,
            "OldOrderQuantity": null,
            "NewDockDate": "2024-01-10",
            "OldDockDate": null,
            "NewShipDate": "2024-01-10",
            "OldShipDate": null,
            "FirmStatusCode": 2,
            "FirmStatus": "Not firm",
            "FirmQuantity": null,
            "FirmDate": null,
            "ImplementQuantity": 128,
            "ImplementDockDate": "2024-01-10",
            "ImplementShipDate": "2024-01-10",
            "ImplementDate": "2024-01-12",
            "ImplementFirm": 2,
            "PrimaryUomCode": "Ea",
            "PrimaryUom": "Each",
            "SourceUomCode": null,
            "SourceUom": null,
            "UnitVolume": 110,
            "VolumeUomCode": "M3",
            "VolumeUom": "Cubic meter",
            "UnitWeight": 110,
            "WeightUomCode": "G",
            "WeightUom": "Gram",
            "CarryingCost": null,
            "HasPriceBreakFlag": false,
            "ListPrice": 10,
            "OrderCost": null,
            "StandardCost": null,
            "PriceSavings": null,
            "OrganizationCurrency": "USD",
            "FixedDaysOfSupply": null,
            "FixedLotMultiplier": 10,
            "FixedOrderQuantity": null,
            "MaximumOrderQuantity": 1000,
            "MinimumOrderQuantity": 1,
            "PlanningTimeFenceDays": 1,
            "ProcessingLeadTime": 2,
            "PostProcessingLeadTime": 2,
            "ItemPlanner": "Smith, Elizabeth",
            "EmployeeId": "280",
            "PoLineId": null,
            "PoLineLocationId": null,
            "RangeFilterDate": "2024-01-10",
            "PlannerCode": "BP_PLAN1",
            "ObjectVersionNumber": 4,
            "CreatedBy": "COLLABPLANNER",
            "CreationDate": "2023-07-31",
            "LastUpdatedBy": "COLLABPLANNER",
            "LastUpdateDate": "2023-08-02",
            "links": [
                {
                    . . .
                }
            ]
        }
    ],
    "count": 3,
    "hasMore": true,
    "limit": 3,
    "offSet": 0
}

Back to Top