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 Get company by id of the authenticated user Get all holidays from a company Create a holiday Update a holiday Delete a holiday Get all recurrent emails from a company Create a recurrent email Update a recurrent email Delete a recurrent email Get all newsletters sent by this company Get newsletter by id of the given company Send newsletter email Send newsletter email preview Count how many customers will receive the newsletter Get all user permissions from a company Create permissions for a certain user Update user permissions Delete permissions by ID Get all app notifications from a company Send an app notification Cancel an app notification before its sent

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 Get export of products by shop id Get import report of products by shop id Execute import of products by shop id Get all promo codes from a shop Create a promo code Get a promo code Patch a promo code Delete a promo code Get all user discounts from a shop Create a user discount entry Get a user discount Patch a user discount entry Delete a user discount entry Create a latch location Get all the latch locations that belong to a shop. Get a latch location Patch a latch location Delete a latch location Create a latch machine Get all the latch machines that belong to a shop. Get a latch machine Patch a latch machine Delete a latch machine Get a list of viresmo shops Upload a shop product photo placeholder Delete a shop's placeholder Upload a shop photo Delete a shop photo Upload a shop spotlight photo Delete a shop's spotlight photo Get zipcode lists Create a zipcode list Get a zipcode list Patch a zipcode list Delete a zipcode list Import fooddesk allergens Import QualityGuard allergens

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 Upload a product option image Delete the image of a product option

Users

Search a user by email address

Reports

Get order list Get production list

Administration

Get paynl invoices

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

Offers

Get all offers for a company Create an offer for a company Get one offer for a company Update an offer for a company Delete an offer for a company

Offer items

Get all offer items for an offer Create an offer item for an offer Get one offer item for an offer Update an offer item for an offer Delete an offer item for an offer

Structs

Company Holiday RecurrentEmail Newsletter UserPermission AppNotification company.Shop.detailed company.Report company.PromoCodeGroup company.UserDiscount company.LatchLocation company.LatchMachine company.ZipcodeList company.Product.detailed Image company.Category.detailed company.Category.simple company.CategoryAvailablePeriod company.CategoryGroup company.ProductPrice company.OptionSet.detailed company.OptionSet.simple company.Option FuturePagedResult company.Order.detailed PagedResult Website.simple Page.detailed Offer OfferItem Address.detailed Address.simple MaxOrders company.LatchViresmoShop company.Product.simple PriceType company.MinMaxSummary company.SeoData company.Stock company.ProductUpfront company.Product.detailed-id company.PaynlInvoice CartPrices OrderCheckout company.VATChange company.VATChange.with-id company.Shop.simple Coordinates Upfront company.MinMax.amount company.MinMax.weight company.MinMax.persons Resolution Price 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

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 Delete the currently 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 Get address delivery information

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 Promotion 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 UserCompanyPermission Offer.detailed Category.simple CategoryGroup MethodHours Social Message OpenStatus ProductPrice.detailed OptionSet.detailed MinMax OfferItem.detailed Product.simple CartItemPrices Checkout.Address Checkout.Coupon Discount CalendarDay Allergen Offer.simple Resolution ProductPrice.simple CartItemOption Checkout.TakeoutShop CartItemSuggestion Latch OfferItem.simple Hours Option.simple Option.detailed CalendarInterval OptionSet.simple

Customer API

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