Skip to main content

API updates

Contains information about new APIs and webhooks from NewStore, and changes made to existing methods and resources.

November 2023

New APIs

EasyPost Adapter Configuration API

Now you can configure the EasyPost adapter using the EasyPost Adapter Configuration API. This formerly private API is now publicly available with a new authentication flow.

As a reminder, the EasyPost adapter is maintained by NewStore as an implementation of the shipping provider webhook specification. Until now, integrators were not able to configure the adapter themselves and had to rely on NewStore Support or the engineering team due to custom authentication. This problem is addressed now.

Read more details about the EasyPost Adapter Configuration API.

September 2023

Updates to existing APIs

Customer v0 and v1 APIs

Because of a lack of usage in active integrations, NewStore decided to sunset the following methods:

  1. Customer API v0 Find product
  2. Customer API v1 Search products

They will stop working on September 15, 2023. Retailers can use the Customer API v0 List products as an alternative.

Users API

Earlier, retailers performed user management via Omnichannel Manager. With this new User management API, you can configure and manage your users with a single API.

For more information, see the API documentation in our Developer Portal.

August 2023

New APIs

Customer profile API v2

Retailers can now use the new Customer Profile API v2 to create and manage customers in their business. For more information, see the API docs.

If you are already using Customer Profile v0 or Customer Profile v1 APIs, see the respective migration guides:


The new API is now available in our new Developer Portal and not the API Explorer (which contains the documentation for the legacy customer profile APIs).

Taxes Integration API

Retailers can now use the Taxes Integration API to create or retrieve tax transactions. Tax transactions contain detailed information about tax calculations, including tax exemption information and taxes applied to an order.

For more information, see the guide on managing tax transactions .

New fulfillment configuration APIs

You can now use 2 new APIs, the Routing rule set API and Service levels API to set up your fulfillment configuration, without having to use the legacy fulfillment configuration API for anything other than provider rates and their priority.

For more information on how to use these APIs to set up your fulfillment configuration (such as service levels and routes), see the tutorial .

July 2023

Updates to existing APIs

Associate App configuration API

New configurations for new customer profiles

Retailers can now use two new features with the new customer profile screens.

To enable these features, see Configuring auto-populated fields for customer profiles and Configuring scanner identifiers for customer profiles .

Following two properties have been added to the Associate App retailer configuration and Associate App store configuration:

  • customer_profile_auto_populate_fields and customer_profile_scanner_identifiers for customizations
  • new_customer_profile for release_toggles

Store fulfillment configuration API

Priority orders for store fulfillment

Retailers can now define a list of service levels for orders that are prioritized. The orders with service levels specified in the priority list are displayed as priority orders in Associate App, which can be accessed by navigating to the Fulfillment tab in the sidebar menu of Associate App.

To enable the feature in Associate App, see Enabling priority orders in store fulfillment .

To define which service levels should be set as priority, see Put Priority Service Levels and define the service level values such as SAME_DAY_DELIVERY, EXPRESS.

June 2023

Updates to existing APIs

Associate App configuration API

A hang tag template for additional pricebooks

Retailers can now customize the hangtag template to print in-store hang tags with custom prices. Following two new properties have been added to the Associate App retailer configuration and Associate App store configuration:

  • hang_tag_pricebooks for customizations
  • new_hang_tag_template for release_toggles

For more information to configure the template, see Customizing a template and to configure the Associate App settings, see Printing in-store hang tags using additional pricebooks .

May 2023

Updates to existing APIs

Taxes Configuration API

The Taxes Configuration API now supports configuration versioning with old configurations now accessible through the Get Configuration API by passing the desired version number query.

The avalara configuration now supports environment field that replaces the url field. The environment field supports one of the following values:

  • sandbox
  • production

For more information, see Configuring Avalara for tax calculation .

For vertex configuration, the administrative_origin field has been moved inside the vertex configuration object. For more information, see the Taxes Configuration API.

The Taxes Configuration API also now supports the custom tax calculation strategy. For more information on setting up your own tax API, see the Custom Tax Provider Setup Guide.

April 2023

Updates to existing APIs

Coupons API

The Coupons API now allows coupons to be restricted for specific customers, using the customer ID. This can be used to provide special discounts to employees or privilege club members or for specific groups such as charity organizations.

A consumers array was added to the request payload, similar to the existing stores property, in which you can add the list of customer IDs that can use the discount coupon.

When creating a coupon, now you can enable or disable the local timezone for the promotions using the localizedTimezone property, which was added to the request payload.

March 2023

Event Stream observability API

Retailers can now use the Event Stream Observability API to monitor existing Event Stream webhook and S3 integrations with NewStore.


You can also use the Tools section in Omnichannel Manager to monitor Event Stream event logs. See Montoring Event Stream logs .

Updates to existing APIs

Store-specific promotions

Retailers can now use the property stores with the APIs to Create a Promotion and Create a Coupon to select specific stores where certain promotions or coupons will be available.

February 2023

New APIs

Customer Profile API v1

Retailers can now use the Customer Profile API v1 to manage the customer profile operations.


The Customer Profile API v0 will be deprecated as of December 01, 2023 and NewStore has communicated the migration plan to the retailers using this API. We recommend that all new integrations use the latest Customer Profile API v1.

Updates to existing APIs

Search by Coupon name and/or code

The Get coupons method has been updated to support searching for coupons by name and/or coupon code. The retrieved results are paginated.

Legacy Coupons API

The deprecation of the legacy Coupons API was extended from March 31, 2023 to June 15, 2023. We recommend that you migrate to the new coupons framework as soon as possible.

January 2023

New APIs

Capacity-based routing API

Retailers can now specify capacity-based routing limits for orders to be fulfilled by stores, allowing stores to not be overwhelmed with orders and missing delivery expectations.

