Jump to

• Request
• Response

Get one buying option

get

/fscmRestApi/resources/11.13.18.05/shoppingCatalogItemDetails/{SearchObjectId}/child/buyingOptions/{SearchObjectId2}

Request

Path Parameters

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

Query Parameters

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

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

Back to Top