/imports - Wherehouse API

List all file imports, includes statistics and feedback on the import.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Query Params

_limit

string

required

Total number of items to return. Maximum 100.

Example:

100

_start

string

required

Offset to return items from, used for pagination.

Example:

_sort

string

required

Field to sort by in the format field:asc or field:desc

Example:

end_time:desc

import_type

string

optional

Example:

repricer

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

meta

object

required

total

integer

required

limit

integer

required

start

integer

required

file_imports

object (File Import)

required

status

string

required

queued | in_progress | completed | failed | skipped

created_at

string

required

start_time

string

required

end_time

string

required

integer

required

import_type

string

required

repricer

platform

object (Connector Type)

required

created

integer

required

Number of items created

invalid

integer

required

Number of invalid items

processed

integer

required

Number of items processed

skipped

integer

required

Number of items skipped

updated

integer

required

Number of items updated

total

integer

required

Number of items submitted

trigger_type

string

required

public_api | csv | xlsx

uid

string

required

updated_at

string

required

Example

{
    "meta": {
        "total": 2,
        "limit": 100,
        "start": 0
    },
    "file_imports": [
        {
            "created": 0,
            "created_at": "2025-02-20T12:57:56.265Z",
            "end_time": "2025-02-20T12:57:57.488Z",
            "id": 60,
            "import_type": "repricer",
            "invalid": 0,
            "platform": {
                "created_at": "2021-08-24T12:07:27.562Z",
                "id": 1,
                "logo": "https://assets.wherehouse.co.za/connectors/logos/takealot.svg",
                "name": "Takealot",
                "uid": "takealot",
                "updated_at": "2024-11-18T09:43:37.203Z",
                "website": null
            },
            "processed": 2,
            "skipped": 2,
            "start_time": "2025-02-20T12:57:57.406Z",
            "status": "completed",
            "total": 2,
            "trigger_type": "public_api",
            "uid": "15147e5d-5ff0-4dd6-a90e-f98569cd1b90",
            "updated": 0,
            "updated_at": "2025-02-20T12:57:57.514Z"
        },
        {
            "created": 0,
            "created_at": "2025-02-20T12:56:57.582Z",
            "end_time": "2025-02-20T12:56:58.825Z",
            "id": 59,
            "import_type": "repricer",
            "invalid": 0,
            "platform": {
                "created_at": "2021-08-24T12:07:27.562Z",
                "id": 1,
                "logo": "https://assets.wherehouse.co.za/connectors/logos/takealot.svg",
                "name": "Takealot",
                "uid": "takealot",
                "updated_at": "2024-11-18T09:43:37.203Z",
                "website": null
            },
            "processed": 2,
            "skipped": 0,
            "start_time": "2025-02-20T12:56:58.627Z",
            "status": "completed",
            "total": 2,
            "trigger_type": "public_api",
            "uid": "f8650842-f925-423e-a3a2-bde5306b746c",
            "updated": 2,
            "updated_at": "2025-02-20T12:56:58.847Z"
        }
    ]
}