Jump to

• Request
• Response
• Examples

Create one search phrase

post

/fscmRestApi/resources/11.13.18.05/shoppingSearches

Request

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• brandFilters: array Brand Filters
  Title: Brand Filters

  The Brand Filters resource filters the items in the search results into distinct brands.
• RequisitioningBUId(required): integer (int64)
  Value that uniquely identifies the requisitioning BU in which the search was run.
• resultItems: array Result Items
  Title: Result Items

  The Result Items resource manages the search results.
• resultPunchoutCatalogs: array Result Punchout Catalogs
  Title: Result Punchout Catalogs

  The Result Punchout Catalogs resource manages the punchout catalogs from the search results.
• SearchPhraseId: integer (int64)
  Value that uniquely identifies the search phrase.
• SearchPhraseTerms(required): string
  Maximum Length: 700

  String of characters that you can use to search.

{
    "required":[
        "RequisitioningBUId",
        "SearchPhraseTerms"
    ],
    "type":"object",
    "properties":{
        "resultPunchoutCatalogs":{
            "title":"Result Punchout Catalogs",
            "type":"array",
            "description":"The Result Punchout Catalogs resource manages the punchout catalogs from the search results.",
            "items":{
                "$ref":"#/components/schemas/shoppingSearches-resultPunchoutCatalogs-item-post-request"
            }
        },
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requisitioning BU in which the search was run.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SearchPhraseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the search phrase.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SearchPhraseTerms":{
            "maxLength":700,
            "type":"string",
            "description":"String of characters that you can use to search.",
            "nullable":false
        },
        "resultItems":{
            "title":"Result Items",
            "type":"array",
            "description":"The Result Items resource manages the search results.",
            "items":{
                "$ref":"#/components/schemas/shoppingSearches-resultItems-item-post-request"
            }
        },
        "brandFilters":{
            "title":"Brand Filters",
            "type":"array",
            "description":"The Brand Filters resource filters the items in the search results into distinct brands.",
            "items":{
                "$ref":"#/components/schemas/shoppingSearches-brandFilters-item-post-request"
            }
        }
    }
}

Nested Schema : Brand Filters

Type: array

Title: Brand Filters

The Brand Filters resource filters the items in the search results into distinct brands.

Show Source

• Array of: object shoppingSearches-brandFilters-item-post-request

{
    "title":"Brand Filters",
    "type":"array",
    "description":"The Brand Filters resource filters the items in the search results into distinct brands.",
    "items":{
        "$ref":"#/components/schemas/shoppingSearches-brandFilters-item-post-request"
    }
}

Nested Schema : Result Items

Type: array

Title: Result Items

The Result Items resource manages the search results.

Show Source

• Array of: object shoppingSearches-resultItems-item-post-request

{
    "title":"Result Items",
    "type":"array",
    "description":"The Result Items resource manages the search results.",
    "items":{
        "$ref":"#/components/schemas/shoppingSearches-resultItems-item-post-request"
    }
}

Nested Schema : Result Punchout Catalogs

Type: array

Title: Result Punchout Catalogs

The Result Punchout Catalogs resource manages the punchout catalogs from the search results.

Show Source

• Array of: object shoppingSearches-resultPunchoutCatalogs-item-post-request

{
    "title":"Result Punchout Catalogs",
    "type":"array",
    "description":"The Result Punchout Catalogs resource manages the punchout catalogs from the search results.",
    "items":{
        "$ref":"#/components/schemas/shoppingSearches-resultPunchoutCatalogs-item-post-request"
    }
}

Nested Schema : shoppingSearches-brandFilters-item-post-request

Type: object

Show Source

• TotalItems: string
  Total count of the items from a particular manufacturer.

{
    "type":"object",
    "properties":{
        "TotalItems":{
            "type":"string",
            "description":"Total count of the items from a particular manufacturer.",
            "nullable":true
        }
    }
}

Nested Schema : shoppingSearches-resultItems-item-post-request

Type: object

Show Source

• Amount: number
  Title: Amount

  Amount of the item in functional currency.
• CurrencyAmount: number
  Title: Amount

  Amount of the item in foreign currency.
• ThumbnailImage: string
  Maximum Length: 700

  Thumbnail image of the item.

