Jump to

• Request
• Response

Get all item details

get

/fscmRestApi/resources/11.13.18.05/shoppingCatalogItemDetails

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:
  
  

  • FindById: Finds catalog item details according to the search object identifier and user preference identifier.
    Finder Variables:
    • SearchObjectId; integer; Value that uniquely identifies the search object referenced by the catalog item.
    • UserPreferenceId; integer; Value that uniquely identifies the user preference referenced by the catalog item.
  • PrimaryKey: Finds catalog item details according to the primary key.
    Finder Variables:
    • SearchObjectId; integer; Value that uniquely identifies the search object referenced by the catalog item.
• 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:
  

  • SearchObjectId; integer; Value that uniquely identifies the search object referenced by the catalog item.
• 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(required):
  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(required):
  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 : shoppingCatalogItemDetails

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object shoppingCatalogItemDetails-item-response

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

Type: object

Show Source

• Amount: number
  Read Only: true

  Amount of the service items in the currency of the buying company.
• Availability: string
  Title: Availability

  Read Only: true

  Maximum Length: 700

  Value that shows the availability of the goods and services.
• buyingOptions: array Buying Options
  Title: Buying Options

  The Buying Options resource gets the different buying options when an item is referenced by multiple agreements.
• CategoryName: string
  Read Only: true

  Maximum Length: 255

  Name of the category that classifies the agreement line.
• Comments: string
  Title: Comments

  Read Only: true

  Maximum Length: 700

  Comments on the agreement line.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date on which the user created the item details.
• CurrencyCode: string
  Read Only: true

  Abbreviation that identifies the item currency.
• ImageURL: string
  Read Only: true

  Maximum Length: 700

  URL (Uniform Resource Locator) of the image of the agreement line.
• InternallyTransferableItemFlag: boolean
  Title: Shippable

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the item is internally transferrable. If false, then the item isn't internally transferrable. This attribute doesn't have a default value.
• InternalTransferOrderEnabledFlag: boolean
  Title: Transfer Orders Enabled

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the item is enabled for internal transfer orders. If false, then the item is disabled for internal transfer orders. This attribute doesn't have a default value.
• ItemCatalogCategoryId: string
  Read Only: true

  Value that uniquely identifies the category of the item.
• itemGTINRelationships: array Item GTIN Relationships
  Title: Item GTIN Relationships

  The Item GTIN Relationships resource gets the global trade item number (GTIN) details for the master item.
• itemImages: array Item Images
  Title: Item Images

  The Item Images resource gets the images for the master item.
• itemManufacturers: array Item Manufacturers
  Title: Item Manufacturers

  The Item Manufacturers resource gets the manufacturer details for the master item.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Name of the master item.
• ItemRevision: string
  Read Only: true

  Maximum Length: 255

  Revision of the master item.
• itemSuppliers: array Item Suppliers
  Title: Item Suppliers

  The Item Suppliers resource gets the supplier details for the master item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date on which the user last updated the item details.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the item details.
• LeadTime: number
  Title: Lead Time Days

  Read Only: true

  Time taken by the supplier to deliver the goods once an order is placed.
• LineType: string
  Title: Line Type

  Read Only: true

  Maximum Length: 30

  Type of agreement line. Valid values are Goods or Services or any user-defined line type.
• links: array Links
  Title: Links

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

  Maximum Length: 255

  Long 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

  Maximum Length: 700

  Number issued by the manufacturer that uniquely identifies the individual product.
• OrderTypeLookupCode: string
  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the type of agreement line. Valid values are QUANTITY Services or FIXED Services.
• PackagingString: string
  Read Only: true

  Maximum Length: 255

  Unit of measure of the packaged supply items.
• PurchasingEnabledFlag: boolean
  Title: Purchasable

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the item is enabled for purchasing. If false, then the item is disabled for purchasing. This attribute doesn't have a default value.
• SearchObjectId: integer (int64)
  Value that uniquely identifies the search object referenced by the catalog item.
• ShortDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the item.
• SourceDocumentHeaderId: integer (int64)
  Value that uniquely identifies the agreement header.
• SourceDocumentHeaderNumber: string
  Title: Agreement

  Read Only: true

  Maximum Length: 30

  Number that identifies the agreement on which the item is available.
• SourceDocumentLineId: integer (int64)
  Value that uniquely identifies the agreement line.
• SupplierItem: string
  Read Only: true

  Maximum Length: 300

  Number that identifies the supplier item.
• SupplierItemAuxiliaryId: string
  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the supplier item auxiliary.
