REST API v2.8

Objects

Objects define the entities stored in Sitoo.

Data Types

Most data types conform to Javascript types. Money and decimal are numerical fixed values that are represented as strings.

Data Type Description
bool Boolean value. true or false.
int Numeric value.
float Numeric value with fraction.
string String value.
array Regular array. Zero based index.
object Object value. <name, value>-tuples.
date Timestamp as int. Number of seconds since the Unix Epoch.
guid Global Unique Identifier as string.
money Money value as string with two decimals ("." separates the fraction). Eg. "123.50".
decimal Fixed decimal as string with three decimals ("." separates the fraction). Eg. "123.456".

category

Categories are the menu items for the webshop and can also be used as containers for products.

Properties

categoryid

int

Read only. The category ID.

categoryparentid

int

The parent category ID or null for top level.

visible

bool

Indicates whether the category is shown in menus or not.

sortorder

int

Index for this category among siblings. Zero based.

custom1

string

Custom field 1.

custom2

string

Custom field 2.

friendly

string

Friendly name. Absolute url = site url + friendly.

seo_title

string

Used for the html title element. If empty the title field will be used instead.

seo_keywords

string

Meta keywords.

seo_description

string

Meta description.

title

string

Title of category.

datecreated

timestamp

Read only. Timestamp when this category was created.

datemodified

timestamp

Read only. Timestamp when this category was last modified.

giftcard

The gift card object.

Properties

type

string

The type of giftcard. ValueDescription"giftcard"GiftCard"creditnote"CreditNote

currencycode

string

Currency for the giftcard. (ISO 4217, alpha-3)

cardnumber

string

The unique id of the gift card (card number).

cardnumber_display

string

Read only. The masked card number, used for public display.

redeemable

bool

Read only. If true, the gift card is active for redeem with the moneyamount available.

date_expires

timestamp

Read only. The date for the expiration of the gift card. (If passed, the gift card is invalid)

date_created

timestamp

Read only. The date that the gift card was created.

moneyamount

money

Read only. Current monetary value of the gift card.

requirespin

bool

Read only. Indicates if PIN is required when redeeming the gift card.

transactions

array

The transactions for this gift card. An array of giftcardtransaction.

giftcardresponse

Response object for gift card operations.

Properties

giftcard

object

The gift card object. See giftcard.

addedtransactionids

array

An array of transactionids added by the request. (Used for rollback)

receipttext

string

Optional text printed on the receipt.

print_voucher

bool

If set to true, a gift card voucher should be printed.

print_pin

string

Optional PIN printed for the gift card (usually 4-6 digits).

giftcardtransaction

Gift card transaction object.

Properties

transactionid

string

Read only. The unique id of this transaction.

date

timestamp

Read only. The date that this transaction occurred.

moneyamount

money

Money added or subtracted by this transaction.

merchant_reference

string

Optional merchant/store reference for this transaction.

staff_reference

string

Optional staff reference for this transaction.

manufacturer

Manufacturer or brand.

Properties

externalcompanyid

int

Read only. Manufacturer ID.

name

string

Name of manufacturer.

description

string

Description.

address

string

Address.

zip

string

Zip.

city

string

City.

state

string

State / Region.

countryid

string

Country ID (2-letter ISO 3166).

phone

string

Phone.

email

string

Email.

url1

string

Home Page url.

url2

string

External link url.

order

An order can either be a Webshop order or a POS order.

Properties

orderid

int

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

creditorderid

int

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

checkouttypeid

int

Read only. Checkout type ID (Webshop orders only).

deliverytypeid

int

Read only. Delivery type ID (Webshop orders only).

email

string

Email.

namefirst

string

First Name.

namelast

string

Last Name.

personalid

string

Personal Number or Organizational ID.

company

string

Company Name.

phone

string

Phone Number.

invoice_address

string

Invoice Address.

invoice_address2

string

Invoice Address 2.

invoice_zip

string

Invoice Zip.

invoice_city

string

Invoice City.

invoice_state

string

Invoice State.

invoice_countryid

string

Invoice Country ID (2-letter ISO 3166).

delivery_address

string

Delivery Address.

delivery_address2

string

Delivery Address 2.

delivery_zip

string

Delivery Zip.

delivery_city

string

Delivery City.

delivery_state

string

Delivery State.

delivery_countryid

string

Delivery Country ID (2-letter ISO 3166).

comment

string

Optional comment placed by buyer.

commentinternal

string

Internal staff comment.

customerref

string

Customer Reference.

checkoutref

string

Checkout Reference (typically set by payment providers).

moneytotal_net

money

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

