- 3 Minutes to read
- DarkLight
3. Supplier Implementation Process
- 3 Minutes to read
- DarkLight
Phases of Implementation
- Mapping & Data Validation
- Requirements Gap Closure
- Customer Vocab Creation(Update)
- Payload Build out
- Testing
- Move to Production
Additional Calls to be implemeted based on API model:
- Checking Data Quality
- Publishing
- Checking for Recipient Feedback
Post Implementation
- Adding Additional Recipients
- Updating Based on Requirement Set Updates
Product Import and Publish Process
There are many ways to implement our API and best method may change based on customer needs. Below is an one option that represents the most efficient sequence to import products, update products, imports assets, link to recipients, set category, check DQ, publish, check status, and retrieve feedback.
Make sure to read the FAQ to avoid common mistakes and get answers to the most frequently asked questions.
- Gather Recipient IDs*
- Gather Taxonomy IDs*
- Gather all attributes (UI)
- Authentication
- Import Product or Update Product
- Check Data Quality per recipient**
- Verify call (needed for custom distributions, optional for integrated as the publish call for integrated recipients will perform verfication.
- Publish Products**
- Get Publication Status**
- Get Feedback**
(*) Inputs not available by API. Use UI or ask your account team to help gather these inputs
(**) Not applicable to all API customers. Will depend on your desired level of automation.
There are many ways to implement our API. You should determine the best method of implementation based on your needs and the functions to be managed by API versus a user in the UI.
Here is one possible call sequence for efficient implementation to create a product record, update it, and publish. This sequence is based on the assumption that the mapping phase is complete, that customer vocab exists, and that the desired recipient requirement sets validations are known, and you have already gathered necessary inputs for recipient IDs and taxonomy node IDs.
For each item to be published:
- Import Product or Update Product: In Product Import, use ImportMode=CreateOrUpdate. Manage initial product import/product update, asset linking and upload, setting recipient, setting taxonomy all within one call to Product Import.
- Update Product with Hierarchy: If package hierarchy is needed, handle in second product import call to update the record with parent information.
- Publish Call with Data Quality check: Perform data quality check within the publication call. Capture records with data quality errors and their associated errors. Action as needed. There are two calls here, publish to a single recipient or publish to a group of recipients. Chose the one that best fits your design needs.
- Get Publication Status of all items published.
- Get feedback for products not in Synchronized state. Action as needed. Return to step 1 as needed.
Known Risks
Recipients control their update timing and frequency. There is the chance that a recipient can make updates to attribution and requirements during an implementation
Mapping, Data Validation, and Gap Closure are pre-requisites to payload build out. Timeline is controlled by the customer and their resourcing constraints. Syndication users must be engaged during this process to ensure attribution accuracy. Business may need to be engaged if source data required to meet recipient requirements is not available or in the wrong format. This may require updates to source data.
Payload Buildout is customer driven and timeline to completion is based on customer resourcing. Syndigo technical teams are available to help answer specific questions during the process.
Recommendations
- Technical teams should have access and be trained in the UI. This allows for fast confirmation during payload build out and helps to better understand the data and their associated structures.
- How can I get a sample payload? You will need a minimal customer vocabulary established as all things pass through the customer vocabulary. Create a product in the UI, link a recipient, and set the category. Once the vocab is in place, then use the product search call to retrieve the product payload, using shouldIncludeMissingVocabularyAttributes=true. The response body is in the same format that you will use in as the request body needed for product import or update.
- Make sure to read the FAQ to avoid common mistakes and get answers to the most frequently asked questions.