Eshop — goods and orders#
The largest API module.
Every resource offers the standard set of actions
get, get-by, get-all, save, update-columns, delete, delete-all —
unless stated otherwise. See the CRUD pattern.
Goods#
| Resource | Note |
|---|---|
product |
product |
product-variant |
variant |
product-set |
the sellable unit — public reading |
product-category |
category — tree, public |
product-type, product-state, product-tag |
code lists |
producer |
manufacturer |
parameter, parameter-group, parameter-rule |
parameters — public |
product-set-fee, product-set-fee-type |
fees |
product-set-link, product-set-link-type |
links between goods |
product-set-statistic |
statistics |
What is sold is the set, not the product
Price, stock and orders all work with the set. The product is only a wrapper. Looking for a price on the product will not find one.
Orders and complaints#
| Resource | Note |
|---|---|
order |
order — owner |
order-status |
statuses |
complaint |
complaint — owner |
complaint-solution, complaint-status |
code lists |
Delivery, payment, discounts#
| Resource | Note |
|---|---|
shipper, shipper-region, shipper-tariff |
carriers and tariffs |
payment-method |
payment methods |
voucher, gift |
codes and gifts |
feed, feed-parameter-action |
comparison-site feeds |
⛔ Unreachable from outside#
| Resource | State |
|---|---|
cart |
⛔ no HTTP actions |
statistics |
⛔ no HTTP actions |
The cart and checkout are not available through the API
An order cannot be created from outside. The ordering path is internal and has no HTTP wrapper. Through the API, orders can only be read.
The same applies to availability, current prices, "my orders", reordering and status transitions.
Prices#
A price is not a column — it is a time snapshot keyed by date, quantity threshold, user group and currency.
The price returned depends on context
A signed-in user with a discount level sees a different price from a guest. Treat
a price list from get-all without context as indicative.
Order statuses#
Statuses carry action flags — confirm stock, cancel, send an email.
Changing a status triggers irreversible actions
A stock write-off and a sent email cannot be taken back.