Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Excerpt

This method allows you to create a Web Order in Komet Sales. This API method only allows you to create the header of the order. If you want to add items to the order you may better want to use web.order.item.add. Keep in mind that this method only works with user's tokens.

Request

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

  • 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. You can obtain this value from the customer.list API method.
  • companyId (required) (integer 10): The ID of the company.
  • companyLocationId (integer:20): Required if the company is in Multi Location mode. You can obtain this value from the location.list API method.


JSON Viewer
width100%
languagejs
themeConfluence
titleSample
{ 
   "customerId": 7122, 
   "companyId": 12333,
   "companyLocationId": 13
}

Response

Output:

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

JSON Viewer
width100%
languagejs
themeConfluence
titleSample
{
        "message":"Web order was successfully created.",
        "status": 1,
        "webOrderId": 30200
}



Panel
titleRelated Articles

Content by Label
showLabelsfalse
max10
showSpacefalse
sorttitle
cqllabel in ("web-order","create-web-order","ecommerce-lite","api","ecommerce")
labelsecommerce api create-web-order ecommerce-lite web-order