moneytotal_vat

money

Read only. Total vat value for items.

moneycheckout_net

money

Read only. Checkout cost net value.

moneycheckout_vat

money

Read only. Checkout cost vat value.

moneytotal_gross_checkout

money

Read only. Total checkout value (ie. checkout_net + checkout_vat).

moneydelivery_net

money

Read only. Delivery cost net value.

moneydelivery_vat

money

Read only. Delivery cost vat value.

moneytotal_gross_delivery

money

Read only. Total delivery value (ie. delivery_net + delivery_vat).

moneyfinal_net

money

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

moneyfinal_vat

money

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

moneyfinal_salestax

money

Read only. Collected sales tax.

moneytotal_gross_roundoff

money

Read only. Roundoff value if applicable.

moneytotal_gross_all

money

Read only. Grand total. The sum to pay.

checkouttypename

string

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

checkoutmethodid

int

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

checkoutmethodsubid

int

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

deliverytypename

string

The name of the delivery type.

orderdate

timestamp

The date of the order.

orderstateid

int

Order state. ValueDescription0Open10Closed20Cancelled-1Abandoned

paymentstateid

int

Payment state. ValueDescription0None10Pending15Reserved20Successful30Cancelled40Failed

ordertypeid

int

Order type. ValueDescription10Order100Booking110POSParked

userid_staff

guid

Read only. User ID for POS staff that handled the purchase.

registerid

guid

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

warehouseid

int

The warehouseid used for this order.

datereserved

timestamp

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

orderitems

array

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

payments

array

Read only. The payments for this order. An array of orderpayment.

orderdelivery

Delivery for order.

Properties

orderdeliveryid

int

Read only. The order delivery ID is unique for a system.

orderid

int

Read only. The order ID for which this delivery was made.

warehouseid

int

Read only. The warehouse ID used for this order delivery.

orderdeliveryref

string

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

datedelivery

timestamp

Read only. The date of the order delivery.

datecancelled

timestamp

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

array

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

orderdeliveryitem

Delivery item for orderdelivery.

Properties

orderdeliveryitemid

int

Read only. Order delivery item ID.

orderdeliveryid

int

Read only. Order delivery ID.

orderitemid

int

Read only. Order item ID.

quantity

int

Read only. Quantity delivered.

orderitem

Order item for order.

Properties

orderitemid

int

Read only. Order item ID.

orderitemtype

int

Read only. Order item type. ValueDescription10Product20Discount

productid

int

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

productname

string

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.

productattributes

string

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

externalinput

string

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

externalinputtitle

string

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

unitlabel

string

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

quantity

int

Quantity, the number of items.

decimalunitquantity

decimal

Unit quantity if applicable, else null

moneynetpriceperunit

money

Read only. Net price per unit.

moneypriceorg

money

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

vatvalue

float

VAT percentage.

deliveryinfo

string

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

moneyitemtotal_net

money

Read only. Net total (eg. $netpriceperunit * quantity).

moneyitemtotal_vat

money

Read only. Vat total.

vouchercode

string

Voucher code.

vouchername

string

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

vouchercomment

string

Voucher comment.

ispercentage

bool

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

vouchervalue

float

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

moneyoriginalprice

money

Read only. Original price net per unit.

moneydiscountedprice

money

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

moneydiscount

money

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

salestaxes

array

Array of orderitemsalestax applied to this orderitem.

decimalquantitytotal

decimal

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

moneynetpriceperquantity

money

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

moneyrowprice

money

Total Row Price.

moneyrowdiscount

money

Total Row Discount.

moneyrowtotal

money

Read only. Total Row Sum. (Price - Discount)

orderitemsalestax

Sales tax for orderitem.

Properties

name

string

Read only. The name of the sales tax.

code

string

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

externalid

string

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

groupregion

string

Read only. The region of the salestaxgroup this salestax item belongs to.

moneytotal

money

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

moneytax

money

Read only. The total net money value for the this sales tax.

decimaltaxvalue

decimal

Read only. The tax value in percent.

orderlogitem

An order log item is created when order changes.

Properties

datelog

timestamp

Read only. Date and time of log entry.

orderid

int

Read only. Order ID.

orderlogtypeid

int

Read only. Type of logitem. ValueDescription0Created10ConfirmationSent11DeliveryConfirmationSent20OrderStateOpen21OrderStateClosed22OrderStateCancelled23OrderStateAbandoned30PaymentStateNone31PaymentStatePending32PaymentStateSuccessful33PaymentStateCancelled34PaymentStateFailed35PaymentStateReserved40DeliveryStateNone50PaymentReceived60DeliveryToTASystem70DeliveryAdded75DeliveryCancelled100IpForOrder999GenericEvent1000AppEvent

