Orders

Get All Orders

get /orders

Use fields to only query the information needed for your use case. Use filter eshopid to only query orders for one site.

PARAMETERS
eshopid
array (integer)
query

Filter on eshopid, use comma as separator for multiple values.

Example: /orders?eshopid=1
externalid
array (string)
query

Filter on externalid, use comma as separator for multiple values.

Example: /orders?externalid=EXT987654321
orderid
array (integer)
query

Filter on orders with matching orderid, use comma as separator for multiple values.

Example: /orders?orderid=12345,12351
receiptid
string
query

Filter on order with matching receipt ID. Note! If this parameter is used, it will override the orderid parameter.

Example: /orders?receiptid=SII000000150000110009
orderidfrom
integer
query

Filter on orders with orderid higher than or equal to the value provided

orderidto
integer
query

Filter on orders with orderid lower than the value provided

orderdatefrom
integer
query

Filter on orders with orderdate starting from the timestamp provided

orderdateto
integer
query

Filter on orders with orderdate ending with the timestamp provided

orderstate
array (integer)
query

Filter on orderstate, use comma as separator for multiple values.

orderstate
Example: /orders?orderstate=0,10
paymentstate
array (integer)
query

Filter on paymentstate, use comma as separator for multiple values.

paymentstate
Example: /orders?paymentstate=15
ordertype
array (integer)
query

Filter on ordertype, use comma as separator for multiple values.

ordertype
Example: /orders?ordertype=10
email
string
query

Filter on customer email address.

start
integer
query

The index of the item to start from

Default: 0
num
integer
query

The number of items returned

Default: 10
sort
string
query

Sort the result.

Default: "-orderid"
fields
array (string)
query

Comma separated list of fields to return. Use this to query only the fields you are using. See order for all fields.

Default: [ "orderid", "eshopid", "email", "namefirst", "namelast", "company", "moneyfinal_net", "moneyfinal_vat", "moneytotal_gross_roundoff", "moneytotal_gross_all", "checkouttypename", "deliverytypename", "orderdate", "orderstateid", "paymentstateid", "ordertypeid", "registerid", "warehouseid", "datereserved", "currencycode", "orderitems", "payments", "reservedpayments", "additionaldata" ]
Example: /orders?fields=orderid,ordertypeid,orderitems,payments,additionaldata
RETURNS

Returns an envelope with items of type order.

gethttps://api.mysitoo.com/v2/accounts/1500/orders.json?eshopid=1&num=2
RESPONSE JSON
{
"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
200Returns an envelope with items of type order.
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Add Order

post /sites/{siteid}/orders

Note! You can't delete an order, set orderstate to cancelled instead.

PARAMETERS
siteid
integer
path
REQUIRED
REQUEST BODY
object
posthttps://api.mysitoo.com/v2/accounts/1500/sites/1/orders.json
{
"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
}
]
}
RESPONSE JSON
11514
HTTP Status Code Summary
200Returns orderid
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Get Orders

get /sites/{siteid}/orders
Deprecated!

NOTE! Deprecated in favor of /orders (Get All Orders)

PARAMETERS
siteid
integer
path
REQUIRED
externalid
array (string)
query

Filter on externalid, use comma as separator for multiple values.

Example: /sites/{siteid}/orders?externalid=EXT987654321
orderid
array (integer)
query

Filter on orders with matching orderid, use comma as separator for multiple values.

Example: /sites/{siteid}/orders?orderid=12345,12351
orderidfrom
integer
query

Filter on orders with orderid higher than or equal to the value provided

orderidto
integer
query

Filter on orders with orderid lower than the value provided

orderdatefrom
integer
query

Filter on orders with orderdate starting from the timestamp provided

orderdateto
integer
query

Filter on orders with orderdate ending with the timestamp provided

orderstate
array (integer)
query

Filter on orderstate, use comma as separator for multiple values.

orderstate
Example: /sites/{siteid}/orders?orderstate=0,10
paymentstate
array (integer)
query

Filter on paymentstate, use comma as separator for multiple values.

paymentstate
Example: /sites/{siteid}/orders?paymentstate=15
ordertype
array (integer)
query

Filter on ordertype, use comma as separator for multiple values.

ordertype
Example: /sites/{siteid}/orders?ordertype=10
email
string
query

Filter on customer email address.

start
integer
query

The index of the item to start from

Default: 0
num
integer
query

The number of items returned

Default: 10
sort
string
query

Sort the result.

Default: "-orderid"
fields
array (string)
query

