Skip to main content
API docs by Redocly

Inventory Manager (0.0.0)

Download OpenAPI specification:Download

Adjusting

List Adjustment Reasons

Lists the reasons for inventory adjustments.

Related methods:

query Parameters
should_include_inactive
boolean (Should Include Inactive)
Default: false

Can display all adjustment reasons, including inactive ones.

Responses

Response samples

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

Create Adjustment Reason

Creates an adjustment reason, which can be used across all stores configured for your business.

Use the type and subtype properties to define the adjustment type and reason for users to select on NewStore Associate App, when adjusting inventory in the store.

Note: you need to pass at least one of: origin_stock_location, destination_stock_location and they need to be created beforehand.

Related methods:

Request Body schema: application/json
destination_stock_location
string (Destination Stock Location)
origin_stock_location
string (Origin Stock Location)
subtype
required
string (Subtype)
type
required
string (Type)

Responses

Request samples

Content type
application/json
{
  • "destination_stock_location": "string",
  • "origin_stock_location": "string",
  • "subtype": "string",
  • "type": "string"
}

Response samples

Content type
application/json
null

Update Adjustment Reason

Use this method to update adjustment reasons in your business.

When you create adjustment reasons for your business, they are activated by default. However, if you do not want associates to use a specific adjustment reason to adjust inventory in the store using NewStore Associate App, deactivate it using this method.

Note: Deactivating an adjustment reason does not delete it from the platform.

If associates have used the adjustment reason before you deactivated it, the reason will still be displayed in the list of inventory adjustments or transactions that are associated with it.

path Parameters
reason_id
required
string <uuid> (Reason Id)

Unique identifier of the adjustment reason

Request Body schema: application/json
is_activated
boolean (Is Activated)
subtype
string (Subtype)
type
string (Type)

Responses

Request samples

Content type
application/json
{
  • "is_activated": true,
  • "subtype": "string",
  • "type": "string"
}

Response samples

Content type
application/json
null

Create Adjustment

Creates an adjustment

Request Body schema: application/json
external_ref
string (External Ref)
required
Array of objects (Line Items)
location_id
required
string (Location Id)
note
string (Note)
reason_id
required
string <uuid> (Reason Id)

Responses

Request samples

Content type
application/json
{
  • "external_ref": "string",
  • "line_items": [
    ],
  • "location_id": "string",
  • "note": "string",
  • "reason_id": "e93b00b6-69c5-47ba-b0e6-cff780f2f878"
}

Response samples

Content type
application/json
null

Configuration

Get Configuration

Retrieves the complete inventory configuration for the retailer.

Responses

Response samples

Content type
application/json
{
  • "allow_asn_overreceiving": false,
  • "create_cycle_count_after_mispack": false,
  • "create_cycle_count_after_mispick": false
}

Patch Configuration

Update the inventory configuration set up for the retailer.

Request Body schema: application/json
allow_asn_overreceiving
boolean (Allow Asn Overreceiving)
Default: true

If it is true, allow to receive more items than specified in ASN. Default is true.

create_cycle_count_after_mispack
boolean (Create Cycle Count After Mispack)
Default: false

If it is true, create cycle count transaction after mispacked fulfillment logistic order.

create_cycle_count_after_mispick
boolean (Create Cycle Count After Mispick)
Default: false

If it is true, create cycle count transaction after mispicked fulfillment logistic order.

Responses

Request samples

Content type
application/json
{
  • "allow_asn_overreceiving": false,
  • "create_cycle_count_after_mispack": false,
  • "create_cycle_count_after_mispick": false
}

Response samples

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

Put Configuration

Replace the inventory configuration set up for the retailer.

Request Body schema: application/json
allow_asn_overreceiving
required
boolean (Allow Asn Overreceiving)
create_cycle_count_after_mispack
required
boolean (Create Cycle Count After Mispack)
create_cycle_count_after_mispick
required
boolean (Create Cycle Count After Mispick)

Responses

Request samples

Content type
application/json
{
  • "allow_asn_overreceiving": false,
  • "create_cycle_count_after_mispack": false,
  • "create_cycle_count_after_mispick": false
}