strvalue

string

Read only. String value.

fvalue

float

Read only. Numeric value.

orderpayment

Payment for order.

Properties

name

string

Read only. The name of the payment

moneyamount

money

Read only. The amount of the payment

reftype

string

Read only. The reference type of the payment (e g "Klarna")

refid

string

Read only. The reference transaction id of the payment

cardissuer

string

Read only. The card issuer (Only applicable if a card payment terminal has been used)

posregister

Cash register. Point of Sale (POS).

Properties

registerid

guid

Read only. Unique ID for this Cash Register.

manufacturerid

string

Read only. Manufacturer ID for this Cash Register used by the Tax Authorities (In Swedish: Tillverkningsnummer).

registerkey

string

Read only. Key for this Cash Register used by the Tax Authorities (In Swedish: Kassabeteckning).

company

string

Read only. Company Name.

companyid

string

Read only. Company ID.

address

string

Read only. Address line 1.

address2

string

Read only. Address line 2.

zip

string

Read only. Zip.

city

string

Read only. City.

state

string

Read only. State.

countryid

string

Read only. Country ID (ISO 3166-1, alpha-2).

currencycode

string

Read only. Currency code (ISO 4217, alpha-3).

receiptlanguagetag

string

Read only. Language used for receipts printed by the Cash Register (RFC 5646, BCP 47).

storesettingid

int

Read only. The ID for the store setting used by the Cash Register.

warehouseid

int

Read only. The ID for the warehouse used by the Cash Register.

salestaxgroupid

int

Read only. The ID for the salestaxgroup used by the Cash Register.

poszreport

Z-report for Cash Register.

Properties

zreportid

int

Read only. ID for this report (report number).

registerid

guid

Read only. Unique ID for this Cash Register.

manufacturerid

string

Read only. Manufacturer ID for this Cash Register.

registerkey

string

Read only. Key for this Cash Register used by the Tax Authorities (In Swedish: Kassabeteckning).

registernumber

int

Read only. Number for this Cash Register (E.g 1, 2, 3...).

datecreated

timestamp

Read only. Timestamp for when this report was created.

company

string

Read only. Company Name.

companyid

string

Read only. Company ID.

address

string

Read only. Address line 1 (street address).

address2

string

Read only. Address line 2 (c/o or similar).

address3

string

Read only. Address line 3 (zip and city).

staff

string

Read only. The name of the staff that produced the report.

comment

string

Read only. The comment that the staff entered for the report.

moneysalestotal

money

Read only. The total gross money value for sales.

moneysalestotalnet

money

Read only. The total net money value for sales.

numsales

int

Read only. The total number of sales.

numsalesitems

int

Read only. The total number of items in sales.

vatgroupssales

array

Read only. Sales grouped by vat values. See poszreportvatgroup for fields.

productgroupssales

array

Read only. Sales grouped by product group. See poszreportproductgroup for fields.

moneyrefundtotal

money

Read only. The total gross money value for refunds.

moneyrefundtotalnet

money

Read only. The total net money value for refunds.

numrefund

int

Read only. The total number of refunds.

numrefunditems

int

Read only. The total number of items in refunds.

vatgroupsrefund

array

Read only. Refunds grouped by vat values. See poszreportvatgroup for fields.

productgroupsrefund

array

Read only. Refunds grouped by product group. See poszreportproductgroup for fields.

moneyroundoff

money

Read only. The total money value for roundoff.

salestaxessales

array

Read only. Collected sales taxes for sales grouped by name, code and taxvalue. See poszreportsalestax for fields.

salestaxesrefund

array

Read only. Collected sales taxes for refunds grouped by name, code and taxvalue. See poszreportsalestax for fields.

moneysummarysales

money

Read only. The total money value for sales.

moneysummaryrefund

money

Read only. The total money value for refunds.

moneysummarysubtotal

money

Read only. The sub total money value (moneysummarysales - moneysummaryrefund).

moneysummarysalestax

money

Read only. The sub total money value for sales tax.

moneysummaryroundoff

money

Read only. The total money value for roundoff.

moneysummarytotal

money

Read only. The total money value for the report (moneysummarysubtotal + moneysummarysalestax + moneysummaryroundoff).

paymentssales

array

Read only. All payments for sales. See poszreportpayment for fields.

paymentsrefund

array

Read only. All payments for refunds. See poszreportpayment for fields.

moneycash_in

money

Read only. The entered money value for cash in the register when it was opened.

