Endpoint - Ticket Preview
Ticket preview API may show different totals sometimes. The reason is related to the tax total. Different inventory batches may have different taxes applied to them. There could be a time gap when you previewed the order and you actually placed the order. The batch you previewed the order total from may have been sold out and the actual order might have been placed from the different batch having different taxes.
Various types of tickets that Treez current accepts
It returns the unique identifier for the ticket. Required for updating the information of existing ticket.
The customer facing order ID that is referred as receipt number on the ticket.
This is an optional field and can be used by the integration partner for additional tracking. Order ID of the external integrating system.
This tells the source used to place the order.
This tells the information of the employee who created the ticket. Blank for online orders, kiosk, API etc.
It brings in the employee id who has processed the order.
It returns the full name of the employee.
It tells the employee’s role.
The field refers to the Member ID of the customer making the purchase. Blank if no customer is selected.
Tells the patient type at the time the sale was completed.
It returns the cash Register Number, or ONLINE_ORDER, KIOSK, EXTERNAL in the case it was created via API.
It reads the current status of the order. The only options that are accepted are:
It tells if the ticket is pre-paid or not. The only value it accepts are:
It returns the date when the ticket was created. It is a system generated value.
It returns the date when the ticket was last updated in the Treez POS. It is a system generated value.
It returns the date when the ticket was completed, abandoned or cancelled. It is a system generated value.
It returns the sum of all line items and fees without tax.
It returns the value of the total tax applied on the ticket.
It returns the value of the total discount applied on the ticket.
It returns the due amount i.e., the grand total.
It could be a note left by cashier during checkout or a note from the external partner while posting the ticket.
THIS IS THE FRESH
It returns the reason if entered at the time of a refund via POS.
THE ITEM WAS
This value is only returned for refunded tickets. It refers to the parent ticket_id against which a refund was made.
It refers to the Pickup or Delivery address entered when the order was processed.
It returns the address id for the particular address.
It records the address for the pick up or delivery order types.
7000 Coliseum Way
This is the 2nd field available for street value of an address. This usually denotes the suite or apartment number for a delivery address.
It records the city name.
Optional field that is applicable only to delivery_address in orders of type DELIVERY.
Required for dynamic sales tax calculation.
It records the 2-letter state code.
It records the ZIP number for the area. 5 digits in general.
It refers the delivery or pickup scheduled time.
It includes all the items ordered in the ticket.
It refers to the product unique id. Can be used to track the product from product API.
This returns the barcode at the product level. It is visible ID that can be scanned to identify the product such as SKU.
[ "z3tM", "Y2tM" ]
This returns the barcode at the inventory level. It is a visible ID that can be scanned to identify the product and particular shipment such as SKU.
[ "W23r", "Y85t" ]
This is the field to identify the inventory location.
FRONT OF HOUSE
It is the unique identification of the product. It can be retrieved from the Product API as the data point product_id.
It returns the name of the exact product ordered.
It refers to the quantity of the particular item ordered in the ticket.
It tells the total price for the line including discounts and tax.
It returns the unit price excluding discounts and excluding tax.
It returns the unit of measure of the product say each, gm etc.
This field refers to the automatic discounts that are applied to the product when entered to a cart unless removed. This takes in either TRUE or FALSE. The value by default is kept as TRUE to support the POS behavior.
This refers to the discount that can be applied at the POS per line item.
It reads in the name of the discount to be applied.
It takes in the amount value for the discount to be applied. Amount value can either be a dollar value or the percentage value.
It reads in the specified method for the amount entered. It only reads DOLLAR or PERCENT.
This returns the list of all the discounts applied per line item.
It returns the name of the discount.
It returns the amount value for the discount for the line item.
It tells the discount method for the amount. It is always either DOLLAR or PERCENT.
This is always the dollar value that tells the total savings done after the discount is applied.
List the various type of discounts applied to a ticket.
It returns the value of the particular id of the tax applied to the ticket line.
It tells the value of tax rate in percentage.
Display the name of the tax applied.
It tells the amount value in dollars applied for the particular tax.
It can be used for pricing adjustment. It overrides the price_sell and all taxes/fees will be calculated over it. If target_price is set, all other applied discounts will be ignored.
Note associated with the target price adjustment.
I've set the price target,
It reads in the name of the fee type applied.
It takes in the amount value for the fee applied. Amount value is a dollar value.
It tells if the ticket counts towards reward points or not.
If the ticket is eligible it returns the value of the points earned.
It returns the reward points used in the particular order.
It includes the payment details for the ticket.
It returns the payment id of the particular payment posted.
This refers to the source via which payment is posted and accomplished.
It reads the payment method used to accomplish the payment for the ticket. In the case of refunds, the method is always going to be CASH.
The amount value paid by the customer using the particular method.
The timestamp when the payment was submitted. It reads the format yyyy-mm-dd.
It reads the consumed products in a day. All items consumed will be reflected in their respective purchase limit groups.
NO ticket can be created for customers who reach/exceed their purchase limits.
Some CA stores are an exception to this rule. If medical customer are allowed to exceed purchase limits because of a prescription from a doctor you can generate a ticket over the recommended purchase limit without encountering an error.
It reads the consumed value for the 'concentrated' in the particular ticket.
It reads the consumed value for the 'non_concentrated' in the particular ticket.
It reads the consumed value for the 'plant' in the particular ticket.
This Array provides the partner the ability to add additional data about the driver, car and route that is being taken for a delivery
This field is used to contain the name of the driver completing the delivery
Occupational license for the delivery driver.
Drivers license of the delivery driver
The phone number that should be used when the Driver or customer have questions.
Make of the car completing the delivery.
Model of the car completing the delivery.
License plate number for the car making the delivery
This should be the estimated departure time of the delivery.
This should be the estimated arrival time of the delivery.
This array provides the multiple legs and steps for the process of making the delivery.
The Legs array contains the multiple steps that are necessary for completing a delivery.
The Steps array details the necessary route you are taking for a leg of the journey.
This field details what is necessary to do to complete the step in a leg of a route.
Head \u003cb\u003enorth<br /> u003c/b\u003e on \u003cb\u003eS Morgan St\u003c/b\u003e toward \u003cb\u003eW Cermak Rd\u003c/b\u003e
This array provides the necessary distance to complete each step in the planned_route.
This field provides the distance for each step.
VIN of the car making the delivery
This is an editable field that allows partners to associate transactions with employees that have a profile in Treez. Employee ID equates to the employee # which can be found on the user management page of Sell Treez.
This editable field allows partners to associate orders with a certain cash drawer when creating or updating tickets. Once the order has been completed, the numbers for that transaction will be displayed in the drawer the partner associated it with.
This field should only be used with customers who are using the Stronghold TreezPay feature of Treez. When a ticket payment_authorization is marked as 'true', SH has to run a check to make sure the customer's bank account is active, accessible, and has the required funds for the transaction. At this step, SH will not place a hold on the funds nor will they withdraw funds from a customer's account.
Updated about 1 month ago