Jump to

• Request
• Response
• Examples

Get all item details

get

/fscmRestApi/resources/11.13.18.05/requisitionProductDetails

Request

Query Parameters

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

  • ByItemId: Find the item according to the item identifier.
    Finder Variables:
    • bind_itemId; integer; Value that uniquely identifies the item.
  • ByPunchoutItemIdentifier: Find the item according to the punchout item identifier.
    Finder Variables:
    • bind_punchoutItemIdentifier; integer; Value that uniquely identifies the punchout item.
  • BySourceDocLineId: Find the item according to the line identifier in the source document.
    Finder Variables:
    • bind_sourceDocLineId; integer; Value that uniquely identifies the line in the source document.
  • PrimaryKey: Find the item according to the catalog item key.
    Finder Variables:
    • CatalogItemKey; integer; Value that uniquely identifies the item using catalog item key.
• 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:
  

  • Amount; number; Amount of the item in functional currency.
  • CatalogItemKey; integer; Value that uniquely identifies the catalog item.
  • CategoryName; string; Name of the category that classifies the item.
  • CurrencyAmount; number; Amount of the item in foreign currency.
  • CurrencyCode; string; Abbreviation that identifies the currency of the item price.
  • CurrencyUnitPrice; integer; Price of item for each unit in foreign currency.
  • FormattedAmount; string; Amount formatted for the currency.
  • FormattedCurrencyAmount; string; Currency amount formatted for the currency.
  • FormattedCurrencyUnitPrice; string; Value of the currency price of item for each unit formatted for the currency.
  • FormattedUnitPrice; string; Price of item for each unit formatted for the currency.
  • FunctionalCurrencyCode; string; Abbreviation that identifies the functional currency.
  • FunctionalCurrencySymbol; string; Symbol that identifies the functional currency.
  • ItemDescription; string; Description of the item that is available on the Product details page.
  • ItemKey; string; Value that uniquely identifies the item. It is a key that the application generates with the combination of item identifier, source document line identifier, language, and punchout item identifier.
  • ItemSource; string; Value that identifies the source of the item. This source can be catalog, noncatalog, quick create, punchout, requisition import, or web service.
  • LongDescription; string; Text description of the item.
  • Manufacturer; string; Name of the party who manufactures the item.
  • ManufacturerPartNumber; string; Value that identifies the part as originating from a manufacturer.
  • OrderTypeLookupCode; string; Abbreviation that identifies the lookup value for the order type. A list of accepted values include Fixed Price and Quantity.
  • PunchoutCatalogId; integer; Value that uniquely identifies the punchout catalog.
  • PunchoutItemIdentifier; integer; Value that uniquely identifies the punchout item.
  • RequisitioningBUId; integer; Value that uniquely identifies the requisitioning business unit.
  • SuggestedVendorName; string; Name of the suggested supplier of the item.
  • SupplierPartNumber; string; Value that identifies the part as originating from a supplier.
  • ThumbnailImage; string; Thumbnail image of the item.
  • UOM; string; Unit of measure that the item uses.
  • UnitPrice; number; Price of item for each unit in functional currency.
• 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 : requisitionProductDetails

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/requisitionProductDetails-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object requisitionProductDetails-item-response

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

Type: object

Show Source

• Amount: number
  Amount of the item in functional currency.
• CatalogItemKey: integer (int64)
  Read Only: true

  Value that uniquely identifies the catalog item.
• CategoryName: string
  Read Only: true

  Maximum Length: 250

  Name of the category that classifies the item.
• CurrencyAmount: number
  Amount of the item in foreign currency.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 32

  Abbreviation that identifies the currency of the item price.
• CurrencyUnitPrice: integer (int64)
  Read Only: true

  Price of item for each unit in foreign currency.
• FormattedAmount: string
  Read Only: true

  Amount formatted for the currency.
• FormattedCurrencyAmount: string
  Read Only: true

  Currency amount formatted for the currency.
• FormattedCurrencyUnitPrice: string
  Read Only: true

  Value of the currency price of item for each unit formatted for the currency.
• FormattedUnitPrice: string
  Read Only: true

  Price of item for each unit formatted for the currency.
