API

Basics

Introduction Errors Languages Versioning Rate limits Domains Release notes Authentication

Management 🔒

All private endpoints for internal use only.

Endpoints

Structs

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

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

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 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 Checkout.Company Checkout.ISOP company.Consumer Allergen Product.company-order CartItemPrices Checkout.Address ProductPrice.company-order CartItemOption Option.detailed OptionSet.simple CartUpload

Customer

All endpoints used to place orders.

General

Endpoints

Orders

Get all orders of an order_group Get an order Get all orders Force a manual update of an order's payment status

Checkout

Validate the cart and checkout information and get essential information for the checkout flow Get the calendar information for a given checkout and cart Upload an attachment for a CartItem Place an order

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 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 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

Dashboard 🔒

All private endpoints for internal use only.

Endpoints

Statistics

Get statistics

Structs

TakeoutConfig

Information needed in the takeout flow

Field	Type	Description
allowed	Bool	A boolean value
use_intervals	Bool	A boolean value

Examples

Example 1

{
    "allowed": false,
    "use_intervals": true
}

Version update available Please adjust your integration to the latest stable version (1.9.0)

1.5.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