Checkout a Web Order

Use this method to checkout a Web Order.

Valid Tokens: User.


Request


URL: 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 the Komet Sales team to get this ID. 


authenticationToken (required)(string:50)

Komet Sales security token.


Input parameters

customerId (required)(integer:20)

Customer ID.

Use this parameter to search orders from a specific Customer.

You can get this value from the customer.list API method.


webOrderId (required)(integer:20)

Web Order ID.


customerPo (optional)(integer:50) 

Customer Purchase Order number.


companyLocationId (integer:20)

Location ID.

Only applies to Multi-Location Companies.

You can get this value from the location.list API method.


{ "customerId": 7343, "webOrderId": 48, "customerPo": "292644" }

Response


message (string) 

Transaction status description.


webOrderId (integer) 

Web Order ID.


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


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