Getting Started with Northbeam Orders API

For all stores that do not use Shopify, or use Shopify in conjunction with another e-commerce platform (including custom platforms), you will need to implement the Northbeam API. We do this so we can collect real-time and historical orders for your brand and display those orders in-app.

The Northbeam API is organized around REST. Our API V1 consists of a general purpose endpoint to create and update information concerning orders placed. Our API accepts and returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

BASE URL
https://api.northbeam.io/v1

Testing

When testing, please use the following base url:

TESTING BASE URL
https://api.dev.northbeam.io/v1

Considerations

• If you are using Shopify do not send orders that are stored in Shopify via this API. We do not deduplicate orders across both channels.
• When you are ready for production API keys, reach out to our customer support team at [email protected]
• NOTE: Our fetch endpoint only returns a subset of data. You should not expect the full payload to be returned, but rather a small list of attributes (order_id, purchase_total, time_of_purchase, and customer_id)

Pixel API

Please also ensure that you are installing the firePurchaseEvent from the Northbeam Pixel API