moneycash_salesrefunds

money

Read only. The total amount of cash from sales/refunds for register since it was opened.

moneycash_petty

money

Read only. The total petty cash change for register since it was opened.

moneycash_bank

money

Read only. The total banking cash change for register since it was opened.

moneycash_expected

money

Read only. The calculated money value for cash in the register before it was counted.

moneycash_counted

money

Read only. The counted money value for cash in the register when closing.

moneycash_diff

money

Read only. The difference in money value for cash between expected and counted values.

moneycash_bankfinal

money

Read only. The amount of cash banked after cash had been counted.

moneycash_out

money

Read only. The money value for cash in the register after it was closed.

moneydiscount

money

Read only. The total money amount for discounts.

numsalestypeproduct

int

Read only. The total number of items of type "product".

numsalestypeservice

int

Read only. The total number of items of type "service".

numsalestypegiftcard

int

Read only. The total number of items of type "gift card".

numreceipts

int

Read only. The total number of receipts.

numopendrawer

int

Read only. The total number of time the cash register drawer was opened (except for normal transactions).

numpractice

int

Read only. The total number of transactions made in practice mode.

moneypractice

money

Read only. The total money value of transactions made in practice mode.

moneygrandtotalsales

money

Read only. The total money value for sales since the start of the cash register.

moneygrandtotalrefund

money

Read only. The total money value for refunds since the start of the cash register.

moneygrandtotalnet

money

Read only. The summary total money value since the start of the cash register (moneygrandtotalsales - moneygrandtotalrefund).

poszreportpayment

Contains the payment details for a poszreport.

Properties

name

string

Read only. The name of the payment.

moneytotal

money

Read only. The total money value of the payment.

subpayments

array

Read only. A specifiction of different payments within the payment type (if applicable). See poszreportsubpayment for fields.

poszreportproductgroup

Contains the product group details for a poszreport.

Properties

name

string

Read only. The name of the product group.

vatvalue

float

Read only. The vat value for the product group.

numtotal

int

Read only. The total number of items for the product group.

moneytotal

money

Read only. The total gross money value for the product group.

moneytotalnet

money

Read only. The total net money value for the product group.

moneytotalvat

money

Read only. The total vat money value for the product group.

poszreportsalestax

Contains the sales tax details for a poszreport.

Properties

name

string

Read only. The name of the sales tax.

code

string

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

externalid

string

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

groupregion

string

Read only. The region of the salestaxgroup this salestax item belongs to.

moneytotal

money

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

moneytax

money

Read only. The total net money value for this sales tax.

decimaltaxvalue

decimal

Read only. The tax value in percent.

poszreportsubpayment

Contains the details for a sub payment of poszreportpayment.

Properties

name

string

Read only. The name of the sub payment.

moneysubtotal

money

Read only. The money value of the sub payment.

poszreportvatgroup

Contains the VAT details for a poszreport.

Properties

vatvalue

float

Read only. The vat value for the vat group.

moneytotal

money

Read only. The total gross money value for the vat group.

moneytotalnet

money

Read only. The total net money value for the vat group.

moneytotalvat

money

Read only. The total vat money value for the vat group.

pricelist

Use pricelists to set different prices for different customer categories.

Properties

pricelistid

int

Read only. Price list ID (default pricelist has ID 1 on all systems).

pricelistname

string

Price list name.

pricelistdescription

string

Price list description.

product

The main product object. Note that stock values are retrieved using the warehouse endpoints.

Properties

productid

int

Read only. The unique internal productid. It is unique over all sites in the system.

sku

string

Stock Keeping Unit (ie. the article number). Can only contain [A-Za-z0-9_+-/].

skumanufacturer

string

The Stock Keeping Unit (SKU) for the manufacturer.

descriptionshort

string

A short description, typically used in product lists etc.

description

string

The main description of the product.

descriptionhtml

string

An extra description field for adding custom html such as embedded videos etc.

deliverystatus

string

Delivery status.

moneyprice

money

Price of the product excluding VAT.

moneypriceorg

money

Regular price.

moneypricein

money

Purchase price which can be used to help calculate profit on products.

unitlabel

string

Unit label (eg. "pcs", "kg"). Default is an empty string.

allowdecimals

bool

Set this if the product can be purchased with fractional quantity.

deliveryinfo

string

Delivery information that can be provided to the customer after the purchase.

externalinputtitle

string

External input title is a text that the customer can add to the product in the cart (eg. for a t-shirt it could be an optional custom text).

offerisenabled

bool

Turn on or off the offer mechanism.

moneyofferprice

money

