API References

Add Product

post
https://api.intersoftsapient.net/v4/products

Add a new product to the system. With this endpoint, you can add product details in the request body, allowing the system to store them in the database, making the product available for further use in your shipment requests.

Body Params

Product details

Product

string
required
length between 1 and 30

A unique Stock Keeping Unit (SKU) code assigned to the product. This code is essential for tracking inventory, helping users identify specific products easily.

string
required
length between 1 and 255

A brief summary providing details about the product, outlining its features, uses, and any pertinent information that helps users understand the product.

Note: If you use the data of the stored product in your create shipment requests, then this description will be used as the item description for customs purposes, detailing the specific item being shipped.

double
required
0.01 to 9999999.99

The commercial value of the product. This field is important for inventory valuation and pricing strategies.

string
required
length ≥ 1

The weight of the individual product in the unit of measure specified in the WeightUnitOfMeasure field.

Note: The maximum allowed weight is 1000 grams. For dutiable shipments, the minimum allowed weight is 0.001 Kg.

string | null

The Harmonized System (HS) code used by customs to determine potential duties and taxes for the product. This code can be 6, 8, or 13 alphanumeric characters, depending on specific services or destinations. Some countries may also use the HS codes of other character lengths, such as 10 characters.

Note: Characters like space and dot are supported.

string | null

An abbreviation representing the country where the product was manufactured or produced, following the ISO 3166-1 alpha-2 standard, for example, "GB" for the United Kingdom. This information is important for customs declarations and compliance with import/export regulations.

string
required
length between 3 and 3

An abbreviation representing the 3 letter ISO currency code in which the product's Value is expressed (for example, "GBP" for British pounds, "EUR" for euros). This is essential for financial transactions and international trade.

string
enum

The unit of measurement for the weight provided, such as the product's Weight, indicating whether the weight is specified in kilograms (KG) or grams (G), ensuring clarity for shipping calculations.

Note: By default, this field is set to KG.

Allowed:
Hazmat
object

Specifies the details whether the product is classified as hazardous material. This designation impacts shipping regulations and handling procedures.

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Updated 12 days ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated 12 days ago

Did this page help you?