Colizey - Unpublish (Deactivate) Product
Summary of Changes: (The purpose of this table is to keep traceability and Product team to highlight the things that were changed into the scope, based on comments or discussions)
Date | Version | Comment |
---|---|---|
05/09/2022 | 1.1 | Based on a comments, added QTY=0 & described the End item flag in both cases |
07/09/2022 | 1.2 | Typo edited; |
The purpose of this page is to describe in details the flow of unpublishing products.
We are able to unpublish the product which was published. In order to do this, we should push the SKU which we have assigned to the product and use the relevant API end point for unpublishing products. The only parameter is an array
of SKUs (string
). Note that all SKUs needs to be in the same format as the ones we provided on our feed.
API Call: POST https://api.colizey.fr/merchant/products/unpublish
API Docs: https://apidoc.colizey.fr/?shell#unpublish-a-product
Body structure: '["sku1", "sku2", "sku3"]'
The SKU which need to push should be taken from Product > SKU.
We will send unpublish API call in 2 cases:
Case1: We have Update Qty=Pending and we will send 0 stock to a product.
Product status=Product Published; Listing status = Active; Update Quantity= Pending; OR List/Update the whole item = Pending & Qty=0;
After successful run, we will have following statuses:
Product status=Product Published; Listing status = Inactive; Update Quantity = Not Needed; End Item =No;
If error, we will have:
Product status=Product Published; Listing status = Active; Update Quantity = Error
We should need the respective Error into Update item error field.
Case2: We have End Item = Yes (1)
Product status=Product Published; Listing status = Active; End Item = Yes;
After successful run, we will have following statuses:
Product status=Product Published; Listing status = Inactive; End Item= No (0);
If error, we will have:
Product status=Product Published; Listing status -Active; End Item = Error;
We need to store the respective Error into End Error field.