Skip to main content

Status API (2023-05)

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.

https://api.kr.omnicommerce.ai/2023-05/

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​

NameRequiredTypeDescription
X-Api-KeyRequiredStringAPI Key (refer to API Authentication Guide)

Response​

NameTypeDescription
doneIntegerNumber of completed products
processingIntegerNumber of products in registration process
errorIntegerNumber 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​

NameRequiredTypeDescription
X-Api-KeyRequiredStringAPI Key (refer to API Authentication Guide)

Response​

NameTypeDescription
idStringID of the requested product
statusStringThe type can be one of DONE, PROCESSING, ERROR
errorsStringExplanation about the cause of the error. This is only provided when the status is ERROR.
requestInfoObjectThe product information sent via the management API (request Body information). This is only provided when the status is DONE.
├requestInfo.urlStringThe main image URL of the product
├requestInfo.detectionStringOne of the values specified in Detection information. (Ex: If the product being sold is a top: TOP)
├requestInfo.salesUrlStringThe URL of the page where the product is being sold
├requestInfo.mobileSalesUrlStringThe mobile version URL of the page where the product is being sold
└requestInfo.metadataObjectVarious 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"

{
    "id": "A1000",
    "status": "DONE",
    "errors": null,
    "requestInfo": {
        "url": "https://image-url.jpg",
        "salesUrl": "https://sales_url.com",
        "mobileSalesUrl": "https://m.sales_url.com",
        "detection": "TOP",
        "metadata": {
            "productName": "product name",
            "originPrice": 10000,
            "currency": "KRW"
        }
    }
}

status = "PROCESSING"

{
    "id": "",
    "status": "PROCESSING",
    "errors": null,
    "requestInfo": {}
}

status = "ERROR"

{
    "id": "",
    "status": "ERROR",
    "errors": "error message",
    "requestInfo": {}
}

status = "DELETE"

{
    "id": "",
    "status": "DELETE",
    "errors": null,
    "requestInfo": {}
}

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​

NameRequiredTypeDescription
X-Api-KeyRequiredStringAPI Key (refer to API Authentication Guide)

Request Body​

NameRequiredTypeDescription
productIdsRequiredList[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", "A1003"
    ]
}

Response​

NameTypeDescription
resultsListRepresents the results for the requested products as a list
├ results[].idStringID of the requested product
├ results[].statusStringThe type can be one of DONE, PROCESSING, ERROR, DELETE
├ results[].errorsStringExplanation about the cause of the error. This is only provided when the status is ERROR.
├ results[].requestInfoObjectThe product information sent via the management API (request Body information). This is only provided when the status is DONE.
├ results[].requestInfo.urlStringThe main image URL of the product
├ results[].requestInfo.detectionStringOne of the values specified in Detection information. (Ex: If the product being sold is a top: TOP)
├ results[].requestInfo.salesUrlStringThe URL of the page where the product is being sold
├ results[].requestInfo.mobileSalesUrlStringThe mobile version URL of the page where the product is being sold
└ results[].requestInfo.metadataObjectVarious 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

All requests succeeded

{
  "results":[
        {
            "id": "A1000",
            "status": "DONE",
            "errors": null,
            "requestInfo": {
                "url": "https://image-url.jpg",
                "salesUrl": "https://sales_url.com",
                "mobileSalesUrl": "https://m.sales_url.com",
                "detection": "TOP",
                "metadata": {
                    "productName": "product name",
                    "originPrice": 10000,
                    "currency": "KRW"
                }
            }
        },
        {
            "id": "A1001",
            "status": "PROCESSING",
            "errors": null,
            "requestInfo": {}
        },
        {
            "id": "A1002",
            "status": "ERROR",
            "errors": "error message"
            "requestInfo": {}
        },
        {
            "id": "A1003",
            "status": "DELETE",
            "errors": null,
            "requestInfo": {}
        }
    ]
}