Configuration APIs

Use these configuration resources to configure and build all necessary features required to get started with NewStore Omnichannel Cloud as a platform. For example, you can use these APIs to configure using NewStore Associate App when offline or to set up payment strategies .

For more information, see the configuration guides or the API portal.

Important

This section only contains information about the configuration APIs in the NewStore platform. For the remaining REST APIs that can be used for integration with the NewStore platform, see the API Explorer .

These tables specify the configuration APIs required to configure a specific business context in the platform.

Order management

Resource	Purpose
DC configuration	Specify the configuration of an external OMS integration with NewStore, and order configurations such as: Order ID sequence parameters Order grace period Locations from which orders can be canceled Limit on items or SKUs that a large order can contain, before it is determined as too large an order and placed on hold. External order webhooks
External OMS ATP configuration	Retrieve ATP information from an external order management system via this webhook configuration.
External OMS and sales orders	Manage warehouse integrations with NewStore, and manage API keys and URLS for DCs.
Order status notifications	Manage notification options for order related events, which include:order_pending and order_cancelled.
Shipment notifications	Manage notification options for shipment related events, such as :shipment_delayed or shipment_delivered.
NewStore Omnichannel Manager configurations	Manage order management configurations such as release toggles in NewStore Omnichannel Manager and order tracking and exports in the platform.
Stock configuration	Specify the time after which reservationsfor orders expire in the platform.

Shipping and delivery

Resource	Purpose
Shipping options	Specify shipping options such as split order configurations and managing provider rates in the platform.
Order routing	Manage order routing configurations such as automatic routing, retrieving ATP information from an external OMS and managing shipment limits for orders.

Inventory management and store operations

Resource	Purpose
Stock on hand configuration	Manage configurations related to adjustment reasons, cycle counts, and stock on hand for your business. Use this resource to also manage inventory configurations that include: Over-receiving against an ASN Creating cycle counts after a mispick or mispack Configuring documents to print during an inventory transaction Limits for items that each inventory transaction can contain in your business
In-store pickup configuration	Manage the in-store pickup configuration set up for your business globally and for specific stores.

Store fulfillment

Resource	Purpose
Package options	Specify the package configurations, such as the width, height, or weight of packages to be used for inventory transactions in stores across your business.

Payment

Resource	Purpose
NewStore Checkout configuration API	Manage credentials required for NewStore Checkout, such as Apple Pay merchant identity certificates.
Payment configuration	Manage payment configurations for your business, including: Adyen adapter and the audit history for the adapter Square adapter and the audit history for the adapter Cash drawer configurations Gift card configurations Feature toggles or configurations for payment details in NewStore Omnichannel Manager NewStore Checkout configurations Payment accounts and options PSPconfigurations
Refund requests	Manage refunds to customers via NewStore Omnichannel Manager for order items.

Clienteling

Resource	Purpose
Clienteling configuration	Manage clienteling operations across stores in your business. Use this resource to enable clienteling capabilities in a store, and list the available phone numbers that can be used for clienteling in the store.

Checkout and Promotions

Resource	Purpose
Promotions configuration	Specify which products in your business are excluded from discounts during a promotions campaign.
Checkout configuration	Manage configurations related to checkout operations in the platform, including: Manager approvals in NewStore Associate App for orders in the store Automatic promotions via NewStore Omnichannel Manager Refund options for orders Accepting imported orders without verifying service levels for such orders Limits on items or SKUs in a large order, before it is determined as too large an order and canceled. Gift wrapping
Tax calculation	Manage configurations related to integrating Avalara and Vertex as third-party tax calculation providers with the NewStore platform.
Financial communications	Manage the configuration of notifications and financial communications sent out to customers from the NewStore platform.

Avalara license management

Manage credentials for Avalara licenses when integrating with the NewStore platform.

NewStore Omnichannel Manager and the NewStore platform

Resource	Purpose
NewStore Omnichannel Manager and email configurations	Manage email service configurations and enabling platform features in NewStore Omnichannel Manager.