Response samples

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

Receiving

List ASNs

List ASNs.

query Parameters
offset
integer (Offset) >= 0
Default: 0

Page offset

count
integer (Count) >= 1
Default: 10

Page length

search
string (Search)

Search terms

start_shipment_date
string <date> (Start Shipment Date)

Earliest shipping date limit

end_shipment_date
string <date> (End Shipment Date)

Latest shipping date limit

status
Array of strings (AsnStatus)
Default: []
Items Enum: "open" "partially_completed" "closed"

ASN statuses

origin_id
Array of strings (Origin Id)
Default: []

ASN origin location identifiers

destination_id
Array of strings (Destination Id)
Default: []

ASN destination location identifiers

sort
Array of strings (Sort) ^-?created_at$
Default: []

Sort the resulting list.

Responses

Response samples

Content type
application/json
null

Create ASN

Creates an ASN against which items can be received into the store's stock on hand.

Request Body schema: application/json
from_location
required
string (From Location)

The identifier of the location ASN was shipped from.

fulfillment_node_id
required
string (Fulfillment Node Id)

The identifier of the fulfillment_node ASN was created for.

required
Array of objects (Items) non-empty

The expected line items to receive.

required
object (References)

Represents the ASN reference that specifies the inventory line items being received.

shipment_date
required
string <date-time> (Shipment Date)

The shipping date for the ASN in ISO 8601 format.

Responses

Request samples

Content type
application/json
{
  • "from_location": "testlocation",
  • "fulfillment_node_id": "7809c25e-630c-42d1-aa5d-f61388b97d74",
  • "items": [
    ],
  • "references": {
    },
  • "shipment_date": "2019-03-25T22:00:00Z"
}

Response samples

Content type
application/json
null

Get ASN

Note that received items that are the same (because they were repeated on ASN creation) will get merged when. This means that their expected and received quantities get summed up when getting the ASN. Being the same means having the same product id. and carton id.; if the same product exists in multiple cartons or if it exists in a carton and without a carton, it won't be merged (unless it had a carton but it was received without a carton).