• SupplierName: string
  Read Only: true

  Maximum Length: 360

  Name of the supplier of the item or agreement.
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 255

  Unit of measure that the item uses.
• UnitPrice: number
  Read Only: true

  Price of the item in the currency of the buying company.
• UNSPSC: string
  Title: UNSPSC

  Read Only: true

  Maximum Length: 700

  Value that uniquely identifies the goods and services that are bought.
• UOMCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date on which the user created the item details.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "itemSuppliers":{
            "title":"Item Suppliers",
            "type":"array",
            "description":"The Item Suppliers resource gets the supplier details for the master item.",
            "items":{
                "$ref":"#/components/schemas/shoppingCatalogItemDetails-itemSuppliers-item-response"
            }
        },
        "SupplierItemAuxiliaryId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the supplier item auxiliary.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ShortDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Abbreviation that identifies the item currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceDocumentHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the agreement header.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the master item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "itemImages":{
            "title":"Item Images",
            "type":"array",
            "description":"The Item Images resource gets the images for the master item.",
            "items":{
                "$ref":"#/components/schemas/shoppingCatalogItemDetails-itemImages-item-response"
            }
        },
        "SearchObjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the search object referenced by the catalog item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Manufacturer":{
            "maxLength":700,
            "type":"string",
            "description":"Name of the party who manufactures the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "itemGTINRelationships":{
            "title":"Item GTIN Relationships",
            "type":"array",
            "description":"The Item GTIN Relationships resource gets the global trade item number (GTIN) details for the master item.",
            "items":{
                "$ref":"#/components/schemas/shoppingCatalogItemDetails-itemGTINRelationships-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemRevision":{
            "maxLength":255,
            "type":"string",
            "description":"Revision of the master item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PurchasingEnabledFlag":{
            "title":"Purchasable",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the item is enabled for purchasing. If false, then the item is disabled for purchasing. This attribute doesn't have a default value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ItemCatalogCategoryId":{
            "type":"string",
            "description":"Value that uniquely identifies the category of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LineType":{
            "title":"Line Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of agreement line. Valid values are Goods or Services or any user-defined line type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "UOMCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceDocumentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the agreement line.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the item details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Availability":{
            "title":"Availability",
            "maxLength":700,
            "type":"string",
            "description":"Value that shows the availability of the goods and services.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InternallyTransferableItemFlag":{
            "title":"Shippable",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the item is internally transferrable. If false, then the item isn't internally transferrable. This attribute doesn't have a default value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the item details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "UnitOfMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure that the item uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":700,
            "type":"string",
            "description":"Comments on the agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "itemManufacturers":{
            "title":"Item Manufacturers",
            "type":"array",
            "description":"The Item Manufacturers resource gets the manufacturer details for the master item.",
            "items":{
                "$ref":"#/components/schemas/shoppingCatalogItemDetails-itemManufacturers-item-response"
            }
        },
        "Amount":{
            "type":"number",
            "description":"Amount of the service items in the currency of the buying company.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ManufacturerPartNumber":{
            "maxLength":700,
            "type":"string",
            "description":"Number issued by the manufacturer that uniquely identifies the individual product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ImageURL":{
            "maxLength":700,
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the image of the agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceDocumentHeaderNumber":{
            "title":"Agreement",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the agreement on which the item is available.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "UnitPrice":{
            "type":"number",
            "description":"Price of the item in the currency of the buying company.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "buyingOptions":{
            "title":"Buying Options",
            "type":"array",
            "description":"The Buying Options resource gets the different buying options when an item is referenced by multiple agreements.",
            "items":{
                "$ref":"#/components/schemas/shoppingCatalogItemDetails-buyingOptions-item-response"
            }
        },
        "LongDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Long description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LeadTime":{
            "title":"Lead Time Days",
            "type":"number",
            "description":"Time taken by the supplier to deliver the goods once an order is placed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier of the item or agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InternalTransferOrderEnabledFlag":{
            "title":"Transfer Orders Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the item is enabled for internal transfer orders. If false, then the item is disabled for internal transfer orders. This attribute doesn't have a default value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "UNSPSC":{
            "title":"UNSPSC",
            "maxLength":700,
            "type":"string",
            "description":"Value that uniquely identifies the goods and services that are bought.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderTypeLookupCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the type of agreement line. Valid values are QUANTITY Services or FIXED Services.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CategoryName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the category that classifies the agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PackagingString":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure of the packaged supply items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date on which the user last updated the item details.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SupplierItem":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the supplier item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Buying Options

Type: array

Title: Buying Options

The Buying Options resource gets the different buying options when an item is referenced by multiple agreements.

Show Source

• Array of: object shoppingCatalogItemDetails-buyingOptions-item-response

{
    "title":"Buying Options",
    "type":"array",
    "description":"The Buying Options resource gets the different buying options when an item is referenced by multiple agreements.",
    "items":{
        "$ref":"#/components/schemas/shoppingCatalogItemDetails-buyingOptions-item-response"
    }
}

Nested Schema : Item GTIN Relationships

Type: array

Title: Item GTIN Relationships

The Item GTIN Relationships resource gets the global trade item number (GTIN) details for the master item.

Show Source

• Array of: object shoppingCatalogItemDetails-itemGTINRelationships-item-response

{
    "title":"Item GTIN Relationships",
    "type":"array",
    "description":"The Item GTIN Relationships resource gets the global trade item number (GTIN) details for the master item.",
    "items":{
        "$ref":"#/components/schemas/shoppingCatalogItemDetails-itemGTINRelationships-item-response"
    }
}

Nested Schema : Item Images

Type: array

Title: Item Images

The Item Images resource gets the images for the master item.

Show Source

• Array of: object shoppingCatalogItemDetails-itemImages-item-response

{
    "title":"Item Images",
    "type":"array",
    "description":"The Item Images resource gets the images for the master item.",
    "items":{
        "$ref":"#/components/schemas/shoppingCatalogItemDetails-itemImages-item-response"
    }
}

Nested Schema : Item Manufacturers

Type: array

Title: Item Manufacturers

The Item Manufacturers resource gets the manufacturer details for the master item.

Show Source

• Array of: object shoppingCatalogItemDetails-itemManufacturers-item-response

{
    "title":"Item Manufacturers",
    "type":"array",
    "description":"The Item Manufacturers resource gets the manufacturer details for the master item.",
    "items":{
        "$ref":"#/components/schemas/shoppingCatalogItemDetails-itemManufacturers-item-response"
    }
}

Nested Schema : Item Suppliers

Type: array

Title: Item Suppliers

The Item Suppliers resource gets the supplier details for the master item.

Show Source

• Array of: object shoppingCatalogItemDetails-itemSuppliers-item-response

{
    "title":"Item Suppliers",
    "type":"array",
    "description":"The Item Suppliers resource gets the supplier details for the master item.",
    "items":{
        "$ref":"#/components/schemas/shoppingCatalogItemDetails-itemSuppliers-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 : shoppingCatalogItemDetails-buyingOptions-item-response

Type: object

Show Source

• Amount: number
  Read Only: true

  Amount of the service items in the currency of the buying company.
• CategoryName: string
  Read Only: true

  Maximum Length: 250

  Name of the category that classifies the agreement line.
• Comments: string
  Title: Comments

  Read Only: true

  Maximum Length: 700

  Comments on the agreement line.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the item currency.
• ImageURL: string
  Read Only: true

  Maximum Length: 255

  URL (Uniform Resource Locator) of the image of the agreement line.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Name of the master item.
• LineType: string
  Title: Line Type

  Read Only: true

  Maximum Length: 30

  Type of agreement line. Valid values are Goods or Services.
• links: array Links
  Title: Links

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

  Maximum Length: 255

  Long description of the item.
• Manufacturer: string
  Title: Manufacturer

  Read Only: true

  Maximum Length: 700

  Name of the party who manufactures the item.
• ManufacturerPartNumber: string
  Title: Manufacturer Part Number

  Read Only: true

  Maximum Length: 700

  Number issued by the manufacturer that uniquely identifies the individual product.
• PackagingString: string
  Read Only: true

  Maximum Length: 255

  Unit of measure of the packaged supply items.
• SearchObjectId: integer (int64)
  Value that uniquely identifies the goods and services that are bought.
• ShortDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the item.
• SourceDocumentHeaderId: integer (int64)
  Value that uniquely identifies the agreement header.
• SourceDocumentHeaderNumber: string
  Title: Agreement

  Read Only: true

  Maximum Length: 30

  Number that identifies the agreement on which the item is available.
• SourceDocumentLineId: integer (int64)
  Value that uniquely identifies the agreement line.
• SupplierItem: string
  Title: Supplier Item

  Read Only: true

  Maximum Length: 300

  Number that identifies the supplier item.
• SupplierItemAuxiliaryId: string
  Title: Supplier Item Auxiliary Identifier

  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the supplier item auxiliary.
• SupplierName: string
  Read Only: true

  Maximum Length: 360

  Name of the supplier of the agreement line.
• UnitPrice: number
  Title: Price

  Read Only: true

  Price of the item in the currency of the buying company.
• UNSPSC: string
  Title: UNSPSC

  Read Only: true

  Maximum Length: 700

  Value that uniquely identifies the goods and services that are bought.
• UOMCode: string
  Title: UOM Code

  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "Comments":{
            "title":"Comments",
            "maxLength":700,
            "type":"string",
            "description":"Comments on the agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Amount":{
            "type":"number",
            "description":"Amount of the service items in the currency of the buying company.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ManufacturerPartNumber":{
            "title":"Manufacturer Part Number",
            "maxLength":700,
            "type":"string",
            "description":"Number issued by the manufacturer that uniquely identifies the individual product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ImageURL":{
            "maxLength":255,
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the image of the agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierItemAuxiliaryId":{
            "title":"Supplier Item Auxiliary Identifier",
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the supplier item auxiliary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceDocumentHeaderNumber":{
            "title":"Agreement",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the agreement on which the item is available.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ShortDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the item currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UnitPrice":{
            "title":"Price",
            "type":"number",
            "description":"Price of the item in the currency of the buying company.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceDocumentHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the agreement header.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the master item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LongDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Long description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier of the agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SearchObjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the goods and services that are bought.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Manufacturer":{
            "title":"Manufacturer",
            "maxLength":700,
            "type":"string",
            "description":"Name of the party who manufactures the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UNSPSC":{
            "title":"UNSPSC",
            "maxLength":700,
            "type":"string",
            "description":"Value that uniquely identifies the goods and services that are bought.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CategoryName":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the category that classifies the agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LineType":{
            "title":"Line Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of agreement line. Valid values are Goods or Services.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PackagingString":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure of the packaged supply items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierItem":{
            "title":"Supplier Item",
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the supplier item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceDocumentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the agreement line.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : shoppingCatalogItemDetails-itemGTINRelationships-item-response

Type: object

Show Source

• GTIN: string
  Title: GTIN

  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the global trade item number (GTIN) of the master item.
• links: array Links
  Title: Links

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

  Maximum Length: 255

  Type of party of the global trade item number (GTIN). Values can be blank, a supplier, or a manufacturer.
• UOM: string
  Title: UOM

  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the unit of measure for which the global trade item number (GTIN) is defined.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOM":{
            "title":"UOM",
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for which the global trade item number (GTIN) is defined.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "GTIN":{
            "title":"GTIN",
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the global trade item number (GTIN) of the master item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of party of the global trade item number (GTIN). Values can be blank, a supplier, or a manufacturer.",
            "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 : shoppingCatalogItemDetails-itemImages-item-response

Type: object

Show Source

• DownloadInfo: string
  Title: DownloadInfo

  JSON formatted string containing information required to programmatically retrieve a file attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  Base64-encoded image of the file displayed in .png format if the source is a convertible image.
• ItemImageURL: string
  Read Only: true

  Uniform resource locator (URL) of the item image.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Base64-encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemImageURL":{
            "type":"string",
            "description":"Uniform resource locator (URL) of the item image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON formatted string containing information required to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : shoppingCatalogItemDetails-itemManufacturers-item-response

Type: object

Show Source

• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 360

  Name of the manufacturer of the item.
• ManufacturerPartNumber: string
  Title: Manufacturer Part Number

  Read Only: true

  Maximum Length: 150

  Number issued by the manufacturer that uniquely identifies the individual part. This attribute differentiates the part from similar parts and counterfeits.

{
    "type":"object",
    "properties":{
        "ManufacturerPartNumber":{
            "title":"Manufacturer Part Number",
            "maxLength":150,
            "type":"string",
            "description":"Number issued by the manufacturer that uniquely identifies the individual part. This attribute differentiates the part from similar parts and counterfeits.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Manufacturer":{
            "title":"Manufacturer",
            "maxLength":360,
            "type":"string",
            "description":"Name of the manufacturer of the item.",
            "nullable":false,
            "readOnly":true,
            "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"
    }
}

Nested Schema : shoppingCatalogItemDetails-itemSuppliers-item-response

Type: object

Show Source

• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 360

  Name of the supplier of the master item.
• SupplierPartNumber: string
  Title: Supplier Item

  Read Only: true

  Maximum Length: 150

  Number issued by the supplier that uniquely identifies the individual part. This attribute differentiates the part from similar parts and counterfeits.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SupplierPartNumber":{
            "title":"Supplier Item",
            "maxLength":150,
            "type":"string",
            "description":"Number issued by the supplier that uniquely identifies the individual part. This attribute differentiates the part from similar parts and counterfeits.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier of the master item.",
            "nullable":false,
            "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"
    }
}

Back to Top