• FunctionalCurrencyCode: string
  Read Only: true

  Maximum Length: 32

  Abbreviation that identifies the functional currency.
• FunctionalCurrencySymbol: string
  Read Only: true

  Symbol that identifies the functional currency.
• ItemDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the item that is available on the Product details page.
• ItemKey: string
  Read Only: true

  Maximum Length: 129

  Value that uniquely identifies the item. It is a key that the application generates with the combination of item identifier, source document line identifier, language, and punchout item identifier.
• ItemSource: string
  Read Only: true

  Maximum Length: 8

  Value that identifies the source of the item. This source can be catalog, noncatalog, quick create, punchout, requisition import, or web service.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LongDescription: string
  Read Only: true

  Maximum Length: 4000

  Text description of the item.
• Manufacturer: string
  Read Only: true

  Maximum Length: 700

  Name of the party who manufactures the item.
• ManufacturerPartNumber: string
  Read Only: true

  Value that identifies the part as originating from a manufacturer.
• OrderTypeLookupCode: string
  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the lookup value for the order type. A list of accepted values include Fixed Price and Quantity.
• priceBreaks: array Price Breaks
  Title: Price Breaks

  The Price Breaks resource gets the price break details of an item.
• PunchoutCatalogId: integer
  Read Only: true

  Value that uniquely identifies the punchout catalog.
• PunchoutItemIdentifier: integer (int64)
  Read Only: true

  Value that uniquely identifies the punchout item.
• RequisitioningBUId: integer
  Read Only: true

  Value that uniquely identifies the requisitioning business unit.
• SuggestedVendorName: string
  Read Only: true

  Maximum Length: 360

  Name of the suggested supplier of the item.
• SupplierPartNumber: string
  Read Only: true

  Value that identifies the part as originating from a supplier.
• ThumbnailImage: string
  Read Only: true

  Maximum Length: 1000

  Thumbnail image of the item.
• UnitPrice: number
  Read Only: true

  Price of item for each unit in functional currency.
• UOM: string
  Read Only: true

  Unit of measure that the item uses.

