There are two main methods to create and update your products on the system, in this guide we will cover both ways.
The two ways to update your products on the system are by either using a CSV file or API.
There are pros and cons for each of the methods and you need to choose the method that suits you best.
You can read about it in the Integrating With Quicklizard guide.
Via API
If it's the first time you are using the API read about setting up a connection and the general process Getting started with API Guide.
Quicklizard has two endpoints designed for that purpose, the Create endpoint and the Update endpoint.
Creating products
The create endpoint is used to create new products on the system.
Our create endpoint is api/v3/products/create.
This endpoint requires two parameters, the QTS, and the "body".
The body is the payload of the products you wish to update. you can create up to 200 products per request.
The body must contain the following information:
- client_key - on which system to create the product (and channel key for omnichannel systems),
- label which is the name of the product,
- shelf_price - which will contain the price of the product,
- permalink - the link to the product on your site.
- product_id - a unique identifier of the product on the system, which will be later used to update the product.
- other optional values are image, cost, inventory, and attributes which will be passed as an array.
To read more about the endpoint and the format of the values please see our documentation here
Updating products
The update endpoint is api/v3/products/update.
It contains the same values and format but works in a 'PUT' method, and has the option to disable products. In order to update a product, the product_id must be identical to the one passed on the creation request.
If you send an already existing attribute, or value it will be updated. if you wish to delete an attribute, pass the value "delete!".
The update endpoint can contain one more variable to be passed in the payload, which is called 'disabled' and used to disable products.
To read more about the endpoint and the format of the values please see our documentation here
Tips
- Product_id is not shown on the system by default, It is usually the same as a unique attribute on your product catalog such as SKU, EAN, MPN, etc. If it isn't another option is to pass an attribute called product_id in addition to see it on the system.
- Using the create endpoint on already existing products will update them, but also automatically send them to pricing and enable them.
- Disabled products are removed from the system after 60 days of being disabled. take that into consideration when disabling a product.
Via CSV file
If it's the first time you are using our SFTP connection read about how to gain access to our SFTP server using our SFTP Connection Guide.
The files should include all the information you wish to update, for the product, mandatory fields are shelf price, product ID, and name. other optional values are cost, inventory, image, and attributes. Each attribute should be passed in its own column.
Files should be a csv file, UTF-8 Encoded.
Please specify what is the separator (usually comma or semicolon), the numeric separator (comma or dot).
An example file is attached at the bottom of the guide.
Note: There are some considerations to take into account when using this method
- The process is executed at a specific time of date, meaning the data should be always uploaded before it is timed to run. otherwise, it would not be updated.
- To create and define the process it should always be coordinated with your CSM, he then makes sure everything is set up as needed and executed correctly and on time.
- Adding new attributes or data to the files would require Quicklizard to make the necessary changes to our process and should always be coordinated with your CSM.
Comments
0 comments
Please sign in to leave a comment.