Skip to content

Latest commit

 

History

History
61 lines (58 loc) · 5.12 KB

OrderRead.md

File metadata and controls

61 lines (58 loc) · 5.12 KB

# OrderRead

Properties

Name Type Description Notes
orderid int The ID of the order. The orderid is unique for a system. [optional]
eshopid int The eshopid that this order belongs to. [optional]
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. [optional]
creditorderid int The ID of the order that was the source of this refund. [optional]
email string Email. [optional]
namefirst string First Name. [optional]
namelast string Last Name. [optional]
personalid string Personal Number or Organizational ID. [optional]
company string Company Name. [optional]
phone string Phone Number. [optional]
invoiceAddress string Invoice Address. [optional]
invoiceAddress2 string Invoice Address 2. [optional]
invoiceZip string Invoice Zip. [optional]
invoiceCity string Invoice City. [optional]
invoiceState string Invoice State. [optional]
invoiceCountryid string Invoice Country ID (2-letter ISO 3166). [optional]
deliveryAddress string Delivery Address. [optional]
deliveryAddress2 string Delivery Address 2. [optional]
deliveryZip string Delivery Zip. [optional]
deliveryCity string Delivery City. [optional]
deliveryState string Delivery State. [optional]
deliveryCountryid string Delivery Country ID (2-letter ISO 3166). [optional]
comment string Order comment. [optional]
commentinternal string Internal staff comment. [optional]
customerref string Customer Reference. [optional]
checkoutref string Checkout Reference (typically set by payment providers). [optional]
moneytotalNet string Total net value for items (no checkout or payment cost is included). [optional]
moneytotalVat string Total vat value for items. [optional]
moneycheckoutNet string Checkout cost net value. [optional]
moneycheckoutVat string Checkout cost vat value. [optional]
moneytotalGrossCheckout string Total checkout value (ie. checkout_net + checkout_vat). [optional]
moneydeliveryNet string Delivery cost net value. [optional]
moneydeliveryVat string Delivery cost vat value. [optional]
moneytotalGrossDelivery string Total delivery value (ie. delivery_net + delivery_vat). [optional]
moneyfinalNet string Final net value (ie. total_net + checkout_net + delivery_net). [optional]
moneyfinalVat string Final vat value (ie. total_vat + checkout_vat + delivery_vat). [optional]
moneyfinalSalestax string Collected sales tax. [optional]
moneytotalGrossRoundoff string Roundoff value if applicable. [optional]
moneytotalGrossAll string Grand total. The sum to pay. [optional]
orderdate int 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. [optional]
orderstateid int Order state. [optional]
paymentstateid int Payment state. [optional]
ordertypeid int Order type.
useridStaff string User ID for the staff that is responsible for the order and should get credit for it. [optional]
registerid string Register ID of the POS client or null if Webshop order. [optional]
warehouseid int The ID of the warehouse that this order is registered for. [optional]
datereserved int The date that a warehouse stock reservation is valid until. (Null value is allowed for no reservation) [optional]
currencycode string Currency for the order. (ISO 4217, alpha-3 uppercased) If not provided, defaults to system currency. [optional]
additionaldata \Spy\SitooClient\Model\OrderAdditionaldataRead [optional]
orderitems \Spy\SitooClient\Model\OrderitemRead[] The order items for this order. An array of orderitem. [optional]
payments \Spy\SitooClient\Model\OrderpaymentRead[] The payments for this order. An array of orderpayment. [optional]
reservedpayments \Spy\SitooClient\Model\OrderreservedpaymentRead[] The reserved payments for this order. An array of orderreservedpayment. [optional]
orderlogitems \Spy\SitooClient\Model\OrderlogitemRead[] The log items for this order. An array of orderlogitem. [optional]

[Back to Model list] [Back to API list] [Back to README]