Product Search View Recipient Overrides
  • 6 Minutes to read
  • Dark
    Light

Product Search View Recipient Overrides

  • Dark
    Light

Article summary

To view recipient specific overrides, mention the following in the postman and then click Send.

POST

Query Parameters

Expand to see the parameters and description


Parameter  Parameter TypeData TypeAccepted ValuesDescription
vocabularyId
Recommended (Conditionally Optional)
StringGUIDIf a valid companyId is provided, vocabularyId is not Required
companyIdRequired (Conditionally Optional)
StringGUIDIf a valid vocabularyId is provided, companyId is not Required
skipCountOptionalInteger>=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
OptionalBooleantrue/falseBased 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
flattenLensedProductOptionalBooleantrue/falseAllows for flattening search results. Using this parameter you'll get only the recipient overrides.
locale
OptionalenumISO 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
OptionalBooleantrue/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.

How to view overrides?

To view ALL overrides in the search call, make sure to minimize filtering of results by setting the parameters:

useLens = false,
shouldIncludeMissingVocabularyAttributes = true

To view the overrides for a specific recipient, set the parameter useLens to true, and provide recipient's GUID or an alias (that was mapped in a vocabulary) in an attribute "TargetPartyAlias"

Headers

Authorization: Specify required Auth Token in the header.

Request Parameters

Expand to see the parameters and description

Parameter  Parameter TypeData TypeAccepted ValuesDescription
TargetPartyAlias
OptionalStringRecipient identifier: GUID or as aliased in customer vocab
Sets the lens through which the product data is returned from search
OrderBy
OptionalString
Attribute GUID (Ex. Product Name, Date Created, etc.).
Sets return results order
Desc
Optional
Booleantrue/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/ORDefaults to AND
OnHold
Optional
Boolean
true/false
Determines if the search returns OnHold products or not.
Archived
OptionalBooleantrue/false
Determines if the search returns Archived products or not.
Language
Optional
EnumISO 639-1 standard
Defaults to en-US. Sets the Language to be used for search
DataOwner
RequiredString
GUIDCompany ID GUID
ProductIds
OptionalArray of StringsProduct GUIDsList of Products to be searched
IdentifierAttributes
OptionalArray of Strings
Attribute GUIDsList of identifier types to be searched
Identifiers
Optional
Array of Strings
Identifier stringsRequired if you are using “Identifier Attributes”. Contains the list of identifiers to find.
AttributeExistsFilters
OptionalArray 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
RequiredEnumCreatedDate, RecordDate   LastModifiedDate, DiscontinueDate, ObsolescenceDate, LastPublishedDate
Part of DateFilter
OperatorRequiredEnumLessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo
Part of DateFilter
ValueRequiredStringCommonly acceptable string representation of a date/timePart of DateFilter
IncludeMissingRequiredBooleantrue/falsePart of DateFilter
WorkflowFilters
OptionalArray of Strings
Workflow, Statuses []Contains an array including “Workflow” name and “Statuses” as defined for the customer workflow.
Workflow RequiredStringWorkflow names as aliased in Customer VocabPart of WorkflowFilters
Statuses
RequiredArray of StringsStatuses names as aliased in Customer Vocab
Part of WorkflowFilters
PackagingTypes
Optional
EnumUndefined, BaseUnit, Case, Pallet, Display, Pack, Load, SetPack, MixedModule, MultiPack, PrePack, PrePack_Assortment
Used primarily for GDSN package hierarchy
ExcludeProductIds
Optional
StringProduct GUIDs
List of products to be excluded

Request


{
    "TargetPartyAlias": "2f4ffbfb-ad8a-4e0e-846e-a27c06acc92b",
    "OrderBy": "Product Name",
    "Desc": false,
    "AttributeFilterOperator": "And",
    "OnHold": false,
    "Archived": false,
    "Language": "en-US",
    "DataOwner": "{{companyId}}",
    "IdentifierAttributes": [
        "GTIN"
    ],
    "Identifiers": [       
        "78787878787878"
    ]
}

Response 200 OK


