Concepts

Zencargo provides a model for storing products in the platform, a product is defined as item that represents a tangible good that would be ordered and shipped.

Creating a product in the platform is typically the first step before a purchase order can be created, shipped, and tracked.

Below is an overview of how products are stored in the Zencargo platform.

Field Name Description Example Value
id The id of the product, this is autogenerated by the zencargo platform during product creation cfeeb6ee-91c4-46b1-9411-71185d359324
name The name of the product Blue T-Shirts
skuCode The sku code of the product 10000
barcode The barcode of the product J48fFJ3811
category The category of the product { "id": "b426b1d7-6210-4cd1-ac65-b3dc184c473b", "name": "Clothes" }
dimensions The dimensions of the product(width, height, length and unit) { "width": 5, "height": 10, "length": 20, "unit": "CM" }
weight The weight of the product(weight value and unit) { "unit": "G", "value": 100 }
unitsPerCarton The number of individual products that are packed inside a single master carton 5
cbmPerUnit The volume of a single unit in cubic meters 100
characteristics Characteristics of the product (see Example Value column to see example options) { "hot": false, "hazardous": false, "specialHandling": false, "refrigerated": false, "stackable": true, "garmentsOnHangers": false, "healthCertificate": false, "riskLevel": "LOW" }
attributes Attributes of the product [ { "attribute": { "id": "b6e596dd-203b-4867-a553-b782d5b0ea10", "name": "Colour", "type": "TEXT" }, "value": "Blue" } ]
tariffCodes Tariff codes for the product, tariff codes for different regions can be provided [ { "tariffRegionCode": "GB", "tariffCode": "12345678" } ]
sellCostPrices The sell price of the product, only one sellCostPrice can have the mainPrice as true [ { "sellCostPrice": { "value": 5, "currency": "GBP" }, "mainPrice": true } ]
buyCostPrices The buy price of the product, only one buyCostPrice can have the mainPrice as true [ { "buyCostPrice": { "value": 5, "currency": "GBP" }, "manufacturer": { "id": "b426b1d7-6210-4cd1-ac65-b3dc184c473b" }, "mainPrice": true } ]
status The status of the product(ACTIVE or ARCHIVED) ACTIVE

Below is a json payload showing an example of a Product

{
  "id": "cfeeb6ee-91c4-46b1-9411-71185d359324",
  "name": "Blue T-Shirts",
  "skuCode": "10000",
  "barcode": "J48fFJ3811",
  "category": {
    "id": "b426b1d7-6210-4cd1-ac65-b3dc184c473b",
    "name": "Clothes"
  },
  "dimensions": {
    "width": 5,
    "height": 10,
    "length": 20,
    "unit": "CM"
  },
  "weight": {
    "unit": "G",
    "value": 100
  },
  "unitsPerCarton": 5,
  "cbmPerUnit": 100,
  "characteristics": {
    "hot": false,
    "hazardous": false,
    "specialHandling": false,
    "refrigerated": false,
    "stackable": true,
    "garmentsOnHangers": false,
    "healthCertificate": false,
    "riskLevel": "LOW"
  },
  "attributes": [
    {
      "attribute": {
        "id": "b6e596dd-203b-4867-a553-b782d5b0ea10",
        "name": "Colour",
        "type": "TEXT"
      },
      "value": "Blue"
    }
  ],
  "tariffCodes": [
    {
      "tariffRegionCode": "GB",
      "tariffCode": "12345678"
    }
  ],
  "sellCostPrices": [
    {
      "sellCostPrice": {
        "value": 5,
        "currency": "GBP"
      },
      "mainPrice": true
    }
  ],
  "buyCostPrices": [
    {
      "buyCostPrice": {
        "value": 5,
        "currency": "GBP"
      },
      "manufacturer": {
        "id": "b426b1d7-6210-4cd1-ac65-b3dc184c473b"
      },
      "mainPrice": true
    }
  ],
  "status": "ACTIVE"
}

Next Steps