API Reference

This page will help you get started with the ShopMy API for Brand Partners.

This API is specifically for Brand Partners, and provides visibility and functionality around orders to your brand.

The ShopMy API uses API tokens to authenticate requests. Our API access is not yet publicly available so for the current moment you will need to utilize an API access token from your account manager or reach out to us at [email protected].

Your API tokens carry many privileges, so be sure to keep them secure! Do not share your secret API tokens in publicly accessible areas such as GitHub, client-side code, and so forth.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Once you have a token, you simply send it as a header on any request as follows:

headers: {
  Authorization: Bearer <TOKEN>
}