Product Search by Workflow

2 Minutes to read

Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

To search the products by workflow, 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 in combination with takeCount to paginate 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
useLens	Optional	Boolean	true/false	Based on target party id as contained in Post body, will return effective values only includes all values. Defaults to true. Ex. Using a recipient ID with useLens as true will return the product data applicable to that recipient
flattenLensedProduct	Optional	Boolean	true/false	Allows for flattening search results. Using this parameter you'll get only the recipient overrides.
locale	Optional	enum	ISO 639-1 standard	Stores the value passed in a language specific variant. Facilitates different values in different langugages on the same attribute. Defaults to en-US.
shouldIncludeMissingVocabularyAttributes	Optional	Boolean	true/false	Will determine if attributes not included in your company vocabulary will be returned in search results. Defaults to setting in customer vocabulary, else defaults to false. If set to true, attributes not in vocabulary will return with its GUID.

You can change the param values of skipCount, takeCount, vocabularyId, vocabularyId, useLens, and locale according to your requirements.

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
TargetPartyAlias	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).
RecipientAliases	Optional	Array of Strings	Recipients identifiers: GUIDs or as aliased in a customer vocab	Limits the search to products explicitly linked to specific recipients.
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

Request


{
    "TargetPartyAlias": "47f66d9f-9429-48ad-8f2a-267dcd67a346",
    "OrderBy": "bda64a3f-507c-49de-883c-fa832c6539e7",
    "Desc": false,
    "OnHold": false,
    "Archived": false,
    "Language": "en-US",
    "WorkflowFilters": [  // Alias must be used, guids not allowed.
        {
            "Workflow" : "Fred Meyer Jewelers",
            "Statuses" : [
                "Email Bobbi Hansen"
            ]
        }
    ]
}

Response 200 OK

need to be added

Was this article helpful?

What's Next

Product Search by Subscription State

Table of contents