Comma separated list of fields to return. Use this to query only the fields you are using. See order for all fields.

Default: [ "orderid", "eshopid", "email", "namefirst", "namelast", "company", "moneyfinal_net", "moneyfinal_vat", "moneytotal_gross_roundoff", "moneytotal_gross_all", "checkouttypename", "deliverytypename", "orderdate", "orderstateid", "paymentstateid", "ordertypeid", "registerid", "warehouseid", "datereserved", "currencycode", "orderitems", "payments", "reservedpayments", "additionaldata" ]
Example: /sites/{siteid}/orders?fields=orderid,ordertypeid,orderitems,payments,additionaldata
RETURNS

Returns an envelope with items of type order.

gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/orders.json?num=2
RESPONSE JSON
{
"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
200Returns an envelope with items of type order.
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Get Order

get /sites/{siteid}/orders/{orderid}
PARAMETERS
siteid
integer
path
REQUIRED
orderid
integer
path
REQUIRED
RETURNS

Returns an item of type order.

gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/orders/11514.json
RESPONSE JSON
{
"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
200Returns an item of type order.
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Update Order

put /sites/{siteid}/orders/{orderid}
PARAMETERS
siteid
integer
path
REQUIRED
orderid
integer
path
REQUIRED
REQUEST BODY
object
puthttps://api.mysitoo.com/v2/accounts/1500/sites/1/orders/11514.json
{
"namefirst": "Adam",
"namelast": "Smith"
}
RESPONSE JSON
true
HTTP Status Code Summary
200Returns true
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Add Order Delivery

post /sites/{siteid}/orders/{orderid}/orderdeliveries

See orderdelivery for fields. Required fields: warehouseid orderdeliveryitems. Required fields for order delivery items: orderitemid quantity

PARAMETERS
siteid
integer
path
REQUIRED
orderid
integer
path
REQUIRED
ignorestock
boolean
query

If set to true, the warehouse stock for the items included will not be affected by this delivery.

Default: false
REQUEST BODY
posthttps://api.mysitoo.com/v2/accounts/1500/sites/1/orders/11514/orderdeliveries.json
{
"warehouseid": 2,
"orderdeliveryref": "D123456789",
"orderdeliveryitems": [
{
"orderitemid": 0,
"quantity": 1
},
{
"orderitemid": 1,
"quantity": 2
},
{
"orderitemid": 2,
"quantity": 1
}
]
}
RESPONSE JSON
13
HTTP Status Code Summary
200Returns orderdeliveryid
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Get Order Deliveries

get /sites/{siteid}/orders/{orderid}/orderdeliveries

See orderdelivery for fields.

PARAMETERS
siteid
integer
path
REQUIRED
orderid
integer
path
REQUIRED
RETURNS

Returns an envelope with items of type orderdelivery for an order.

gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/orders/11511/orderdeliveries.json
RESPONSE JSON
{
"totalcount": 1,
"items": [
{
"orderdeliveryid": 10,
"orderid": 11511,
"warehouseid": 1,
"orderdeliveryref": "",
"datedelivery": 1463041059,
"datecancelled": null,
"pluginname": "",
"orderdeliveryitems": [
{
"orderdeliveryitemid": 14,
"orderdeliveryid": 10,
"orderitemid": 0,
"quantity": 2
},
{
"orderdeliveryitemid": 15,
"orderdeliveryid": 10,
"orderitemid": 1,
"quantity": 1
}
]
}
]
}
HTTP Status Code Summary
200Returns an envelope with items of type orderdelivery for an order.
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Add Order Log Item

post /sites/{siteid}/orders/{orderid}/orderlogitems

This endpoint is used to add log items to the order. NOTE! Check orderlogitem for types allowed to post to an order.

PARAMETERS
siteid
integer
path
REQUIRED
orderid
integer
path
REQUIRED
REQUEST BODY
posthttps://api.mysitoo.com/v2/accounts/1500/sites/1/orders/11511/orderlogitems.json
{
"orderlogtypeid": 900
}
RESPONSE JSON
true
HTTP Status Code Summary
200Returns true
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Get Order Log Items

get /sites/{siteid}/orders/{orderid}/orderlogitems
PARAMETERS
siteid
integer
path
REQUIRED
orderid
integer
path
REQUIRED
RETURNS

Returns an envelope with items of type orderlogitem for an order.

gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/orders/11511/orderlogitems.json
RESPONSE JSON
{
"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
200Returns an envelope with items of type orderlogitem for an order.
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Objects

checkoutmethod
integer

  • 0 Default
  • 100 PaynovaCard
  • 101 PaynovaBank
  • 200 Paypal
  • 300 KlarnaFaktura
  • 301 KlarnaKonto
  • 305 KlarnaCheckout
  • 306 KlarnaCheckoutV3
  • 400 HandelsbankenFaktura
  • 401 HandelsbankenKonto
  • 500 Intrum
  • 600 PointCard
  • 601 PointBank
  • 700 CollectAtStore

money
string

Pattern: ^[-+]?[0-9]+\.[0-9]{2}$

order
object

The Sitoo order object.

PROPERTIES
orderid
integer
READ ONLY

The ID of the order. The orderid is unique for a system.

eshopid
integer
READ ONLY

The eshopid that this order belongs to.

externalid
string

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.

creditorderid
integer

The ID of the order that was the source of this refund.

checkouttypeid
integer
READ ONLY
DEPRECATED

Checkout type ID (Webshop orders only).

deliverytypeid
integer
READ ONLY
DEPRECATED

Delivery type ID (Webshop orders only).

email
string

Email.

Default: ""
namefirst
string

First Name.

Default: ""
namelast
string

Last Name.

Default: ""
personalid
string

Personal Number or Organizational ID.

Default: ""
company
string

Company Name.

Default: ""
phone
string

Phone Number.

Default: ""
invoice_address
string

Invoice Address.

Default: ""
invoice_address2
string

Invoice Address 2.

Default: ""
invoice_zip
string

Invoice Zip.

Default: ""
invoice_city
string

Invoice City.

Default: ""
invoice_state
string

Invoice State.

Default: ""
invoice_countryid
string

Invoice Country ID (2-letter ISO 3166).

Default: ""
delivery_address
string

Delivery Address.

Default: ""
delivery_address2
string

Delivery Address 2.

Default: ""
delivery_zip
string

Delivery Zip.

Default: ""
delivery_city
string

Delivery City.

Default: ""
delivery_state
string

Delivery State.

Default: ""
delivery_countryid
string

Delivery Country ID (2-letter ISO 3166).

Default: ""
comment
string

Order comment.

Default: ""
commentinternal
string

Internal staff comment.

Default: ""
customerref
string

Customer Reference.

Default: ""
checkoutref
string

Checkout Reference (typically set by payment providers).

Default: ""
moneytotal_net
READ ONLY

Total net value for items (no checkout or payment cost is included).

moneytotal_vat
READ ONLY

Total vat value for items.

moneycheckout_net
READ ONLY

Checkout cost net value.

moneycheckout_vat
READ ONLY

Checkout cost vat value.

moneytotal_gross_checkout
READ ONLY

Total checkout value (ie. checkout_net + checkout_vat).

moneydelivery_net
READ ONLY

Delivery cost net value.

moneydelivery_vat
READ ONLY

Delivery cost vat value.

moneytotal_gross_delivery
READ ONLY

Total delivery value (ie. delivery_net + delivery_vat).

moneyfinal_net
READ ONLY

Final net value (ie. total_net + checkout_net + delivery_net).

moneyfinal_vat
READ ONLY

Final vat value (ie. total_vat + checkout_vat + delivery_vat).

moneyfinal_salestax
READ ONLY

Collected sales tax.

moneytotal_gross_roundoff
READ ONLY

Roundoff value if applicable.

moneytotal_gross_all
READ ONLY

Grand total. The sum to pay.

checkouttypename
string
DEPRECATED

The name of the checkout type (eg. "Credit Card" or "Invoice").

checkoutmethodid
READ ONLY
DEPRECATED

The checkout method used for a checkout type. (Webshop orders only)

checkoutmethodsubid
integer
READ ONLY
DEPRECATED

Used by some payment provider proxies (eg. Klarna stores the P-class).

deliverytypename
string
DEPRECATED

The name of the delivery type.

orderdate

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.

orderstateid

Order state.

Default: 0
paymentstateid

Payment state.

Default: 0
ordertypeid
REQUIRED

Order type.

userid_staff
string
READ ONLY

User ID for the staff that is responsible for the order and should get credit for it.

registerid
string
READ ONLY

Register ID of the POS client or null if Webshop order.

warehouseid
integer

The ID of the warehouse that this order is registered for.

datereserved

The date that a warehouse stock reservation is valid until. (Null value is allowed for no reservation)

currencycode
string

Currency for the order. (ISO 4217, alpha-3 uppercased) If not provided, defaults to system currency.

additionaldata
object

Additional data for this order. The defined properties can be generated by Sitoo, any other properties are allowed as long as their values are of type string.

Default: {}
crm-customerid
string

ID for the customer in the CRM system

crm-membernumber
string

Member Number for the customer in the CRM system

customcrm-contactid
string

ID of the customer

customcrm-membernumber
string

Member number for the customer

delivery-ignore-stock
string

A value of "true" indicates that deliveries for this order should not affect stock levels for the items in it.

delivery-pickup-externalid
string

External ID for the Warehouse where the pickup should be made

delivery-pickup-warehouseid
string

Warehouse ID where the pickup should be made

influencer-influencercode
string

Code used to activate influencer voucher

influencer-influencername
string

Name of influencer

pos-originalsales-orderid
string

Order ID referring to the original purchase being returned

pos-receiptid
string

Receipt ID for the purchase

pos-refundsales-orderid
string

Order ID referring to the purchase that was done in connection to this refund

pos-refund-orderid
string

Order ID for the refund that was done in connection to this purchase

pos-refund-receiptid
string

Receipt ID for the refund that was done in connection to this purchase

pos-sourceorderid
string

ID for the order that was the source for this purchase (Booking or POSParked)

pos-staff-userid
string

User ID for the POS staff that handled the transaction

pos-staff-externalid
string

External ID for the POS staff that handled the transaction

pos-staff2-externalid
string

External ID for the POS staff that handled secondary authorization of the transaction

pos-staffsales-userid
string

User ID for the POS staff that is responsible for the sale (or refund)

pos-staffsales-externalid
string

External ID for the POS staff that is responsible for the sale (or refund)

pos-staffsales-name
string

Name for the POS staff that is responsible for the sale (or refund)

pos-timezone
string

The timezone for the POS that generated the transaction

refundreasoncode-comment
string

Comment for refund

refundreasoncode-reasoncode
string

Reason code for refund

serviceorder-id
string

ID of the service order being paid for

store-externalid
string

External ID for the store where the purchase was made

store-externalgroupid
string

External Group ID for the store where the purchase was made

store-name
string

Name of the store where the purchase was made

voyado-contactid
string

Contact ID from Voyado for the customer that made the purchase

voyado-membernumber
string

Member Number from Voyado for the customer that made the purchase

<*>
string
Custom properties are allowed if the value is of type string
orderitems
array

The order items for this order. An array of orderitem.

Default: []
payments

The payments for this order. An array of orderpayment.

Default: []
reservedpayments

The reserved payments for this order. An array of orderreservedpayment.

Default: []
orderlogitems
READ ONLY

The log items for this order. An array of orderlogitem.

orderdelivery
object

Delivery for order.

PROPERTIES
orderdeliveryid
integer
READ ONLY

The order delivery ID is unique for a system.

orderid
integer
READ ONLY

The order ID for which this delivery was made.

warehouseid
integer
REQUIRED

The warehouse ID used for this order delivery.

orderdeliveryref
string

Delivery reference (waybill no. or similar tracking number).

Default: ""
datedelivery
READ ONLY

The date of the order delivery.

datecancelled
READ ONLY

The date the delivery was cancelled, or null if not cancelled.

pluginname
string
READ ONLY

Name of plugin that handles this delivery.

orderdeliveryitems
REQUIRED

Array of delivery items for this delivery. See orderdeliveryitem for fields.

orderdeliveryitem
object

Delivery item for orderdelivery.

PROPERTIES
orderdeliveryitemid
integer
READ ONLY

Order delivery item ID.

orderdeliveryid
integer
READ ONLY

Order delivery ID.

orderitemid
integer
REQUIRED

Order item ID.

quantity
integer
REQUIRED

Quantity delivered.

orderitem
object

Order item for order.

PROPERTIES
orderitemid
integer
READ ONLY

Order item ID.

orderitemtype

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.

Default: 10
productid
integer
READ ONLY

Product ID. Backlink to a product. NOTE! The product ID may no longer exist in the system.

productname
string
REQUIRED

Product Name. The title for the product at the time of the order.

sku
string

Stock-keeping unit (ie. the article number) for the product at the time of the order.

Default: ""
productattributes
string

Product variant data (eg. "Color: Red, Size: M") for the product at the time of the order.

Default: ""
externalinput
string

Text entered by buyer (eg. text on a custom made t-shirt).

Default: ""
externalinputtitle
string

Title for text entered by buyer (eg. "Your t-shirt text").

Default: ""
unitlabel
string

Unit (typically empty) (eg. "kg").

Default: ""
quantity
integer
REQUIRED

Quantity, the number of items.

decimalunitquantity
string

Unit quantity if applicable, else null

moneynetpriceperunit
READ ONLY

Net price per unit.

moneypriceorg

Regular net price of product per unit. (Suggested Retail Price)

Default: "0.00"
vatvalue
number

VAT percentage.

Default: 0
deliveryinfo
string

Delivery info is information sent to the customer after the purchase.

Default: ""
moneyitemtotal_net
READ ONLY

Net total (eg. $netpriceperunit * quantity).

moneyitemtotal_vat
READ ONLY

Vat total.

vouchercode
string

Voucher code.

Default: ""
vouchername
string

Voucher name. The name shown when the code is applied.

Default: ""
vouchercomment
string

Voucher comment.

Default: ""
ispercentage
boolean
DEPRECATED

If true, vouchervalue is percentage otherwise it is a fixed sum.

Default: false
vouchervalue
number

Value of voucher. Percentage or fixed sum depending on ispercentage.

Default: 0
moneyoriginalprice
READ ONLY

Original price net per unit.

moneydiscountedprice
READ ONLY

Discounted price per unit. Only set if moneyoriginalprice is set.

moneydiscount
READ ONLY

Discount value per unit. Only set if moneyoriginalprice is set.

salestaxes

Array of orderitemsalestax applied to this orderitem.

Default: []
additionaldata
object

Additional data for this order item. The defined properties can be generated by Sitoo, any other properties are allowed as long as their values are of type string.

Default: {}
crm-bonuscheckid
string

ID of bonus check used

crm-promotionid
string

ID of promotion used

customcrm-bonuscheckid
string

ID of bonus check used

customcrm-promotionid
string

ID of promotion used

giftcard-cardnumber
string

Card number of giftcard purchased

orderitem-moneyrowdiscount
string

The total row discount sent in POST/PUT

pos-originalsales-orderitemid
string

ID/Index referring to the item from the original purchase being returned, indicated by the pos-originalsales-orderid field on the order

pricelist-externalid
string

External ID for the pricelist used

product-group-name
string

The name of the product group for this item

reasoncode-manualdiscount
string

Reason code for manual discount on item

reasoncode-manualprice
string

Reason code for manual price change on item

reasoncode-return
string

Reason code for return of item (Either reclaim or refund)

return-warehouseid
string

ID for the warehouse that the item was returned to (if other than the register warehouse)

<*>
string
Custom properties are allowed if the value is of type string
decimalquantitytotal
string
READ ONLY

Extended field. The total quantity. i.e. quantity x decimalunitquantity (or 1 if null)

moneynetpriceperquantity
READ ONLY

Extended field. Net price per quantity. i.e. moneynetpriceperunit x decimalunitquantity (or 1 if null)

moneyrowprice

Total Row Price. (Only used for POST/PUT)

Default: "0.00"
moneyrowdiscount

Total Row Discount. (Only used for POST/PUT)

Default: "0.00"

orderitemsalestax
object

Sales tax for orderitem.

PROPERTIES
name
string
REQUIRED

The name of the sales tax.

code
string

An identifier that can be used to specify the sales tax.

Default: ""
externalid
string

A custom value to make it easier to export to external systems.

groupregion
string

The region of the salestaxgroup this salestax item belongs to.

moneytotal
REQUIRED

The total sales the collected tax is calculated on. (ie. the sales with no tax)

moneytax
REQUIRED

The total net money value for the this sales tax.

decimaltaxvalue
string
REQUIRED

The tax value in percent.

orderitemtype
integer

  • 10 Product
  • 20 Discount

orderlogitem
object

Order log item for order.

PROPERTIES
datelog
READ ONLY

Date and time of log entry.

orderid
integer
READ ONLY

Order ID.

orderlogtypeid
REQUIRED

Type of order log item. All types are read only except for 900 (ReadyForPickup) and 910 (PickupRejected).

strvalue
string

String value.

fvalue
number

Numeric value.

orderlogtype
integer

  • 0 Created
  • 10 ConfirmationSent
  • 11 DeliveryConfirmationSent
  • 20 OrderStateOpen
  • 21 OrderStateClosed
  • 22 OrderStateCancelled
  • 23 OrderStateAbandoned
  • 30 PaymentStateNone
  • 31 PaymentStatePending
  • 32 PaymentStateSuccessful
  • 33 PaymentStateCancelled
  • 34 PaymentStateFailed
  • 35 PaymentStateReserved
  • 40 DeliveryStateNone
  • 50 PaymentReceived
  • 60 DeliveryToTASystem
  • 70 DeliveryAdded
  • 75 DeliveryCancelled
  • 100 IpForOrder
  • 900 ReadyForPickup
  • 910 PickupRejected (The property fvalue will hold the warehouse ID that rejected it and strvalue will hold the reason code)
  • 999 GenericEvent
  • 1000 AppEvent

orderpayment
object

Payment for order.

PROPERTIES
name
string
REQUIRED

The name of the payment

moneyamount
REQUIRED

The amount of the payment

externalid
string

External ID for the the payment (if applicable)

reftype
string

The reference type of the payment (if applicable)

refid
string

The reference transaction id of the payment (if applicable)

cardissuer
string

The card issuer (if applicable)

additionaldata
object

Additional data for this payment. The defined properties can be generated by Sitoo, any other properties are allowed as long as their values are of type string.

Default: {}
adyen-cardalias
string

Adyen card number token

adyen-cardtype
string

Adyen card type

adyen-paymentmethod
string

Adyen payment method

adyen-paymentmethodvariant
string

Adyen payment method variant

adyen-pspreference
string

Adyen PSP reference

adyen-tenderreference
string

Adyen tender reference

adyen-txdate
string

Adyen transaction date (ISO-8601)

bambora-host2t-internalreference
string

Internal reference for the payment in Bambora Terminal

bambora-host2t-terminalid
string

ID for the Bambora Terminal

coiney-transactionref
string

Transaction reference for Coiney payment

custompayment-mobile
string

Mobile number used for custom payment

custompayment-paymentid
string

ID for custom payment

giftcard-cardnumber
string

Card number of giftcard used for payment

giftcard-cardnumber-display
string

The masked card number of giftcard used for payment

izettle-panhash
string

PAN hash value for iZettle

izettle-sitooreference
string

The Sitoo instance reference for the payment in iZettle

klarna-klarnareference
string

Klarna order reference

klarna-merchantid
string

Klarna merchant ID

klarna-orderid
string

Klarna order ID

klarnav2-id
string

Klarna ID for payment made with legacy v2 API

mobile
string

Mobile number used for payment

mobilepay-paymentid
string

The ID for the MobilePay payment

nets-amount
string

The amount for the payment in Nets Terminal

nets-issuerid
string

Property issuerId from LocalModeEventArgs in Nets Terminal

nets-sitooreference
string

The Sitoo instance reference for the payment in Nets Terminal

nets-terminalid
string

Property terminalID from LocalModeEventArgs in Nets Terminal

payment-method
string

The payment method used for this payment

pos-originalsales-payment-index
string

Index referring to the payment from the original purchase being returned, indicated by the pos-originalsales-orderid field on the order

swish-paymentid
string

The ID for the Swish payment

verifone-lpp-reference-number
string

Reference number for the payment in Verifone Terminal

verifone-card-masked-pan
string

The masked card number for the payment in Verifone Terminal

virtual-payment
string

Set to "true" if the payment is not a real transaction, but simply an exchange done between 2 orders

<*>
string
Custom properties are allowed if the value is of type string
reservedpaymentid
string

Reference to the reserved payment for this payment (if applicable)

orderreservedpayment
object

Reserved payment for order.

PROPERTIES
id
string
REQUIRED

The reference (ID) of the reserved payment

name
string
REQUIRED

The name of the reserved payment

moneyreserved
REQUIRED

The amount of the reserved payment

externalid
string

External ID for the the reserved payment (if applicable)

reftype
string

The reference type of the reserved payment (if applicable)

refid
string

The reference transaction id of the reserved payment (if applicable)

cardissuer
string

The card issuer (if applicable)

additionaldata
object

Additional data for this reserved payment. See orderpayment for system keys.

Default: {}
<*>
string
Custom properties are allowed if the value is of type string

orderstate
integer

  • -1 Abandoned
  • 0 Open
  • 10 Closed
  • 20 Cancelled

ordertype
integer

  • 10 Order
  • 100 Booking
  • 110 POSParked

paymentstate
integer

  • 0 None
  • 10 Pending
  • 15 Reserved
  • 20 Successful
  • 30 Cancelled
  • 40 Failed

timestamp
integer

Number of seconds since the Unix Epoch.