Get Importation Status List

Description

This service is used to return a complete list of all import status for the logged-in party.


Request

Restrictions

This service requires an authenticated user and can only be called after a successful partner login.

Endpoint

GET https://<server-url>/api/v4/import/status

Parameters

Parameter
Location
Required
Description

touchpoint

Query / Header

Yes

The authentication token for the API session. Use Thalamus-Token for the header.

token

Query / Header

Yes

The authentication token for the API session. Use Thalamus-Token for the header.

page

Query / Header

No

The result page number to display. Default value is 1

pageSize

Query / Header

No

The result items to display per page. Default value is 25

orderBy

Query / Header

No

The column name used to order the results. Default value is ´name´

ascending

Query / Header

No

Indicates the order direction of the results. Default value is true

type

Query / Header

No

The import file type to filter.

name

Query / Header

No

The importation name set by the user.

beginDate

Query / Header

No

The inferior limit (inclusive) of the creation date restriction. Format yyyy-MM-dd

endDate

Query / Header

No

The superior limit (inclusive) of the creation date restriction. Format yyyy-MM-dd

state

Query / Header

No

The state id of the importation.

withErrors

Query / Header

No

Indicates to filter importation with at least one row with error.

Note: beginDate and endDate work together. Both parameters must be set to filter per creation date.

SUPPORTED STATE IDS:

  • Waiting = 1

  • Processing = 2

  • Processed = 3

  • Error in file format = 4

  • Configuration Pending = 5

  • Cancelled = 6

SUPPORTED IMPORT FILE TYPES:

  • Partner Sales = 25011

  • Partner Stock = 25012

  • Physical locations = 25006

  • Companies = 25004

Full URL Example

https://<server-url>/api/v4/import/status?touchpoint=test&token=...

Request Body

This request does not have a body.


Response

✅ Successful Response: 200 Ok

  • HTTP Status Code: 200 Ok

  • The full datasources information is returned

Example Response

JSON

{
    "totalSize": 130,
    "fileProcessorInfoElements": [
        {
            "id": 270,
            "fileType": "EXCEL",
            "importDate": 1749663723000,
            "userId": 1,
            "state": "PROCESSED",
            "rowsOk": 0,
            "rows": 2000,
            "rowsWithErrors": 2000,
            "rowsSkipped": 0,
            "percentageProcessed": 0,
            "totalToProcess": 0,
            "fileSize": 56,
            "url": "https://s3.amazonaws.com/thalamus-imports/mmorena/develop/2025-06-11-14-38-05__PARTNERSaleImporter_f17e7515b5fed7f07f62b1d26d5dc211.xlsx",
            "fileImportType": null,
            "name": "2025-06-11-14-38-05__PARTNERSaleImporter"
        },
        {
            "id": 269,
            "fileType": "EXCEL",
            "importDate": 1749661415000,
            "userId": 1,
            "state": "PROCESSED",
            "rowsOk": 0,
            "rows": 2000,
            "rowsWithErrors": 2000,
            "rowsSkipped": 0,
            "percentageProcessed": 0,
            "totalToProcess": 0,
            "fileSize": 48,
            "url": "https://s3.amazonaws.com/thalamus-imports/mmorena/develop/2025-06-11-13-58-45__PARTNERSaleImporter_12f7c14d15607b7423ce9dedd5a36274.xlsx",
            "fileImportType": null,
            "name": "2025-06-11-13-58-45__PARTNERSaleImporter"
        },
        {
            "id": 268,
            "fileType": "EXCEL",
            "importDate": 1749660562000,
            "userId": 1,
            "state": "PROCESSING",
            "rowsOk": 0,
            "rows": 0,
            "rowsWithErrors": 0,
            "rowsSkipped": 0,
            "percentageProcessed": 0,
            "totalToProcess": 0,
            "fileSize": 0,
            "url": null,
            "fileImportType": null,
            "name": "2025-06-11-13-49-16__PARTNERSaleImporter"
        }       ......,
		......,
		......,
        {
            "id": 229,
            "fileType": "EXCEL",
            "importDate": 1745606368000,
            "userId": 1,
            "state": "PROCESSED",
            "rowsOk": 5,
            "rows": 6,
            "rowsWithErrors": 1,
            "rowsSkipped": 0,
            "percentageProcessed": 0,
            "totalToProcess": 0,
            "fileSize": 7,
            "url": "https://s3.amazonaws.com/thalamus-imports/mmorena/develop/2025-04-25-15-36-08__Error-PARTNER-Physical-Location-Importer_6a89bbac2ce5c33c14f464e6bcefaa0d.xlsx",
            "fileImportType": null,
            "name": "2025-04-25-15-36-08__Error-PARTNER-Physical-Location-Importer"
        }
    ]
}

❌ Unsuccessful Response: 400 Bad Request

  • HTTP Status Code: 400 Bad Request

  • Body: A JSON object containing details about the error.

Example Response

JSON

{
  "errors": {
    "partnerDataSource": "TouchpointCodeRequired",
    "partnerDataSource": "InvalidTouchpointCode"
  }
}

Last updated

Was this helpful?