If the product is in offer mode, the offerprice will be used instead of the price. The product is in offer mode if enabled and within the offer date period.

offertitle

string

Title of offer (eg. "Summer Campaign").

offerdatestart

timestamp

Start date of offer. If null then no start boundary is set.

offerdateend

timestamp

End date of offer. The last day the offer is still active. If null then no end boundary is set. To turn off date check for offers just set offerdatestart and offerdateend to null.

active

bool

If false, the product is not shown in in the Webshop (product lists etc.).

activepos

bool

If false, the product is not shown in in the POS.

vatid

int

The reference to which Product Group the product belongs to. The Product Group also determines VAT. See productgroup for more information.

deliveryclassid

int

The reference to the delivery class ID. The ID is used when calculating the shipping price.

defaultcategoryid

int

Default category for the product.

manufacturerid

int

The reference to the manufacturer.

manufacturerurl

string

Manufacturer's url for the product.

custom1

string

Custom field 1.

custom2

string

Custom field 2.

custom3

string

Custom field 3.

custom4

string

Custom field 4.

custom5

string

Custom field 5.

stockcountenable

bool

Turns on/off stock handling for the product.

stockallowbackorder

bool

Decides if a product can be backorder listed. If not, it is not displayed when out of stock.

variantparentid

int

Read only. If null then it is a single product, otherwise it is a variant. Variantparentid refers to the owning parent's productid. The product which has a self reference (ie. the variantparentid is same as the produtid) is the main variant (ie. the owner).

barcode

string

Barcode for the product.

offerisactive

bool

Read only. Indicates if the product is in offer mode or not.

moneyfinalprice

money

Read only. The final price of the product. If in offer mode then the final price is offferprice else price.

vatvalue

float

Read only. The VAT in percentage.

productgrouptype

int

Read only. The product group type. ValueDescription10Product20Service30GiftCard

pricelisthasvolume

bool

Read only. True if product has volume pricing.

variant

array

Read only. Array of variant items ["name" => "<name>", "value" => "<value>"].

friendly

string

Friendly name. Absolute url = site url + friendly.

seo_title

string

Used for the html title element. If empty the title field will be used instead.

seo_keywords

string

Meta keywords.

seo_description

string

Meta description.

title

string

Title of product (ie. Product Name).

datecreated

timestamp

Read only. Timestamp when the product was created.

datemodified

timestamp

Read only. Timestamp when the product was last modified.

productgroup

A product group contains the VAT and type for a product.

Properties

vatid

int

Read only. The ID of the product group (vatid).

value

float

VAT percentage (eg. 25 = 25%).

productgrouptype

int

The type of the product group. ValueDescription10Product20Service30GiftCard

productgroupname

string

The name of the product group.

comment

string

Internal comment.

productvariant

Product variant data.

Properties

productid

int

The unique internal productid. It is unique over all sites in the system.

active

bool

If false, the product is not shown in in the Webshop (product lists etc.).

activepos

bool

If false, the product is not shown in in the POS.

title

string

Title of product (ie. Product Name).

sku

string

Stock Keeping Unit (ie. the article number). If entered, it needs to be unique for the site.

deliverystatus

string

Delivery status. If set then it overrides any Stock texts on the site. If not set (ie. empty) then the stock is displayed using the stockcount field.

moneyprice

money

Price of the product excluding VAT.

moneypriceorg

money

Optional regular price which is shown in some themes.

moneypricein

money

Optional purchase price which can be used to help calculate profit on products.

moneyofferprice

money

If the product is in offer mode, the offerprice will be used instead of the price. The product is in offer mode if enabled and within the offer date period.

barcode

string

Barcode for the product.

friendly

string

Friendly name. Absolute url = site url + friendly.

attributes

array

Array of attributes (string). It corresponds to the groups array in productvariants. For each group in productvariants this array must have a value at the same index and with a value from the corresponding options array.

pricelisthasvolume

bool

Read only. Calculated value. True if product has volume prices and false if not.

productvariantgroup

Product variant group with options.

Properties

name

string

Name of product variant group.

options

array

Options. Eg. ["Red", "Blue", "Pink"].

productvariants

Product variants collection.

Properties

groups

array

Array of productvariantgroup.

variants

array

Array of productvariant.

resource

A resource is an uploaded file.

Properties

resourceid

string

ID for the file as a relative URL (typically the filename).

mimetype

string

Read only. Mime-type for the file (example: image/png).

width

int

Read only. Width of image in pixels (only applies to images).

height

int

Read only. Height of image in pixels (only applies to images).

filesize

int

Read only. Filesize on disk in bytes for file.

