Sales Order API

Sales Order API

This API is used for creating sales orders for partner facilities as well as patient sales orders.

Introduction

The Sales Order API allows to create/update/get details from ICS account. API is secured by OAuth authentication, allowing customer to access records for specific facility depending on the API use case:

1. Fetch Sales Order details.
2. Create Sales Order for partner facilities or for patient sale.
3. Update Sales Order.

Overview

The Sales Order API has below endpoints,

/ping: This endpoint returns API health.

This endpoint consists of GET method, which gives the health status of the API.

/SalesOrder: This endpoint returns transfer details from the ICS.

This endpoint consists of GET, PUT methods, these are used to fetch, create/update the Sales Orders in ICS system.

GET: This method returns Sales Order details by using below query parameters.

• sourceSystem: It is mandatory parameter used for querying the SalesOrder details.
• sourceSystemSalesOrderId: This is an external (source) salesOrder Ids used for querying the SalesOrder details.
• icsSalesOrderId: This is the ICS transfer ID generated by the ICS system. This is an optional field.
• pageNumber: It is an optional field used for querying the SalesOrder details with specific page number.
• toDate & fromDate: These are optional parameters to extract sales order based on specific creattion date range in ICS system.

PUT: This method creates/updates SalesOrder details in ICS system.

Key features and benefits

The following are features and benefits of the Sales Order API:

1. Provides access to Sales Order data based on client id and source system code.
2. Puts customers in control of their data sharing permissions and grants through API Security.
3. Data validation against while modifying orders.
4. No PII or secure information is logged during transaction.

How it works

The following diagram illustrates how the Sales Order API works.

1. The customer sends client ID and Secret requesting authorization token from Mule OAuth provider API.
2. Send the security token with valid JSON request to Sales Order endpoint.
3. If the access is successful, API will perform the operations and create/update/get the records to/from ICS.
4. Response from ICS is captured and return to source system.
5. If any error in the flow or validation error, Mule API handles and reverts the specific error with the customer along with standard error codes.

Validations

The following are the validations for data transformation in Sales Orders API.

1. sourceSystem and sourceSystemSalesOrderId are mandatory parameters while SO creation.
2. order Items is mandatory in Sales order and payment Information is optional.
3. icsPackageId is mandatory for pharmacy sales order and it is optional for cultivators and processors.
4. Cultivators/processors can either pass icsPackageId or itemProduct values in order item.
5. For pharmacy, package must have packageSize and valid test result.
6. If package is used at order item level, package quantity is reserved while order status is in progress. It gets reduce to zero after receive transfer is complete.
7. Order item quantity and package remaining quantity should match while creating the order.
8. Order Item quantity cannot be more than package quantity.
9. Tax information is optional for all facilities, however valid tax name along with either tax rate or tax amount to be passed in input.
10. If facility is using credit memo for payment, it should be valid.

Use cases

The Sales Order API supports data access for the following use cases.