Integrate and interact with Unbxd PIM

Import Status API

The Import Status API lets you track the import status via the import id. The import_id is generated in the response object of Import Products from URL API.

Endpoint:

GET /v1/imports/{import_id}/status

Request Parameters:

Header

Name: Value Required Data Type
content-type: application/json Yes String
Authorization: api_key Yes String

 

Path Parameters

Parameter Data Type Description
import_id String  Import id to track the status of the import

 

Response:

{
    "data": {
        "product_stats": {
            "updated": {},
            "added": {
                "total": 7,
                "parents": 0,
                "variants": 0,
                "solo": 7
            },
            "total": 7,
            "processed": 7
        },
        "properties_stats": {
            "added": 70,
            "referenced": 3
        },
        "importDamStats": {
            "success": 0,
            "failed": 0,
            "pending": 7
        },
        "total": 7,
        "processed": 7,
        "failed": 0,
        "import_id": "5cd0b618f5053a00089145a5",
        "import_name": "first import for brand A",
        "import_type": "import",
        "import_state": "IMPORT_COMPLETED"
    }
}

Schema

Name Data Type Description
updated
total Integer  Total products updated
parents Integer  Total parent products updated
variants Integer  Total variant products updated
solo Integer  Total solo products updated
added
total Integer  Total products added
parents Integer  Total parent products added
variants Integer  Total variant products added
solo Integer  Total solo products added
properties stats
added Integer  Total properties added
import dam stats
success Integer Digital assets successfully imported
failed Integer Digital assets that failed to import
pending Integer Digital assets pending import
import_id String  Import id to track the status of the import
import_name String  Name of the import
import_type String  Type of import, for example, product import
import_state String Import status:

  • PRE_IMPORT_STARTED,
  • PRE_IMPORT_IN_PROGRESS,
  • PRE_IMPORT_COMPLETED,
  • PRE_IMPORT_FAILED,
  • MAPPING_IN_PROGRESS,
  • MAPPING_COMPLETED,
  • MAPPING_VALIDATE_SUCCESS,
  • MAPPING_VALIDATE_PROGRESS,
  • MAPPING_VALIDATE_FAILED,
  • PROPERTY_CREATION_STARTED,
  • PROPERTY_CREATION_FAILED,
  • PROPERTY_CREATION_SUCCESS,
  • IMPORT_STARTING,
  • IMPORT_WAITING_START,
  • IMPORT_STARTED,
  • IMPORT_IN_PROGRESS,
  • IMPORT_TIMED_OUT,
  • IMPORT_FAILED,
  • IMPORT_COMPLETED
Yes No
0 of 0 users found this section helpful
Suggest Edit