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
Upload a shop avatar
Delete a shop's avatar
Upload a shop banner
Delete a shop's banner
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
Upload a product photo
Delete a product's first photo
Create multiple products
Update multiple products
Categories
Get all the categories that belong to a company
Get all the categories that belong to a shop
Get information about one category
Create a category
Update a category
Delete a category
Upload a category banner
Delete a category's banner
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
Update an order
Get the printable HTML of an order
Reset the order numbers for specified shops
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
Statistics
Get order statistics
Websites
Update website settings & data
Delete website by id
Upload a file for a website
Create a page for a website
Update website page data
Delete website page by id
Upload a file for a website page
Structs
company.Shop.detailed
company.Product.detailed
Image
company.Category.detailed
company.Category.simple
company.ProductPrice
company.OptionSet.detailed
company.OptionSet.simple
company.Option
FuturePagedResult
company.Order.detailed
PagedResult
Website.simple
Page.detailed
Company
Address.detailed
company.Product.simple
PriceType
company.MinMaxSummary
company.SeoData
company.Product.detailed-id
CartPrices
OrderCheckout
company.VATChange
company.VATChange.with-id
Coordinates
company.CategoryGroup
company.MinMax.amount
company.MinMax.weight
company.MinMax.persons
Resolution
company.Shop.simple
Price
Address.simple
CartItem.company
company.OrderInvoice
Checkout.ISOP
company.Consumer
Allergen
Product.company-order
CartItemPrices
ProductPrice.company-order
CartItemOption
Option.detailed
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
Get all the messages that belong to an order
Create a message for an order
Websites
Get website by domain
Get website page by id
App Notifications
Create an app notification token
Create an app notification token
Emails
User
Get information about the authenticated user
Set the information about the authenticated user
Shops
Get shop by id
Search shops
Get recent shops
Get all shops of a company
Get shop by url
Get all shops of the current platform
Get shop photos
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
FuturePagedResult
OrderMessage
Website.detailed
Page.detailed
AppNotificationToken
User
Shop.extended
Product.detailed
company.SeoData
CartPrices
OrderCheckout
Shop.simple
Checkout.Checkout
CartConfig
CalendarMonth
CartUpload
UserNotifications
Address.detailed
Contact
ShopStatus
Coordinates
Shop.detailed
ShopPhoto
PriceType
Price
MinMaxSummary
Image
Order.simple
Address.simple
Joyn
CartItem.order
CartItem.cart
Checkout.Delivery
Checkout.Takeout
Checkout.Latch
Checkout.ISOP
Checkout.Warranty
Checkout.Invoice
Checkout.Configuration
CartItemSuggestionGroup
PaymentConfig
TakeoutConfig
DeliveryConfig
LatchConfig
InvoiceConfig
ValidationError
Page.simple
Checkout.Company
Offer.simple
Category.simple
CategoryGroup
MethodHours
Social
Message
OpenStatus
ProductPrice.detailed
OptionSet.detailed
MinMax
OfferItem.detailed
Product.simple
CartItemPrices
Checkout.Address
Checkout.Coupon
Discount
CalendarDay
Allergen
Resolution
ProductPrice.simple
CartItemOption
Checkout.TakeoutShop
CartItemSuggestion
Latch
Hours
Option.simple
Option.detailed
CalendarInterval
OptionSet.simple
This documentation page is not found
Version update available
Please adjust your integration to the latest stable version (1.9.0)
1.7.0
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