Sales Orders Overview

The Sales Orders API enables the retrieval and update of Sales Orders placed by customers.

Using the Sales Orders API you can:

  • Create, update and retrieve individual sales orders.
  • Retrieve all sales orders for a site that have been recently updated.

The Sales Orders API is composed of the following:

  • Sales Order: a customer order consisting of header information, order lines and payment details. Order lines list the individual products, quantities and selling prices.

Examples

Retrieve an individual sales order:

GET /sales_orders/41431982495823

 

Retrieve a list of recently updated orders for a site:

GET /sales_orders?updated_since=2018—03-20T08:23:12.563Z&customer_site_code=103

Swagger Definition

The Swagger definition for this version of the Sales Orders API can be found at: https://app.swaggerhub.com/apis/Triquestra/sales_orders/1.0.2.

Security Risk Profile

Financial Data 2: able to create and modify sales orders with payments.

Personal Data 0: no personal data exposed.

Business Data 3: able to create and modify sales orders with payments.