Overview

This method allows to 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-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.
  • customerPo (optional) (string)(integer:50): customer PO number.
  • companyLocationId (integer:20): Required if the company is in Multi Location mode. You can obtain this value from the location.list API method.


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.