Skip to main content
API docs by Redocly

Store operations (0.1)

Download OpenAPI specification:Download

URL: https://apidocs.newstore.io

API for managing stores and related entities, such as employees.

Employees

Employees represent the personnel that are employed at a store and contain details such as contact information and the associated store.

Use it to update and retrieve employees. Employees are created via the Identity Provider.

List employees

Retrieves the list of employees.

Related methods:

Responses

Response samples

Content type
application/json
{
  • "employees": [
    ]
}

Get employee

Retrieves the employee"s details.

path Parameters
employee_id
required
string

The unique identifier of an employee.

Responses

Response samples

Content type
application/json
{
  • "id": "4vpg8bG5iilWGkyCkUpwb0",
  • "email": "jay.doubleyou@example.com",
  • "first_name": "Jay",
  • "last_name": "DoubleYou",
  • "telephone_number": "202-111-2367",
  • "store_id": "78b4fc81-d4a2-5edd-84d9-149a84312400",
  • "image_url": "www.test-image-url.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "store": {
    },
  • "printer_location": {
    },
  • "is_active": true
}

Assign employee to a store

Assigns the employee to a store.

Only store_id is applied. The employee's identity — email, first_name, last_name, telephone_number — and is_active are owned by your identity provider and are synchronized into NewStore from user management, so sending them here has no effect: they are accepted and ignored, and listed in ignored_fields in the response.

To change an employee's name, email or phone number, change it in your identity provider. To deactivate an employee, block or remove the user in your identity provider — that clears the store assignment as well.

No field is required. A request body of {"store_id": "<store_id>"} is enough to assign a store.

path Parameters
employee_id
required
string

The unique identifier of an employee.

Request Body schema: application/json
store_id
string or null [ 1 .. 256 ] characters

The store to assign the employee to.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "store_id": "78b4fc81-d4a2-5edd-84d9-149a84312400"
}

Response samples

Content type
application/json
{
  • "id": "4vpg8bG5iilWGkyCkUpwb0",
  • "email": "jay.doubleyou@example.com",
  • "first_name": "Jay",
  • "last_name": "DoubleYou",
  • "telephone_number": "202-111-2367",
  • "store_id": "78b4fc81-d4a2-5edd-84d9-149a84312400",
  • "image_url": "www.test-image-url.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "store": {
    },
  • "printer_location": {
    },
  • "is_active": true,
  • "applied_fields": [
    ],
  • "ignored_fields": [
    ]
}

Get store employees

Gets all employees belonging to a store.

path Parameters
store_id
required
string

The identifier of the store.

Responses

Response samples

Content type
application/json
{
  • "employees": [
    ]
}

Stores

Represents a physical store in your business. It holds information on street and postal addresses, service hours, and delivery details.

Use it to create, update, and retrieve stores.

Create store

Creates a store. See the Setting up a store tutorial.

After you have created a store, you can:

Ensure that you have imported a price book before you assign it to a store. See the Importing master data tutorial.

To set up a shipping strategy for the store, including shipping methods, provider rates, and routes, create a fulfillment configuration. See the fulfillment config tutorial.

By default a fulfillment location will also be created with the same id as the store's id. If you are using custom fulfilment location IDs, then you will need to: create the fulfillment location with its custom ID so that Store Fulfillment can work with your store after creating the Store.

Related methods:

Request Body schema: application/json
label
string <= 256 characters
object (Address)

Represents an address

object or null (Address)

Represents an address

division_name
string or null

Division of the company this store belongs to.

manager_id
string or null <= 36 characters
image_url
string or null
phone_number
string or null

The telephone number at which the store can be reached.

active_status
boolean

Whether the store is active in the business. This is an informational flag: Omnichannel Manager, Associate App and store locators use it to hide inactive stores from store selectors. It does not control order routing or ATP. To stop a location from receiving fulfillment orders, disable the location via the Location API instead.

supported_shipping_methods
Array of strings
Items Enum: "traditional_carrier" "same_day_delivery" "in_store_pick_up" "in_store_handover"
gift_wrapping
boolean
pricebook
string or null

Identifier of a pricebook which should be used for this store. The pricebook defines prices for all products sold in the store. If a pricebook is not specified, a default pricebook will be used by the store.

