Orders
Get All Orders
get /ordersUse fields to only query the information needed for your use case. Use filter eshopid
to only query orders for one site.
Filter on eshop ID, use comma as separator for multiple values.
Filter on external ID, use comma as separator for multiple values.
Filter on orders with matching order ID, use comma as separator for multiple values.
Filter on order with matching receipt ID. Note! If this parameter is used, it will override the orderid
parameter.
Filter on orders with matching credit order ID, used for being able to validate what has been returned for an order. Note! If this parameter is used, it will override the orderid
parameter.
Filter on orders with order ID higher than or equal to the value provided
Filter on orders with order ID lower than the value provided
Filter on orders with order date starting from the timestamp provided
Filter on orders with order date ending with the timestamp provided
Filter on order state, use comma as separator for multiple values.
Filter on payment state, use comma as separator for multiple values.
Filter on order type, use comma as separator for multiple values.
Filter on order with matching warehouseid
property, use comma as separator for multiple values.
Filter on customer email address.
The index of the item to start from
The number of items returned
Sort the result.
- orderid
- -orderid
Comma separated list of fields to return. Use this to query only the fields you are using. See Order for all fields.
{ "totalcount": 1514, "items": [ { "orderid": 11513, "eshopid": 1, "email": "", "namefirst": "", "namelast": "", "company": "", "moneyfinal_net": "14.15", "moneyfinal_vat": "0.85", "moneytotal_gross_roundoff": "0.00", "moneytotal_gross_all": "15.00", "checkouttypename": "Sitoo POS - Card", "deliverytypename": "", "orderdate": 1463041119, "orderstateid": 10, "paymentstateid": 20, "ordertypeid": 10, "registerid": "{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}", "warehouseid": 1, "datereserved": null, "currencycode": "USD", "additionaldata": {}, "orderitems": [ { "orderitemid": 0, "orderitemtype": 10, "productid": 24, "productname": "Cookbook", "sku": "121292-4", "productattributes": "", "externalinput": "", "externalinputtitle": "", "unitlabel": "", "quantity": 1, "decimalunitquantity": null, "moneynetpriceperunit": "14.15", "moneypriceorg": "0.00", "vatvalue": 6, "deliveryinfo": "", "moneyitemtotal_net": "14.15", "moneyitemtotal_vat": "0.85", "voucherid": 0, "vouchercode": "", "vouchername": "", "moneyoriginalprice": "14.15", "moneydiscountedprice": "0.00", "moneydiscount": "0.00", "salestaxes": [], "additionaldata": {}, "decimalquantitytotal": "1.000", "moneynetpriceperquantity": "14.15" } ], "payments": [ { "name": "Card", "moneyamount": "15.00", "externalid": "123456", "reftype": "verifonelpp", "refid": "160512095647 000046160830", "cardissuer": "Mastercard", "additionaldata": {} } ] }, { "orderid": 11512, "eshopid": 1, "email": "", "namefirst": "", "namelast": "", "company": "", "moneyfinal_net": "-2392.00", "moneyfinal_vat": "-598.00", "moneytotal_gross_roundoff": "0.00", "moneytotal_gross_all": "-2990.00", "checkouttypename": "Sitoo POS - Card", "deliverytypename": "", "orderdate": 1463041119, "orderstateid": 10, "paymentstateid": 20, "ordertypeid": 10, "registerid": "{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}", "warehouseid": 1, "datereserved": null, "currencycode": "USD", "additionaldata": { "refundreasoncode-reasoncode": "RC123", "refundreasoncode-comment": "Guarantee" }, "orderitems": [ { "orderitemid": 0, "orderitemtype": 10, "productid": 19, "productname": "Coffee Table", "sku": "44079-0", "productattributes": "", "externalinput": "", "externalinputtitle": "", "unitlabel": "", "quantity": -1, "decimalunitquantity": null, "moneynetpriceperunit": "2392.00", "moneypriceorg": "0.00", "vatvalue": 25, "deliveryinfo": "", "moneyitemtotal_net": "-2392.00", "moneyitemtotal_vat": "-598.00", "voucherid": 0, "vouchercode": "", "vouchername": "", "moneyoriginalprice": "2392.00", "moneydiscountedprice": "0.00", "moneydiscount": "0.00", "salestaxes": [], "additionaldata": {}, "decimalquantitytotal": "-1.000", "moneynetpriceperquantity": "2392.00" } ], "payments": [ { "name": "Card", "moneyamount": "-2900.00", "externalid": "123456", "reftype": "verifonelpp", "refid": "160512094850 000046160832", "cardissuer": "Mastercard", "additionaldata": {} } ] } ]}
HTTP Status Code Summary | |
---|---|
200 | Returns an envelope with items of type Order. |
400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
401 | Unauthorized. Authorization failed. |
404 | Resource not found. The url is invalid. |
429 | Too Many Requests. |
500 | Internal Server Error. |
Add Order
post /sites/{siteid}/ordersNote! You can't delete an order, set orderstate to cancelled instead.
{ "ordertypeid": 10, "namefirst": "John", "namelast": "Smith", "company": "Company Inc", "phone": "555-1451", "email": "john.smith@example.com", "currencycode": "USD", "orderitems": [ { "productname": "Sofa Cosy", "sku": "10038-2", "quantity": 1, "moneyrowprice": "125.00", "vatvalue": 25 }, { "productname": "Sofa Cosy", "sku": "83428-0", "quantity": 2, "moneyrowprice": "250.00", "moneyrowdiscount": "50.00", "vatvalue": 25 }, { "productname": "Sofa Stressless", "sku": "83537-0", "quantity": 1, "moneyrowprice": "106.00", "vatvalue": 6 } ]}
11514
HTTP Status Code Summary | |
---|---|
200 | Returns orderid |
400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
401 | Unauthorized. Authorization failed. |
404 | Resource not found. The url is invalid. |
429 | Too Many Requests. |
500 | Internal Server Error. |
Get Orders
get /sites/{siteid}/ordersNOTE! Deprecated in favor of /orders
(Get All Orders)
Filter on externalid, use comma as separator for multiple values.
Filter on orders with matching orderid, use comma as separator for multiple values.
Filter on orders with orderid higher than or equal to the value provided
Filter on orders with orderid lower than the value provided
Filter on orders with orderdate starting from the timestamp provided
Filter on orders with orderdate ending with the timestamp provided
Filter on order state, use comma as separator for multiple values.
Filter on payment state, use comma as separator for multiple values.
Filter on order type, use comma as separator for multiple values.
Filter on customer email address.
The index of the item to start from
The number of items returned
Sort the result.
- orderid
- -orderid
Comma separated list of fields to return. Use this to query only the fields you are using. See Order for all fields.
{ "totalcount": 1514, "items": [ { "orderid": 11513, "email": "", "namefirst": "", "namelast": "", "company": "", "moneyfinal_net": "14.15", "moneyfinal_vat": "0.85", "moneytotal_gross_roundoff": "0.00", "moneytotal_gross_all": "15.00", "checkouttypename": "Sitoo POS - Card", "deliverytypename": "", "orderdate": 1463041119, "orderstateid": 10, "paymentstateid": 20, "ordertypeid": 10, "registerid": "{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}", "warehouseid": 1, "datereserved": null, "currencycode": "USD", "additionaldata": {}, "orderitems": [ { "orderitemid": 0, "orderitemtype": 10, "productid": 24, "productname": "Cookbook", "sku": "121292-4", "productattributes": "", "externalinput": "", "externalinputtitle": "", "unitlabel": "", "quantity": 1, "decimalunitquantity": null, "moneynetpriceperunit": "14.15", "moneypriceorg": "0.00", "vatvalue": 6, "deliveryinfo": "", "moneyitemtotal_net": "14.15", "moneyitemtotal_vat": "0.85", "voucherid": 0, "vouchercode": "", "vouchername": "", "moneyoriginalprice": "14.15", "moneydiscountedprice": "0.00", "moneydiscount": "0.00", "salestaxes": [], "additionaldata": {}, "decimalquantitytotal": "1.000", "moneynetpriceperquantity": "14.15" } ], "payments": [ { "name": "Card", "moneyamount": "15.00", "externalid": "123456", "reftype": "verifonelpp", "refid": "160512095647 000046160830", "cardissuer": "Mastercard", "additionaldata": {} } ] }, { "orderid": 11512, "email": "", "namefirst": "", "namelast": "", "company": "", "moneyfinal_net": "-2392.00", "moneyfinal_vat": "-598.00", "moneytotal_gross_roundoff": "0.00", "moneytotal_gross_all": "-2990.00", "checkouttypename": "Sitoo POS - Card", "deliverytypename": "", "orderdate": 1463041119, "orderstateid": 10, "paymentstateid": 20, "ordertypeid": 10, "registerid": "{3CCB9848-155A-49E1-7CA8-5F7F78FC3067}", "warehouseid": 1, "datereserved": null, "currencycode": "USD", "additionaldata": { "refundreasoncode-reasoncode": "RC123", "refundreasoncode-comment": "Guarantee" }, "orderitems": [ { "orderitemid": 0, "orderitemtype": 10, "productid": 19, "productname": "Coffee Table", "sku": "44079-0", "productattributes": "", "externalinput": "", "externalinputtitle": "", "unitlabel": "", "quantity": -1, "decimalunitquantity": null, "moneynetpriceperunit": "2392.00", "moneypriceorg": "0.00", "vatvalue": 25, "deliveryinfo": "", "moneyitemtotal_net": "-2392.00", "moneyitemtotal_vat": "-598.00", "voucherid": 0, "vouchercode": "", "vouchername": "", "moneyoriginalprice": "2392.00", "moneydiscountedprice": "0.00", "moneydiscount": "0.00", "salestaxes": [], "additionaldata": {}, "decimalquantitytotal": "-1.000", "moneynetpriceperquantity": "2392.00" } ], "payments": [ { "name": "Card", "moneyamount": "-2900.00", "externalid": "123456", "reftype": "verifonelpp", "refid": "160512094850 000046160832", "cardissuer": "Mastercard", "additionaldata": {} } ] } ]}
HTTP Status Code Summary | |
---|---|
200 | Returns an envelope with items of type Order. |
400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
401 | Unauthorized. Authorization failed. |
404 | Resource not found. The url is invalid. |
429 | Too Many Requests. |
500 | Internal Server Error. |
Get Order
get /sites/{siteid}/orders/{orderid}{ "orderid": 11514, "eshopid": 1, "externalid": null, "creditorderid": null, "checkouttypeid": 0, "deliverytypeid": 0, "email": "john.smith@example.com", "namefirst": "John", "namelast": "Smith", "personalid": "", "company": "Company Inc", "phone": "555-1451", "invoice_address": "", "invoice_address2": "", "invoice_zip": "", "invoice_city": "", "invoice_state": "", "invoice_countryid": "", "delivery_address": "", "delivery_address2": "", "delivery_zip": "", "delivery_city": "", "delivery_state": "", "delivery_countryid": "", "comment": "", "commentinternal": "", "customerref": "", "checkoutref": "", "moneytotal_net": "360.00", "moneytotal_vat": "71.00", "moneycheckout_net": "0.00", "moneycheckout_vat": "0.00", "moneytotal_gross_checkout": "0.00", "moneydelivery_net": "0.00", "moneydelivery_vat": "0.00", "moneytotal_gross_delivery": "0.00", "moneyfinal_net": "360.00", "moneyfinal_vat": "71.00", "moneyfinal_salestax": "0.00", "moneytotal_gross_roundoff": "0.00", "moneytotal_gross_all": "431.00", "checkouttypename": "", "checkoutmethodid": 0, "checkoutmethodsubid": 0, "deliverytypename": "", "orderdate": 1550669772, "orderstateid": 0, "paymentstateid": 0, "ordertypeid": 10, "userid_staff": null, "registerid": null, "warehouseid": null, "datereserved": null, "currencycode": "USD", "additionaldata": {}, "orderitems": [ { "orderitemid": 0, "orderitemtype": 10, "productid": 14, "productname": "Sofa Cosy", "sku": "10038-2", "productattributes": "", "externalinput": "", "externalinputtitle": "", "unitlabel": "", "quantity": 1, "decimalunitquantity": null, "moneynetpriceperunit": "100.00", "moneypriceorg": "0.00", "vatvalue": 25, "deliveryinfo": "", "moneyitemtotal_net": "100.00", "moneyitemtotal_vat": "25.00", "voucherid": 0, "vouchercode": "", "vouchername": "", "moneyoriginalprice": "100.00", "moneydiscountedprice": "0.00", "moneydiscount": "0.00", "salestaxes": [], "additionaldata": {}, "decimalquantitytotal": "1.000", "moneynetpriceperquantity": "100.00" }, { "orderitemid": 1, "orderitemtype": 10, "productid": 16, "productname": "Sofa Cosy", "sku": "83428-0", "productattributes": "", "externalinput": "", "externalinputtitle": "", "unitlabel": "", "quantity": 2, "decimalunitquantity": null, "moneynetpriceperunit": "80.00", "moneypriceorg": "0.00", "vatvalue": 25, "deliveryinfo": "", "moneyitemtotal_net": "160.00", "moneyitemtotal_vat": "40.00", "voucherid": 0, "vouchercode": "", "vouchername": "", "moneyoriginalprice": "100.00", "moneydiscountedprice": "80.00", "moneydiscount": "20.00", "salestaxes": [], "additionaldata": { "orderitem-moneyrowdiscount": "50.00" }, "decimalquantitytotal": "2.000", "moneynetpriceperquantity": "80.00" }, { "orderitemid": 2, "orderitemtype": 10, "productid": 15, "productname": "Sofa Stressless", "sku": "83537-0", "productattributes": "", "externalinput": "", "externalinputtitle": "", "unitlabel": "", "quantity": 1, "decimalunitquantity": null, "moneynetpriceperunit": "100.00", "moneypriceorg": "0.00", "vatvalue": 6, "deliveryinfo": "", "moneyitemtotal_net": "100.00", "moneyitemtotal_vat": "6.00", "voucherid": 0, "vouchercode": "", "vouchername": "", "moneyoriginalprice": "100.00", "moneydiscountedprice": "0.00", "moneydiscount": "0.00", "salestaxes": [], "additionaldata": {}, "decimalquantitytotal": "1.000", "moneynetpriceperquantity": "100.00" } ], "payments": [], "orderlogitems": [ { "datelog": 1550669772, "orderlogtypeid": 0, "strvalue": null, "fvalue": null } ]}
HTTP Status Code Summary | |
---|---|
200 | Returns an item of type Order. |
400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
401 | Unauthorized. Authorization failed. |
404 | Resource not found. The url is invalid. |
429 | Too Many Requests. |
500 | Internal Server Error. |
Update Order
put /sites/{siteid}/orders/{orderid}{ "namefirst": "Adam", "namelast": "Smith"}
true
HTTP Status Code Summary | |
---|---|
200 | Returns true |
400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
401 | Unauthorized. Authorization failed. |
404 | Resource not found. The url is invalid. |
429 | Too Many Requests. |
500 | Internal Server Error. |
Get All Order Deliveries
get /orderdeliveriesEndpoint to get deliveries for multiple orders. Use the orderid
query parameter to define which order deliveries should be returned. See OrderDelivery for fields.
Filter on orders with matching order ID, use comma as separator for multiple values.
Comma separated list of fields to return. Use this to query only the fields you are using.
Returns an envelope with items of type OrderDelivery for the order IDs specified.
{ "totalcount": 2, "items": [ { "orderdeliveryid": 10, "orderid": 11511, "state": "delivered" }, { "orderdeliveryid": 11, "orderid": 11512, "state": "ready-for-pickup" } ]}
HTTP Status Code Summary | |
---|---|
200 | Returns an envelope with items of type OrderDelivery for the order IDs specified. |
400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
401 | Unauthorized. Authorization failed. |
404 | Resource not found. The url is invalid. |
429 | Too Many Requests. |
500 | Internal Server Error. |
Add Order Delivery
post /sites/{siteid}/orders/{orderid}/orderdeliveriesSee OrderDelivery for fields. Required fields: warehouseid
orderdeliveryitems
. Required fields for order delivery items: orderitemid
quantity
If set to true
, the warehouse stock for the items included will not be affected by this delivery. This has been deprecated in favor of using the ignorestock
property for the delivery. Note that if this parameter is provided, it will override the property of the object.
The store_externalid property added to the OrderLogItemDeliverySource object for an order log item.
The pos_staff_userid property added to the the OrderLogItemDeliverySource object for an order log item.
The pos_staff_externalid property added to the the OrderLogItemDeliverySource object for an order log item.
The reasoncode property added to the the OrderLogItemDeliverySource object for an order log item.
The reason comment property added to the the OrderLogItemDeliverySource object for an order log item.
{ "warehouseid": 2, "orderdeliveryref": "D123456789", "orderdeliveryitems": [ { "orderitemid": 0, "quantity": 1 }, { "orderitemid": 1, "quantity": 2 }, { "orderitemid": 2, "quantity": 1 } ]}
13
HTTP Status Code Summary | |
---|---|
200 | Returns orderdeliveryid |
400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
401 | Unauthorized. Authorization failed. |
404 | Resource not found. The url is invalid. |
429 | Too Many Requests. |
500 | Internal Server Error. |
Get Order Deliveries
get /sites/{siteid}/orders/{orderid}/orderdeliveriesSee OrderDelivery for fields.
{ "totalcount": 1, "items": [ { "orderdeliveryid": 10, "orderid": 11511, "warehouseid": 1, "orderdeliveryref": "", "datedelivery": 1463041059, "datecancelled": null, "pluginname": "", "state": "delivered", "ignorestock": false, "binlocation": "", "orderdeliveryitems": [ { "orderdeliveryitemid": 14, "orderdeliveryid": 10, "orderitemid": 0, "quantity": 2 }, { "orderdeliveryitemid": 15, "orderdeliveryid": 10, "orderitemid": 1, "quantity": 1 } ] } ]}
HTTP Status Code Summary | |
---|---|
200 | Returns an envelope with items of type OrderDelivery for an order. |
400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
401 | Unauthorized. Authorization failed. |
404 | Resource not found. The url is invalid. |
429 | Too Many Requests. |
500 | Internal Server Error. |
Update Order Delivery
put /sites/{siteid}/orders/{orderid}/orderdeliveries/{orderdeliveryid}Update an order delivery. Valid properties to update are state
, warehouseid
, ignorestock
, orderdeliveryref
and binlocation
. The properties warehouseid
and ignorestock
are only allowed to be updated before the state
has been set to delivered
or cancelled
. To cancel a delivery, set state
to cancelled
.
The store_externalid property
added to the OrderLogItemDeliverySource object for an order log item.
The pos_staff_userid property added to the the OrderLogItemDeliverySource object for an order log item.
The pos_staff_externalid property added to the the OrderLogItemDeliverySource object for an order log item.
The reasoncode property added to the the OrderLogItemDeliverySource object for an order log item.
{ "state": "delivered"}
true
HTTP Status Code Summary | |
---|---|
200 | Returns true |
400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
401 | Unauthorized. Authorization failed. |
404 | Resource not found. The url is invalid. |
429 | Too Many Requests. |
500 | Internal Server Error. |
Add Order Log Item
post /sites/{siteid}/orders/{orderid}/orderlogitemsThis endpoint is used to add log items to the order. NOTE! Check OrderLogItem for types allowed to post to an order.
{ "orderlogtypeid": 900}
true
HTTP Status Code Summary | |
---|---|
200 | Returns true |
400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
401 | Unauthorized. Authorization failed. |
404 | Resource not found. The url is invalid. |
429 | Too Many Requests. |
500 | Internal Server Error. |
Get Order Log Items
get /sites/{siteid}/orders/{orderid}/orderlogitems{ "totalcount": 4, "items": [ { "datelog": 1463041059, "orderid": 11511, "orderlogtypeid": 0, "strvalue": null, "fvalue": null }, { "datelog": 1463041059, "orderid": 11511, "orderlogtypeid": 999, "strvalue": "Register 1 (SII0000001500001)\nReceipt #10009\nStaff", "fvalue": null }, { "datelog": 1463041059, "orderid": 11511, "orderlogtypeid": 70, "strvalue": null, "fvalue": 10 }, { "datelog": 1463041059, "orderid": 11511, "orderlogtypeid": 21, "strvalue": "Staff", "fvalue": null } ]}
HTTP Status Code Summary | |
---|---|
200 | Returns an envelope with items of type OrderLogItem for an order. |
400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
401 | Unauthorized. Authorization failed. |
404 | Resource not found. The url is invalid. |
429 | Too Many Requests. |
500 | Internal Server Error. |
Objects
CheckoutMethodinteger
0
Default100
PaynovaCard101
PaynovaBank200
Paypal300
KlarnaFaktura301
KlarnaKonto305
KlarnaCheckout306
KlarnaCheckoutV3400
HandelsbankenFaktura401
HandelsbankenKonto500
Intrum600
PointCard601
PointBank700
CollectAtStore
Moneystring
Orderobject
The Sitoo order object.
The ID of the order. The order ID is unique for a system.
The eshopid that this order belongs to.
External ID for the order. The externalid is unique for a system and can only contain [A-Za-z0-9_-] with a length of 1-40 characters.
The ID of the order that was the source of this refund.
Checkout type ID (Webshop orders only).
Delivery type ID (Webshop orders only).
Email.
First Name.
Last Name.
Personal Number or Organizational ID.
Company Name.
Phone Number.
Invoice Address.
Invoice Address 2.
Invoice Zip.
Invoice City.
Invoice State.
Invoice Country ID (2-letter ISO 3166).
Delivery Address.
Delivery Address 2.
Delivery Zip.
Delivery City.
Delivery State.
Delivery Country ID (2-letter ISO 3166).
Order comment.
Internal staff comment.
Customer Reference.
Checkout Reference (typically set by payment providers).
Total net value for items (no checkout or payment cost is included).
Total vat value for items.
Checkout cost net value.
Checkout cost vat value.
Total checkout value (ie. checkout_net + checkout_vat).
Delivery cost net value.
Delivery cost vat value.
Total delivery value (ie. delivery_net + delivery_vat).
Final net value (ie. total_net + checkout_net + delivery_net).
Final vat value (ie. total_vat + checkout_vat + delivery_vat).
Collected sales tax.
Roundoff value if applicable.
Grand total. The sum to pay.
The name of the checkout type (eg. "Credit Card" or "Invoice").
The checkout method used for a checkout type. (Webshop orders only)
Used by some payment provider proxies (eg. Klarna stores the P-class).
The name of the delivery type.
The date of the order. In a POST request, the default is the current timestamp. Orders generated from the POS will have the date of when the transaction was made. Note! if the POS is offline when the transaction is made, then the order will be created on the backend at a later time, but the date will still be set to when the transaction was made.
Order state.
Payment state.
Order type.
User ID for the staff that is responsible for the order and should get credit for it.
Register ID of the POS client or null if Webshop order.
The ID of the warehouse that this order is registered for.
The date that a warehouse stock reservation is valid until. (Null value is allowed for no reservation)
Currency for the order. (ISO 4217, alpha-3 uppercased) If not provided, defaults to system currency.
Additional data for this order. The properties below are a summary of defined properties that may be generated by Sitoo or external integrations. Other properties are also allowed as long as their values are of type string.
ID for the CRM channel used (Applicable for systems using multiple CRM channels)
ID for the customer in the CRM system
Member Number for the customer in the CRM system
ID of the customer
Member number for the customer
A value of "true"
indicates that deliveries for this order should not affect stock levels for the items in it.
A value of "true"
indicates that deliveries for this order should be forced to contain the entire order (all items in it).
The process definition for packing a delivery in store (used when delivery-type
is set to
pack-pickup
or pack-ship
). Possible values:
single-all
One delivery which has to contain all itemssingle-partial
One delivery that may be partialmulti
(default) Multiple deliveries allowed. Option is also to pack parts of the order and allow other store or distribution center to fulfill the rest
External ID for the Warehouse where the pickup should be made
Warehouse ID where the pickup should be made
The type of delivery that should be done on this order. Possible values:
prepacked-pickup
Pre-packed delivery sent to the location of the store, customer pickup in storepack-pickup
Pack in store, customer pickup in storepack-ship
Pack in store, send to customer delivery address
Code used to activate influencer voucher
Name of influencer
Order ID referring to the original purchase being returned
Receipt ID for the purchase
Order ID referring to the purchase that was done in connection to this refund
The initiation mode for the return/refund
scanner-receiptid
Receipt ID barcode scannedscanner-receiptid-giftreceipt
Gift receipt ID barcode scannedlatest-purchase
Latest purchasesearch-orderid
Search for order IDsearch-externalid
Search for order external IDsearch-receiptid
Search for receipt IDsearch-receiptid-giftreceipt
Search using gift receiptorder-list
Returned from list view of orderscrm-transaction-list
Returned from list of previous purchases for customermanual
Manual return
Order ID for the refund that was done in connection to this purchase
Receipt ID for the refund that was done in connection to this purchase
ID for the order that was the source for this purchase (Booking or POSParked)
User ID for the POS staff that handled the transaction
User ID(s) for extra POS staff that were part of handling the cart (excluding the staff that handled the transaction). If multiple IDs are provided, they will be separated by comma.
External ID for the POS staff that handled the transaction
External ID for the POS staff that handled secondary authorization of the transaction
User ID for the POS staff that is responsible for the sale (or refund)
External ID for the POS staff that is responsible for the sale (or refund)
Name for the POS staff that is responsible for the sale (or refund)
The timezone for the POS that generated the transaction
Comment for refund
Reason code for refund
ID of the service order being paid for
External ID for the store where the purchase was made
External Group ID for the store where the purchase was made
Name of the store where the purchase was made
Contact ID from Voyado for the customer that made the purchase
Member Number from Voyado for the customer that made the purchase
The order items for this order. An array of OrderItem.
The payments for this order. An array of OrderPayment.
The reserved payments for this order. An array of OrderReservedPayment.
The log items for this order. An array of OrderLogItem.
OrderDeliveryobject
Delivery for order.
The order delivery ID is unique for a system.
The state of the order delivery. When setting the state
to delivered
, the datedelivery
property will be set and a warehouse transaction affecting stock will be done (unless ignorestock
has been set to true
).
The order ID for which this delivery was made.
The warehouse ID for this order delivery.
If set to true
there will be no warehouse transaction done for this delivery.
Delivery reference (waybill no. or similar tracking number).
Bin location for the delivery (used for locating a package during customer pickup).
The date of the order delivery (when the state
was set to delivered
).
The date the delivery was cancelled, or null if not cancelled.
Name of plugin that handles this delivery.
Array of delivery items for this delivery. See OrderDeliveryItem for fields.
OrderDeliveryItemobject
Delivery item for order delivery.
Order delivery item ID.
Order delivery ID.
Order item ID.
Quantity delivered.
OrderDeliveryStatestring
The order delivery state. States can only change to another value in the order they are defined. Intermediate states may be skipped.
new
Newready-to-ship
Ready To Shipin-transit
In Transitarrived
Arrivedready-for-pickup
Ready For Pickupdelivered
Deliveredcancelled
Cancelled
OrderItemobject
Order item for order.
Order item ID.
Order item type. Note that item of type Discount needs to be preceded by one of type Product (to which it belongs) and the field moneyrowdiscount should be used to set the value of the discount.
Product ID. Backlink to a product. NOTE! The product ID may no longer exist in the system.
Product Name. The title for the product at the time of the order.
Stock-keeping unit (ie. the article number) for the product at the time of the order.
Product variant data (eg. "Color: Red, Size: M") for the product at the time of the order.
Text entered by buyer (eg. text on a custom made t-shirt).
Title for text entered by buyer (eg. "Your t-shirt text").
Unit (typically empty) (eg. "kg").
Quantity, the number of items.
Unit quantity if applicable, else null
Net price per unit.
Regular net price of product per unit. (Suggested Retail Price)
VAT percentage.
Delivery info is information sent to the customer after the purchase.
Net total (eg. $netpriceperunit * quantity).
Vat total.
Voucher code.
Voucher name. The name shown when the code is applied.
Voucher comment.
If true, vouchervalue is percentage otherwise it is a fixed sum.
Value of voucher. Percentage or fixed sum depending on ispercentage.
Original price net per unit.
Discounted price per unit. Only set if moneyoriginalprice is set.
Discount value per unit. Only set if moneyoriginalprice is set.
Array of OrderItemSalesTax applied to this order item.
Additional data for this order item. The properties below are a summary of defined properties that may be generated by Sitoo or external integrations. Other properties are also allowed as long as their values are of type string.
ID of bonus check used
ID of promotion used
ID of bonus check used
ID of promotion used
A value of "true"
indicates that this order item should be excluded from calculation of dashboard KPIs
Card number of giftcard purchased
The unique IMEI number for this item
The unique IMEI2 number for this item
The unique serial number for this item
The total row discount sent in POST/PUT
ID/Index referring to the item from the original purchase being returned, indicated by the pos-originalsales-orderid
field on the order
External ID for the price list used
The name of the product group for this item
Reason code for manual discount on item
Reason code for manual price change on item
Reason code for return of item (Either reclaim or refund)
ID for the warehouse that the item was returned to (if other than the register warehouse)
Extended field. The total quantity. i.e. quantity x decimalunitquantity (or 1 if null)
Extended field. Net price per quantity. i.e. moneynetpriceperunit x decimalunitquantity (or 1 if null)
Total Row Price. (Only used for POST/PUT)
Total Row Discount. (Only used for POST/PUT)
OrderItemSalesTaxobject
Sales tax for order item.
The name of the sales tax.
An identifier that can be used to specify the sales tax.
A custom value to make it easier to export to external systems.
The region of the salestaxgroup this salestax item belongs to.
The total sales the collected tax is calculated on. (ie. the sales with no tax)
The total net money value for the this sales tax.
The tax value in percent.
OrderItemTypeinteger
10
Product20
Discount
OrderLogItemobject
Order log item for order.
Date and time of log entry.
Order ID.
Type of order log item. All types are read only except for 900 (ReadyForPickup) and 910 (PickupRejected).
String value.
Numeric value.
OrderLogItemDeliverySourceobject
Object holding the source information and changes for an order log item regarding a delivery action.
Order delivery ID.
The state of the delivery (after the event). See OrderDeliveryState for values.
The warehouse ID used for this order delivery.
If set to true
there will be no warehouse transaction done for the delivery.
Delivery reference (waybill no. or similar tracking number).
Bin location for the delivery (used for locating a package during customer pickup).
External ID for the store where the delivery was handled.
User ID for the POS staff that handled the delivery.
External ID for the POS staff that handled the delivery.
Reason code for this order delivery action
Reason comment for this order delivery action
OrderLogTypeinteger
0
Created10
ConfirmationSent11
DeliveryConfirmationSent20
OrderStateOpen21
OrderStateClosed22
OrderStateCancelled23
OrderStateAbandoned30
PaymentStateNone31
PaymentStatePending32
PaymentStateSuccessful33
PaymentStateCancelled34
PaymentStateFailed35
PaymentStateReserved40
DeliveryStateNone50
PaymentReceived60
DeliveryToTASystem70
DeliveryAdded (The propertystrvalue
will hold a JSON representation of an OrderLogItemDeliverySource)72
DeliveryUpdated (The propertystrvalue
will hold a JSON representation of an OrderLogItemDeliverySource)75
DeliveryCancelled (The propertystrvalue
will hold a JSON representation of an OrderLogItemDeliverySource)100
IpForOrder900
ReadyForPickup910
PickupRejected (The propertyfvalue
will hold the warehouse ID that rejected it andstrvalue
will hold the reason code)950
EmailReceipt (The propertystrvalue
will hold the email address)998
LogDataCleared (Used for clearing sensitive data from order log. The propertystrvalue
will hold the date of the log entry that was cleared)999
GenericEvent1000
AppEvent
OrderPaymentobject
Payment for order.
The name of the payment
The amount of the payment
External ID for the the payment (if applicable)
The reference type of the payment (if applicable)
The reference transaction id of the payment (if applicable)
The card issuer (if applicable)
Additional data for this payment. The properties below are a summary of defined properties that may be generated by Sitoo or external integrations. Other properties are also allowed as long as their values are of type string.
Currency code used for original Adyen payment
Adyen card number token
Adyen card type
Adyen payment method
Adyen payment method variant
Unique ID of the terminal that processed the original Adyen payment
Adyen PSP reference
Adyen tender reference
Adyen transaction date (ISO-8601)
Internal reference for the payment in Bambora Terminal
ID for the Bambora Terminal
Transaction reference for Coiney payment
Mobile number used for custom payment
ID for custom payment
The amount for the payment in the currency specified by foreign-currency-code
The foreign currency used for the payment (ISO 4217, alpha-3 uppercased)
The exchange rate for the payment where the default currency is quoted against the currency specified by foreign-currency-code
Card number of giftcard used for payment
The masked card number of giftcard used for payment
PAN hash value for iZettle
The Sitoo instance reference for the payment in iZettle
Klarna order reference
Klarna merchant ID
Klarna order ID
Klarna ID for payment made with legacy v2 API
Mobile number used for payment
The ID for the MobilePay payment
The amount for the payment in Nets Terminal
Property issuerId from LocalModeEventArgs in Nets Terminal
The Sitoo instance reference for the payment in Nets Terminal
Property terminalID from LocalModeEventArgs in Nets Terminal
The masked card number for the card payment
The payment method used for this payment
Index referring to the payment from the original purchase being returned, indicated by the pos-originalsales-orderid
field on the order
The ID for the Swish payment
Reference number for the payment in Verifone Terminal
The masked card number for the payment in Verifone Terminal
The ID for the Vipps payment in Sitoo
The Order ID for the Vipps payment
The Transaction ID for the Vipps payment
Set to "true" if the payment is not a real transaction, but simply an exchange done between 2 orders
Reference to the reserved payment for this payment (if applicable)
OrderReservedPaymentobject
Reserved payment for order.
The reference (ID) of the reserved payment
The name of the reserved payment
The amount of the reserved payment
External ID for the the reserved payment (if applicable)
The reference type of the reserved payment (if applicable)
The reference transaction id of the reserved payment (if applicable)
The card issuer (if applicable)
Additional data for this reserved payment. See OrderPayment for system keys.
OrderStateinteger
-1
Abandoned0
Open10
Closed20
Cancelled
OrderTypeinteger
10
Order100
Booking110
POSParked
PaymentStateinteger
0
None10
Pending15
Reserved20
Successful30
Cancelled40
Failed
Timestampinteger
Number of seconds since the Unix Epoch.