POST /v1/external/products
Use this API to add a new product to your Shiprocket account. Provide the required product details and any additional info to successfully add a new product to your product list.
Notes:
- 'sku' Id has to be unique. It cannot be the same as an existing sku.
- In case no category code is added, the code should be default.
- 'type' field should be either 'single' or 'multiple.'
Parameters:
| PARAMS | REQUIRED | DATA TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|---|
sku | YES | string | Stock Keeping Unit or the identification unit of an individual product (generally alphanumeric). | bat123 |
HSN | NO | string | Harmonised System Nomenclature. A code number is used to classify goods for taxation purposes. Done to determine which category of taxes do the goods come under. | 4412 |
name | YES | string | Name of the product. | Batman Toy |
tax_code | NO | string | The percentage of tax that is to be imposed. | 10 |
type | YES | string | If there is only one product or multiple types of products. Single or Multiple | Single. |
qty | YES | integer | Total Quantity of the products to be shipped. | 5 |
low_stock | NO | string | Specifies when the low stock notification should come on | / |
category_code | YES | string | You can add a category code to your ShipRocket account from “add category” | default |
description | NO | string | Gives a description of the product. | Batman plastic toy. |
brand | NO | string | The product brand name. | Bat |
size | NO | integer | The size of the product. | 25 |
weight | NO | integer | The weight of the product in kgs. | 0.5 |
length | NO | integer | The length of the product in cms. | 10 |
width | NO | integer | The width of the product in cms. | 5 |
height | NO | integer | The height of the product in cms. | 15 |
ean | NO | string | European Article Number - A barcode for product identification (which helps manufacturers identify how many products have been sold once a sale is made). It is 13 digits long and required for international selling. | / |
upc | NO | string | Universal Product Code – Barcode for product identification which is used across the world. It is 12 digits long. | / |
isbn | NO | string | International Standard Book Number – Identification barcode for books, magazines, e-books and other published media. It is 10 digits long. | / |
color | NO | string | The colour of the product. | Black |
imei_serialnumber | NO | string | The International Mobile Equipment Identity Number, which is used by a network to identify valid devices. E.g. if two iPhones have to be shipped, they will have 2 IMEI numbers | / |
cost_price | NO | integer | The manufacture cost price of the product. | 500 |
mrp | NO | string | Maximum Retail Price. How much is the maximum price which the product can be sold at. | 1000 |
status | NO | boolean | In Boolean, if the product details have been successfully or unsuccessfully added. | 1 |
image_url | NO | string | Shows the URL of the product images which have been uploaded. | / |
Servers
- https://apiv2.shiprocket.in
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | No | |
category_code |
String | No | |
type |
String | No | |
qty |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.