delivery_zip_codes
Array of strings[ items [ 2 .. 32 ] characters ]
shipping_provider_info
object

Shipping provider information containing all external provider (like zip codes, the external store id and so on).

Array of objects
timezone
string <= 256 characters

Only allows timezone values that comply with the tz database.

tax_id
string or null = 9 characters
tax_included
boolean

If true, the prices associated with this store include tax.

catalog
string or null <= 256 characters

The name of the catalog containing the list of products that can be sold at this store.

locale
string or null <= 32 characters

The locale of the catalog assigned to the store. The product data in the catalog is displayed based on the locale specified here.

store_id
string [ 1 .. 256 ] characters ^[a-zA-Z0-9_-]*$

store id (only for store creation)

display_price_unit_type
string
Enum: "net" "gross"

Responses

Request samples

Content type
application/json
{
  • "label": "001_US_ABC_Street",
  • "physical_address": {
    },
  • "shipping_address": {
    },
  • "division_name": "US",
  • "manager_id": "466ba016-42d4-47cb-a953-0b808c949b64",
  • "image_url": "www.image-url.com",
  • "phone_number": "202-555-0138",
  • "active_status": true,
  • "supported_shipping_methods": [
    ],
  • "gift_wrapping": false,
  • "pricebook": "dodici-ca",
  • "delivery_zip_codes": [
    ],
  • "shipping_provider_info": { },
  • "business_hours": [
    ],
  • "timezone": "America/New_York",
  • "tax_id": null,
  • "tax_included": true,
  • "catalog": "storefront-catalog-en",
  • "locale": "en-US",
  • "store_id": "050_Mc_Avenue",
  • "display_price_unit_type": "gross"
}

Response samples

Content type
application/json
{
  • "label": "001_US_ABC_Street",
  • "physical_address": {
    },
  • "shipping_address": {
    },
  • "division_name": "US",
  • "manager_id": "466ba016-42d4-47cb-a953-0b808c949b64",
  • "image_url": "www.image-url.com",
  • "phone_number": "202-555-0138",
  • "active_status": true,
  • "supported_shipping_methods": [
    ],
  • "gift_wrapping": false,
  • "pricebook": "dodici-ca",
  • "delivery_zip_codes": [
    ],
  • "shipping_provider_info": { },
  • "business_hours": [
    ],
  • "timezone": "America/New_York",
  • "tax_id": null,
  • "tax_included": true,
  • "catalog": "storefront-catalog-en",
  • "locale": "en-US",
  • "store_id": "050_Mc_Avenue",
  • "display_price_unit_type": "gross",
  • "revision": 1,
  • "updated_at": null,
  • "created_at": null
}

List stores

Retrieves the list of stores.

Related methods:

query Parameters
lat
number

Used if you want to fetch nearby stores. You must provide both latitude and longitude to query by location.

long
number

Used if you want to fetch nearby stores. You must provide both latitude and longitude to query by location.

radius
number

Used if you want to fetch nearby stores. Given a set of coordinates, only stores within this distance (in meters) will be returned.

max_stores
number

Used if you want to fetch nearby stores. Maximum number of stores returned when fetching by location. Latitude and longitude parameters are mandatory.

Responses

Response samples

Content type
application/json
{
  • "stores": [
    ]
}

Get store

Gets the store and all its detailed information.

path Parameters
store_id
required
string

The unique identifier of a store.

Responses

Response samples

Content type
application/json
{
  • "label": "001_US_ABC_Street",
  • "physical_address": {
    },
  • "shipping_address": {
    },
  • "division_name": "US",
  • "manager_id": "466ba016-42d4-47cb-a953-0b808c949b64",
  • "image_url": "www.image-url.com",
  • "phone_number": "202-555-0138",
  • "active_status": true,
  • "supported_shipping_methods": [
    ],
  • "gift_wrapping": false,
  • "pricebook": "dodici-ca",
  • "delivery_zip_codes": [
    ],
  • "shipping_provider_info": { },
  • "business_hours": [
    ],
  • "timezone": "America/New_York",
  • "tax_id": null,
  • "tax_included": true,
  • "catalog": "storefront-catalog-en",
  • "locale": "en-US",
  • "store_id": "050_Mc_Avenue",
  • "display_price_unit_type": "gross",
  • "revision": 1,
  • "updated_at": null,
  • "created_at": null
}

