Products APIs

Modified on Wed, 1 Oct at 8:42 PM

Create Product

Endpoint URL

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

Example Request Body

Here is an example of a request body:

{
  "productName": "Pencil",
  "sku": "1234AB123CDEas",
  "price": "23.5",
  "taxAmount": "11",
  "barcode": "1245125123421",
  "secondBarcode": "231412312",
  "description": "This is product description",
  "brandId": 6345,
  "category": "Category of the product",
  "productImage": "",
  "customAttributes": [
    {
      "attributeName": "112",
      "attributeValue": "test product"
    }
  ]
}

Request Parameters

Name	Required	Type	Description
sku	yes	string	SKU of the product
productName	yes	string	Name of the product
price	yes	string	Price of the product
taxAmount	no	string	Tax Amount of the product
brandId	no	string	Brand id of the product
description	no	string	Description of the product
barcode	no	string	Barcode of the product
secondBarcode	no	string	Second Barcode of the product
productImage	no	string	Image Link of the product
category	no	string	Category of the product
hsCode	no	string	A standardized numerical method of classifying traded products
itemOrigin	no	string	Origin of the product
bundleItems	no	boolean	It can be true/ false
category	no		Category of product
customAttributes	no	JSONArray	Custom attributes of the product
Name	Required	Type	Description
attributeValue	no	string	Value of the attribute
attributeName	yes	string	Name of the attribute

Available Packages: All Packages

This API endpointallows clients to add new products to the system by providing key product details. This endpoint is essential for catalog management, enabling businesses to define and register products for use in their operations, such as inventory management, sales, and order processing.

Request Parameters: |

Request Paramaters for Custom Attributes array: |

Product List

Endpoint URL

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

Example Request Body

Here is an example of a request body:

{
  "pageSize": 100,
  "currentPage": 1
}

Request Parameters

Name	Required	Type	Description
pageSize	no	number	items per page, default is 100
currentPage	no	number	page numbe to be called, default is 1

Available Packages: All Packages

This API endpoint provides a simple and efficient way to retrieve a list of products available in your inventory. This endpoint returns essential product details such as names, images, SKUs, and barcodes, enabling applications to display and manage product information effectively.

Request Parameters: |

Add Box

Endpoint URL

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

Example Request Body

Here is an example of a request body:

{
  "name": "xsmall",
  "length": 25,
  "width": 24,
  "height": 9
}

Request Parameters

Name	Required	Type	Description
name	yes	string	name of the box, name should be unique
length	yes	double	length of the package
width	yes	double	width of the package
height	yes	double	height of the package

Available Packages: All Packages

This API endpoint allows you to create new boxes with the dimensions you provided.

Request Parameters: |

Update Box

Endpoint URL

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

Example Request Body

Here is an example of a request body:

{
  "name": "xsmall",
  "length": 3,
  "width": 4,
  "height": 3
}

Available Packages: All Packages

You can change the dimension information of an existing box. Since the name is unique, you can change the information of that box by entering the name information in the request.

Get Box

Endpoint URL

GET https://api.tryoto.com/rest/v2/getBox

Available Packages: All Packages

This API endpoint you to retrieve the name, id and dimension information of all boxes currently in your account.