Get Template

Description

This service gets a file template


Request

Restrictions

Can only be called after a successful login as it Requires an authenticated user

Endpoint

GET https://<server-url>/api/v4/import/template/{type}

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.

type

Query / Header

Yes

Type of the file to import

SUPPORTED IMPORT FILE TYPES:

  • Partner Sales = 25011

  • Partner Stock = 25012

  • Physical locations = 25006

  • Companies = 25004

Full URL Example

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

Request Body

This request does not have a body.


Response

✅ Successful Response: 200 Ok

  • HTTP Status Code: 200 Ok

  • Data from the consulted file

❌ 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?