datecreated

timestamp

Read only. Timestamp for the date that the file was created.

salestax

A definition of a sales tax.

Properties

salestaxid

int

The ID of the sales tax.

name

string

The name of the sales tax.

code

string

The code used for the sales tax.

decimalvaluedefault

decimal

The default tax percentage for this sales tax.

productgrouprules

array

An array of salestaxproductgrouprule applicable to this sales tax.

salestaxgroup

A collection of salestax used for a point of sale.

Properties

salestaxgroupid

int

The ID of the sales tax group.

name

string

The name of the sales tax group.

region

string

The region for the sales tax group.

salestaxes

array

An array of salestax applicable to this sales tax group.

salestaxproductgrouprule

A sales tax rule for a specific product group.

Properties

vatid

int

The VAT ID of the productgroup that this rule applies to.

type

int

The type for this rule. ValueDescription10Total20OverMin30Exempt

moneymin

money

The minimum value for this rule (if applicable).

moneymax

money

The maximum value for this rule (if applicable).

decimalvalue

decimal

The tax percentage for this rule.

externalid

string

An external ID used for this rule. (e.g Product Tax Code)

shipment

A shipment is the object used for handling shipments in Sitoo systems. Shipments are common to all sites.

Properties

shipmentid

int

Read only. ID of shipment in Sitoo.

shipmentstate

int

State of shipment. ValueDescription0New10InTransit20Received100Cancelled

archived

bool

Flag indicating archived shipment.

externalid

string

External ID for shipment.

barcode

string

Barcode used to identify this shipment. Needs to have a unique value.

comment

string

Comment for the shipment.

emailowner

string

The email of the owner of the shipment.

emailreceivedby

string

The email of the person responsible for processing the received shipment.

datenew

timestamp

Read only. The date and time when the shipment was created.

dateintransit

timestamp

Read only. The date and time when the shipment was set to shipmentstate InTransit. (If null, the state has never been set)

datereceived

timestamp

Read only. The date and time when the shipment was set to shipmentstate Received. (If null, the state has never been set)

datecancelled

timestamp

Read only. The date and time when the shipment was set to shipmentstate Cancelled. (If null, the state has never been set)

dateestimatedpickup

timestamp

The estimated date and time for pickup from sender or null if not set.

dateestimateddelivery

timestamp

The estimated date and time for delivery to receiver or null if not set.

sender_warehouseid

int

The warehouseid in Sitoo for sender or null if not applicable.

sender_name

string

The name of the sender.

sender_address

string

Address for the sender.

sender_address2

string

Address 2 for the sender.

sender_zip

string

Zip for the sender.

sender_city

string

City for the sender.

sender_state

string

State for the sender.

sender_countryid

string

Country ID for the sender (2-letter ISO 3166).

sender_referencename

string

Reference name for the sender.

sender_referenceemail

string

Reference email for the sender.

sender_referencemobile

string

Reference mobile phone for the sender.

sender_instructions

string

Instructions for the sender.

receiver_warehouseid

int

The warehouseid in Sitoo for receiver or null if not applicable.

receiver_name

string

The name of the receiver.

receiver_address

string

Address for the receiver.

receiver_address2

string

Address 2 for the receiver.

receiver_zip

string

Zip for the receiver.

receiver_city

string

City for the receiver.

receiver_state

string

State for the receiver.

receiver_countryid

string

Country ID for the receiver (2-letter ISO 3166).

receiver_referencename

string

Reference name for the receiver.

receiver_referenceemail

string

Reference email for the receiver.

receiver_referencemobile

string

Reference mobile phone for the receiver.

receiver_instructions

string

Instructions for the receiver.

carrier_name

string

The name of the carrier.

carrier_reference

string

The carrier reference for the shipment.

carrier_trackingurl

string

The carrier tracking url for the shipment.

shipmentpackages

array

The packages in this shipment. An array of shipmentpackage.

shipmentitems

array

The items in this shipment. An array of shipmentitem.

shipmentpackage

A shipment package is an optional grouping of shipmentitem in a shipment.

Properties

shipmentpackageid

int

ID of shipment package in Sitoo.

barcode

string

Barcode used to identify this package. Needs to have a unique value.

externalid

string

External ID for package.

comment

string

Comment for package.

shipmentitem

A shipment item is a row contained in a shipment. Can be grouped in shipmentpackage.

Properties

shipmentitemid

int

Row ID for shipment item.

shipmentpackageid

int

Reference to shipment package that this item belongs to.

sku

string

The SKU for this shipment item.

productname

string

The name of the product in this shipment item.

unitlabel

string

