Publish Product(s) Multiple Recipients
- 1 Minute to read
- DarkLight
Publish Product(s) Multiple Recipients
- 1 Minute to read
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
To publish a single product to multiple recipients, mention the following in the postman and then click Send.
POST
How to properly test API calls
The resources allocated to the UAT environment are drastically lower than what exists in our Production Environment.
It is not possible to publish as many products to UAT as to production.
Use the UAT environment ONLY for testing purposes and checking payload structures!
Query Parameters
Expand to see the parameters and description
| Parameter | Parameter Type | Data Type | Accepted Values | Description |
| vocabularyID | Required | String | GUID | GUID |
| useDataQuality | Optimal | Boolean | true/false | When set to true will return data quality errors when the product is not at 100% |
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 |
dataOwner | Required | String | GUID | Company identifier |
| identifierName | Required | String | Must be a valid identifier in the customer vocabulary | Sets the identifier type |
| identifierValue | Required | String | Any value that exists in the products' identifiers | The value we are searching for |
| targetMarkets | Optional | Array | 3 Digit numeric target market code | Defaults to USA/840 |
| sourcePartyAlias | Required | String | Must be a valid Alias in the customer vocabulary or source party GUID | The source party (supplier) for the catalog item being published |
| targetPartyCriteriaList | Required | Array | Comma separated list of targetPartyAliases | A list of recipients to which to publish |
| targetPartyAlias | Required | String | Must be a valid Alias in the customer vocabulary or target party GUID | The target party (recipient) for the catalog item being published |
| invertTargetPartyCriteriaList | Optional | Boolean | true/false | Defaults to false. Makes the publish call publish to all linked recipients excluding those in the targetPartyCriteriaList array |
Request
{
"dataOwner": "0642243f-73e6-4f04-9037-a118112c2e99",
"identifierValue": "00084992838889",
"identifierName": "GTIN",
"targetMarkets": [
"840"
],
"sourcePartyAlias": "77cee940-0b37-43d2-bd47-b88ee8aba398",
"targetPartyCriteriaList": [
{
"targetPartyAlias": "fa398a77-7423-4c4c-9b0a-accd9a8ebe84"
}
]
// "invertTargetPartyCriteria": false,
// "overrideTargetMarketsByTargetPartyAlias": {
// "additionalProp1": [
// "string"
// ],
// "additionalProp2": [
// "string"
// ],
// "additionalProp3": [
// "string"
// ]
// }
}
Response 200 OK
{
"PublicationResponseByParty": {
"fa398a77-7423-4c4c-9b0a-accd9a8ebe84": {
"PublicationStarted": true
}
}
}
Was this article helpful?