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.
Sample
https://api.kometsales.com/api/web.order.details.list? webOrderId=24323&customerId=7349& -H authenticationToken=token_info_goes_here
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.
{
"message":"OK",
"status":1,
"webOrders":[
{
"id":48,
"number":27,
"statusId":1,
"companyId":7030,
"userId":793,
"companyLocationId":13,
"customerId":7349,
"items":[
{
"id":"8b891222-5ce4-11e7-81aa-2ca9caf6766c",
"webOrderItemId":928343,
"webOrderItemType":1,
"imageUrl":"http://test.kometsales.com.s3.amazonaws.com/7030/product/217044_250x250.jpg?AWSAccessKeyId=AKIAJCADKODN6ZCRUIYQ&Expires=1498924690&Signature=E8QAUci0ibpj%2F2Jzaf2vXtcmpK4%3D",
"productDescription":"Agapanthus Silver Queen",
"quantity":1,
"price":7,
"totalPrice":14,
"deliverBy":"2017-06-29",
"carrierId":1661,
"carrierName":"Armellini Miami",
"shipName":"RSVP2",
"markCode":"",
"itemSizeId":2520,
"itemSizeCode":"FB",
"unitType":"Bunch",
"stemsBunch":2,
"pack":2
}
],
"subTotal":14,
"additionalCharges":0,
"total":14
}
]
}
Related Articles
-
Page:
-
Page:
-
Page:
-
Page:
-
Page:
-
Page:
-
Page:
-
Page:
-
Page: