Available NewStore APIs

Adjusting

List adjustment reasons

X

Create adjustment reason

X

Update adjustment reason

X

Create adjustment

X

Associate app configuration

Get associate app configuration for inventory management features

X

Set associate app configuration for inventory management features

X

Associate app retailer configuration

Get associate app configuration

X

Update associate app configuration

X

Update associate app configuration

X

Associate app store configuration

Get associate app configuration for the given store

X

Update associate app configuration

X

Update associate app configuration for the given store

X

Deletes associate app configuration for the given store

X

Automatic promotion

Get promotion

X

Update promotion

X

Create promotion

X

List promotions

X

Availabilities

Request availabilities

X

List ATP information

X

Availabilities export

Start global ATP export

X

Start ATP export for channel

X

Get ATP for channel

X

List of fulfillment location groups

X

Create fulfillment location group

X

Update fulfillment location group

X

Delete fulfillment location group

X

Cancel line items

Cancel line items

X

Capacity based routing

Patch store capacity

X

Get store capacity

X

Post store capacity

X

Get remaining store capacity

X

Update store capacity configuration using patch

X

Get the configuration for store capacity

X

Upsert the store capacity configuration using post

X

Get the store capacity availability based on the configuration and the routed items in the last 48 hours

X

Cash drawer reports

List daily cash summary reports

X

Cash drawers

List cash drawers

X

Add cash drawer

X

Update cash drawer

X

Get cash drawer

X

Decommission cash drawer

X

Start cash sale or return transaction

X

Start non-sale transaction

X

Perform a cash count

X

Track cash drawer activity

X

Activate cash drawer

X

Deactivate cash drawer

X

List daily cash reports

X

Get cash transaction

X

Finish cash sale or exchange transaction

X

Record a cash count

X

Set cash count action

X

Cash settings

List transaction types

X

Configure transaction type

X

Create reason

X

Update reason

X

Catalog import

List one catalog import mapping for a tenant

X

Create or overwrites an existing catalog import configuration

X

Delete a catalog import configuration

X

Catalog locale manager

List all catalog import configurations for a tenant

X

Categories

List categories

X

Checkout configuration

Get checkout configuration

X

Update checkout configuration

X

Replace checkout configuration

X

Configuration

Create or update a shipping option token key pair

X

Get the public key for a shipping option token

X

Add/update carrier config

X

Get carrier config

X

Add/update customs config

X

Get customs config

X

Add/update timeout value for HTTP adapters

X

Get timeout value for HTTP adapters

X

Get configuration

X

Patch configuration

X

Put configuration

X

Consumers

List order history

X

Counting

Import stock quantities

X

Create count task

X

Coupons

Create coupon

X

List coupons

X

Get coupon

X

Update coupon

X

Create coupon codes

X

Get coupon codes

X

Update coupon codes

X

Create coupon codes import

X

List coupon codes import

X

Get coupon codes import

X

Currencies

List currencies

X

Customer profile

List profiles

X

Create or show profile

X

Show profile

X

Update profile

X

Create profile deletion request

X

Customer profile address

List addresses

X

Create or show address

X

Destroy address

X

Show address

X

Update address

X

Customer profile updates

Update customer profile for order

X

Customization config

Get NewStore associate app customization configuration

X

Retrieve specific NewStore associate app customization configuration

X

Update NewStore associate app customization configuration

X

Update NewStore associate app customization configuration

X

Delivery

Create routing options

X

List shipments

X

Book a delivery

X

Create a manifest

X

Cancel delivery for delivery request ID

X

Delivery options configuration

Get customization adapter config

X

Set customization adapter config

X

Get packing timer duration

X

Set packing timer duration

X

Get shipping price config for split orders

X

Set shipping price config for split orders

X

Get config for customizable provider rates

X

Set config for customizable provider rates

X

Get priority of provider rates

X

Set priority of provider rates

X

Documents configuration

Get documents configuration

X

Set documents configuration

X

Delete store documents configuration

X

Get store document configuration

X

Set store documents configuration

X

Get priority service levels

X

Put priority service levels

X

EasyPost adapter config

Destroy EasyPost adapter config

X

Show EasyPost adapter config

X

Replace EasyPost adapter config

X

Email

Retrieve configuration options for the email service

X

Change the configuration for the email service

X

Employees

List employees

X

Create employee

X

Get employee

X

Update employee

X

Get store employees

X

Event

Publish event

X

Event stream observability

Get information about published events

X

External OMS configuration

Get external OMS configuration

X

Enable external OMS configuration

X

External order webhook

Get webhook configuration

X

Fetch historical order status

Fetch historical order status

X

Financial communication configuration

Get financial communication configuration

X

Update financial communication configuration

X

Create a financial communication configuration

X

Financial documents

Get financial documents configuration

X

Create or replace financial document configuration

X

Update financial document configuration

X

Financial instruments

Create financial instrument

X

Capture funds

X

Refund amount

X

Void funds

X

Fulfillment app configuration

Get fulfillment app configuration

X

Update fulfillment app configuration

X

Set fulfillment app configuration

X

Fulfillment config

Add or update fulfillment configuration

X

Get fulfillment config

X

Fulfillment config history

Get all revisions

X

Get revision by ID

X

Put revision by ID

X

Fulfillment provider

Accept fulfillment request

X

Get item cancelation status

X

Cancel items

X

Get item rejection status

X

Reject items

X

Resend fulfillment request

X

Get shipping status

X

Update shipping status

X

Fulfillment request

Get fulfillment requests for an order

X

Update the status of order items in a fulfillment request

X

Fulfillment requests

Create fulfillment request

X

Gift card

Return balance

X

Issue gift card

X

Activate gift card

X

Deactivate gift card

X

Activate gift card

X

Deactivate gift card

X

Identity providers

List providers

X

Create provider

X

Destroy provider

X

Show provider

X

Update provider

X

List supported providers

X

Import

List import jobs

X

Create import job

X

Get import job

X

Start import job

X

List import errors

X

Save import errors

X

Set import job status to fail

X

List import chunks

X

Import historical orders

Import historical orders

X

In-store pickup config

Create in-store pickup config

X

Get in-store pickup config

X

Delete in-store pickup config

X

Update in-store pickup config

X

Get in-store pickup config for the store

X

Update in-store pickup config for store

X

Delete in-store pickup config for store

X

In-store pickup options

Generate in-store pickup options

X

Injection configuration

Get order injection configuration

X

Update order injection configuration

X

Replace order injection configuration

X

Integration operation

Start the integration

X

Stop the integration

X

Get integration log

X

Integration registration

List registered integrations

X

Register new integration

X

Update the integration

X

Get integration details

X

Delete the integration

X

Item return

Get item return configuration

X

Update item return configuration

X

Create or replace item return configuration

X

Item returns

Create return

X

Item returns (v1)

List returns for order

X

Get return

X

List assets

Lists the assets from a tenant

X

Locales

List locales

X

Locations

List locations

X

Enable location as inventory master

X

Enable location

X

Disable location

X

Retrieve location

X

Update dc location

X

Retrieve location by store ID

X

Loyalty

Create loyalty coupon

X

Manage integration configurations

Get configuration

X

Update configuration

X

Manage orders

List product or shipping prices

X

Cancel order

X

Update grace period

X

Add serial numbers to order items

X

Manager approval

List approval rules

X

Create approval rule

X

Update approval rule

X

Delete approval rule

X

Manager approval rules

List approval rules

X

Create approval rule

X

Update approval rule

X

Delete approval rule

X

NewStore checkout

Get shopping cart

X

Create payment session

X

Process payment

X

NOM

Retrieve configuration options for NOM

X

Change configuration options for NOM

X

Order history for customers

Get order history for customer

X

Order injection

Create order

X

Orders

Request purchase history details of a customer

X

