Endpoint - Config Test
This call is made when the test button is pressed in the user config. It should test the customer's integration is valid. It may also be used in automation jobs to check if there is a constant or global error.
When the config test button is pressed by a user we call 3 endpoints to ensure the channel is functioning.
Endpoint - Config Test
Endpoint - Shipping Tags
Endpoint - Payment Tags
Request
Post
ConfigTestRequest
ConfigTestRequest
Field Name | Type | Description |
---|---|---|
AuthorizationToken | String | Authorization Token from the customers integration. |
Sample
{
"AuthorizationToken": "0dfdbaf3e4d5434f825e774e31bcc148"
}
Response
ConfigTestResponse
ConfigTestResponse
Field Name | Type | Description |
---|---|---|
Error | String | If there was an error with the request. |
Sample
{
"Error": "User config does not exist"
}
Updated 21 days ago