Documentation

Getting Started

This guide will help you get started with MidwayPlus API! The MidwayPlus API allows both Brands and Resellers to interact with their MidwayPlus account. Keep inventory and pricing up to date, sync or submit orders, and much more.

Creating API Credentials

To interact with most features of the API, you must authenticate to your account. You can manage your API credential in in the dedicated settings page in MidwayPlus. More information regarding the authentication can be found on the Authentication documentation page.

API Browser & Swagger

OpenAPI specifications can be found here. You can also browse and test the API specs in the Swagger API browser.

Environments

The production API is api.midwayplus.com.

The sandbox API is sandboxapi.midwayplus.com. The sandbox API shares the same environment as the MidwayPlus B2B sandbox, which is sandbox.midwayplus.com.
The sandbox and production environments are completely separate. You can not use a production account or API credentials unless those accounts are created in the sandbox environment.
The sandbox environment uses a test Stripe account and FedEx account. Unfortunately, some features, such as UPS account signups and label printing are disabled because of a lacking test environment provided by the service. Note that the sandbox environment will send emails - you should avoid using real email addresses to avoid confusion. Emails from the sandbox environment are from sandbox@midwayplus.com.