Push Orders into an Order Management System

This tutorial will walk you through the feature called “push orders.” Push Orders allows you to automatically or manually transmit order data to a third party system.  This feature allows you to push orders to an API endpoint in our JSON format. 

If you need to go over the steps to configure "Order Push" for ASI Smartbooks, please click here. 

The store level order push is supported by Shopworks and OrderDesk. More information on their setup guides can be found below on their dedicated articles:

• Shopworks
• OrderDesk

Article Sections

• Activate JSON Order Push
• Select Order Push Method
• Configure BrightSites JSON
• Push Order Information to your API URL
• Related Articles

Activate JSON Order Push

Start by activating the feature. 

1. Access the Features page.
2. Click into the Add-Ons section.
3. Toggle on the Order Push feature. Click Approve if you agree to an additional monthly support fee. Click Close or Set Up Now to continue.

Select Order Push Method

The Push Order settings are what you will configure in Bright Sites to manually or automatically submit order data (push) into a third party system.

1. Access the Integrations page.
2. Click into the Push Orders section.
3. Click into the Setup section.
4. Push Method - Select BrightSites JSON from the drop down.
5. Failure notification E-mails - Input the email(s) that would need to be notified in the event if the order push fails.
6. Automatically Push Orders - Activate this switch to have the order automatically push to your API URL after the order is placed (or Approved in the case of an MOAS order). Otherwise, the order can be pushed manually in the store administrative area (see below images).
7. Save - Click to submit changes.

Configure BrightSites JSON

1. Navigate to the BrightSites JSON section.
2. API Version - This would be the version of the show Order API that is sent to your integrated provider. If you're unsure on which version to select, we recommend asking your provider what version of the API they're currently using.
3. API URL - Input the API URL, which refers to the endpoint where we need to push orders to. If you're unsure on what this is, we recommend working with your provider as this is usually something they will provide to you to setup on our side.
   • Orders will be pushed in the same JSON format as our API: https://docs.mybrightsites.com/#show-order
4. Require Authentication (Recommended) - Activate if the endpoint is protected using basic http authentication (recommended), you would enter the username and password here.
   • NOTE: For more information see: https://www.httpwatch.com/httpgallery/authentication.
5. Username - Enter a username if Require Authentication is turned on.
6. Password - Enter a password if Require Authentication is turned on.
7. Save - Click to save your configuration.

Order Push Failure Information:

When configuring Order Push settings, you can add email addresses to receive alerts if a push fails:



However, these notifications are only sent when our system receives an explicit HTTP error code (such as a 4xx or 5xx response). If a push is technically successful at the protocol level (for example, a 200 OK response) but includes an error message in the response body, a notification will not be triggered.

If you suspect this is happening, please contact the receiving system to confirm they are returning the appropriate HTTP status codes for failed requests.

Push Order Information to your API URL

Push and Re-Push can be done from the Order Summary Page.

1. Push Order - Click to Push Order option on the individual order you wish to send.
2. Re-Push Order - Click Re-Push Order to send the order again.

Push or Re-push can also be done from within an individual order.

Related Articles

• Push Orders for ASI SmartBooks