A delta (also known as Incremental) feed upload is when you perform a partial feed upload. Changes are updated to the existing product catalog.

📘
Note
We support only one type of operation(Add, Update, or Delete) in a single delta upload request.
For eg: it can be either of "Add", "Update" or "Delete" for delta uploads. You cannot use multiple operations in the same delta uploads.

API Structure

API Endpoint

Method : POST

End Point : {feed end point}/api/{siteKey}/upload/catalog/delta

Description : This API helps to upload some of the updated fields of the catalog.

Request Parameters

Request Parameter:

siteKey: A unique identifier provided when you create an Unbxd account. This key can also be retrieved from the Console. This is a required field.
secretKey: A unique identifier provided when your Unbxd account is created. The secretKey is used to authorize your upload request. This is a private key and will not be exposed to the public. This is a required field.
feed end point : The feed end point depends upon the region selected at the time of site creation.

Response Parameters

Response Parameters:

fileName: The name of the feed file, in JSON format.
uploadID: The unique identifier assigned to your upload session.
Status: Indicates the upload situation or progress of your feed file.Status can be:

Accepted
Indexing
Indexed
Failed

timeStamp: Indicates the time of the file in YYYY-MM-DD | HH:MM:SS format.
message: Indicates if the upload succeeded or failed. This field will also indicate the error code.
code: 200 if feed upload request is ACCEPTED. The code for a feed upload request may be updated if the feed upload request fails during indexing.

Error Codes

We use conventional HTTP response codes to indicate success or failure of an API request.

201 (Ok): Indicates the upload was successful.

401 (Authorization Error): Indicates you may have provided an invalid API key.

400 (Bad Request): Indicates you may have missed a required parameter.

500 (Internal Server Error): Though these are rare, this indicates we may have messed up.

Sample Request

curl -X POST 
 https://feed.unbxd.io/api/{siteKey}/upload/catalog/delta 
  -H 'Authorization:{secretKey}' 
  -F file=@{fileName}.json

Sample Response

{
  "fileName": "{fileName}",
  "uploadId": "{id}",
  "timeStamp": 6581239201,  
  "status":"ACCEPTED",  
  "message":"File Queued",  
  "code":200
}

Sample Feed

This is how a delta feed upload will appear if you want to update the variants, and when the variantId is unique:

{
  "feed": {
    "catalog": {
      "update": {
        "items": [
          {
            "variants": [
              {
                "variantId": "00889705456424",
                "v_qty": "0",
                "vSize": "s",
                "vColor": "Red"
              }
            ]
          }
        ]
      }
    }
  }
}

If you want to update other fields of a product that has a unique ID:

{
  "feed": {
    "catalog": {
      "update": {       
        "items":[{
        "uniqueId":”12345”,
        "color":"blue",
        "size":”10”
      }]
    }
  }
}

Check Status

After the upload, you can check the status of the uploaded feed. There are two ways to do this: by URL or via APIs.

In the address field, type in:
https://feed.unbxd.io/api/{siteKey}/catalog/delta/status
To check the status of the last 10 uploads, type in:
https://feed.unbxd.io/api/{siteKey}/catalog/delta/status?count=10
To view the status of your upload using the Upload ID:
https://feed.unbxd.io/api/{siteKey}/catalog/delta/{uploadId}/status

📘
Note

Once you get the response using the Upload ID, replace (uploadID).

To locate your site key, navigate to Manage > Configure Site > Keys > Site Keys within the console.

Best Practices

To ensure your feed is uploaded and integrated seamlessly, we recommend the following:

We recommend a gap of at least 15 minutes between consecutive delta uploads.
Don’t use a delta feed API to upload a complete feed.

📘
Note
Delta feed upload requests received by our systems are processed immediately. However, the changes may require upto 10 mins to reflect in the API response in some cases.