Unit (typically left blank) (e g "kg").

decimalunitquantity

decimal

Unit quantity if applicable, else null.

quantity

int

The number of units in this shipment item.

quantityreceived

int

The number of units received for this shipment.

moneypricein

money

The purchase price per unit for this shipment item or null. If entered it can be used for the warehouse stock transaction resulting from the shipment.

externalid

string

External ID for shipment item (if applicable).

site

A system can contain multiple sites each with it's own set of products, categories, pricelists etc.

Properties

siteid

guid

Read only. The site ID.

protocol

string

Read only. Site protocol (ie. http or https).

server

string

Read only. Server (domain).

abspath

string

Read only. Absolute path.

siteurl

string

Read only. Request to the site (protocol + "://" + server + abspath).

eshopid

int

Read only. Eshop ID.

user

Users are common to all sites in a system.

Properties

userid

guid

Read only. Unique ID of user.

email

string

Users email. Must be unique.

namefirst

string

First name.

namelast

string

Last name.

personalid

string

Personal ID.

company

string

Company name.

department

string

Department.

companyid

string

Organization ID.

address

string

Address.

address2

string

Extra address field.

zip

string

Zip or postal code.

city

string

City.

state

string

State or region.

countryid

string

Country ID (ISO 3166-1, alpha-2).

phone

string

Phone number.

mobile

string

Cellular phone number.

notes

string

Internal notes about the user.

datecreated

timestamp

Read only. Creation date.

datemodified

timestamp

Read only. Last modified date.

pricelistid

int

Pricelist ID.

voucher

Vouchers are used for creating campaigns.

Properties

voucherid

int

Read only. The ID of the voucher.

active

bool

If true then this voucher is active in the webshop.

activepos

bool

If true then this voucher is active in the POS.

vouchercode

string

Code used for this voucher. (Used for grouping vouchers in reports and stats)

voucherpassword

string

Optional password used for this voucher.

vouchername

string

Name of this voucher.

vouchercomment

string

Description for this voucher.

voucherterms

string

Terms for this voucher.

datecreated

timestamp

The date this voucher was created

datestart

timestamp

The start date for the validity of this voucher. No start date if value is null.

dateend

timestamp

The end date for the validity of this voucher. No end date if value is null.

vouchertype

int

Voucher Type ValueDescription100OrderDiscountM110OrderDiscountX120OrderBuyForMGetDiscountN200ProductDiscountM210ProductDiscountX220ProductBuyXForPriceM230ProductBuyXPayForY240ProductBuyXPayForYDiscountZRest300PackageBuyForPriceM

value_x

int

The X value (integer) used for calculations on the voucher.

value_y

int

The Y value (integer) used for calculations on the voucher.

value_z

int

The Z value (integer) used for calculations on the voucher.

money_m

money

The M value (money) used for calculations on the voucher.

money_n

money

The N value (money) used for calculations on the voucher.

maxuses

int

The maximum number of times the voucher can be applied for a purchase.

priority

int

The priority of the voucher where 1 is highest and 5 is lowest.

vouchergrouptype

int

Read only. The group type for the voucher. ValueDescription10Order20Product30Package

voucherstate

int

Read only. Voucher state. ValueDescription10Active20Planned30Inactive

products

array

An array of product ID.

productoptions

array

An array of voucherproductoption used for vouchers of Package group type. Each option of the array must be fulfilled for the voucher to be applied.

voucherproductoption

Used for defining an option for vouchers of "Package" type.

Properties

num

int

The number of products for this option that has to exists in the cart for the option to be fulfilled.

products

array

Array of productids representing this option.

warehouse

A location for stockenabled goods.

Properties

warehouseid

int

Read only. The unique ID of the warehouse.

warehousetype

int

Type of warehouse. ValueDescription10FIFO20Virtual

currencycode

string

The currency code used for the warehouse (3-letter ISO 4217).

name

string

The name of the warehouse.

address

string

Address for the warehouse.

address2

string

Address 2 for the warehouse.

zip

string

Zip for the warehouse.

city

string

City for the warehouse.

state

string

State for the warehouse.

countryid

string

Country ID for the warehouse (2-letter ISO 3166).

externalid

string

External ID for the warehouse.

warehousebatch

All changes to a warehouse is made using transactions. To make a change, first create a warehousebatch, add batch items and then set the batch to closed. That will commit the batch and create a warehousetransaction.

Properties

warehousebatchid

int

Read only. The unique ID of the warehousebatch.

warehouseid

int

Read only. The warehouse ID for this warehousebatch.

warehousetransactionid

int

