Skip to main content
API docs by Redocly

Gateway (v1)

Download OpenAPI specification:Download

Product

Create a new product

This endpoint allows you to create a new product in the system. Supply all required fields, including barcode type id, barcode number, vendor product code etc. When all fields are populated it creates the Single Unit Product, Inner Pack Product, Outer Pack / Master Product & Pallet Product. A successful operation returns the created product id with a list of ids the each hierarchy level as well.

Authorizations:
Bearer
Request Body schema: application/json
required

Product object that needs to be added to the system

Array
unitBarcodeTypeId
required
string <= 5 characters

The ID of the type of barcode for the product unit. These option have a set defined list in our system. For UPC the id is 8ZdNb, EAN id is NyL2q, ISBN id is gb4aq, GTIN id is XZEjy & ASIN is is 7bNWq

unitBarcodeNumber
required
string

The numeric value of the product's barcode.

title
required
string

The main product title or name displayed in catalogs.

vendorProductCode
required
string

The unique product code assigned by the vendor or supplier.

shortDescription
required
string <= 30 characters

A short description of the product, suitable for listings. Max length 30 characters

longDescription
string

A detailed description of the product, for detailed pages or catalogs.

shelfLife
string or null
isVATApplicable
boolean or null
rspInclusive
number or null <double>
listPriceInclusive
number or null <double>
listPriceExclusive
number or null <double>
releaseDate
string or null <date-time>
unitSize
string or null
unitGrossWeight
number or null <double>
unitNetWeight
number or null <double>
unitLength
number or null <double>
unitWidth
number or null <double>
unitHeight
number or null <double>
unitTare
number or null <double>
unitIsSellableUnit
boolean or null
unitIsOrderablePack
boolean or null
innerBarcodeTypeId
string or null
innerBarcodeNumber
string or null
innerRepack
boolean or null
innerIsOrderablePack
boolean or null
innerIsSellableUnit
boolean or null
innerTare
number or null <double>
innerHeight
number or null <double>
innerWidth
number or null <double>
innerLength
number or null <double>
innerNetWeight
number or null <double>
innerGrossWeight
number or null <double>
innerQuantity
integer or null <int32>
masterBarcodeTypeId
string or null
masterBarcodeNumber
string or null
masterRepack
boolean or null
masterIsOrderableUnit
boolean or null
masterIsSellableunit
boolean or null
masterTare
number or null <double>
masterHeight
number or null <double>
masterWidth
number or null <double>
masterLength
number or null <double>
masterNetWeight
number or null <double>
masterGrossWeight
number or null <double>
masterPackQuantityPerMaster
integer or null <int32>
palletBarcodeTypeId
string or null
palletBarcodeNumber
string or null
palletRepack
boolean or null
palletIsOrderableUnit
boolean or null
palletIsSellableunit
boolean or null
palletTare
number or null <double>
palletHeight
number or null <double>
palletWidth
number or null <double>
palletLength
number or null <double>
palletNetWeight
number or null <double>
palletGrossWeight
number or null <double>
palletLayerPerPallet
integer or null <int32>
palletCasesPerLayer
integer or null <int32>

Responses

Request samples

Content type
application/json
[
  • {
    }
]