Data API Resources

The Data API provides deep access to the data powering any website - exposing the majority of its data models. A lot of them are very low level - essentially exposing raw database tables as XML Resources and allowing you CRUD operations on them. Please keep in mind:

Some of these formats are optimised for specific use cases - and are not necessarily perfectly normalised.
Some of these formats are not ideal, but are widely used - meaning we are stuck with supporting them.
Some resources require precise formatting of specific fields. For example a field may be new line delimited or stored as JSON. It is important to retain this formatting as it may be required by the software in that particular area.

A lot of the resources have plural names - e.g. `Enquiries` or `UserCustomGroups`. When being output by the API in a `ResultSet`, the node will be singular - e.g. `Enquiry` or `UserCustomerGroup`. This should also be the case when you are sending a payload back to the API.

Some of the more commonly used resources have interfaces layered on top of the raw data model to provide a cleaner developer experience. These include:

Outside of this, other commonly accessed resources include:

Cat - category data
CatParent - the relationship between a category & its parent(s)
ProdCat - the relationship between a product & the categories it is in
Country - supported countries
CountryRegions - regions withing countries, associated post codes & supported shipping methods
Coupon - coupon codes & discounts
Currency - supported currencies & their associated rates
Enquiries - enquiries submitted via a contact form
Webhooks - subscribe to a webhook to receive push notifications from certain events - e.g new order
Wishlist - a customer wishlist - related to a Customer
WishItem - items on a customer wishlist - related to a Wishlist.

Product related resources

The following resources store data about products:

Product - main product data
ExtraImages - additional product images
Inventory - product inventory
Merchandising - product promotion & special / discounts
Options - simple or advanced product option configuration - e.g. colour, size. Note this resource has quite complicated formats.
Variants - variations of the product with their own code, pricing, inventory etc. Generally representing the combination of options - e.g. Small, Green T-shirt
PricingAdvanced - pricing records for a product relating to price tiers (by customer group), quantity pricing, multicurrency.
ProdAccessGroup - access control relating to products (if enabled on the website)
ProductAttributes - additional attributes & associated values stored against a product - used for filtering & display on a product page

Variant related resources

Variants (product variations) operate almost like standalone SKUs - in that they can have their own code, price, description, inventory etc. Some of the resources that relate to products can also relate to Variants:

VariantOptions - linking a variant to a specific combination of options.
PricingAdvanced - pricing records (as described above) but related to the variant entry instead.
Inventory - inventory records for this variant

Order related resources

Order - main order data
Orderline - one or more orderlines related to the order
OrderlineDiscounts - discounts applied to an order or orderline
OrderlineTax - additional tax information relating to tax applied to an orderline
Shipments - tracking an order shipment - who it was shipped with, tracking number, link etc
ShipmentLines - what orderlines were included in a shipment

Customer related resources