Skip to main content

API updates

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

November 2024​

Updates to existing APIs​

Associate App configuration API

Removal of release toggle property ship_to_store_enabled

Associate App does not use the release toggle property release_toggles > ship_to_store_enabled any more as this has become a productized capability in the app. Use the property capabilities > ship_to_store_enabled instead to enable this feature for your business.

September 2024​

Updates to existing APIs​

What is being changed? NewStore Promotions Listing API for Coupons will stop supporting partial flag. The API will behave as if value was set to true.

What do you need to do? If you are using this API and expecting codes to be present in coupon, you need to change your integration to ask for codes for coupon by making separate API list codes call for each coupon.

On November 1, 2024:

  • Codes array will be removed from coupon entity

August 2024​

Updates to existing APIs​

Routing Ruleset API

Release date: August 30th, 2024

The PUT and PATCH methods on the Routing Ruleset API now support the definition of multiple countries within a single route entry in the routing rules.

Customer Profile Addresses API

Release date: August 12th, 2024

The Create or Show Address API method now does not require the following properties to be specified when creating an address:

  • full_name
  • address_line_1
  • city

Release date: August 6th, 2024

The Create or Show Address API method now does not require the value of the zip_code property to be specified when creating an address.

Historic Order Import API

Release date: August 1st, 2024

The historic order import API now attempts to convert billing and shipping address phone numbers to the E.164 standard to create customer profile and profile addresses. For detailed information on various phone number conversion use cases, see the API documentation

July 2024​

New APIs​

Customer segmentation operations API

Release date: July 8th, 2024

The Customer segmentation operations API provides powerful tools for creating and managing customer segments, which can be used to tailor marketing and selling efforts more effectively.

Key functionalities include the ability to create store-specific customer segments using tags based on specific criteria, update segment definitions, and retrieve details about existing segments.

Associate App now features an Outreach List tab for the Clienteling screen, allowing associates to leverage customer segments via this API.

Together, they enable targeted outreach, such as boosting high-value customer loyalty or to re-engage at-risk customers. See Sending messages via Outreach Lists .

Fiscalization Configuration APIs

Release date: 24 June, 2024

You can now use Fiscalization Configuration APIs for:

  • Updating offline mode configuration for fiscal countries.
  • Setting up and viewing fiscal stores.
  • Activating and viewing fiscal cashboxes.

For more information on how to use these APIs to set up your fiscalization configuration, see Fiscalization APIs.

Updates to existing APIs​

Taxes Configuration APIs

Release date: 31 July, 2024

Retailers can now use the tenant and store level tax configuration APIs for configuring tax exemption classes for custom, fixed rate, and fixed rate per country tax providers.

A new property (feature toggle) jurisdiction_in_tax_name_enabled has now been introduced to the vertex payload under the taxes configuration API, which enables retailers to add the name of the jurisdiction in the tax line of receipts.

For example: Sales and Use Tax - ALABAMA can be specified as the value for this property, which describes the tax imposed by the state of Alabama.

This optional property is set to False by default and can be enabled both globally or for specific stores.

Fiscalization Configuration APIs

Release date: 31 July, 2024

Retailers can now use the Update store API for configuring tax exemption class mapping in Italian stores.

Customer v0 and v1 APIs

The sunset dates for customer v0 and v1 have been changed, the sunset is now set for March 31, 2025.

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

Retailers can use the Customer API v0 List products as an alternative instead.

See the deprecation notice .

Associate App configuration API

Release date: 22 July, 2024

The feature toggle reason_codes_enabled is not used for newer Associate App versions, and the Cart management configuration option priceOverride is not used for newer Associate App versions.

If you are on Associate App v1.52.0 or later, reason codes are enabled by default.

You can enable both item level manual discounts and price override, when on Associate App v1.52.0 or later, by specifying itemDiscount as a value within the cart_management or cart_management_v2 property in the Update Associate App configuration method.

For Associate App v1.52.0 or later, the cart_management_v2 property has no impact on price overrides. This property is only applicable if you are on Associate App v1.50.0 or v1.51.0. See Configuring price overrides for items (v1.50.0 and v1.51.0) as an example.

The reference of the new configuration can be found here for manual discounts and here for price overrides.

June 2024​

Updates to existing APIs​

App Extension API

Release date: 24 June, 2024

Added two new methods, getProductConfiguration and updateProductConfiguration(configuration), for Advanced App Extension update product configuration actions. These methods update the product configuration with the new attribute values provided in the configuration object. See the API documentation.

Order information retrieval API

Release date: 17 June, 2024

You can now use the Order information retrieval API to retrieve information related to orders being processed in the NewStore platform or via an external OMS.

Previously, this method was part of Customer API v0 but has now been separated out as a standalone resource.

The Order history for customers method now also supports retrieving the history also for orders originating from NewStore OMS. To use this new functionality, provide a new Accept header in the HTTP request. See the API documentation.

April 2024​

Updates to existing APIs​

Associate App configuration API

Removal of release toggle new_gift_card_overview

As the New Gift Card overview is available for all retailers by default, the Associate App does not use the release toggle new_gift_card_overview.

The release toggle new_gift_card_overview will be removed from the Associate App configuration API on April 22, 2024.

Customer Profile Updates API

The maximum length requirement on the consumer_id property has been removed. This allows you to update customer profiles for orders that use PII tokens.

Fulfillment Request API

The Fulfillment Request API now supports a new rejection reason called rescinded, allowing retailers to reject items in a fulfillment request and reroute them without any changes to availability.

Edge cases:

  • If your organization's settings allow it (i.e. reroute_to_rejected_fulfillment_nodes is set to true), rejected fulfillment nodes will be downgraded in priority during the routing process. Otherwise, rejected fulfillment nodes will be ignored during future routing attempts (i.e. if reroute_to_rejected_fulfillment_nodes is set to false).
  • If all fulfillment nodes are rejected and you don't want to reroute to these nodes, the rejected items will be put on hold.

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:

Important

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 retrieving tax information .

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.

note

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.

note

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" \
         -d'
    {
      "policy": {
        "JP-*": {
          "limit": 8,
          "hours": {
            "*": [23, 11],
            "saturday": null,
            "sunday": null
          }
        }
      },
      {
        "US-*": {
          "limit": 8,
          "hours": {
            "*": [8, 20],
            "saturday": null,
            "sunday": null
          }
        }
      }
    }'

Related topics