1. Products
  • Introduction
  • Getting Started
  • Authentication
  • Error Handling
  • Contact Support
  • Modaltrans API
    • Get Auth Token
      • Get Bearer Token
    • Accounting
      • Invoices
        • Retrieve an Invoice
        • List all Invoices
    • Customs
      • NCTS Declarations
        • List all NCTS Declarations
        • Retrieve an NCTS Declaration
        • Create an NCTS Declaration with XML Data
        • Create an Ens Declaration from JSON
        • Update an NCTS Declaration
        • Download an NCTS Declaration
        • List Timelines of NCTS Declaration
        • List Messages of NCTS Decalaration
      • Customs Declarations
        • List all Customs Declarations
        • Retrieve a Custom Declaration
        • Create a Customs Declaration
        • Update a Custom Declaration
        • Delete a Custom Declaration
        • Retrieve a Declaration History
        • Retrieve an MRN Status of Declaration
      • Declaration Requests
        • List all Declaration Orders
        • Retrieve a Declaration Request
        • Create a Declaration Request
        • Update a Declaration Request
        • Delete a Declaration Request
    • Logistics
      • Bookings
        • Retrieve a Booking
        • List all Bookings
        • Create a Booking
        • Update a Booking
      • Locations
        • List all Locations
        • Retrieve a Location
      • Positions
        • Update a Transport
      • Tracking
        • Available Shipping Lines
        • Retrieve a Tracking Data
        • Subscribe to Tracking
      • Shipments
        • Retrieve a Shipment
        • List All Shipments
        • Retrieve Financials of Shipment
        • List Contacts of the Shipment
        • Create a Shipment
        • Update a Shipment
    • Depot
      • Orders
        • Retrieve an Order
        • List all Orders
        • Create an Order
        • Update an Order
      • Products
        • Retrieve a Product
          GET
        • List all Products
          GET
        • Create a Product
          POST
        • Update a Product
          PATCH
        • List Product Stocks
          GET
      • Inventories
        • List all Inventories
    • Fleet Management
      • Drivers
        • Retrieve a Driver
        • Retrieve a Driver's Vehicle
        • List Driver Positions
        • Update a Driver
      • Vehicles
        • Retrieve a Vehicle
        • Update a Vehicle
      • Gps Service Controller
        • Create Gps Responses
      • Service Logs
        • List all Service Logs
        • Retrieve a Service Log
        • Create a Service Log
        • Delete a Service Log
        • Update a Service Log
      • Periodic Documents
        • Retrieve a Periodic Document
        • Update a Periodic Document
        • Create a Periodic Document
    • CRM
      • Companies
        • List all Companies
        • Retrieve a Company
        • Create a Company
        • Update a Company
        • Delete a Company
    • Timelines
      • Retrieve a Timeline
      • List Timelines
      • Create a Timeline
    • S3 Files
      • List all S3Files
      • Create an S3File
      • Delete an S3File
    • Notifications
      • List all Notifications
      • Update a Notification Status
    • User Details
      • List User Details
      • Update User Details
  1. Products

Create a Product

Developing
Testing Env
https://demo.modaltrans.com
Testing Env
https://demo.modaltrans.com
POST
/api/v1/products
Creates a Product.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
UpdateProduct
code
string 
required
Code of the product
barcode
string 
required
Barcode for the product
product_name
string 
required
Name of the product
country_id
string 
optional
Country code where the product is registered
gtip_code
string 
optional
Gtip Code (HS code) of the product
price
number 
optional
Price of the product
price_curr
string 
optional
Currency of the product price
weight_unit
string 
optional
Weight unit of the product
imco
string 
optional
IMCO values of the product
min_count
integer 
optional
Minimum count of the product
min_temperature
number 
optional
Minimum storage temperature of the product (in °C)
max_temperature
number 
optional
Maximum storage temperature of the product (in °C)
storage_area
string 
optional
Storage area for the product
length
number 
optional
Length of the product (in cm)
width
number 
optional
Width of the product (in cm)
height
number 
optional
Height of the product (in cm)
sku_model
string 
optional
SKU model of the product
io_type
enum<string> 
optional
Input/output type of the product
Allowed values:
inputoutputinput_output
status
string 
optional
Status of the product
pack_type
string 
optional
Package Type of the product
warehouse_code
string 
required
Code of the warehouse where the product is stored
Example
{
    "product": {
        "code": "PROD12345",
        "barcode": "5012345678900",
        "product_name": "Stainless Steel Kettle",
        "warehouse_code": "TEST1212",
        "price": "29.99",
        "price_curr": "GBP",
        "imco": "imco14",
        "storage_area": "shelf",
        "length": 10.0,
        "width": 10.0,
        "height": 30.0,
        "sku_model": "KETTLE-X100", 
        "io_type": "input_output",
        "pack_type": "Box"
    }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://demo.modaltrans.com/api/v1/products' \
--header 'Content-Type: application/json' \
--data-raw '{
    "product": {
        "code": "PROD12345",
        "barcode": "5012345678900",
        "product_name": "Stainless Steel Kettle",
        "warehouse_code": "TEST1212",
        "price": "29.99",
        "price_curr": "GBP",
        "imco": "imco14",
        "storage_area": "shelf",
        "length": 10.0,
        "width": 10.0,
        "height": 30.0,
        "sku_model": "KETTLE-X100", 
        "io_type": "input_output",
        "pack_type": "Box"
    }
}'

Responses

🟢201Created
application/json
Body
array of:
code
string 
required
Code of the product
barcode
string 
required
Barcode of the product
product_name
string 
required
Name of the product
country_id
string 
required
Country ID of the product
gtip_code
string 
required
HS code of the product
price
number 
required
Price of the product
price_curr
string 
required
Currency of the price
weight_unit
string 
required
Unit of weight measurement
imco
string 
required
IMCO values of the product
min_count
integer 
required
Minimum count
min_temperature
number 
required
Minimum storage temperature
storage_area
string 
required
Storage area for the product
length
number 
required
Length of the product
width
number 
required
Width of the product
height
number 
required
Height of the product
sku_model
string 
required
SKU model of the product
io_type
string 
required
Type of input/output
status
string 
required
Status of the product
pack_type
string 
optional
Pack Type
Example
[
    {
        "code": "string",
        "barcode": "string",
        "product_name": "string",
        "country_id": "string",
        "gtip_code": "string",
        "price": 0,
        "price_curr": "string",
        "weight_unit": "string",
        "imco": "string",
        "min_count": 0,
        "min_temperature": 0,
        "storage_area": "string",
        "length": 0,
        "width": 0,
        "height": 0,
        "sku_model": "string",
        "io_type": "string",
        "status": "string",
        "pack_type": "string"
    }
]
🟠403Forbidden
🟠404Record Not Found
🟠400Bad Request
🟠422Unprocessable Entity
Modified at 2024-08-28 10:03:33
Previous
List all Products
Next
Update a Product
Built with