How can I identify an item via the API ?

Introduction

Implio uses a combination of three different identifiers. These ids are used internally and externally and provided to you in each API request or response.

List of ids

Type of id Description
batchId
All items submitted in one API call to Implio will have a unique batchId that identifies the batch of items sent.
taskId
Every piece of content submitted to Implio, whether it is a new item or an update to an existing item, is automatically assigned a unique id that identifies it throughout the entire moderation process all the way back to you.
id
Identifies an item in your own system. It is the only id provided by you and not generated by Implio.
Multiple revisions of an item should have the same id. Otherwise Implio will consider them as separate items and won't be able to display differences between one revision and another.

Ids in API requests and responses

For every new item submitted to Implio via an API request, we immediately provide you with the three above-listed ids in the response.

Below is an example of API call you make to submit items to Implio and the response you would get from us.

API request API response
[  
  {  
 "id":"123459",
    "content":{  
      "title":"Item for sale",
      "body":"Super item for sale in mint condition"
    }
  },
  {  
 "id":"987654",
    "content":{  
      "title":"Another item for sale",
      "body":"Bargain item"
     }
  }
]
{  
 "batchId":"ff26234c-eaf8-4990-b09b-0e0a8b469ecc",
  "accepted":[  
    {  
 "id":"123459",
 "taskId":"5bd7ab44-17ac-4dfc-897c-c6de8421849a"
    },
    {  
 "id":"987654",
 "taskId":"586f3d2f-e33c-4b34-8f6e-494201dc5607"
    }
  ],
  "rejected":[  

  ]
}

Similarly, we provide these ids when you pull or when we push the moderation decisions back to you.

Was this article helpful?

Can’t find what you’re looking for?

We are here to support you.