Open API Integration in OrderGrid

OrderGrid enables seamless integration with third-party applications through Open API, allowing for efficient order and inventory management across platforms. The purpose of this API is to enable client applications to programmatically communicate with OrderGrid. With Open API, OrderGrid clients can:

Send orders from their platform directly into the OrderGrid app.
Sync inventory data.
Access reporting information and much more.

Types of Open API Integrations

OrderGrid supports two types of Store API integrations, each designed to meet different fulfillment needs:

Store API (Single Warehouse Integration)

This integration creates a store that routes all incoming orders to a single designated warehouse. When set up, the selected warehouse receives all orders sent to the OrderGrid app from this store.

Store API DTC (Dynamic Warehouse Integration)

This integration creates a store with flexible order routing, allowing orders to be directed to various warehouses. Orders can be routed based on:

Predefined routing rules within OrderGrid
The specific fulfillment warehouse specified in the order payload

With these integration options, OrderGrid can adapt to the unique order fulfillment requirements of each client, streamlining operations across single or multiple warehouses.

Setup Store API integration

To create a Store API store, follow these steps 🪜:

On the stores page, click on + New Store button.
Select Integration: Choose Store API from the list of available integrations.
Add details for Store Information:
- Store Name: Assign a unique name to your store.
- Short Description: Briefly describe the store’s purpose.
- Store Currency: Select the transaction currency.
- Warehouse: Choose the warehouse for order processing.
Click Connect to finalize the setup.

✅ Requirement :

A warehouse needs to be created on the Warehouse company and added to the Client company for the setup of Store API integration.

Setup Store API DTC integration

To create a Store API - DTC Store, follow the steps 🪜:

On the stores page, click on + New Store button.
Select Integration:
- From the list of integrations, choose Store API - DTC.
Add Store Information:
- Enter the following required details:
  - Store Name: Provide a unique name for the store (up to 40 characters).
  - Short Description: Briefly describe the store's purpose (up to 50 characters).
  - Store Currency: Select the currency the store will use for transactions.
Connect the Store:
- Click Connect to finalize the store setup.

Once the Store API or Store API DTC is created, you will need to create API Keys and Postbacks to complete setting up the Open API integration in the OrderGrid app.

Create API keys

🔐 Access Required:

Users with only an Admin role can access this page.

To create API keys in the OrderGrid app, follow the steps 🪜:

Navigate to ☰ > Settings > API Keys.
API Key: click New API Key to create an API key.
Webhook Key: Click New Webhook Key to create a Webhook key.
Shipping Key: Click New Shipping Key to create a Shipping key.

⚠️ Delete an API Key:

API Key can be deleted by clicking the Delete button next to the created key. If the API connection is already established between the OrderGrid app and the external application with the active API key, deleting it could cause significant issues.

Setup Postbacks

Using the postback, the API allows sending various app events to external client applications. When configuring a store in OrderGrid, users have the option to set Event Based Callbacks. The following Events may be used to trigger callbacks:

Order Packed
Order Short Picked
Order Shipped
Order Voided
Picking Started
Item Picked
Item Short Picked
Inventory Changes
Lane Assignment: Assign/Transfer Staging Lane
Unloading
Purchase Order
Goods Received Note
Order Returned
Move Order

Each of these events can be set up to send POST requests to different Callback URLs. Username and Password will be used for Basic Auth. The Payloads will be in JSON format.

To set various postbacks, follow the steps 🪜:

Navigate to ☰ > Settings > PostBacks.
Click + Post back .
Add information:
- Select Postback type.
- Add: Postback URL.
- For Basic Authentication:
  - Add Username.
  - Add Password.
Click Save .

⚠️ Delete a Postback:

A postback can be deleted by clicking the Delete button next to the created postback.

Utilize OrderGrid Backend API documentation.

To access the documentation, please click on the following hyperlink: OrderGrid Backend API documentation.

This documentation provides detailed information on how to use the OrderGrid backend API, including various payload examples. It will assist you in completing the API integration with the OrderGrid App.