Product Search by Subscription State
- 7 Minutes to read
- DarkLight
Product Search by Subscription State
- 7 Minutes to read
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
To search the product by Subscription State, 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, useLens, locale, and shouldIncludeMissingVocabularyAttributes 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 |
| RecipientAliases | Optional | String | Recipient identifier: GUID or as aliased in customer vocab | Sets the lens through which the product data is returned from search |
| SubscriptionExists | Optional | Boolean | true/false | Determines if should show the products with existing subscription. |
| 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). |
| 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 |
| RecipientFilters | Required | Array of Strings | Includes: IncludeLinkedRecipients, SubscriptionExists | List of identifier types to be searched |
| PublicationFilters | Required | Array of Strings | Includes: PublicationStatus | |
| PublicationStatus | Required | Enum | NotPublished = 0 (Not yet published), Publishing = 1 (Publish in progress), PendingSupplierAction = 2 (Waiting for publish on a supplier action), PublishedAwaitingSubscription = 3 (Published and waiting for a subscription), PendingRecipientAction = 4 (Waiting for publish on a recipient action), PublishedAwaitingResponse = 5 (Published and waiting for a response), Synchronized = 6 (Publish complete), Error = 7 (Publish could not be completed due to error), WithdrawCorrection = 8 (Publication was withdrawn. This notifies the recipient that product type or its hierarchy is changing), WithdrawDelete = 9 (Publication was withdrawn for purposes of delete. This notifies the recipient that the product will be removed from circulation), Rejected = 10 (Publication was rejected by recipient) | Allows searching for a specific publication status. |
| IncludeLinkedRecipients | Optional | Boolean | true/false | Shows products that are linked to recipients. |
ProductIds | Optional | Array of Strings | Product GUIDs | List of Products to be searched. |
ExcludeProductIds | Optional | String | Product GUIDs | List of products to be excluded. |
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. |
| Operator | Optional | Enum | LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo | Part of DateFilter |
| Value | Optional | String | Commonly acceptable string representation of a date/time | Part of DateFilter |
| IncludeMissing | Optional | 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 |
Request
{
"Archived": null,
"ProductIds": [
"put your product GUID here" //to return Status by Product ID
],
"RecipientAliases": [
"" //provide recipient's alias or GUID for precise search results
],
"RecipientFilters": [
{
"IncludeLinkedRecipients": true //shows products that are linked to recipients
// "SubscriptionExists": true
},
{
"PublicationFilters": [
{
"PublicationStatus": "6"
/**
public enum PublicationStatus
{
///
/// Not yet published
///
NotPublished = 0,
///
/// Publish in progress
///
Publishing = 1,
///
/// Waiting for publish on a supplier action
///
PendingSupplierAction = 2,
///
/// Published and waiting for a subscription
///
PublishedAwaitingSubscription = 3,
///
/// Waiting for publish on a recipient action
///
PendingRecipientAction = 4,
///
/// Published and waiting for a response
///
PublishedAwaitingResponse = 5,
///
/// Publish complete
///
Synchronized = 6,
///
/// Publish could not be completed due to error
///
Error = 7,
///
/// Publication was withdrawn. This notifies the recipient that product type or its hierarchy is changing
///
WithdrawCorrection = 8,
///
/// Publication was withdrawn for purposes of delete. This notifies the recipient that the product will be removed from circulation
///
WithdrawDelete = 9,
///
/// Publication was rejected by recipient.
///
Rejected = 10
}
**/
}
]
}
]
}
Response 200 OK
{
"ErrorMode": "Fail",
"DefaultLocale": "en-US",
"ProducingOperationDetails": {},
"ProductImportData": {
"ProductsToImport": [
{
"ImportMode": "Update",
"ProductIdentifierPropertyOverride": "",
"ProductIdentifierValue": "c3227cbe-8ee1-4781-93d5-05cbb2ff864d",
"TaxonomyNodes": [],
"CatalogItems": [
{
"Party": "77cee940-0b37-43d2-bd47-b88ee8aba398",
"TargetMarket": "840"
}
],
"PackageType": "BaseUnit",
"ImmediateParentDetails": {
"19e106d9-5c46-40f9-9b6f-02205299706f": {
"Quantity": 12
}
},
"RecipientsToLink": [],
"WorkflowId": null,
"ComplexValues": [],
"NutritionalInformationModule": {
"Values": [],
"MultiValues": [],
"ContainerValues": [],
"AssetValues": [],
"DocumentValues": [],
"IsExplicitNullValue": false
},
"LifeCycle": {
"CreatedDate": {
"Value": "2019-06-14T20:45:06.68295Z",
"Delete": false
},
"DiscontinueDate": {
"Value": "2019-08-10T00:00:00",
"Delete": false
},
"DeleteDate": {
"Value": "2019-08-11T00:00:00",
"Delete": false
}
},
"Values": [
{
"Name": "UPC",
"ValuesByLocale": {
"en-US": "053883471146"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "MFG Brand Name",
"ValuesByLocale": {
"en-US": "BELLA Contemporary Storage"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Packaging Level",
"ValuesByLocale": {
"en-US": "BASE_UNIT_OR_EACH"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "GTIN",
"ValuesByLocale": {
"en-US": "00053883471146"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "MFG Name",
"ValuesByLocale": {
"en-US": "F & M Tool and Plastics, Inc."
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Short Description",
"ValuesByLocale": {
"en-US": "14 Quart Storage Container"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Country of Origin (numeric)",
"ValuesByLocale": {
"en-US": "840"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Package Width",
"ValuesByLocale": {
"en-US": "11.500"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Package Height UOM",
"ValuesByLocale": {
"en-US": "INH"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Package Width UOM",
"ValuesByLocale": {
"en-US": "INH"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Package Weight UOM",
"ValuesByLocale": {
"en-US": "LBR"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Package Weight",
"ValuesByLocale": {
"en-US": "0.950"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Has Item Been Recalled",
"ValuesByLocale": {
"en-US": "N"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Item is the Lowest Packaging Level",
"ValuesByLocale": {
"en-US": "Y"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Item is Sold to the Consumer",
"ValuesByLocale": {
"en-US": "Y"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Item is Shipped/Despatched at this Packaging Level",
"ValuesByLocale": {
"en-US": "Y"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Package Depth",
"ValuesByLocale": {
"en-US": "15.250"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Market Availability Date",
"ValuesByLocale": {
"en-US": "2013-02-03 00:00:00.000000"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Net Package Quantity/Net Content",
"ValuesByLocale": {
"en-US": "1.0000"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Information Effective Date",
"ValuesByLocale": {
"en-US": "2013-02-03 00:00:00.000000"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Minimum Order Quantity",
"ValuesByLocale": {
"en-US": "12"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Multiple Order Quantity",
"ValuesByLocale": {
"en-US": "12"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Order UOM",
"ValuesByLocale": {
"en-US": "EA"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Package Depth UOM",
"ValuesByLocale": {
"en-US": "INH"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Package Height",
"ValuesByLocale": {
"en-US": "7.250"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Selling UOM",
"ValuesByLocale": {
"en-US": "EA"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Layers Per Pallet",
"ValuesByLocale": {
"en-US": "5"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
},
{
"Name": "Items Per Pallet Layer",
"ValuesByLocale": {
"en-US": "9"
},
"Recipient": "",
"Delete": false,
"IsExplicitNullValue": false
}
],
"MultiValues": [],
"ContainerValues": [],
"AssetValues": [],
"IsExplicitNullValue": false
}
],
"ProductIdentifierProperty": ""
}
}
Was this article helpful?