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

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

❌ Unsuccessful Response: 400 Bad Request

  • HTTP Status Code: 400 Bad Request

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

Example Response

JSON

Last updated

Was this helpful?