Introduction
Overview
Rest API
API URLs
Authentication
Specific Data types
API Updates
JSON Format
Rate Limits
Errors
Best Practice
Other Response Headers
Guides
Overview
Product Catalog
Overview
Product Groups
Categories
Manufacturers
Products
Product Variants
Products Images
Product Integration Process
Prices & Campaigns
Overview
Prices
Vouchers
Influencers
Stores & Warehouses
Overview
Stores
Warehouses
Omni Sales
Overview
Buy Online, Pick Up In Store
Buy Online, Ship From Store
Buy Online, Return In Store
API Reference
Overview
Cash Registers
Get Cash Registers
Get Cash Register
Get Z-Reports
Get Z-Report
Objects
money
posregister
poszreport
poszreportdiscount
poszreportpayment
poszreportproductgroup
poszreportsalestax
poszreportsubpayment
poszreportvatgroup
timestamp
Categories
Add Category
Get Categories
Get Category
Update Category
Delete Category
Objects
category
timestamp
Dashboard Custom Metrics
Add Custom Metric
Get Custom Metrics
Delete Custom Metric
Get Custom Metric Values
Update Custom Metric Values
Delete Custom Metric Values
Objects
CustomMetric
CustomMetricValue
Error
Gift Cards
Add Gift Card
Get Gift Card
Add Gift Card Transaction
Delete Gift Card Transactions
Objects
deliverytype
giftcard
giftcardresponse
giftcardtransaction
giftcardtype
money
timestamp
Influencer Codes
Batch Add Influencer Codes
Get Influencer Codes
Batch Update Influencer Codes
Batch Delete Influencer Codes
Get Influencer Code
Objects
influencercode
money
timestamp
Influencer Vouchers
Get Influencer Voucher
Add Influencer Voucher Transaction
Delete Influencer Voucher Transaction
Objects
influencervoucher
influencervouchertransaction
influencervouchertransactionresponse
money
Manufacturers
Batch Add Manufacturers
Get Manufacturers
Batch Update Manufacturers
Batch Delete Manufacturers
Get Manufacturer
Update Manufacturer
Delete Manufacturer
Objects
manufacturer
Orders
Get All Orders
Add Order
Get Orders
Get Order
Update Order
Get All Order Deliveries
Add Order Delivery
Get Order Deliveries
Update Order Delivery
Add Order Log Item
Get Order Log Items
Objects
CheckoutMethod
Money
Order
OrderDelivery
OrderDeliveryItem
OrderDeliveryState
OrderItem
OrderItemSalesTax
OrderItemType
OrderLogItem
OrderLogItemDeliverySource
OrderLogType
OrderPayment
OrderReservedPayment
OrderState
OrderType
PaymentState
Timestamp
POS Payment Types
Get POS Payment Types
Objects
POSPaymentMethod
POSPaymentType
Price Lists
Add Price List
Get Price Lists
Get Price List
Update Price List
Delete Price List
Get Price Lists Items
Batch Set Price List Items
Batch Delete Price List Items
Objects
money
pricelist
pricelistitem
volumepricelevel
Product Custom Attributes
Add Custom Attribute
Get Custom Attributes
Get Custom Attribute
Update Custom Attribute
Delete Custom Attribute
Objects
CustomAttribute
Product Groups (VAT)
Add Product Group
Get Product Groups
Get Product Group
Update Product Group
Delete Product Group
Objects
productgroup
productgrouptype
Product Images & Files
Add Product File
Get Product Files
Get Product File
Delete Product File
Add Product Image
Get Product Images
Get Product Image
Delete Product Image
Objects
resource
timestamp
Product Variants
Get Product Variants
Set Product Variants
Objects
money
productvariant
productvariantgroup
productvariants
Products
Batch Add Products
Get Products
Batch Update Products
Batch Delete Products
Get Product
Update Product
Delete Product
Objects
money
product
productgrouptype
timestamp
Resources
Get Resources
Objects
resource
timestamp
Reason Codes
Add Reason Code
Get Reason Codes
Get Reason Code
Update Reason Code
Delete Reason Code
Objects
reasoncode
reasoncodetype
Sales Taxes
Add Sales Tax
Get Sales Taxes
Get Sales Tax
Update Sales Tax
Delete Sales Tax
Add Sales Tax Group
Get Sales Tax Groups
Get Sales Tax Group
Update Sales Tax Group
Delete Sales Tax Group
Objects
money
salestax
salestaxgroup
salestaxproductgrouprule
salestaxproductgroupruletype
Service Orders
Add Service Order
Get Service Orders
Get Service Order
Update Service Order
Objects
ServiceCustomer
ServiceItem
ServiceOrder
ServiceOrderState
ServiceProduct
ServiceStore
ServiceUser
Shipments
Add Shipment
Get Shipments
Get Shipment
Update Shipment
Objects
archivedfiltertype
money
shipment
shipmentitem
shipmentpackage
shipmentstate
timestamp
Sites
Get Sites
Get Site
Objects
site
Stores
Add Store
Get Stores
Get Store
Update Store
Delete Store
Objects
Store
StoreType
WarehouseUseType
Vouchers
Add Voucher
Get Vouchers
Get Voucher
Update Voucher
Delete Voucher
Objects
Money
ProductAttributeMapping
Timestamp
Voucher
VoucherDiscountOption
VoucherGroupType
VoucherProductOption
VoucherState
VoucherType
Users
Get Users
Batch Add Users
Batch Update Users
Get User
Update User
Delete User
Objects
Role
Timestamp
User
Warehouse Batches
Add Warehouse Batch
Get Warehouse Batches
Get Warehouse Batch
Update Warehouse Batch
Get Warehouse Batch Items
Batch Set Warehouse Batch Items
Batch Delete Warehouse Batch Items
Objects
money
timestamp
transactiontype
warehousebatch
warehousebatchitem
warehousebatchstate
Warehouse Transactions
Get Warehouse Transactions
Get Warehouse Transaction
Batch Add Warehouse Transactions
Get All Warehouse Transactions
Objects
money
timestamp
transactiontype
warehouseitemlog
warehousetransaction
returnvalue
Warehouses
Add Warehouse
Get Warehouses
Get Warehouse
Update Warehouse
Delete Warehouse
Get Warehouse Items
Batch Set Warehouse Items
Objects
money
timestamp
warehouse
warehouseitem
warehousetype
warehouseusetype
Z-Reports
Get POS Z-reports
Get POS Z-report
Get Store Z-reports
Get Store Z-report
Get Store Z-report Configuration
Set Store Z-report Configuration
Objects
Money
PosZReport
StoreZReport
StoreZReportConfig
StoreZReportData
ZReportCurrencyConversion
ZReportDiscount
ZReportPayment
ZReportProductGroup
ZReportSalesTax
ZReportSubPayment
ZReportVatGroup
Release Notes
SPI CRM v2
Overview
Endpoints
Search Customer
Add Customer
Update Customer
Get Customer
Get Transactions
Redeem Items
Undo Redeem Items
Get Consents
Get Additional Options
Lookup Customer
Objects
AdditionalOptionsSection
AdditionalOption
AdditionalOptionEnumValue
Address
BonusCheck
CommunicationType
Consent
Customer
CustomerAdditionalOption
CustomerSection
CustomerSectionValueMoney
CustomerSectionValueText
CustomerStatus
CustomerStatusColor
DecimalQuantity
Error
Gender
Money
Promotion
PromotionCartAmount
PromotionCartPercent
PromotionManual
PromotionOffer
Redeem
SearchKeyType
Transaction
TransactionItem
TransactionItemDiscount
TransactionPayment
Release Notes
SPI CRM v1
Overview
Consents
Get Consents
Objects
crmconsent
Contacts
Add Contact
Find Contact
Get Contact
Update Contact
Add Transaction
Objects
crmbonuscheck
crmcontact
crmpromotion
crmtransaction
crmtransactionitem
crmtransactionitemdiscount
crmtransactionpayment
decimalquantity
gender
money
promotiontype
promotiontypecartamount
promotiontypecartpercent
promotiontypemanual
promotiontypeoffer
status_color
Lookup Contacts
Lookup Contacts
Objects
crmbonuscheck
crmcontact
crmpromotion
crmtransaction
crmtransactionitem
crmtransactionitemdiscount
crmtransactionpayment
decimalquantity
gender
money
promotiontype
promotiontypecartamount
promotiontypecartpercent
promotiontypemanual
promotiontypeoffer
status_color
Test Cases
Release Notes
SPI Events
Overview
Events
Add Events
Objects
Event
OrderData
OrderDeliveryData
ShipmentData
ShipmentV3Data
StoreZReportData
WarehouseTransactionData
ZReportData
Release Notes
SPI Gift Card
Overview
Gift Cards
Add Gift Card
Get Gift Card
Add Gift Card Transaction
Delete Gift Card Transactions
Objects
deliverytype
giftcard
giftcardresponse
giftcardtransaction
giftcardtype
money
timestamp
SPI Payment
Overview
Payments
Add Payment
Get Payment
Update Payment
Objects
cpacartitem
cpacartitemdiscount
cpacustomer
cpapayment
decimalquantity
money
paymentstate_cancelled
paymentstate_completed
paymentstate_inprogress
paymentstate_ready_to_complete
Release Notes
SPI Product Search
Overview
Product Search
Search Products
Objects
filter
filter_option
image
images
money
product
product_search_result
sales_tax
Release Notes
Shipments v3
Overview
Endpoints
Get Shipments
Add Shipment
Get Shipment
Delete Shipment
Get Shipment Actions
Add Shipment Action
Objects
ActionType
ErrorCode
ErrorMessage
Address
Contact
ContactAddress
Carrier
Dimensions
Weight
ShipmentState
ShipmentReceivedItem
ShipmentReceivedItems
ShipmentReceivedItemsUndeclared
ShipmentAction
ShipmentInfo
ShipmentPackage
ShipmentItem
ShipmentItemSerialNumber
Shipment
ShipmentEnvelope
ShipmentActionEnvelope
Release Notes
Purchase Prices v3
Overview
Endpoints
Get Price Lists
Add Price List
Get Price List
Update Price List
Delete Price List
Get Price List Items
Set Price List Items
Delete Price List Items
Get Mapping
Set Mapping
Get Computed Purchase Prices
Objects
PriceListEnvelope
PriceListItemEnvelope
PriceList
PriceListItem
PriceListItems
MappingItem
Mapping
ComputedPrices
ErrorCode
ErrorMessage
Release Notes
Purchase Prices v3 Release Notes
2022-06-21
Beta Release
About
Contact
Help Desk
Support
FAQ
Sign Up
Copyright © 2024 Sitoo AB. All rights reserved.