Status API (2022-08)
The Status API provides the ability to check the status after registration through the Management API of OMNICOMMERCE.
API Endpoint
The default API Endpoint is as follows, and the current latest version is 2023-05.
caution
The version of this page is 2022-08.
https://api.kr.omnicommerce.ai/2022-08/
Product Status Management API
GET /management/status-count: Obtain a summary of counts grouped by status
This API summarizes the number of items grouped by their status.
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-Api-Key | Required | String | API Key (refer to API Authentication Guide) |
Response
| Name | Type | Description |
|---|---|---|
| done | Integer | Number of completed products |
| processing | Integer | Number of products in registration process |
| error | Integer | Number of products with errors |
Response Example
200 Accepted
Request success
{
"done": 1000,
"processing": 1000,
"error": 0
}
GET /management/status/{product_id}: Check single product status
This API provides details on the current processing status of a specific product.
Requset Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-Api-Key | Required | String | API Key (refer to API Authentication Guide) |
Response
| Name | Type | Description |
|---|---|---|
| status | String | The type can be one of DONE, PROCESSING, ERROR |
| errors | String | Explanation about the cause of the error. This is only provided when the status is ERROR. |
| requestInfo | Object | The product information sent via the management API (request Body information). This is only provided when the status is DONE. |
| ├requestInfo.id | String | Product ID: The product ID is used as a Unique Key in the respective Workspace. |
| ├requestInfo.url | String | The main image URL of the product |
| ├requestInfo.detection | String | One of the values specified in Detection information. (Ex: If the product being sold is a top: TOP) |
| ├requestInfo.salesUrl | String | The URL of the page where the product is being sold |
| ├requestInfo.mobileSalesUrl | String | The mobile version URL of the page where the product is being sold |
| └requestInfo.metadata | Object | Various product information managed by the client, such as product name, brand, price, season, discount rate, etc. (Refer to: Product Meta Information) |
Response Example
200 Accepted
status = "DONE"
{
"status": "DONE",
"requestInfo": {
"id": "",
"url": "",
"detection":"",
"salesUrl": "",
"mobileSalesUrl": "",
"metadata": {}
}
}
status = "PROCESSING"
{
"status": "PROCESSING"
}
status = "ERROR"
{
"status": "PROCESSING",
"errors": "error message"
}
POST /management/status: Check status of multiple products
This API provides information about the various statuses of the given list of product ids.
Requset Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-Api-Key | Required | String | API Key (refer to API Authentication Guide) |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| productIds | Required | List[String] | List of product IDs. Up to 100 are allowed. |
caution
You can request up to 100 items per Request.
Request example
{
"productIds": [
"A1000", "A1001", "A1002"
]
}
Response
| Name | Type | Description |
|---|---|---|
| done | List | The product information for items marked as DONE status as delivered through the management API. |
| ├done[].id | String | Product ID: The product ID is used as a Unique Key in the respective Workspace. |
| ├done[].url | String | The main image URL of the product |
| ├done[].detection | String | One of the values specified in Detection information. (Ex: If the product being sold is a top: TOP) |
| ├done[].salesUrl | String | The URL of the page where the product is being sold |
| ├done[].mobileSalesUrl | String | The mobile version URL of the page where the product is being sold |
| └done[].metadata | Object | Various product information managed by the client, such as product name, brand, price, season, discount rate, etc. (Refer to: Product Meta Information) |
| processing | List[String] | List of product IDs that are in process |
| error | List | List of products with errors |
| ├error[].id | String | Product ID: The product ID is used as a Unique Key in the respective Workspace. |
| └error[].message | String | Error message during processing |
Response Example
200 Accepted
All requests succeeded
{
"done": [{
"id": "A1000",
"url": "",
"detection":"",
"salesUrl": "",
"mobileSalesUrl": "",
"metadata": {}
},{
"id": "A1001",
"url": "",
"detection":"",
"salesUrl": "",
"mobileSalesUrl": "",
"metadata": {}
},{
"id": "A1002",
"url": "",
"detection":"",
"salesUrl": "",
"mobileSalesUrl": "",
"metadata": {}
}],
"processing": [],
"error":[]
}
In case of some products are in processing status.
{
"done": [{
"id": "A1000",
"url": "",
"detection":"",
"salesUrl": "",
"mobileSalesUrl": "",
"metadata": {}
},{
"id": "A1001",
"url": "",
"detection":"",
"salesUrl": "",
"mobileSalesUrl": "",
"metadata": {}
}],
"processing": ["A1002"],
"error":[]
}
An example of when all possible states exist.
{
"done": [{
"id": "A1000",
"url": "",
"detection":"",
"salesUrl": "",
"mobileSalesUrl": "",
"metadata": {}
}],
"processing": ["A1001"],
"error":[
{
"id":"A1002",
"message": "error message"
}
]
}
In case of all products are in processing status.
{
"done": [],
"processing": ["A1000", "A1001", "A1002"],
"error":[]
}
In case of some products are in error status.
{
"done": [],
"processing": ["A1000"],
"error":[
{
"id":"A1001",
"message": "error message"
}, {
"id":"A1002",
"message": "error message"
}
]
}
In case of all products are in error status.
{
"done": [],
"processing": [],
"error":[
{
"id":"A1000",
"message": "error message"
}, {
"id":"A1001",
"message": "error message"
}, {
"id":"A1002",
"message": "error message"
}
]
}