Product Search Marketplace by Attribute
- 2 Minutes to read
- DarkLight
Product Search Marketplace by Attribute
- 2 Minutes to read
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
To search for marketplace products, mention the following in the postman and then click Send.
POST
Query Parameters
Expand to see the parameters and description
| Parameter | Parameter Type | Data Type | Accepted Values | Description |
| vocabularyId | Recommended (Conditionally Optional) | String | GUID | If a valid companyId is provided, vocabularyId is not Required |
| companyId | Required (Conditionally Optional) | String | GUID | If a valid vocabularyId is provided, companyId is not Required |
| skipCount | Optional | Integer | >=0; (skipCount+takeCount)<10,000 | Used for parsing large numbers of product records. Quantity of records to skip before you start taking products. Whatever value is used for the takeCount, add to skipCount for the subsequent call |
| takeCount | Optional | Integer | >= 0; Max: 500 | Sets quantity of results to return at one time. Used for parsing large numbers of product records |
Headers
Authorization: Specify required Auth Token in the header.
Request Parameters
Expand to see the parameters and description
| Parameter | Parameter Type | Data Type | Accepted Values | Description |
| TargetPartyId | Optional | String | Recipient identifier: GUID or as aliased in customer vocab | Sets the lens through which the product data is returned from search |
| OrderBy | Optional | String | Attribute GUID (Ex. Product Name, Date Created, etc.). | Sets return results order |
| Desc | Optional | Boolean | true/false | Determines sort order (ascending or descending). |
| AttributeFilterOperator | Optional | Boolean Operator | AND/OR | Defaults to AND |
| OnHold | Optional | Boolean | true/false | Determines if the search returns OnHold products or not. |
| Archived | Optional | Boolean | true/false | Determines if the search returns Archived products or not. |
| Language | Optional | Enum | ISO 639-1 standard | Defaults to en-US. Sets the Language to be used for search |
| DataOwner | Required | String | GUID | Company ID GUID |
| ProductIds | Optional | Array of Strings | Product GUIDs | List of Products to be searched |
| IdentifierAttributes | Optional | Array of Strings | Attribute GUIDs | List of identifier types to be searched |
| Identifiers | Optional | Array of Strings | Identifier strings | Required if you are using “Identifier Attributes”. Contains the list of identifiers to find. |
| AttributeExistsFilters | Optional | Array of Strings | Attribute GUIDs | Returns products that has (does not have) desired attribute. |
| AttributeFilters | Optional | Array of Strings | Attribute GUIDs | Searches the value of attribute defined. |
| SearchType | Part of AttributeFilters | Enum | Contains - has search val within the attribute value searched Prefix, - starts with this search value Suffix, - ends with this search value Fuzzy, - Similar match (fuzzy, a char might be missing in search value for example) Search - exact match for search value | Part of AttributeFilters |
| DateFilter | Optional | Array of Strings | See example, includes: Name, Operator, Value, IncludeMissing | Array (see example). Searched date field and defined. |
| Name | Required | Enum | CreatedDate, RecordDate LastModifiedDate, DiscontinueDate, ObsolescenceDate, LastPublishedDate | Part of DateFilter |
| Operator | Required | Enum | LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo | Part of DateFilter |
| Value | Required | String | Commonly acceptable string representation of a date/time | Part of DateFilter |
| IncludeMissing | Required | Boolean | true/false | Part of DateFilter |
| WorkflowFilters | Optional | Array of Strings | Workflow, Statuses [] | Contains an array including “Workflow” name and “Statuses” as defined for the customer workflow. |
| Workflow | Required | String | Workflow names as aliased in Customer Vocab | Part of WorkflowFilters |
| Statuses | Required | Array of Strings | Statuses names as aliased in Customer Vocab | Part of WorkflowFilters |
| PackagingTypes | Optional | Enum | Undefined, BaseUnit, Case, Pallet, Display, Pack, Load, SetPack, MixedModule, MultiPack, PrePack, PrePack_Assortment | Used primarily for GDSN package hierarchy |
| ExcludeProductIds | Optional | String | Product GUIDs | List of products to be excluded |
| ProductSourcePartyAliases | Optional | Array of strings | Dependent on Customer Vocab | No default |
| TaxonomyAliases | Optional | Array of strings | Dependent on Customer Vocab | No default |
| ExcludeTaxonomyAliases | Optional | Array of strings | Dependent on Customer Vocab | No default |
| CategoryAliases | Optional | Array of strings | Dependent on Customer Vocab | No Default. Gets or sets a flag that restricts the result set to products that have the specified preference status |
| PreferredProductsFilter | Required | Boolean | true/false; null | No Default. Gets or sets a flag that restricts the result set to products that have the specified preference status |
| OnHold | Optional | Boolean | true/false; null | Defaults to false. Determines if the search returns OnHold products or not. |
| Archived | Optional | Boolean | true/false; null | Defaults to false. Determines if the search returns Archived products or not. |
Request
{
"Language": "en-US",
"OrderBy": "26834672-7c90-4918-9b19-5bd419023b12", // PostedDate
"Desc": true,
"OnHold": false,
"Archived": false,
"AttributeFilterOperator": "And",
"AttributeFilters": [
{
"AttributeName": "UPC", // "6d030ff8-72ce-4f42-ba53-023f55c53a20",
"Language": "en-US",
"Values": [
"036800007451"
]
}
]
}
Response 200 OK
{
"ErrorMode": "Fail",
"DefaultLocale": "en-US",
"ProducingOperationDetails": {
"ResultCount": 0,
"TotalHitCount": 0
},
"MarketplaceProductImportData": []
}
Was this article helpful?