Page Comparison

Table of Contents

Request

URL: https://theexternalsystem.com

Content-Type: URL Parametersapplication/JSON

Method: GETPOST

Parameters

invoiceId (required)(integer)

Komet Sales internal Invoice ID.

Header

authenticationToken (string:50)

Komet Sales Internal Company IDToken. You can use this optional parameter to identify yourself when integrating with external systems or extract it from the token. The method chosen will depend on your specific operation.

Body

token orderId (optional)(stringlong)

Komet Sales internal order ID.

companyId (long)

Komet Sales Company Token. You can use this optional parameter to identify yourself when integrating with external systems or extract it from the token. The method chosen will depend on your specific operation.

URL Example

internal Company ID.

Request Example

{
   "companyId":6316,
   "orderId":6908
}

Response

Content-Type: application/JSON

Body

status (boolean)

Result of the request.

Valid values: 0 = Error | 1 = Success

message (string)

In this parameter, you can enter a customized message describing the status. This message will be reflected in Komet Sales.

error (string)

In this parameter, you can parameter allows you to enter a customized error message describing the status. This The message will be reflected in Komet Sales.

Response

Example

Success

{
   "status":"1",
   "message":"<<Custom Success Message>>"
}

Error

{
   "status":"0",
   "error":"<<Custom Error Message>>"
}

Step two: Set up the Order

Cancellation Webhook

Once you have created the endpoint in your system, you need to add it to your Komet Sales account.

To add your endpoint, do the following instructions:

1. Go to Setup and select Settings.

2. Click on Order Confirmation WebhookWebhooks from the Integrations group of settings.

3. Select Order Cancellation from the dropdown list.

4. Enter the URL that Komet Sales will call when orders are confirmedthis webhook is triggered.

5. Select your authentication type:

   1. Basic. Enter your username and password.

   2. Bearer Token. Enter your authentication token.

6. Enter the email addresses that the system will notify when an error occurs in the external system in the Error Notification field. You can enter up to 5 email addresses.

7. Click on Save.

Notification sample

This is an example of the email notification the users will receive.