Skip to content

Import Status

If an import exceeds the maximum duration, a 202 ACCEPTED response will be returned containing information regarding the import. This information contains an id, which can be used to continuously poll the status of the import.

Method

GET

URL format

/api/v2/import/status/{id}

Parameters

Name Type Description Example
id string The id of the import. 5537431447739019570

Required headers

The header Api-Key is required.

Request body

N/A

Request content-type

N/A

Response content-type

application/json

Responses

Response Description
200 Import information serialised to JSON.
403 Api-Key could not be validated.
404 Cluster not found.
5xx Server error such as cluster unavailable or busy. The response body may contain more information about the error.

Import information

Name Type Description Example
id string The id of the import. 5537431447739019570
status string The progression status of the import. Can be NOT_FOUND, WAITING, BLOCKED, IN_PROGRESS, SUCCESS, FAILURE, and ABORTED IN_PROGRESS
type string The entity type that is being handled in the import. PRODUCTS
reason string Potential error message of a failed import. Import failed.

Example

Request

cURL

#!/bin/bash
curl -i \
-X GET \
-H "Api-Key: {PRIVATE-KEY}" \
"https://{cluster-id}.api.esales.apptus.cloud/api/v2/import/status/5300580843122327405"

Response

{
    "id": "5300580843122327405",
    "status": "WAITING",
    "type": "PRODUCTS"
}

Last update: January 19, 2021
Back to top
×
Copyright

This online publication is intellectual property of Apptus Technologies. Its contents can be duplicated in part or whole, provided that a copyright label is visibly located on each copy and the copy is used in conjunction with the product described within this document.

All information found in these documents has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither Apptus Technologies nor the authors shall be held liable for possible errors or the consequences thereof.

Software and hardware descriptions cited in these documents might be registered trademarks. All trade names are subject to copyright restrictions and may be registered trademarks. Apptus Technologies essentially adheres to the manufacturer’s spelling. Names of products and trademarks appearing in this document, with or without specific notation, are likewise subject to trademark and trade protection laws and may thus fall under copyright restrictions.

CLOSE