Skip to main content

Example payloads

Minimum required fields to create a Master Product​

[
  {
    "masterProductId": "",
    "mainDetails": {
      "title": "Koo Baked Beans",
      "shortDescription": "Koo Baked Beans"
    },
    "unit": {
      "barcodeTypeId": "NyL2q",
      "barcodeNumber": "1",
      "longDescription":"Koo Baked Beans Single Unit",
      "vendorProductCode":"HJ-KNJJNSNJS-UN1"
    },
    "inner": {
      "barcodeTypeId": "NyL2q",
      "barcodeNumber": "1",
      "longDescription":"Koo Baked Beans Inner-Pack",
      "vendorProductCode":"HJ-KNJJNSNJS-IN2"
    },
    "master": {
      "barcodeTypeId": "NyL2q",
      "barcodeNumber": "1",
      "longDescription":"Koo Baked Beans Master-Pack",
      "vendorProductCode":"HJ-KNJJNSNJS-MA3"
    },
    "pallet": {
      "barcodeTypeId": "NyL2q",
      "barcodeNumber": "1",
      "longDescription":"Koo Baked Beans Pallet"",
      "vendorProductCode":"HJ-KNJJNSNJS-PA4"
    }
  }
]

Example cURL request​

curl -X POST "https://gateway.fmcg.dotzw.com/api/orchestration/product/master/create" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "masterProductId": "",
    "mainDetails": {
      "title": "Koo Baked Beans",
      "shortDescription": "Koo Baked Beans"
    },
    "unit": {
      "barcodeTypeId": "NyL2q",
      "barcodeNumber": "1",
      "longDescription":"Koo Baked Beans Single Unit",
      "vendorProductCode":"HJ-KNJJNSNJS-UN1"
    },
    "inner": {
      "barcodeTypeId": "NyL2q",
      "barcodeNumber": "1",
      "longDescription":"Koo Baked Beans Inner-Pack",
      "vendorProductCode":"HJ-KNJJNSNJS-IN2"
    },
    "master": {
      "barcodeTypeId": "NyL2q",
      "barcodeNumber": "1",
      "longDescription":"Koo Baked Beans Master-Pack",
      "vendorProductCode":"HJ-KNJJNSNJS-MA3"
    },
    "pallet": {
      "barcodeTypeId": "NyL2q",
      "barcodeNumber": "1",
      "longDescription":"Koo Baked Beans Pallet"",
      "vendorProductCode":"HJ-KNJJNSNJS-PA4"
    }
  }
]'

Minimum required fields to create a Variant Product​

[
  {
    "masterProductId" : "<ID of an existing Master Product. You need to have created a Master Product before you create a Variant>",
    "mainDetails": {
      "title": "Koo Baked Beans",
      "shortDescription": "Koo Baked Beans"
    },
    "unit": {
      "barcodeTypeId": "NyL2q",
      "barcodeNumber": "1",
      "longDescription":"Koo Baked Beans Single Unit",
      "vendorProductCode":"HJ-KNJJNSNJS-UN1"
    },
    "inner": {
      "barcodeTypeId": "NyL2q",
      "barcodeNumber": "1",
      "longDescription":"Koo Baked Beans Inner-Pack",
      "vendorProductCode":"HJ-KNJJNSNJS-IN2"
    },
    "master": {
      "barcodeTypeId": "NyL2q",
      "barcodeNumber": "1",
      "longDescription":"Koo Baked Beans Master-Pack",
      "vendorProductCode":"HJ-KNJJNSNJS-MA3"
    },
    "pallet": {
      "barcodeTypeId": "NyL2q",
      "barcodeNumber": "1",
      "longDescription":"Koo Baked Beans Pallet"",
      "vendorProductCode":"HJ-KNJJNSNJS-PA4"
    }
  }
]

Example cURL request​

curl -X POST "https://gateway.fmcg.dotzw.com/api/orchestration/product/variant/create" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "masterProductId" : "Ikn89",
    "mainDetails": {
      "title": "Koo Baked Beans",
      "shortDescription": "Koo Baked Beans"
    },
    "unit": {
      "barcodeTypeId": "NyL2q",
      "barcodeNumber": "1",
      "longDescription":"Koo Baked Beans Single Unit",
      "vendorProductCode":"HJ-KNJJNSNJS-UN1"
    },
    "inner": {
      "barcodeTypeId": "NyL2q",
      "barcodeNumber": "1",
      "longDescription":"Koo Baked Beans Inner-Pack",
      "vendorProductCode":"HJ-KNJJNSNJS-IN2"
    },
    "master": {
      "barcodeTypeId": "NyL2q",
      "barcodeNumber": "1",
      "longDescription":"Koo Baked Beans Master-Pack",
      "vendorProductCode":"HJ-KNJJNSNJS-MA3"
    },
    "pallet": {
      "barcodeTypeId": "NyL2q",
      "barcodeNumber": "1",
      "longDescription":"Koo Baked Beans Pallet"",
      "vendorProductCode":"HJ-KNJJNSNJS-PA4"
    }
  }
]'

What's next?​

  • Test it out! Play around with our API and create some records API Reference