Request order details

X

Orders by ID and type

Get order by ID and ID type

X

Packages

Get documents to print configuration

X

Payment accounts

Get payments

X

Get a summary of a payment account

X

Precalculate the payment instruments for a future refund

X

Payment option: Stores

List payment options and their configuration

X

List refund options and their configuration

X

PII Data

Create data

X

Destroy data

X

Show data

X

Pricebook export

Show price book export

X

Prices

Get prices

X

Printer locations

Get printer location

X

Update printer location

X

Delete printer location

X

Printers

List printers in a store

X

Create a printer in a store

X

Get a printer in a store

X

Update printer

X

Delete printer

X

List printers

X

Create printer

X

Get printer

X

Update printer

X

Delete printer

X

Product export

List products

X

Products

List products

X

Get product details

X

Promotion configuration

Get global exclusion list

X

Update global exclusion list

X

Delete global exclusion list

X

Receipts

Get a list of receipts for the order

X

Get receipt by ID

X

Receiving

List ASNs

X

Create ASN

X

Get ASN

X

Execute ASN action

X

Refund API: Orders

List refund requests

X

Create refund request

X

Get refund request

X

Calculate refund amount

X

Rejected events

List rejected events

X

Get rejected event

X

Delete rejected event

X

Retry rejected event

X

Return process configuration

Get return configuration

X

Create or update return configuration

X

Roles

List permissions

X

List roles

X

Create role

X

Destroy role

X

Show role

X

Replace role

X

List users by role

X

Routing

Get routing insights

X

Get routing rules example

X

Get routing rules

X

Update the routing rules

X

Patch the routing rules

X

Get the routing rules section

X

Safety stock

Get safety stock

X

Set safety stock

X

Get the last safety stock update status

X

Get ATP insights

X

Sales order configuration

Get order ID sequence parameters

X

Set order ID sequence parameters

X

Get a grace period for orders

X

Create a grace period for orders

X

List locations from which orders can be canceled

X

Set locations from which orders can be canceled

X

Get limits on items for large orders

X

Set limits on items for large orders

X

Secrets

Get private key metadata

X

Service levels

List service levels

X

Set service levels

X

Patch service levels

X

Get service level

X

Shipments

Book shipment

X

Cancel shipment

X

Shipping offers

Request shipping offers

X

Shipping rules configuration

Get setting for tenant feature toggle to upload routing rules CSV

X

Set setting for tenant feature toggle to upload routing rules CSV

X

Shops

List shops

X

Get shop

X

Some tag

Complete addresses to structured results

X

Stock locations

List stock locations

X

Create stock location

X

Get stock location

X

Update stock location

X

Stock on hand

Stock of all products in a store

X

Stock of a single product in a store

X

Stock subscriptions

List subscriptions

X

Store tax configuration

Create tax configuration for a store

X

List store tax configurations

X

Get tax configuration of a store

X

Partially update the tax configuration of a store

X

Delete tax configuration of a store

X

Support endpoints

Get booking status

X

Tax quotation

Create tax quotation

X

Tax transactions

Create a preview tax transaction

X

Get tax transaction for an order

X

Get tax transaction for a return

X

Create a preview tax transaction by calculating the total amounts of cart items without storing the transaction

X

Get tax transaction for an order

X

Get tax transaction for a return

X

Templates service

List styles

X

Get style

X

Put style

X

List templates

X

Get template sample data

X

Put sample data

X

Get sample data

X

Get template documentation

X

Render template

X

Preview template

X

Get template

X

Put template

X

Delete template

X

Tenant tax configuration

Create tax configuration

X

Get tax configuration

X

Partially update tax configuration

X

Tracking

Update shipment tracking details

X

Set shipment status

X

Transferring

Create transfer order

X

Create transfer

X

Get transfer shipping configuration

X

Create or update transfer shipping configuration

X

Get transfer

X

Users

List users

X

Create user

X

Destroy user

X

Show user

X

Replace user

X