Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Products

Add Product

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.

post/v4/products

Request body

SkuCodestring required

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

Descriptionstring required

A brief summary providing details about the product, outlining its features, uses, and any pertinent information that helps users understand the product. <br /> <br />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.

Valuenumber double required

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

Weightstring required

The weight of the individual product in the unit of measure specified in the WeightUnitOfMeasure field. <br><br>Note: The maximum allowed weight is 1000 grams. For dutiable shipments, the minimum allowed weight is 0.001 Kg.

HSCodestring nullable

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. <br><br>Note: Characters like space and dot are supported.

CountryOfOriginstring nullable

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.

CurrencyCodestring required

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.

WeightUnitOfMeasure'KG' | 'Grams'

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.<br><br>Note: By default, this field is set to KG.</br></br>

ManufactureProductIdstring nullable

A unique manufacturer identifier for the item being shipped, for example, proprietary manufacturer code, model number, or internal code. <br><br>This field is used to reference the shipped item and supports carrier-specific requirements.

StandardisedProductIdstring nullable

A globally recognised product identifier for the item being shipped, for example, GTIN, EAN, and UPC. <br><br>This field is used for standardised item identification and supports carrier-specific requirements for customs and risk assessment.

Example request

{
  "SkuCode": "SKU123",
  "Description": "White Men Large T-shirt",
  "Value": 19.99,
  "Weight": "0.5",
  "HSCode": "6109100010",
  "CountryOfOrigin": "GB",
  "CurrencyCode": "GBP",
  "Hazmat": {
    "UNCode": "1002",
    "ProperShippingName": "Compressed Air",
    "Class": "9",
    "Id8000Category": "Nail Varnish",
    "Quantity": 3.5,
    "EmergencyActionCode": "E012"
  }
}

Response

The product was added successfully.

SkuCodestring required

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

Example response

{
  "SkuCode": "SKU123"
}