Skip to main content

Store operations (0.1)

Download OpenAPI specification:Download

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 create, update, and retrieve employees.

List employees

Retrieves the list of employees.

Related methods:

Responses

Response samples

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

Create employee

Creates a new employee. Before using this method, ensure you have created a store.

Related methods:

Request Body schema: application/json
id
string <= 36 characters
email
required
string <= 256 characters
first_name
required
string <= 256 characters
last_name
required
string <= 256 characters
telephone_number
required
string <= 32 characters
store_id
string or null [ 1 .. 256 ] characters
image_url
string or null <= 256 characters
created_at
string <date-time>
updated_at
string <date-time>
object or null
object or null
is_active
boolean

Responses

Request 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
}

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
}

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
}

Update employee

Updates the employee. Only attributes specified in the request are changed.

path Parameters
employee_id
required
string

The unique identifier of an employee.

Request Body schema: application/json
id
string <= 36 characters
email
required
string <= 256 characters
first_name
required
string <= 256 characters
last_name
required
string <= 256 characters
telephone_number
required
string <= 32 characters
store_id
string or null [ 1 .. 256 ] characters
image_url
string or null <= 256 characters
created_at
string <date-time>
updated_at
string <date-time>
object or null
object or null
is_active
boolean

Responses

Request 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
}

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
}

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": [
    ]
}

Printer Locations

Groups printers in a physical location of the store.

Get printer location

Returns the printer location with the given ID.

path Parameters
uuid
required
string

The identifier of the printer location.

store_id
required
string

The identifier of the store.

Responses

Response samples

Content type
application/json
{
  • "printer_location": {
    }
}

Update printer location.

Update existing printer location with the given UUID.

path Parameters
uuid
required
string

The identifier of the printer location.

store_id
required
string

The identifier of the store.