This feature can be enabled using the store capacity configuration API.

Use the Capacity-based Routing API to set up and manage capacity-based routing in your stores. For more information, see Managing capacity-based routing for stores .

A typical use case for enabling store capacity routing could be that you would like to only route fulfillment orders to stores during open hours only for stores in Japan, at a maximum of 8 orders per day.

In this example, we set up the capacity-based routing feature for all stores in Japan and the US. Using store names that have a common denominator by area, will also allow you to take advantage of wildcards in the store name when setting up capacity-based routing for stores.

Sample payload
    curl -i \
-H "Authorization: Bearer $TOKEN" \
-H 'Content-type: application/json' \
-XPOST "${URL}/v0/store_capacity" \
"policy": {
"JP-*": {
"limit": 8,
"hours": {
"*": [23, 11],
"saturday": null,
"sunday": null
"US-*": {
"limit": 8,
"hours": {
"*": [8, 20],
"saturday": null,
"sunday": null

October 2022

New APIs

Warehouse returns

If you have enabled appeasements for order items in Omnichannel Manager via the Refund request config API or intend to, you can now use a new version of the Item return API to prevent over-refunding on returned items that have been appeased.

September 2022

Updates to existing APIs

Idempotency key fixed for the employee.updated event

A new revision field has now been added to the employee.updated event payload and to its idempotency key. This allows integrators to detect duplicate events. Check the Event Stream Webhooks documentation for an example of this event.

External item IDs added to GraphQL API

What changed?

The ReturnItem entity in the GraphQL query API now contains the externalItemId field for items.


A customer may purchase an item from a website and return it in-store via NewStore Associate App. The externalItemId field enables the NewStore platform to match the internal order ID with an external order.

For more information, see GraphQL API .

August 2022

Updates to existing APIs

Tax configurations for stores

Retailers can now configure the tax strategy, tax provider account information, and default tax rates for individual stores that override the global configuration for their business. This allows retailers to have regional or store-specific tax strategies, multiple tax provider accounts, accurate fallback rates, and default tax rates for specific stores when using Offline Mode in Associate App.

For more information on how to configure tax for individual stores, see Store tax configuration API.

July 2022

New APIs

Stock on hand APIs

Retailers can now use the Stock on hand APIs to retrieve stock quantities of products from a store across all stock locations.

For more information on reconciling the stock on hand data with ERP systems using the event stream, see Syncing stock on hand after a cycle count .

Updates to existing APIs

Order information retrieval API (v0)

What changed?

You can now use the Get order by ID method to retrieve order information using NewStore-specific order identifiers.


Retailers are able to retrieve order information with this API even if they only have the universal order identifier generated via NewStore.

Customer API v0

What changed?

The Get ATP method was removed from the Customer API v0.


To retrieve the ATP for a product, use Get unallocated items for a product method from the internal Stock Admin API v0.

New shipping rules API

Retailers can now use the new Shipping Rules API to create Routes within the fulfillment configuration, to fulfill orders in their business. This API allows partners and retailers to use a CSV file to create and upload the routing strategy for their business directly.

For more information, see the tutorial .

June 2022

Delivery options API

The Delivery options API is now replaced by the Delivery API. Use the methods within Configuration to set up or retrieve shipping option tokens and key pairs.

May 2022

New APIs

Receipts API

Retailers can now use the Receipts API to view receipts for an order and download them in PDF format.

For additional information on printing receipts and configuring financial documents, see Printed documents and labels .

Updates to existing APIs

In-store Pickup Admin API

What changed?

The In-store > pickup API was replaced with the Delivery API.


This was a temporary API, which was built for managing the shipping option token private key as a secret in the in-store pickup service. The Delivery API does the same job of creating and updating shipping option token key pair.

Related documentation:

For more information on using the Delivery API, see Prerequisites in the in-store pickup configuration tutorial.

April 2022

New APIs

Configuration APIs

Retailers can now use the Fulfillment request configuration API to enable updates to shipment status of orders via NewStore Omnichannel Manager. For more information, See Updating the shipment status for external orders .

February 2022

New APIs

Order Management APIs

Retailers can now use the following new APIs to manage orders and related data in the NewStore platform:

  • Cancel an order: Use this API to specify a reason and cancel an order in your business. You can also add notes for longer explanations for cancellations.

    For more information, see the Cancel order API docs.

  • Update grace period for an order: Use this API to extend the grace period for an order.


    The API allows you to extend the grace period of an order by only 15 minutes, for orders that are still in the grace period.

    For more information, see the Update grace period API docs.

  • ATP insights for a fulfillment location: Use this API to retrieve detailed information about the ATP for products in a fulfillment location, such as a store or warehouse. The response payload includes information about reservations, allocations, and future allocations for the specified product.

    For more information, see the ATP insights API docs.

January 2022

New APIs

App configuration API

Retailers can now use an API to configure NewStore Associate App for their business. See the sections related to NewStore Associate App in the configuration guides .

For more information on the API, see the App Configuration API docs.

In-store pickup configuration API

Retailers can now use an API to configure in-store pickup options for their business. For more information, see Configuring in-store pickup shipping options .

For more information on the API, see the In-store pickup API docs.

Financial documents configuration API

Retailers can use an API to configure NewStore Associate App for their business. For more information, see Configuring financial documents .

For more information on the API, see the Financial documents config API docs.

Updates to existing APIs

Event stream webhook

What changed?

The following property was added to the request payload schema:

revision: Can have an integer as a possible value.


The following order events contains the new property:



Retailers can use this field to differentiate between different events emitted by the NewStore platform. This helps them identify specific orders when a number of orders are placed on hold by the platform.

Related documentation: Event Stream webhook schema

Related topics