Skip to main content
GET
Get category import status

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

domain
string
required

The brand domain name (for example, vessel.com or containerstore.com) used to scope the request to a specific brand's data and configuration. The authenticated principal must be authorized for the specified brand.

Example:

"vessel.com"

Path Parameters

import_id
string<uuid>
required

Import ID returned from POST /api/v2/categories/import.

Example:

"a0cf63a0-55b8-4a25-9218-d972d4d65a79"

Response

Import status

import_id
string<uuid>
required
status
string
required
Example:

"COMPLETED"

total_rows
integer
required
Example:

333

processed_rows
integer
required
Example:

333

created_at
string<date-time>
required
name
string
Example:

"tcs_category_test.csv"

new_count
integer
Example:

333

updated_count
integer
Example:

0

skipped_count
integer
Example:

0

failed_count
integer
Example:

0

input_filename
string
Example:

"tcs_category_test.csv"

input_file_url
string<uri> | null
Example:

"https://example.com/input.csv"

error_file_url
string<uri> | null
Example:

null

error_message
string | null
Example:

null

started_at
string<date-time> | null
completed_at
string<date-time> | null