Sales Orders: Overview
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.16.
Overview
The Sales Orders API enables the retrieval and update of Sales Orders placed by customers.
Using the Sales Orders API you can:
- Create and retrieve individual sales orders.
- Retrieve all sales orders for a site that have been recently updated.
- Restrict the user’s action on an order in Infinity.
- Create and void sales order lines for existing sales orders.
- Update sales order line status for existing sales orders.
- Dispatch sales order lines for existing sales orders.
- Create sales orders payments for existing sales orders.
The Sales Orders API is composed of the following:
- SalesOrder: A customer order consisting of header information, order lines, delivery information and payment details. Order lines list the individual products, quantities and selling prices.
- Attachments: Images, PDFs or any other file can be added to a quote as an attachment for reference purposes.
Examples
Create a new sales order:
POST/sales_order
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
Search for existing sales orders:
POST/sales_orders/search
Insert new order lines for an existing sales order:
POST/sales_orders/{sales_order_code}/lines
Mark specific order lines as voided:
PUT/sales_orders/{sales_order_code}/line_void
Mark specific order lines as taken:
PUT/sales_orders/{sales_order_code}/line_dispatch
Update an existing sales order line status:
PUT/sales_orders/{sales_order_code}/line_status
Add a new payment for an existing sales order:
POST/sales_orders/{sales_order_code}/payment
Restrict user action on an order in Infinity:
POST /sales_orders/{sales_order_code}/lock_status
{ "lock_status": "Restricted" }
Security 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.