{
    "type":"object",
    "properties":{
        "ThumbnailImage":{
            "maxLength":700,
            "type":"string",
            "description":"Thumbnail image of the item.",
            "nullable":true
        },
        "CurrencyAmount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount of the item in foreign currency.",
            "nullable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount of the item in functional currency.",
            "nullable":true
        }
    }
}

Nested Schema : shoppingSearches-resultPunchoutCatalogs-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : shoppingSearches-item-response

Type: object

Show Source

• brandFilters: array Brand Filters
  Title: Brand Filters

  The Brand Filters resource filters the items in the search results into distinct brands.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequisitioningBUId: integer (int64)
  Value that uniquely identifies the requisitioning BU in which the search was run.
• resultItems: array Result Items
  Title: Result Items

  The Result Items resource manages the search results.
• resultPunchoutCatalogs: array Result Punchout Catalogs
  Title: Result Punchout Catalogs

  The Result Punchout Catalogs resource manages the punchout catalogs from the search results.
• SearchDate: string (date)
  Read Only: true

  Date when the search was conducted.
• SearchPhraseId: integer (int64)
  Value that uniquely identifies the search phrase.
• SearchPhraseTerms: string
  Maximum Length: 700

  String of characters that you can use to search.

{
    "type":"object",
    "properties":{
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requisitioning BU in which the search was run.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "resultItems":{
            "title":"Result Items",
            "type":"array",
            "description":"The Result Items resource manages the search results.",
            "items":{
                "$ref":"#/components/schemas/shoppingSearches-resultItems-item-response"
            }
        },
        "SearchDate":{
            "type":"string",
            "description":"Date when the search was conducted.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "brandFilters":{
            "title":"Brand Filters",
            "type":"array",
            "description":"The Brand Filters resource filters the items in the search results into distinct brands.",
            "items":{
                "$ref":"#/components/schemas/shoppingSearches-brandFilters-item-response"
            }
        },
        "resultPunchoutCatalogs":{
            "title":"Result Punchout Catalogs",
            "type":"array",
            "description":"The Result Punchout Catalogs resource manages the punchout catalogs from the search results.",
            "items":{
                "$ref":"#/components/schemas/shoppingSearches-resultPunchoutCatalogs-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SearchPhraseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the search phrase.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SearchPhraseTerms":{
            "maxLength":700,
            "type":"string",
            "description":"String of characters that you can use to search.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Brand Filters

Type: array

Title: Brand Filters

The Brand Filters resource filters the items in the search results into distinct brands.

Show Source

• Array of: object shoppingSearches-brandFilters-item-response

{
    "title":"Brand Filters",
    "type":"array",
    "description":"The Brand Filters resource filters the items in the search results into distinct brands.",
    "items":{
        "$ref":"#/components/schemas/shoppingSearches-brandFilters-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 : Result Items

Type: array

Title: Result Items

The Result Items resource manages the search results.

Show Source

• Array of: object shoppingSearches-resultItems-item-response

{
    "title":"Result Items",
    "type":"array",
    "description":"The Result Items resource manages the search results.",
    "items":{
        "$ref":"#/components/schemas/shoppingSearches-resultItems-item-response"
    }
}

Nested Schema : Result Punchout Catalogs

Type: array

Title: Result Punchout Catalogs

The Result Punchout Catalogs resource manages the punchout catalogs from the search results.

Show Source

• Array of: object shoppingSearches-resultPunchoutCatalogs-item-response

{
    "title":"Result Punchout Catalogs",
    "type":"array",
    "description":"The Result Punchout Catalogs resource manages the punchout catalogs from the search results.",
    "items":{
        "$ref":"#/components/schemas/shoppingSearches-resultPunchoutCatalogs-item-response"
    }
}

Nested Schema : shoppingSearches-brandFilters-item-response

Type: object

Show Source

• links: array Links
  Title: Links

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

  Maximum Length: 255

  Name of the party who manufactures the item.
• TotalItems: string
  Total count of the items from a particular manufacturer.

{
    "type":"object",
    "properties":{
        "Manufacturer":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the party who manufactures the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalItems":{
            "type":"string",
            "description":"Total count of the items from a particular manufacturer.",
            "nullable":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 : 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 : shoppingSearches-resultItems-item-response

Type: object

Show Source

• Amount: number
  Title: Amount

  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
  Title: Amount

  Amount of the item in foreign currency.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 32

  Abbreviation that identifies the currency of the item that is displayed in the search results.
• CurrencyUnitPrice: number
  Title: Price

  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
  Title: Description

  Read Only: true

  Maximum Length: 960

  Description of the item that is displayed in the search results.
• ItemId: integer (int64)
  Read Only: true

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

  Maximum Length: 88

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

  Maximum Length: 255

  Default Value: CATALOG

  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.
• Manufacturer: string
  Title: Brand

  Read Only: true

  Maximum Length: 700

  Name of the party who manufactures the item.
• OrderTypeLookupCode: string
  Title: Line Type

  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.
• PunchoutCatalogId: integer (int64)
  Read Only: true

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

  Value that uniquely identifies the punchout item.
• ThumbnailImage: string
  Maximum Length: 700

  Thumbnail image of the item.
• UnitOfMeasure: string
  Read Only: true

  Unit of measure that the item uses.
• UnitPrice: number
  Title: Price

  Read Only: true

  Price of item for each unit in functional currency.

{
    "type":"object",
    "properties":{
        "PunchoutCatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies punchout catalog.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "UnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure that the item uses.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Uom"
                ]
            },
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount of the item in functional currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemSource":{
            "maxLength":255,
            "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,
            "default":"CATALOG",
            "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
        },
        "CurrencyUnitPrice":{
            "title":"Price",
            "type":"number",
            "description":"Price of item for each unit in foreign currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalCurrencySymbol":{
            "type":"string",
            "description":"Symbol that identifies the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FunctionalCurrencyCode"
                ]
            },
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Description",
            "maxLength":960,
            "type":"string",
            "description":"Description of the item that is displayed in the search results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyAmount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount of the item in foreign currency.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":32,
            "type":"string",
            "description":"Abbreviation that identifies the currency of the item that is displayed in the search results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitPrice":{
            "title":"Price",
            "type":"number",
            "description":"Price of item for each unit in functional currency.",
            "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
        },
        "ThumbnailImage":{
            "maxLength":700,
            "type":"string",
            "description":"Thumbnail image of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemKey":{
            "maxLength":88,
            "type":"string",
            "description":"Value that uniquely identifies the item. It is a key that the application generates when it searches for the item. It is the combination of item identifier, source document line identifier, language, and punchout item identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PunchoutItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the punchout item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Manufacturer":{
            "title":"Brand",
            "maxLength":700,
            "type":"string",
            "description":"Name of the party who manufactures 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":{
            "title":"Line Type",
            "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":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"
            }
        },
        "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
        }
    }
}

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 : shoppingSearches-resultPunchoutCatalogs-item-response

Type: object

Show Source

• CatalogId: integer (int64)
  Read Only: true

  Value that uniquely identifies the punchout catalog.
• CatalogName: string
  Read Only: true

  Maximum Length: 30

  Name of the punchout catalog that is displayed in the search results.
• ImageURL: string
  Read Only: true

  URL (Uniform Resource Locator) of the image of the item.
• links: array Links
  Title: Links

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

  URL (Uniform Resource Locator) of the image of the punchout catalog.

{
    "type":"object",
    "properties":{
        "ImageURL":{
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the image of 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"
            }
        },
        "PunchoutURL":{
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the image of the punchout catalog.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CatalogName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the punchout catalog that is displayed in the search results.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the punchout catalog.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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"
    }
}

Links

brandFilters

Operation: /fscmRestApi/resources/11.13.18.05/shoppingSearches/{SearchPhraseId}/child/brandFilters

Parameters:

• SearchPhraseId: $request.path.SearchPhraseId

The Brand Filters resource filters the items in the search results into distinct brands.

resultItems

Operation: /fscmRestApi/resources/11.13.18.05/shoppingSearches/{SearchPhraseId}/child/resultItems

Parameters:

• SearchPhraseId: $request.path.SearchPhraseId

The Result Items resource manages the search results.

resultPunchoutCatalogs

Operation: /fscmRestApi/resources/11.13.18.05/shoppingSearches/{SearchPhraseId}/child/resultPunchoutCatalogs

Parameters:

• SearchPhraseId: $request.path.SearchPhraseId

The Result Punchout Catalogs resource manages the punchout catalogs from the search results.

Back to Top

Examples

This example describes how to create one search phrase.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/shoppingSearches"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
 "SearchPhraseTerms":   "1002258"
}

Example Response Body

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

{  
   "SearchPhraseId":300100124738549,
   "SearchDate":"2018-03-16",
   "SearchPhraseTerms":"1002258",
   "RequisitioningBUId":204,
   "links":[  
      {  
         "rel":"self",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124738549",
         "name":"shoppingSearches",
         "kind":"item",
         "properties":{  
            "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
         }
      },
      {  
         "rel":"canonical",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124738549",
         "name":"shoppingSearches",
         "kind":"item"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124738549/child/resultItems",
         "name":"resultItems",
         "kind":"collection"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124738549/child/brandFilters",
         "name":"brandFilters",
         "kind":"collection"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124738549/child/resultPunchoutCatalogs",
         "name":"resultPunchoutCatalogs",
         "kind":"collection"
      }
   ]
}

Example 2 Request Body

The following example includes the contents of the request body in JSON format to get the result items from the search results. The request payload specifies attribute values that the command will use in the record that it creates.

{
"SearchPhraseTerms":"Laptop Desc"
}

Example 2 Response Body

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

{  
   "SearchPhraseId":300100124920663,
   "SearchDate":"2018-03-16",
   "SearchPhraseTerms":"Laptop Desc",
   "RequisitioningBUId":204,
   "links":[  
      {  
         "rel":"self",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920663",
         "name":"shoppingSearches",
         "kind":"item",
         "properties":{  
            "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
         }
      },
      {  
         "rel":"canonical",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920663",
         "name":"shoppingSearches",
         "kind":"item"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920663/child/resultItems",
         "name":"resultItems",
         "kind":"collection"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920663/child/brandFilters",
         "name":"brandFilters",
         "kind":"collection"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920663/child/resultPunchoutCatalogs",
         "name":"resultPunchoutCatalogs",
         "kind":"collection"
      }
   ]
}

Example 3 Request Body

The following example includes the contents of the request body in JSON format to get the punchout catalogs from the search results. The request payload specifies attribute values that the command will use in the record that it creates.

{
"SearchPhraseTerms":"Rest_Punchout"
}

Example 3 Response Body

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

{  
   "SearchPhraseId":300100124920640,
   "SearchDate":"2018-03-16",
   "SearchPhraseTerms":"Rest_Punchout",
   "RequisitioningBUId":204,
   "links":[  
      {  
         "rel":"self",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920640",
         "name":"shoppingSearches",
         "kind":"item",
         "properties":{  
            "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
         }
      },
      {  
         "rel":"canonical",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920640",
         "name":"shoppingSearches",
         "kind":"item"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920640/child/resultItems",
         "name":"resultItems",
         "kind":"collection"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920640/child/brandFilters",
         "name":"brandFilters",
         "kind":"collection"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920640/child/resultPunchoutCatalogs",
         "name":"resultPunchoutCatalogs",
         "kind":"collection"
      }
   ]
}

Example 4 Request Body

The following example includes the contents of the request body in JSON format to get the items in the search results into distinct brands.. The request payload specifies attribute values that the command will use in the record that it creates.

{
"SearchPhraseTerms":"Laptop"
}

Example 4 Response Body

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

{  
   "SearchPhraseId":300100124920664,
   "SearchDate":"2018-03-16",
   "SearchPhraseTerms":"Laptop",
   "RequisitioningBUId":204,
   "links":[  
      {  
         "rel":"self",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920664",
         "name":"shoppingSearches",
         "kind":"item",
         "properties":{  
            "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
         }
      },
      {  
         "rel":"canonical",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920664",
         "name":"shoppingSearches",
         "kind":"item"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920664/child/resultItems",
         "name":"resultItems",
         "kind":"collection"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920664/child/brandFilters",
         "name":"brandFilters",
         "kind":"collection"
      },
      {  
         "rel":"child",
         "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920664/child/resultPunchoutCatalogs",
         "name":"resultPunchoutCatalogs",
         "kind":"collection"
      }
   ]
}

Back to Top