Request Body schema: */*
name
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "printer_location": {
    }
}

Delete printer location

Remove the printer location with the given UUID.

path Parameters
uuid
required
string

The identifier of the printer location.

store_id
required
string

The identifier of the store.

Responses

Printers

Represents a printer in the store.

List printers

Returns the list of printers set up in the store.

path Parameters
store_id
required
string

The identifier of the store.

Responses

Response samples

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

Create printer

Creates a new printer.

path Parameters
store_id
required
string

The identifier of the store.

Request Body schema: application/json
ipv4
string <= 16 characters
ipv6
string <= 40 characters
location
string <= 100 characters
mac_address
string [ 17 .. 32 ] characters
manufacturer
required
string
Enum: "Virtual" "Star" "AirPrint" "Posnet" "Epson"
model
string [ 3 .. 64 ] characters
name
required
string [ 3 .. 64 ] characters
paper_size
string or null <= 32 characters
printer_location_id
string = 36 characters
store_id
required
string [ 1 .. 256 ] characters
type
required
string
Enum: "document_printer" "label_printer" "fiscal_printer"
url
string <= 256 characters
port
integer
serial_number
string [ 1 .. 256 ] characters

Responses

Request samples

Content type
application/json
{
  • "ipv4": "string",
  • "ipv6": "string",
  • "location": "string",
  • "mac_address": "stringstringstrin",
  • "manufacturer": "Virtual",
  • "model": "string",
  • "name": "string",
  • "paper_size": "string",
  • "printer_location_id": "stringstringstringstringstringstring",
  • "store_id": "string",
  • "type": "document_printer",
  • "url": "string",
  • "port": 0,
  • "serial_number": "string"
}

Response samples

Content type
application/json
{
  • "printer": {
    }
}

Get printer

Returns the printer with the given ID.

path Parameters
uuid
required
string

The identifier of the printer.

store_id
required
string

The identifier of the store.

Responses

Response samples

Content type
application/json
{
  • "printer": {
    }
}

Update printer

Updates existing printer with the given UUID.

path Parameters
uuid
required
string

The identifier of the printer.

store_id
required
string

The identifier of the store.

Request Body schema: appplication/json
ipv4
string <= 16 characters
ipv6
string <= 40 characters
location
string <= 100 characters
mac_address
string [ 17 .. 32 ] characters
manufacturer
required
string
Enum: "Virtual" "Star" "AirPrint" "Posnet" "Epson"
model
string [ 3 .. 64 ] characters
name
required
string [ 3 .. 64 ] characters
paper_size
string or null <= 32 characters
printer_location_id
string = 36 characters
store_id
required
string [ 1 .. 256 ] characters
type
required
string
Enum: "document_printer" "label_printer" "fiscal_printer"
url
string <= 256 characters
port
integer
serial_number
string [ 1 .. 256 ] characters

Responses

Request samples

Content type
appplication/json
{
  • "ipv4": "string",
  • "ipv6": "string",
  • "location": "string",
  • "mac_address": "stringstringstrin",
  • "manufacturer": "Virtual",
  • "model": "string",
  • "name": "string",
  • "paper_size": "string",
  • "printer_location_id": "stringstringstringstringstringstring",
  • "store_id": "string",
  • "type": "document_printer",
  • "url": "string",
  • "port": 0,
  • "serial_number": "string"
}

Response samples

Content type
application/json
{
  • "printer": {
    }
}

Delete printer

Removes the printer with the given UUID.

path Parameters
uuid
required
string

The identifier of the printer.

store_id
required
string

The identifier of the store.

Responses

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. Use the queue_prioritization property to define the priority for fulfillment requests on NewStore Fulfillment App. See About order fulfillment.

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.

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
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.

Array of objects
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_-]*$
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": "string",
  • "image_url": "www.image-url.com",
  • "phone_number": "202-555-0138",
  • "active_status": true,
  • "supported_shipping_methods": "in_store_pick_up",
  • "gift_wrapping": false,
  • "pricebook": "dodici-ca",
  • "delivery_zip_codes": [
    ],
  • "shipping_provider_info": { },
  • "business_hours": [
    ],
  • "timezone": "America/New_York",
  • "tax_id": "stringstr",
  • "tax_included": true,
  • "queue_prioritization": [
    ],
  • "catalog": "string",
  • "locale": "string",
  • "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": "string",
  • "image_url": "www.image-url.com",
  • "phone_number": "202-555-0138",
  • "active_status": true,
  • "supported_shipping_methods": "in_store_pick_up",
  • "gift_wrapping": false,
  • "pricebook": "dodici-ca",
  • "delivery_zip_codes": [
    ],
  • "shipping_provider_info": { },
  • "business_hours": [
    ],
  • "timezone": "America/New_York",
  • "tax_id": "stringstr",
  • "tax_included": true,
  • "queue_prioritization": [
    ],
  • "catalog": "string",
  • "locale": "string",
  • "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": "string",
  • "image_url": "www.image-url.com",
  • "phone_number": "202-555-0138",
  • "active_status": true,
  • "supported_shipping_methods": "in_store_pick_up",
  • "gift_wrapping": false,
  • "pricebook": "dodici-ca",
  • "delivery_zip_codes": [
    ],
  • "shipping_provider_info": { },
  • "business_hours": [
    ],
  • "timezone": "America/New_York",
  • "tax_id": "stringstr",
  • "tax_included": true,
  • "queue_prioritization": [
    ],
  • "catalog": "string",
  • "locale": "string",
  • "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
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.

Array of objects
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_-]*$
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": "string",
  • "image_url": "www.image-url.com",
  • "phone_number": "202-555-0138",
  • "active_status": true,
  • "supported_shipping_methods": "in_store_pick_up",
  • "gift_wrapping": false,
  • "pricebook": "dodici-ca",
  • "delivery_zip_codes": [
    ],
  • "shipping_provider_info": { },
  • "business_hours": [
    ],
  • "timezone": "America/New_York",
  • "tax_id": "stringstr",
  • "tax_included": true,
  • "queue_prioritization": [
    ],
  • "catalog": "string",
  • "locale": "string",
  • "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": "string",
  • "image_url": "www.image-url.com",
  • "phone_number": "202-555-0138",
  • "active_status": true,
  • "supported_shipping_methods": "in_store_pick_up",
  • "gift_wrapping": false,
  • "pricebook": "dodici-ca",
  • "delivery_zip_codes": [
    ],
  • "shipping_provider_info": { },
  • "business_hours": [
    ],
  • "timezone": "America/New_York",
  • "tax_id": "stringstr",
  • "tax_included": true,
  • "queue_prioritization": [
    ],
  • "catalog": "string",
  • "locale": "string",
  • "store_id": "050_Mc_Avenue",
  • "display_price_unit_type": "gross",
  • "revision": 1,
  • "updated_at": null,
  • "created_at": null
}