Overview

This method returns a list of Web Orders with their corresponding details. Keep in mind that this method only works with user's tokens.

Request

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

  • Method: GET
  • Content-Type: URL Params

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): Web Order ID that you want to get the details. 
  • companyLocationId: Required if the company is in Multi Location mode. You can obtain this value from the location.list API method.
  • statusId (optional) (integer: 1): 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 yet. 


Response

Output:

    • message (String) : description of the transaction status.
    • status (integer:1): transaction status. 1 for success or 0 for failure.
    • webOrders (Array): array of Web Orders created in Komet Sales.
      • id (integer: 20): Internal Web Order ID. 
      • number (integer: 10): Number of the Web Order. 
      • statusId (integer: 1): Status of the Web Order. 1 = Pending, 2 = confirmed (checked out).
      • companyLocationId (integer: 10): Location where belongs the order from. Only valid for companies in Multi Location mode. 
      • customerId (integer: 10): Id of the customer that owns the web order. 
      • subtotal (decimal:10,2): total of the order. This amount does not include Additional Charges nor taxes.
      • additionalCharges (decimal:10,2): total of additional charges.
      • total (decimal:10,2): total of the order. Subtotal + additionalCharges + taxes.
      • items (array): array of items that are associated to the web order. 
        • id (string): ID that identifies the row between all the records of the result. 
        • webOrderItemId (integer): If the web order item id. 
        • webOrderItemType (integer: 1) 0 if it's an invoice item (invoice), 1 if it's a prebook item. 
        • imageUrl (string): URL for the product image. 
        • 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. Unit Price times total units.
        • deliveryBy (date): Date when the order is delivered. (date format YYYY-MM-DD).
        • carrierId  (integer:20): carrier Komet Sales internal ID.
        • carrierName (string:200): carrier name.
        • shipName (string:200): Ship to name.
        • markCode (string: 50): Mark code associated to the order. Also called order name. 
        • itemSizeId (integer: 10): Id of the Box Type. 
        • itemSizeCode (string: 3): Box type code (HB, QB, FB, etc). 
        • unitType (string: 10): Stem or Bunch. 
        • stemsBunch (integer: 10): Number of stems per bunch. 
        • pack (integer: 10): Number of units per box.
        • 🔒 lineStatus (string: 20): Determines the product status. Possible Values: Pending Checkout, Pending Confirmation, Confirmed, Shipped. 
        • 🔒 referenceNumber (string: 20): Reference number or tracking number associated to the order when the product is already billed. 
        • 🔒 orderNumber(integer:10): Order number associated to the web order. It is returned when the inventoryOrigin is 1 (OH)
        • 🔒 prebookNumber(integer:10) Prebook number associated to the web order. It is returned when the inventoryOrigin is 2 (FS)

🔒 Fields with this icon are only available when the token has the Transactional API Access enabled. For more info, please visit the Transactional API Access page.