{
    "ErrorMode": "Fail",
    "DefaultLocale": "en-US",
    "ProducingOperationDetails": {
        "TotalHitCount": 1,
        "ResultCount": 1
    },
    "ProductImportData": {
        "ProductsToImport": [
            {
                "ImportMode": "Update",
                "ProductIdentifierPropertyOverride": "",
                "ProductReferencePropertyOverride": "",
                "ProductIdentifierValue": "d283e104-897c-42f9-989b-d65c7026c92e",
                "SourceParties": [],
                "TaxonomyNodes": [],
                "CatalogItems": [],
                "PackageType": "BaseUnit",
                "ImmediateParentDetails": {},
                "RecipientsToLink": [
                    "Amazon US",
                    "da01c000-d531-46ee-ba61-60ce5bfbbccf",
                    "f6ab47b5-faa3-4540-831c-4407f98537fb",
                    "ef79b6eb-bc2e-40d8-bd69-88c995122a58"
                ],
                "RecipientsRequirementSets": {
                    "Amazon US": [
                        "Amazon Listing 2.0"
                    ],
                    "da01c000-d531-46ee-ba61-60ce5bfbbccf": [
                        "c90ce648-11c7-43bc-8f0b-b258ef3efd09"
                    ],
                    "f6ab47b5-faa3-4540-831c-4407f98537fb": [
                        "44b9fa8c-375b-f18b-6159-2122f222ddd9",
                        "b3ca7493-6360-4d04-8cb7-07ae12225e74"
                    ],
                    "ef79b6eb-bc2e-40d8-bd69-88c995122a58": [
                        "26cf8c4f-95be-4da4-bd7c-8f4b524c71d2"
                    ]
                },
                "ComplexValues": [],
                "NutritionalInformationModule": {},
                "LifeCycle": {
                    "CreatedDate": {
                        "Value": "2023-04-24T21:15:22.7817613Z",
                        "Delete": false
                    },
                    "IsFutureProduct": false
                },
                "AuditInfo": {
                    "CreatedDate": "2023-04-24T21:15:22.7817687Z",
                    "LastModifiedDate": "2024-06-05T10:08:01.0089897Z"
                },
                "Archived": false,
                "StagingStatus": "Synchronized",
                "Values": [
                    {
                        "Name": "External Product ID Type",
                        "ValuesByLocale": {
                            "en-US": "gtin"
                        },
                        "SourceParty": "",
                        "Recipient": "2f4ffbfb-ad8a-4e0e-846e-a27c06acc92b",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "Product Name",
                        "ValuesByLocale": {
                            "en-US": "Amazon Product Name Override"
                        },
                        "SourceParty": "",
                        "Recipient": "2f4ffbfb-ad8a-4e0e-846e-a27c06acc92b",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "MFG Brand Name",
                        "ValuesByLocale": {
                            "en-US": "Amazon brand override"
                        },
                        "SourceParty": "",
                        "Recipient": "2f4ffbfb-ad8a-4e0e-846e-a27c06acc92b",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "Product Name",
                        "ValuesByLocale": {
                            "en-US": "Adding Images"
                        },
                        "SourceParty": "",
                        "Recipient": "",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "GTIN",
                        "ValuesByLocale": {
                            "en-US": "78787878787878"
                        },
                        "SourceParty": "",
                        "Recipient": "",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "Short Description",
                        "ValuesByLocale": {
                            "en-US": "Short Description from API"
                        },
                        "SourceParty": "",
                        "Recipient": "",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "Packaging Level",
                        "ValuesByLocale": {
                            "en-US": "BASE_UNIT_OR_EACH"
                        },
                        "SourceParty": "",
                        "Recipient": "",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "Main Product Image",
                        "ValuesByLocale": {
                            "en-US": "d15b778e-55a4-42d5-b20d-8bedc141fbc9"
                        },
                        "SourceParty": "",
                        "Recipient": "",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "nutrientFormatTypeCodeReference",
                        "ValuesByLocale": {
                            "en-US": "US_FDA_NFP_2020_STANDARD_SIDE_BY_SIDE"
                        },
                        "SourceParty": "",
                        "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "ingredientStatement",
                        "ValuesByLocale": {
                            "en-US": "TEST"
                        },
                        "SourceParty": "",
                        "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "isNutrientRelevantDataProvided",
                        "ValuesByLocale": {
                            "en-US": "Y"
                        },
                        "SourceParty": "",
                        "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "organicProductPlaceOfFarmingCode",
                        "ValuesByLocale": {
                            "en-US": "EU_OR_NON_EU_AGRICULTURE"
                        },
                        "SourceParty": "",
                        "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "dietTypeDescription",
                        "ValuesByLocale": {
                            "en-US": "TEST"
                        },
                        "SourceParty": "",
                        "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "preparationInstructions",
                        "ValuesByLocale": {
                            "en-US": "TEST"
                        },
                        "SourceParty": "",
                        "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "preparationType",
                        "ValuesByLocale": {
                            "en-US": "BAKE"
                        },
                        "SourceParty": "",
                        "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "numberOfServingsPerPackage",
                        "ValuesByLocale": {
                            "en-US": "1"
                        },
                        "SourceParty": "",
                        "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "numberOfServingsPerPackageMeasurementPrecisionCode",
                        "ValuesByLocale": {
                            "en-US": "APPROXIMATELY"
                        },
                        "SourceParty": "",
                        "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "nutrientDetailNutrientValueDerivationCode",
                        "ValuesByLocale": {
                            "en-US": "ANALYTICAL"
                        },
                        "SourceParty": "",
                        "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    }
                ],
                "MultiValues": [
                    {
                        "Name": "servingSuggestion",
                        "ValuesByLocale": {
                            "en-US": [
                                "TEST"
                            ]
                        },
                        "SourceParty": "",
                        "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "nutritionalClaim",
                        "ValuesByLocale": {
                            "en-US": [
                                "TEST"
                            ]
                        },
                        "SourceParty": "",
                        "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "growingMethodCode",
                        "ValuesByLocale": {
                            "en-US": [
                                "FLY_FREE"
                            ]
                        },
                        "SourceParty": "",
                        "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "Name": "nutritionLabelTypeCode",
                        "ValuesByLocale": {
                            "en-US": [
                                "1"
                            ]
                        },
                        "SourceParty": "",
                        "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    }
                ],
                "ContainerValues": [
                    {
                        "ParentAttribute": "Allergen Related Information",
                        "RowList": [
                            {
                                "Values": [],
                                "MultiValues": [],
                                "ContainerValues": [],
                                "AssetValues": [],
                                "IsExplicitNullValue": false
                            }
                        ],
                        "SourceParty": "",
                        "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "ParentAttribute": "Sub Ingredients",
                        "RowList": [
                            {
                                "Values": [],
                                "MultiValues": [],
                                "ContainerValues": [],
                                "AssetValues": [],
                                "IsExplicitNullValue": false
                            }
                        ],
                        "SourceParty": "",
                        "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    },
                    {
                        "ParentAttribute": "Diet Type Information",
                        "RowList": [
                            {
                                "Values": [],
                                "MultiValues": [],
                                "ContainerValues": [],
                                "AssetValues": [],
                                "IsExplicitNullValue": false
                            }
                        ],
                        "SourceParty": "",
                        "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    }
                ],
                "AssetValues": [
                    {
                        "Name": "Main Product Image",
                        "ValuesByLocale": {
                            "en-US": {
                                "Name": "Banana.jpg",
                                "Url": "https://assets.uat.syndigo.com/d15b778e-55a4-42d5-b20d-8bedc141fbc9?originalFileName=true",
                                "SourceUrl": "https://images.unsplash.com/photo-1587132137056-bfbf0166836e",
                                "Format": "jpeg"
                            }
                        },
                        "SourceParty": "",
                        "Recipient": "",
                        "Delete": false,
                        "IsExplicitNullValue": false
                    }
                ],
                "IsExplicitNullValue": false
            }
        ],
        "ProductIdentifierProperty": "",
        "ProductReferenceProperty": "",
        "Archived": false
    }
}


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence