URL: https://api.kometsales.com/api/web-order-details.list

Method: GET

Content-Type: URL Parameters

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)

Komet Sales internal Web Order ID.. 

companyLocationId (required)(integer:10)

Location ID.

Only applies to Multi-Location Companies.

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

statusId (optional)(integer:1)

Order status.

Valid values: 1 = Pending | 2 = Checked-Out

If this value is not sent, the system will only return information for orders that have not been checked out.

message (string)

Transaction status description.

status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure

webOrders (array)

An array containing Web Orders created in Komet Sales.

id (integer:20)

Komet Sales Internal Web Order ID. 

number (integer:10)

Web Order number.

statusId (integer:1)

Web Order status.

Valid values: 1 = Pending | 2 = Confirmed

companyLocationId (integer:10)

Order location.

Only applies to Multi-Location Companies. 

customerId (integer:10)

Web Order Customer ID. 

subtotal (decimal:10,2)

Order subtotal.

This amount does not include additional charges or taxes.

additionalCharges (decimal:10,2)

Total additional charges.

total (decimal:10,2)

Order total.

Calculated with: subtotal + additionalCharges + taxes.

items (array)

An array of items that are associated with the web order. 

id (string)

ID that identifies the row between all the records of the result. 

webOrderItemId (integer)

Komet Sales internal Web Order Item ID. 

webOrderItemType (integer:1)

Item type.

Valid values: 0 = Invoice | 1 = Prebook

imageUrl (string)

Product image URL.

productDescription (string:200)

Product description. 

quantity (integer:10)

Total boxes. 

price (decimal:10,3)

Unit price. 

totalPrice (decimal:10,2)

The amount of the product line.

Calculated with: Unit Price x Total Units

deliveryBy (date)

Date when the order will be delivered.

Date format: YYYY-MM-DD

carrierId  (integer:20)

Komet Sales internal Carrier ID.

carrierName (string:200)

Carrier name.

shipName (string:200)

Ship-To name.

markCode (string:50)

Mark code associated to the order, also known as order name. 

itemSizeId (integer:10)

Box Type ID. 

itemSizeCode (string:3)

Box type code.

For example: HB, QB, or FB. 

unitType (string:10)

Unit type.

Valid values: Stem or Bunch. 

stemsBunch (integer:10)

Number of Stems per Bunch. 

pack (integer:10)

Number of Units per Box.

🔒lineStatus (string:20)

Product status.

Valid values: Pending Checkout, Pending Confirmation, Confirmed, Shipped. 

🔒referenceNumber (string:20)

Order reference or tracking number when the product is already billed. 

🔒orderNumber(integer:10)

Web Order order number. 

It is returned when inventoryOrigin = 1 (OH).

🔒prebookNumber(integer:10)

Web Order Prebook number.

It is returned when inventoryOrigin = 2 (FS).