Read only. The warehouse transaction ID for this warehousebatch.

transactiontype

int

The type of the transaction. ValueDescription10ManualIn20ManualOut30Sales40Refund50StockTaking

datecreated

timestamp

Read only. The creation date for this warehousebatch.

warehousebatchstate

int

The state of this warehousebatch. ValueDescription10Open20Closed30Cancelled

emailowner

string

The email for the owner of this warehousebatch.

comment

string

The comment for this warehousebatch.

shipmentid

int

The ID for the shipment that is the source of this warehouse batch (if applicable).

externalid

string

External ID for the warehousebatch which will be transferred to the warehouse transaction (if applicable).

reasoncode

string

A reason code for the warehousebatch which will be transferred to the warehouse transaction (if applicable).

warehousebatchitem

Warehouse batch item for a warehousebatch.

Properties

warehousebatchitemid

int

Read only. The unique ID of the warehousebatchitem.

warehousebatchid

int

Read only. The ID of the warehousebatch that this warehousebatchitem belongs to.

warehouseitemid

int

Read only. The unique ID of the warehouseitem.

datemodified

timestamp

Read only. The modified date for this warehousebatchitem.

decimalquantity

decimal

The stock quantity for this warehousebatchitem.

moneypricein

money

The purchase price per item for this warehousebatchitem.

emailowner

string

The email for the owner of this warehousebatchitem.

comment

string

A comment for the warehousebatchitem.

sku

string

The SKU for this stock item.

warehouseitem

Contains the current state of a product's stock count and stock value. Also has the bin location within the warehouse and the reordering threshold.

Properties

warehouseitemid

int

Read only. The unique ID of the warehouseitem.

warehouseid

int

Read only. The ID of the warehouse this warehouseitem belongs to.

sku

string

The SKU for this stock item.

binlocation

string

Bin location for the stock for this warehouse.

decimalthreshold

decimal

Threshold for ordering new stock.

decimaltotal

decimal

Current stock level for this warehouseitem. (Read Only if not warehousetype Virtual)

moneytotal

money

Current stock value for this warehouseitem. (Read Only if not warehousetype Virtual)

datelastmodified

timestamp

Read only. The last date this warehouseitem has been part of a transaction.

datelaststocktaking

timestamp

Read only. The last date this warehouseitem has been part of a stocktaking transaction.

decimalreserved

decimal

Read only. Reserved stock level for this warehouseitem.

decimalavailable

decimal

Read only. Available stock level for this warehouseitem.

warehouseitemlog

Log item that belongs to a warehousetransaction (ie. has a product's stock count and value for a transaction).

Properties

warehouseitemlogid

int

Read only. The unique ID of the warehouseitemlog.

warehouseitemid

int

Read only. The ID of the warehouseitem that this warehouseitemlog belongs to.

warehousetransactionid

int

Read only. The ID of the warehousetransaction that this warehouseitemlog belongs to.

decimalquantity

decimal

Read only. The change of stock in this transaction.

decimaltotal

decimal

Read only. The stock level after this transaction.

moneypricein

money

Read only. The purchase price per item for this transaction (Not applicable for all transactions).

moneytotal

money

Read only. The value of this stock after this transaction.

moneyvalue

money

Read only. The sum value of this itemlog entry. (The warehouse value changed).

sku

string

Read only. The SKU for this stock item.

warehousereasoncode

Reason codes are used to label warehouse transactions.

Properties

reasoncodeid

int

Read only. The unique ID of the reason code.

transactiontype

int

The type of the transaction that the reason code can be used for. ValueDescription10ManualIn20ManualOut30Sales40Refund50StockTaking

reasoncode

string

The reason code. (Max 32 characters)

name

string

The name used to display the reason code. (Max 64 characters)

warehousetransaction

All changes to a warehouse is made using transactions.

Properties

warehousetransactionid

int

Read only. The unique ID of the warehousetransaction.

warehouseid

int

Read only. The ID of the warehouse that this warehousetransaction belongs to.

datecreated

timestamp

Read only. The date when the transaction was created.

transactiontype

int

Read only. The type of the transaction. ValueDescription10ManualIn20ManualOut30Sales40Refund50StockTaking

description

string

Read only. A description for the transaction.

orderdeliveryid

int

Read only. The ID for the orderdelivery that created this transaction (if applicable).

shipmentid

int

Read only. The ID for the shipment that created this transaction (if applicable).

externalid

string

Read only. External ID for the warehouse transaction (if applicable).

reasoncode

string

Read only. A reason code for the warehouse transaction (if applicable).

items

array

Read only. Array of warehouseitemlog.