Update Existing Product Information

Sample Example

Sample Request

Products in JSON format can be sent as batches if they are packed inside a comma-separated list.

[{
        "item_id": "2159967",
        "locale": "en_US",      
        "in_stock": 1,    
        "price": {            
              "USD": 40.9        
          },              
        "original_price": {            
              "USD": 49.9        
          } 
}]

Sample Response

Catalog API returns responses with status code 200 for successful requests. Successful responses display the number of valid products to be updated and the full information of the failed products.

{
    "success": true,
    "message": {
        "invalidRatio": 0,
        "valid": {
            "count": 1
        },
        "invalid": {
            "count": 0,
            "details": []
        },
        "warnings": {
            "count": 0,
            "details": []
        }
    }
}

Sample Request

Update API can also return successful responses with warnings in the response body. These warnings refer to optional attributes being entered by the user wrongly. In such cases, products in the requests are still processed. However, product attributes causing the warnings are ignored and not updated in your Product Catalog. You can see a sample request and a Catalog API response that contains a warning below.

 [{
    "item_id": "Item-123",
    "locale": "en_US",
    "in_stock": 1,
    "price": {
        "USD": 35.5
    },
    "original_price": {
        "USD": 35.5
    },
    "product_attributes": {
        "stock_code": "01020304"
    }
}]

Sample Response

In this example, if the stock_code attribute is not defined as a Product Attribute for you before requesting the Catalog API, responses include a warning message as below.

{
    "success": true,
    "message": {
        "invalidRatio": 0,
        "valid": {
            "count": 1
        },
        "invalid": {
            "count": 0,
            "details": []
        },
        "warnings": {
            "count": 1,
            "details": [
                {
                    "message": "Product attribute keys are not included in partners attribute.(stock_code)is not included in partner attribute map.",
                    "count": 1,
                    "document_ids": [
                        "Item-123:en_US"
                    ]
                }
            ]
        }
    }
}

400 Invalid Data Exception; Couldn’t Parse JSON

{
    "status": false,
    "message": "Request data is not in valid JSON format."
}

400 Maximum Allowed Record Count

{
    "status": false,
    "message": "Maximum allowed request size is exceeded."
}

400 Maximum Allowed Request Size

{
    "status": false,
    "message": "Maximum allowed request size is exceeded."
}

401 Partner Cannot Be Validated

{
    "status": false,
    "message": "Partner does not have necessary integration settings for Catalog API."
}

401 Wrong Token Usage

{
    "status": false,
    "message": "Partner token authentication failed."
}

500 Internal Server Error

{
    "status": false,
    "message": "Internal server error."
}

Limitations

• Only existing data can be sent via this API. If a non-exist product is sent, it will be not updated.
• For all the other limitations, refer here.