Overview

This method allows check out a Web Order. Please keep in mind that this method only works with user's tokens.

Request

https://api.kometsales.com/api/web-order.checkout

  • Method: POST
  • Content-Type: application/json

Headers

  • X-SALES-CHANNEL (optional) (string: 20): Valid values: "WEB_APP", "MOBILE_APP", "K2K" , "ECOMMERCE_LITE". 
  • X-ACCOUNT (required)(integer:20): Company ID that is using the API. Please ask Komet Sales team to have this ID. 
  • authenticationToken (required)(string:50): Komet Sales security token.

Input parameters:

  • customerId (required)(integer:20): customer ID used to search orders from only one customer. You can obtain this value from the customer.list API method.
  • webOrderId (required)(integer:20): The ID of the Web Order that you want to check out on Komet Sales.

 

Sample
{ 
     "customerId": '7349',
     "webOrderId": 48
}

Response

Output:

    • message (String) : description of the transaction status.
    • webOrderId: The ID of the Web Order created on Komet Sales.
    • status (integer:1): transaction status. 1 for success or 0 for failure.

Sample
{
 "message":"The Web Order was successfully checked out.",
 "webOrderId":48,
 "status":1
}