| Anchor | ||||
|---|---|---|---|---|
|
| Excerpt | ||
|---|---|---|
Use this method 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 an order, you must use the Add Items to a Web Order.
| Info |
|---|
Invoices created through this method are subject to a transaction fee. Internal company transactions are generally exempt from this transaction fee. |
Table of Contents
| Table of Contents | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Request
URL: https://api.kometsales.com/api/web-order.create
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 get this ID.
authenticationToken (required)(string:50)
Komet Sales security token.
Input parameters
customerId (required)(integer:20)
Customer ID.
You can get this value from the customer.list API method.
companyId (required)(integer 10)
Company ID.
companyLocationId (required)(integer:20)
Location ID.
Only applies to Multi-Location Companies.
You can get this value from the location.list API method.
| Code Block |
|---|
{
"customerId": "7122",
"companyId": "12333",
"companyLocationId": "13"
} |
Response
message (string)
Transaction status description.
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure
webOrderId (integer)
Komet Sales internal Web Order ID.
| Code Block |
|---|
{
"message": "Web order was successfully created.",
"status": "1",
"webOrderId": "30200"
} |
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|
...