{
    "type":"object",
    "properties":{
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requisitioning business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyUnitPrice":{
            "type":"integer",
            "description":"Price of item for each unit in foreign currency.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item that is available on the Product details page.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that identifies the currency of the item price.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalCurrencyCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that identifies the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Manufacturer":{
            "maxLength":"700",
            "type":"string",
            "description":"Name of the party who manufactures the item.",
            "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"
            }
        },
        "SupplierPartNumber":{
            "type":"string",
            "description":"Value that identifies the part as originating from a supplier.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SupplierPartNum"
                ]
            },
            "x-queryable":true
        },
        "FormattedUnitPrice":{
            "type":"string",
            "description":"Price of item for each unit formatted for the currency.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FunctionalCurrencyCode",
                    "UnitPrice"
                ]
            },
            "x-queryable":true
        },
        "PunchoutCatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the punchout catalog.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CatalogItemKey":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"Amount of the item in functional currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemSource":{
            "maxLength":"8",
            "type":"string",
            "description":"Value that identifies the source of the item. This source can be catalog, noncatalog, quick create, punchout, requisition import, or web service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManufacturerPartNumber":{
            "type":"string",
            "description":"Value that identifies the part as originating from a manufacturer.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ManufacturerPartNum"
                ]
            },
            "x-queryable":true
        },
        "FormattedAmount":{
            "type":"string",
            "description":"Amount formatted for the currency.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Amount",
                    "FunctionalCurrencyCode"
                ]
            },
            "x-queryable":true
        },
        "FormattedCurrencyUnitPrice":{
            "type":"string",
            "description":"Value of the currency price of item for each unit formatted for the currency.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CurrencyCode",
                    "CurrencyUnitPrice"
                ]
            },
            "x-queryable":true
        },
        "FunctionalCurrencySymbol":{
            "type":"string",
            "description":"Symbol that identifies the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FunctionalCurrencyCode"
                ]
            },
            "x-queryable":true
        },
        "PunchoutItemIdentifier":{
            "type":"integer",
            "description":"Value that uniquely identifies the punchout item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyAmount":{
            "type":"number",
            "description":"Amount of the item in foreign currency.",
            "nullable":true,
            "x-queryable":true
        },
        "priceBreaks":{
            "title":"Price Breaks",
            "type":"array",
            "description":"The Price Breaks resource gets the price break details of an item.",
            "items":{
                "$ref":"#/components/schemas/requisitionProductDetails-priceBreaks-item-response"
            }
        },
        "UnitPrice":{
            "type":"number",
            "description":"Price of item for each unit in functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOM":{
            "type":"string",
            "description":"Unit of measure that the item uses.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Uom"
                ]
            },
            "x-queryable":true
        },
        "LongDescription":{
            "maxLength":"4000",
            "type":"string",
            "description":"Text description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ThumbnailImage":{
            "maxLength":"1000",
            "type":"string",
            "description":"Thumbnail image of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemKey":{
            "maxLength":"129",
            "type":"string",
            "description":"Value that uniquely identifies the item. It is a key that the application generates with the combination of item identifier, source document line identifier, language, and punchout item identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestedVendorName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the suggested supplier of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedCurrencyAmount":{
            "type":"string",
            "description":"Currency amount formatted for the currency.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CurrencyAmount",
                    "CurrencyCode"
                ]
            },
            "x-queryable":true
        },
        "OrderTypeLookupCode":{
            "maxLength":"25",
            "type":"string",
            "description":"Abbreviation that identifies the lookup value for the order type. A list of accepted values include Fixed Price and Quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":"250",
            "type":"string",
            "description":"Name of the category that classifies the item.",
            "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 : Price Breaks

Type: array

Title: Price Breaks

The Price Breaks resource gets the price break details of an item.

Show Source

• Array of: object requisitionProductDetails-priceBreaks-item-response

{
    "title":"Price Breaks",
    "type":"array",
    "description":"The Price Breaks resource gets the price break details of an item.",
    "items":{
        "$ref":"#/components/schemas/requisitionProductDetails-priceBreaks-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Nested Schema : requisitionProductDetails-priceBreaks-item-response

Type: object

Show Source

• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the currency for the price break of an item.
• DeliverTo: string
  Title: Deliver To

  Read Only: true

  Maximum Length: 302

  Value that identifies the deliver-to location of the line.
• Discount: number
  Title: Discount Percent

  Read Only: true

  Percent of discount for the price break.
• EndDate: string (date)
  Title: End Date

  Read Only: true

  Date when the price break becomes inactive.
• FormattedDiscount: string
  Read Only: true

  Percent of discount formatted for the currency.
• FormattedFunctionalCurrencyPrice: string
  Read Only: true

  Functional currency price formatted for the currency.
• FormattedPrice: string
  Read Only: true

  Price break of an item formatted for the currency.
• FunctionalCurrencyCode: string
  Abbreviation that identifies the functional currency for the price break of an item.
• FunctionalCurrencyPrice: number
  Value for the price break of an item in the functional currency.
• FunctionalCurrencySymbol: string
  Read Only: true

  Symbol that identifies the functional currency for the price break of an item.
• LineLocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the line location.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Price: number
  Title: Price

  Read Only: true

  Price or price break of the order shipment.
• Quantity: number
  Title: Quantity

  Read Only: true

  Quantity of the item from the blanket purchase agreement price break line.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  Date when the price break becomes active.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure for the price break of an item.

{
    "type":"object",
    "properties":{
        "DeliverTo":{
            "title":"Deliver To",
            "maxLength":"302",
            "type":"string",
            "description":"Value that identifies the deliver-to location of the line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Discount":{
            "title":"Discount Percent",
            "type":"number",
            "description":"Percent of discount for the price break.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure for the price break of an item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "FormattedPrice":{
            "type":"string",
            "description":"Price break of an item formatted for the currency.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CurrencyCode",
                    "Price"
                ]
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of the item from the blanket purchase agreement price break line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalCurrencySymbol":{
            "type":"string",
            "description":"Symbol that identifies the functional currency for the price break of an item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FunctionalCurrencyCode"
                ]
            },
            "x-queryable":true
        },
        "FormattedFunctionalCurrencyPrice":{
            "type":"string",
            "description":"Functional currency price formatted for the currency.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FunctionalCurrencyCode",
                    "FunctionalCurrencyPrice"
                ]
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the price break becomes inactive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalCurrencyPrice":{
            "type":"number",
            "description":"Value for the price break of an item in the functional currency.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CurrencyCode",
                    "Price"
                ]
            },
            "x-queryable":true
        },
        "FormattedDiscount":{
            "type":"string",
            "description":"Percent of discount formatted for the currency.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Discount"
                ]
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the price break becomes active.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency for the price break of an item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalCurrencyCode":{
            "type":"string",
            "description":"Abbreviation that identifies the functional currency for the price break of an item.",
            "nullable":true,
            "x-queryable":true
        },
        "Price":{
            "title":"Price",
            "type":"number",
            "description":"Price or price break of the order shipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the line location.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Back to Top

Examples

This example describes how to get all item details.

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

Example Response Body

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

{
    "items": [
        {
            "ItemKey": "l#100000012320874#-2#-2#US",
            "PunchoutItemIdentifier": -2,
            "PunchoutCatalogId": -2,
            "ItemDescription": "Ergonomic Keyboard",
            "LongDescription": null,
            "CurrencyCode": "USD",
            "OrderTypeLookupCode": "QUANTITY",
            "CategoryName": "Miscellaneous_1",
            "CurrencyUnitPrice": 0,
            "UnitPrice": 0,
            "CurrencyAmount": null,
            "Amount": null,
            "SuggestedVendorName": null,
            "Manufacturer": null,
            "ThumbnailImage": null,
            "ItemSource": "CATALOG",
            "FunctionalCurrencyCode": "USD",
            "CatalogItemKey": 30439,
            "FunctionalCurrencySymbol": "$",
            "ManufacturerPartNumber": null,
            "SupplierPartNumber": null,
            "UOM": "Each",
            "RequisitioningBUId": 204,
            "FormattedUnitPrice": "0.00",
            "FormattedCurrencyUnitPrice": "0.00",
            "FormattedAmount": null,
            "FormattedCurrencyAmount": null,
            "links": [
                {
                    "rel": "self",
                    "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30439",
                    "name": "requisitionProductDetails",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30439",
                    "name": "requisitionProductDetails",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30439/child/priceBreaks",
                    "name": "priceBreaks",
                    "kind": "collection"
                }
            ]
        },
        {
            "ItemKey": "l#1769#-2#-2#US",
            "PunchoutItemIdentifier": -2,
            "PunchoutCatalogId": -2,
            "ItemDescription": "Keyboard - 111 Keys",
            "LongDescription": null,
            "CurrencyCode": "USD",
            "OrderTypeLookupCode": "QUANTITY",
            "CategoryName": "Miscellaneous_1",
            "CurrencyUnitPrice": 0,
            "UnitPrice": 0,
            "CurrencyAmount": null,
            "Amount": null,
            "SuggestedVendorName": null,
            "Manufacturer": null,
            "ThumbnailImage": null,
            "ItemSource": "CATALOG",
            "FunctionalCurrencyCode": "USD",
            "CatalogItemKey": 30441,
            "FunctionalCurrencySymbol": "$",
            "ManufacturerPartNumber": null,
            "SupplierPartNumber": null,
            "UOM": "Each",
            "RequisitioningBUId": 204,
            "FormattedUnitPrice": "0.00",
            "FormattedCurrencyUnitPrice": "0.00",
            "FormattedAmount": null,
            "FormattedCurrencyAmount": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30441",
                    "name": "requisitionProductDetails",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30441",
                    "name": "requisitionProductDetails",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30441/child/priceBreaks",
                    "name": "priceBreaks",
                    "kind": "collection"
                }
            ]
        },
        {
            "ItemKey": "l#300100063781146#-2#-2#US",
            "PunchoutItemIdentifier": -2,
            "PunchoutCatalogId": -2,
            "ItemDescription": "ATO-Dining-Table-Glass",
            "LongDescription": null,
            "CurrencyCode": "USD",
            "OrderTypeLookupCode": "QUANTITY",
            "CategoryName": "Miscellaneous_1",
            "CurrencyUnitPrice": 10000,
            "UnitPrice": 10000,
            "CurrencyAmount": null,
            "Amount": null,
            "SuggestedVendorName": null,
            "Manufacturer": null,
            "ThumbnailImage": null,
            "ItemSource": "CATALOG",
            "FunctionalCurrencyCode": "USD",
            "CatalogItemKey": 30064,
            "FunctionalCurrencySymbol": "$",
            "ManufacturerPartNumber": null,
            "SupplierPartNumber": null,
            "UOM": "Each",
            "RequisitioningBUId": 204,
            "FormattedUnitPrice": "10,000.00",
            "FormattedCurrencyUnitPrice": "10,000.00",
            "FormattedAmount": null,
            "FormattedCurrencyAmount": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30064",
                    "name": "requisitionProductDetails",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30064",
                    "name": "requisitionProductDetails",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30064/child/priceBreaks",
                    "name": "priceBreaks",
                    "kind": "collection"
                }
            ]
        },
        {
            "ItemKey": "l#300100063781269#-2#-2#US",
            "PunchoutItemIdentifier": -2,
            "PunchoutCatalogId": -2,
            "ItemDescription": "ATO-Dining-Table-Glass-Table",
            "LongDescription": null,
            "CurrencyCode": "USD",
            "OrderTypeLookupCode": "QUANTITY",
            "CategoryName": "Miscellaneous_1",
            "CurrencyUnitPrice": 5000,
            "UnitPrice": 5000,
            "CurrencyAmount": null,
            "Amount": null,
            "SuggestedVendorName": null,
            "Manufacturer": null,
            "ThumbnailImage": null,
            "ItemSource": "CATALOG",
            "FunctionalCurrencyCode": "USD",
            "CatalogItemKey": 30079,
            "FunctionalCurrencySymbol": "$",
            "ManufacturerPartNumber": null,
            "SupplierPartNumber": null,
            "UOM": "Each",
            "RequisitioningBUId": 204,
            "FormattedUnitPrice": "5,000.00",
            "FormattedCurrencyUnitPrice": "5,000.00",
            "FormattedAmount": null,
            "FormattedCurrencyAmount": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30079",
                    "name": "requisitionProductDetails",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30079",
                    "name": "requisitionProductDetails",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/30079/child/priceBreaks",
                    "name": "priceBreaks",
                    "kind": "collection"
                }
            ]
        },
        {
            "ItemKey": "l#100100039742321#300100113893538#-2#US",
            "PunchoutItemIdentifier": -2,
            "PunchoutCatalogId": -2,
            "ItemDescription": "Fus13_SItem_Motherboard Mini",
            "LongDescription": null,
            "CurrencyCode": "USD",
            "OrderTypeLookupCode": "QUANTITY",
            "CategoryName": "Miscellaneous_1",
            "CurrencyUnitPrice": 23,
            "UnitPrice": 23,
            "CurrencyAmount": null,
            "Amount": null,
            "SuggestedVendorName": "CV_SuppA01",
            "Manufacturer": "Intel",
            "ThumbnailImage": null,
            "ItemSource": "CATALOG",
            "FunctionalCurrencyCode": "USD",
            "CatalogItemKey": 98528,
            "FunctionalCurrencySymbol": "$",
            "ManufacturerPartNumber": "192.168.22.1",
            "SupplierPartNumber": "SItem2",
            "UOM": "EA",
            "RequisitioningBUId": 204,
            "FormattedUnitPrice": "23.00",
            "FormattedCurrencyUnitPrice": "23.00",
            "FormattedAmount": null,
            "FormattedCurrencyAmount": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/98528",
                    "name": "requisitionProductDetails",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/98528",
                    "name": "requisitionProductDetails",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails/98528/child/priceBreaks",
                    "name": "priceBreaks",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 5,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/>version/requisitionProductDetails",
            "name": "requisitionProductDetails",
            "kind": "collection"
        }
    ]
}

Back to Top