REST API Endpoints for Orders

Overview

Orders are the very core of most e-commerce websites and allow merchants to accept reservations, payment, and shipping for products of various kinds in their store.  This area of the API allows you to manage how that is done.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of REST and API’s
  • Understanding of C# and/or JavaScript

Getting Started

If you haven’t already done so, you should probably have a development environment ready to development against, complete with Hotcakes installed and configured.

REST API endpoints for Orders

There are a handful of REST API endpoints that allow you to display or manage various aspects of orders.  Those endpoints are detailed below.

Endpoint Return Type Description
OrdersCreate OrderDTO Creates a new order in your store.
OrdersDelete Boolean Permanently deletes an order from the store.
OrdersFind OrderDTO Enables you to find a specific order in your store.
OrdersFindAll List of OrderSnapshotDTO Allows you to find all orders in the store.
OrdersUpdate OrderDTO Updates an existing order with the given changes.

 

Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.