Skip to main content

Online Ordering API | Getting Started

The process to get started with Online Ordering is outlined in the table. Note that each step is its own process.

Step

Topic

Description

1

Getting Started with APIs

Steps to obtain an integrator token and additional information about our APIs.

2

Confidentiality Statement

Information about our non-disclosure agreement (NDA) terms and conditions regarding endpoints.

3

API Prerequisites

A list of prerequisites to complete before starting the integration development process.

4

Setup

Describes the structure of sites and menu item objects that Online Ordering uses.

Online Ordering API | Next Steps

After setting up Online Ordering API in the Portal, see the following topics for additional information.

Step

Topic

Description

1

Self-Service Onboarding

Describes the steps for enabling subscription self-service onboarding.

2

Integration Error Handling

Information and recommendations for integration errors.

3

Create, Submit, and Modify Online Orders

Describes the step-by-step process to create and process online orders, as well as the many other capabilities of the Online Ordering API. This includes Marketplace Facilitator Taxes.

4

Additional Features

Describes additional features have been added with the latest version.

5

Order Object

Information and code samples of an online order.

6

Operation Definitions

Online order details including endpoints, data models, and error responses.

7

FAQ

Frequently asked questions regarding Online Ordering onboarding.