Update store

Updates the store. Only attributes supplied in the request are changed.

Note: When you deactivate a store, ensure that the store has no employees assigned to it. To prevent routing orders to deactivated stores, also contact NewStore support to ensure that:

  • there is no stock left in the store.
  • the fulfillment configuration is updated to remove the fulfillment_node_id matching the store.

Related methods:

path Parameters
store_id
required
string

The unique identifier of a store.

Request Body schema: application/json
label
string <= 256 characters
object (Address)

Represents an address

object or null (Address)

Represents an address

division_name
string or null

Division of the company this store belongs to.

manager_id
string or null <= 36 characters
image_url
string or null
phone_number
string or null

The telephone number at which the store can be reached.

active_status
boolean

Whether the store is active in the business. This is an informational flag: Omnichannel Manager, Associate App and store locators use it to hide inactive stores from store selectors. It does not control order routing or ATP. To stop a location from receiving fulfillment orders, disable the location via the Location API instead.

supported_shipping_methods
Array of strings
Items Enum: "traditional_carrier" "same_day_delivery" "in_store_pick_up" "in_store_handover"
gift_wrapping
boolean
pricebook
string or null

Identifier of a pricebook which should be used for this store. The pricebook defines prices for all products sold in the store. If a pricebook is not specified, a default pricebook will be used by the store.

delivery_zip_codes
Array of strings[ items [ 2 .. 32 ] characters ]
shipping_provider_info
object

Shipping provider information containing all external provider (like zip codes, the external store id and so on).

Array of objects
timezone
string <= 256 characters

Only allows timezone values that comply with the tz database.

tax_id
string or null = 9 characters
tax_included
boolean

If true, the prices associated with this store include tax.

catalog
string or null <= 256 characters

The name of the catalog containing the list of products that can be sold at this store.

locale
string or null <= 32 characters

The locale of the catalog assigned to the store. The product data in the catalog is displayed based on the locale specified here.

store_id
string [ 1 .. 256 ] characters ^[a-zA-Z0-9_-]*$

store id (only for store creation)

display_price_unit_type
string
Enum: "net" "gross"

Responses

Request samples

Content type
application/json
{
  • "label": "001_US_ABC_Street",
  • "physical_address": {
    },
  • "shipping_address": {
    },
  • "division_name": "US",
  • "manager_id": "466ba016-42d4-47cb-a953-0b808c949b64",
  • "image_url": "www.image-url.com",
  • "phone_number": "202-555-0138",
  • "active_status": true,
  • "supported_shipping_methods": [
    ],
  • "gift_wrapping": false,
  • "pricebook": "dodici-ca",
  • "delivery_zip_codes": [
    ],
  • "shipping_provider_info": { },
  • "business_hours": [
    ],
  • "timezone": "America/New_York",
  • "tax_id": null,
  • "tax_included": true,
  • "catalog": "storefront-catalog-en",
  • "locale": "en-US",
  • "store_id": "050_Mc_Avenue",
  • "display_price_unit_type": "gross"
}

Response samples

Content type
application/json
{
  • "label": "001_US_ABC_Street",
  • "physical_address": {
    },
  • "shipping_address": {
    },
  • "division_name": "US",
  • "manager_id": "466ba016-42d4-47cb-a953-0b808c949b64",
  • "image_url": "www.image-url.com",
  • "phone_number": "202-555-0138",
  • "active_status": true,
  • "supported_shipping_methods": [
    ],
  • "gift_wrapping": false,
  • "pricebook": "dodici-ca",
  • "delivery_zip_codes": [
    ],
  • "shipping_provider_info": { },
  • "business_hours": [
    ],
  • "timezone": "America/New_York",
  • "tax_id": null,
  • "tax_included": true,
  • "catalog": "storefront-catalog-en",
  • "locale": "en-US",
  • "store_id": "050_Mc_Avenue",
  • "display_price_unit_type": "gross",
  • "revision": 1,
  • "updated_at": null,
  • "created_at": null
}