The Orders API allows you to automatically transfer key data from orders placed on OMG stores to third-party systems such as shop management, ERP, and order management systems.
To connect OMG to another system using the Orders API, you will need to work with a software developer and provide them with the Orders API documentation. Developer documentation is available in the Things to Remember section.
Enable the Orders API Integration
Before you can use the Orders API, you must first enable the integration in the OMG app:
Note: Only Owner and Accountant roles can access the Integrations Manager page. If you are the Owner or Accountant of your business and cannot access the Integrations Manager page, email email@example.com.
Step 1: Click "Dealer Settings" from the OMG homepage.
Step 2: Click "Integrations" from the My Account menu.
Step 3: Navigate to the "OMG Orders API" section.
Step 4: Click on the green "Connect" button.
Step 5: Click on the "Settings" button, and copy the authorization token by clicking the green copy button.
Step 6: Paste the authorization token directly into your third-party system. This allows you to make requests and get order exports from the OMG orders API.
Now, your OMG Orders API integration is connected!
Disable the Orders API Integration
Step 1: To disable the OMG Orders API integration, click the "Settings" button.
Step 2: Click the red "Disable" button. Disabling the integration will immediately stop order data from being sent from OMG to your third-party system.
Step 3: The OMG Orders API integration has been disabled successfully. Click "Done"
Data Shared through the Orders API
The following list provides an overview of the order information sent through the OMG Orders API. See the OMG Order Export Guide below for a detailed list:
- Exports: All orders related to single or multiple sale codes from the OMG stores
- Store ID: The OMG store sale code.
- Store Name: The OMG store name.
- Store URL: The URL consumers use to access the OMG store.
- Open Date: The date and time when the store opens.
- Close Date: The date and time when the store closes.
- Work Order Number: The work order identifier.
- Orders: The information about orders including order number, customer and shipping information, details about the products, taxes and fees, and the order total.
- Deposits: The information about deposits, including deposit ID, total amount of money on the deposit, OMG fees, processing fees, and net amount after fees. This can be negative if the deposit is a refund.
- Work Orders: The detailed Work Order information for products in the store. This will only be provided if you specify decoration information within the OMG Work Order tool.
Things to Remember
- You will need to work with a software developer, either on your team or one that you hire, to connect the third-party system(s) to OMG.
OMG cannot provide troubleshooting or support for third-party systems.
- Users can turn the Orders API integration off/on at any time, however, if you choose to disable the integration, your existing authorization token will become invalid. You must request a NEW token each time you want to reconnect OMG to your third-party system via the Orders API.
- The Orders API provides a one-way integration allowing order data to be sent from OMG to the third-party system. Data does not flow from the third-party system back to OMG.
- OMG Orders API User Documentation_v1.0.1.pdf - Provides developer documentation.
- OMG Order Export Guide_v1.3.pdf - Provides a full list of data available via the Orders API.
What types of third-party systems can the Orders API be used with?
- You can use the Orders API with any third-party system that can accept and read the OMG stock export.
How many orders/records can be requested via API?
- The third-party systems can ask for a maximum of 50 records per request with the Orders API.
Are there any limits to the number of calls that can be made?
- No, there is no limit to the number of API calls made to the Orders API.