Configuring an external OMS

  • Updated on Nov 11, 2025
  • Published on Nov 15, 2024
  • 2 minute(s) read
Prev Next

In some scenarios, you may want to continue using a legacy order management system (OMS) for primary order fulfillment tasks, and configure NewStore to only fulfill basic routing and fulfillment responsibilities mentioned here.

For more information on using an external OMS to fulfill orders in your business, see Using an external OMS to fulfill orders.

To retrieve the external OMS configuration set up for your business, use the Get external OMS config method.

To enable or disable an external OMS for your business, use the Enable external OMS config method, and set the enabled property to true.

Configuring ATP via an external OMS

When an external OMS is enabled, to retrieve the product ATP information from it, NewStore uses the Availability webhook instead of maintaining the ATP of products for your business.

To retrieve the webhook configuration for ATP information, use the Get webhook config method. To update the webhook config to retrieve ATP information for products, use the Update webhook config method:

  • In the url property, specify the webhook URL that will be called by NewStore. It must use the https scheme.

  • In the api_key property, specify the API key to be sent with requests to ensure they originate from NewStore. The Authorization header in each request from NewStore will be set to this API key. To prevent unauthorized access, the endpoint must reject requests without the correct API key.

  • In the external_identifier property, specify the type of product identifier that the integration will check for when retrieving ATP information.

    Note

    Currently, you can only specify product_id as the external identifier for products.

  • In the timeout property, specify the timeout limit in seconds for the request.

After the webhook config has been set, use the Enable config to request external ATP data method and set value to true to start requesting ATP data from the external OMS. To retrieve the current configuration for your business, use the Get config to request external ATP data method.

Note

If this configuration is disabled, NewStore uses the value for stock within the platform as ATP for products.

If you decide to stop using an external OMS to fulfill orders, and want to use NewStore to manage order fulfillment in your business, use the Delete webhook config method to delete the webhook configuration.

Note

Ensure that NewStore maintains ATP for products in your business when you stop using an external OMS, and start using NewStore for order fulfillment tasks. See About order fulfillment.

Displaying external OMS orders in NewStore Associate App

To display external OMS orders and purchase history for external OMS orders in NewStore Associate App:

  1. Use the Update app configuration method.

  2. Set use_new_om_ui to true.

Related topics