API
Basics
Introduction
Errors
Languages
Versioning
Rate limits
Domains
Release notes
Authentication
Company
All endpoints used to manage shops and products.
General
Endpoints
Companies
Get all the companies of the authenticated user
Shops
Get a shop
Get all the shops of a company
Update a shop
Products
Get all the products that belong to a company and filter the results
Get all the products that belong to a shop and filter the results
Get all the products that belong to a category and filter the results
Get information about one product
Create a product
Update a product
Delete a product
Categories
Get all the categories that belong to a shop
Get information about one category
Create a category
Update a category
Delete a category
Product prices
Get all the product prices that belong to a product
Get information about one product price
Create a product price
Update a product price
Delete a product price
Option sets
Get information about an option set
Get all the option sets that belong to a company
Create an option set
Update an option set
Delete an option set
Options
Get information about an option
Get all the options that belong to an option set
Create an option
Update an option
Delete an option
Orders
Get orders of a shop
VAT
Return all the VAT changes in a company
Create one or multiple VAT changes in a company
Modify one or multiple VAT changes in a company
Delete one or multiple VAT changes in a company
Structs
company.Shop.detailed
company.Product.detailed
company.Category.detailed
company.ProductPrice
company.OptionSet.detailed
company.OptionSet.simple
company.Option
PagedResult
Company
Address.detailed
company.Product.simple
PriceType
company.MinMaxSummary
company.SeoData
company.Category.simple
company.VATChange
company.VATChange.with-id
Coordinates
Image
company.MinMax.amount
company.MinMax.weight
company.MinMax.persons
company.Shop.simple
company.Order.detailed
Allergen
Prices
OrderCheckout
Resolution
Address.simple
CartItem.company
Checkout.Company
Checkout.ISOP
company.Consumer
Product.company-order
CartItemPrices
Checkout.Address
ProductPrice.company-order
Option.detailed
CartUploadWithOptionSet
OptionSet.simple
CartUpload
Customer
All endpoints used to place orders.
General
Endpoints
Categories
Get category by id
Orders
Get all orders of an order_group
Get an order
Get all orders
Force a manual update of an order's payment status
User
Get information about the authenticated user
Set the information about the authenticated user
Shops
Get shop by id
Search shops
Get recent shops
Products
Search for products in a shop
Get product by id
Patch product by id (edit favourite)
Return all specialities of a shop
Return all products for an offer in a shop
Return all favourites the current user has in a shop
Structs
Category.detailed
OrderGroup
Order.detailed
User
Shop.extended
Product.detailed
company.SeoData
CartPrices
OrderCheckout
Shop.simple
Order.simple
Checkout.Checkout
CartConfig
CalendarMonth
CartUpload
UserNotifications
Address.detailed
HoursInfo
Contact
Coordinates
Shop.detailed
PriceType
MinMaxSummary
Image
Address.simple
Joyn
CartItem.order
CartItem.cart
Checkout.Delivery
Checkout.Takeout
Checkout.Latch
Checkout.ISOP
Checkout.Warranty
Checkout.Invoice
Checkout.Configuration
PaymentConfig
TakeoutConfig
DeliveryConfig
LatchConfig
InvoiceConfig
ValidationError
Checkout.Company
Offer.simple
Category.simple
CategoryGroup
Social
Message
ProductPrice.detailed
OptionSet.detailed
MinMax
Product.simple
CartItemPrices
Checkout.Address
Checkout.Coupon
Discount
CalendarDay
Hours
Allergen
Resolution
ProductPrice.simple
Option.detailed
CartUploadWithOptionSet
Checkout.TakeoutShop
Latch
OfferItem.simple
Option.simple
OptionSet.simple
CalendarInterval
This documentation page is not found
Version update available
Please adjust your integration to the latest stable version (1.9.0)
0.2.2
stable
1.10.0
development
1.9.0
stable
1.8.0
stable
1.7.0
stable
1.6.0
stable
1.5.2
stable
1.5.1
stable
1.5.0
stable
1.4.0
stable
1.3.0
stable
1.2.0
stable
1.1.0
stable
1.0.1
stable
1.0.0
stable
0.3.0
stable
0.2.2
stable
0.2.1
stable
0.2.0
stable