Stock Management APIs

Modified on Wed, 1 Oct at 8:43 PM

Update Stock Quantity

Endpoint URL

POST https://api.tryoto.com/rest/v2/updateStockQuantity

Example Request Body

Here is an example of a request body:

{
  "actionType": "adjust",
  "locationCode": "ASDS",
  "sku": "156487494561",
  "qty": "40"
}

Request Parameters

Name	Required	Type	Description
actionType	yes	enum	"set","adjust"
locationCode	yes	string	Location code of the inventory
sku	yes	string	SKU of the product in the inventory
qty	yes	integer	Quantity to be set or adjusted in the inventory

Available Packages: Scale Package, Enterprise Package, Marketplaces

This API endpoint enables efficient inventory management by allowing you to update the quantity of a SKU in two flexible ways:

1. Adjust : Modify the existing quantity by adding or deducting a specified amount. To decrease the quantity, provide a negative value for `qty`. For example, setting `qty` to ` 5` will deduct 5 units from the current stock.

2. Set : Directly set the quantity on hand to a specific value, replacing the current stock with the provided `qty`.

Request Parameters: |

Check Inventory Stock

Endpoint URL

GET https://api.tryoto.com/rest/v2/checkInventoryStock?sku=SG1,SG2,SG3

Request Parameters

Name	Required	Type	Description
sku	yes	string	The product's SKU identifier

Available Packages: Scale Package, Enterprise Package, Marketplaces

This API endpoint allows you to retrieve real time stock availability for products at specific locations.

It provides detailed information on the quantity of items on hand and forecasted stock for each product at various pickup locations, offering a location based view of inventory distribution.

Request Parameters: |

Response: success : Indicates whether the request was successful (`true` or `false`).

stock : A dictionary with SKUs as keys, containing a list of stock details for each location:

pickupLocationCode : The code representing the specific location.

sku : The product's SKU identifier.

quantityForecasted : The forecasted stock level at the location.

quantityOnHand : The actual available stock at the location.

Check Global Stock

Endpoint URL

GET https://api.tryoto.com/rest/v2/checkGlobalStock?sku=12,123123

Request Parameters

Name	Required	Type	Description
sku	yes	string	The product's SKU identifier

Available Packages: Scale Package, Enterprise Package, Marketplaces

This API endpoint provides an overview of total stock availability for SKUs across all locations. This endpoint aggregates stock levels to display a global view, helping businesses understand their overall inventory status.

Request Parameters: |

Response: success : Indicates whether the request was successful (`true` or `false`).

stock : A dictionary with SKUs as keys, containing global stock details for each product:

sku : The product's unique SKU identifier.

quantityOnHand : The total quantity of the product available across all locations.

quantityForecasted : The total forecasted stock quantity, if applicable.

minInventory : The minimum inventory threshold for the product, if defined.

Create Inventory Order

Endpoint URL

POST https://api.tryoto.com/rest/v2/createInventoryOrder

Example Request Body

Here is an example of a request body:

{
  "action": "inbound",
  "locationCode": "WHA",
  "binLocationName": "test",
  "orderDate": "31/03/2022",
  "deliveryDate": "31/03/2023",
  "waybillNumber": "12345",
  "description": "loc1",
  "items": [
    {
      "sku": "123123",
      "qty": "1"
    }
  ]
}

Request Parameters

Name	Required	Type	Description
action	yes	enum	"inbound": Creates the order as purchase type and sets the ingoing location field "outbound": Creates the order as disposal and sets the outgoing location field
locationCode	yes	string	Code of the warehouse or the branch of the inventory
binLocationName	no	string	Name of the desired Bin
orderDate	no	date	Date of the order, must be a valid date value
deliveryDate	no	date	Date of the delivery, must be a valid date value
waybillNumber	no	string	WayBillNumber of the order
description	no	string	Arbitrary description of the order
items	no	JSONArray	An array of the items of the order
Name	Required	Type	Description
sku	yes	string	SKU of the item of the customer that exists on database
qty	yes	integer	Quantity of the item, must be a positive number

Available Packages: Scale Package, Enterprise Package, Marketplaces

This API endpoint creates inventory order as inbound or outbound for a warehouse or branch location. This API is used mostly to provide the incoming or outgoing bulk items from ERP systems to OTO. Once the order is created the status will be new for the warehouse or branch to accept and process the order.

Request Parameters: |

Request paramaters for Items array: |

Update Packing Status

Endpoint URL

POST https://api.tryoto.com/rest/v2/updatePackingStatus

Example Request Body

Here is an example of a request body:

{
  "orderId": "123",
  "packingStatus": "packed"
}

Request Parameters

Name	Required	Type	Description
orderId	yes	string	Id of the order that you wanna update packing status
packingStatus	yes	string	Packing status value can be `packed` or `picked`

Available Packages: Scale Package, Enterprise Package, Marketplaces

This API endpoint allows you to update the packing status of an order during the fulfillment process. This endpoint is used to record and track the progress of orders as they move through the packing stage, ensuring accurate status updates for operational visibility.

Request Parameters: |

Get Orders Ready For Packing

Endpoint URL

POST https://api.tryoto.com/rest/v2/getPackingOrders

Example Request Body

Here is an example of a request body:

{
  "warehouseCode": "WH123"
}

Request Parameters

Name	Required	Type	Description
warehouseCode	yes	String	`pickupLocationCode` of the warehouse.

Available Packages: Scale Package, Enterprise Package, MarketplacesEndFragment

This API endpoint retrieves a list of orders that are ready for pick and pack operations. This endpoint is designed to streamline warehouse workflows by providing access to orders that have completed prior processes and are prepared for fulfillment.

Request Parameters: |