path Parameters
asn_id
required
string <uuid> (Asn Id) 
    The unique identifier of the ASN. Use the
    [List ASNs](/newstore-cloud/inventory/inventory_manager_api_api.html#operation/listASNs)
    method to retrieve the ID.

Responses

Response samples

Content type
application/json
{
  • "completion_date": "2019-08-24T14:15:22Z",
  • "force_closed_by": "string",
  • "from_location": "string",
  • "fulfillment_node_id": "string",
  • "id": "string",
  • "item_total": 0,
  • "line_items": [
    ],
  • "received_item_total": 0,
  • "received_product_total": 0,
  • "references": {
    },
  • "revision": 0,
  • "shipment_date": "2019-08-24T14:15:22Z",
  • "status": "open",
  • "to_location_label": "string",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Execute ASN action

Executes actions on an ASN.

path Parameters
asn_id
required
string <uuid> (Asn Id)

The ASN identifier

Request Body schema: application/json
type
required
any (Type)
Value: "CLOSE"

An enumeration.

Responses

Request samples

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

Response samples

Content type
application/json
null

Counting

Import stock quantities

Imports stock quantities for products in the specified stock location, in the specified store configured for your business. The uploaded file is processed asynchronously.

Important: Use this method to start importing stock quantities only when NewStore is inventory master in the store.

To import stock quantities, upload a CSV file with the quantities to import for products in this stock location. See this example CSV file for reference.

path Parameters
fulfillment_node_id
required
string (Fulfillment Node Id)

Fulfillment node of the import

stock_location
required
string (Stock Location) 
The name of the stock location. To retrieve the name of the stock location,
use the [List stock locations](/newstore-cloud/inventory/stock_locations.html#operation/listStockLocations) method.
Request Body schema: multipart/form-data
count_type
required
string
Enum: "cycle_count" "full_count"

An enumeration.

external_id
string

A name to distinguish the import from the other ones.

file
required
string <binary>

The CSV file containing the stock quantities that you want to import.

Responses

Response samples

Content type
application/json
null

Create Count Task

Creates a count task for the specified store.

If you use NewStore as inventory master for your business, use this method to create a count task to count the items in a specific stock location.

For more information on:

path Parameters
store_id
required
string (Store Id)

The store identifier. Use the List stores method to get the ID.

Request Body schema: application/json
due_date
required
string <date> (Due Date)

The date the count transaction is scheduled for in ISO 8601 format.

external_id
required
string (External Id)

Unique external identifier for the count task.

product_ids
required
Array of strings (Product Ids) non-empty [ items non-empty ]

The array of product identifiers to be counted.

stock_location
string (Stock Location) 
    The stock location name in which the cycle count should be done.
    If no value is provided, or NewStore is not the inventory master for
    your business, the cycle count task is created for the default stock
    location in the store.

Responses

Request samples

Content type
application/json
{
  • "due_date": "2022-10-10",
  • "external_id": "cycle-count-x",
  • "product_ids": [
    ],
  • "stock_location": "main"
}

Response samples

Content type
application/json
null

Transferring

Create Transfer Order

Creates a transfer order that contains a list of items to be transferred from one store to another.

If you use NewStore as inventory master for your business, use this method to create a transfer order to transfer items from a specific stock location to the main or default stock location of another store or DC.

For more information on:

  • Using NewStore as inventory master in the store, see Enabling a location as inventory master.
  • Managing stock locations in your business, see Stock locations.
Request Body schema: application/json
due_date
string <date-time> (Due Date)

Represents the date when the transfer order is due.

external_ref
required
string (External Ref)

Represents the external reference by which external system can refer to this item.

from_location_id
required
string (From Location Id)

The fulfillment node identifier of the location from where the transfer order is sent.

from_stock_location
string (From Stock Location)

The stock location from which the items are being transferred.

required
Array of objects (Items) non-empty

Ordered product identifier with its quantity.

order_date
required
string <date-time> (Order Date)

Represents the date when the transfer order was created.

to_location_id
required
string (To Location Id)

The fulfillment node identifier of the location to where the transfer order is sent.

Responses

Request samples

Content type
application/json
{
  • "due_date": "2019-08-24T14:15:22Z",
  • "external_ref": "string",
  • "from_location_id": "string",
  • "from_stock_location": "string",
  • "items": [
    ],
  • "order_date": "2019-08-24T14:15:22Z",
  • "to_location_id": "string"
}

Response samples

Content type
application/json
null

Create Transfer

Create and start a transfer.

path Parameters
transfer_order_id
required
string <uuid> (Transfer Order Id)

The identifier of the open transfer order to create a transaction in.

Responses

Response samples

Content type
application/json
null

Get Transfer Shipping Configuration

Retrieves the transfer shipping configuration set up for your business. The response includes the transfer shipping configuration with a list of shipping routes and the service levels configured for each route.

Responses

Response samples

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

Create or Update Transfer Shipping Configuration

Creates or updates a transfer shipping configuration, used for shipping transfer orders. A transfer order is used to send inventory from a store to another location (DC or store). When you update the configuration using this method, the response body contains the revision of the configuration.

The values of the from_location_id and to_location_ids properties in the schema are set during the first stock import.

The transfer configuration is related to the fulfillment configuration. The service levels (service_level_ids) you use in the transfer configuration:

  • Must be present in your fulfillment configuration.
  • Have the same service level priority as in the fulfillment configuration.

For a complete example, see

Tutorial: Setting up a transfer configuration.

Request Body schema: application/json
required
Array of objects (Transfer Shipping Configuration)
Array
from_location_id
required
string (From Location Id)
service_level_ids
required
Array of strings (Service Level Ids)
to_location_ids
required
Array of strings (To Location Ids)

Responses

Request samples

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

Response samples

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

Get Transfer

Get the details of a Transfer.

path Parameters
transfer_id
required
string <uuid> (Transfer Id)

Transfer Transaction identifier.

Responses

Response samples

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