POST http:///api/v1/partner/products
The request body takes a complete ProductAddRequest resource, containing the following writable properties:
{
"active": "boolean",
"assets": [
{
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
}
],
"automaticReOrder": "boolean",
"brandId": "string",
"bundleItems": [
{
"productId": "string",
"quantity": "number"
}
],
"byGram": "boolean",
"byPrepackage": "boolean",
"cannabisType": "string",
"categoryId": "string",
"categoryName": "string",
"customGramType": "string",
"customWeight": "number",
"description": "string",
"enableExciseTax": "boolean",
"enableMixMatch": "boolean",
"externalId": "string",
"flowerType": "string",
"genetics": "string",
"importId": "string",
"lowInventoryNotification": "boolean",
"lowThreshold": "number",
"medicalConditions": [
{
"created": "int64",
"deleted": "boolean",
"id": "string",
"modified": "int64",
"name": "string",
"updated": "boolean"
}
],
"medicinal": "boolean",
"name": "string",
"overrideMetrcCategoryId": "string",
"priceIncludesALExcise": "boolean",
"priceIncludesExcise": "boolean",
"priceRanges": [
{
"assignedPrice": "number",
"id": "string",
"price": "number",
"priority": "int32",
"salePrice": "number",
"weightTolerance": {
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"enabled": "boolean",
"endWeight": "number",
"id": "string",
"modified": "int64",
"name": "string",
"priority": "int32",
"startWeight": "number",
"unitValue": "number",
"updated": "boolean",
"weightKey": "string",
"weightValue": "number"
},
"weightToleranceId": "string"
}
],
"pricingTemplateId": "string",
"producerAddress": {
"address": "string",
"addressLine2": "string",
"city": "string",
"companyId": "string",
"country": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"latitude": "number",
"longitude": "number",
"modified": "int64",
"state": "string",
"updated": "boolean",
"zipCode": "string"
},
"producerLicense": "string",
"producerMfg": "string",
"productSaleType": "string",
"productType": "string",
"reOrderLevel": "number",
"secondaryVendors": [
"string"
],
"sellable": "boolean",
"showInWidget": "boolean",
"sku": "string",
"tags": [
"string"
],
"toleranceId": "string",
"unitPrice": "number",
"usableMarijuana": "number",
"vendorId": "string",
"vendorImportId": "string",
"weightPerUnit": "string",
"wmThreshold": "number"
}
Name | Type | Description | Additional |
---|---|---|---|
active | boolean | Optional | |
assets[] | array | Optional | |
assets[].active | boolean | Optional | |
assets[].assetType | string |
Possible values are:
|
Optional |
assets[].companyId | string | Optional | |
assets[].created | int64 | Optional | |
assets[].deleted | boolean | Optional | |
assets[].id | string | Optional | |
assets[].key | string | Optional | |
assets[].largeURL | string | Optional | |
assets[].largeX2URL | string | Optional | |
assets[].mediumURL | string | Optional | |
assets[].modified | int64 | Optional | |
assets[].name | string | Optional | |
assets[].origURL | string | Optional | |
assets[].priority | int32 | Optional | |
assets[].publicURL | string | Optional | |
assets[].secured | boolean | Optional | |
assets[].thumbURL | string | Optional | |
assets[].type | string |
Possible values are:
|
Optional |
assets[].updated | boolean | Optional | |
automaticReOrder | boolean | Optional | |
brandId | string | Optional | |
bundleItems[] | array | Optional | |
bundleItems[].productId | string | Optional | |
bundleItems[].quantity | number | Optional | |
byGram | boolean | Optional | |
byPrepackage | boolean | Optional | |
cannabisType | string |
Possible values are:
|
Optional |
categoryId | string | Optional | |
categoryName | string | Optional | |
customGramType | string |
Possible values are:
|
Optional |
customWeight | number | Optional | |
description | string | Optional | |
enableExciseTax | boolean | Optional | |
enableMixMatch | boolean | Optional | |
externalId | string | Optional | |
flowerType | string | Optional | |
genetics | string | Optional | |
importId | string | Optional | |
lowInventoryNotification | boolean | Optional | |
lowThreshold | number | Optional | |
medicalConditions[] | array | Optional | |
medicalConditions[].created | int64 | Optional | |
medicalConditions[].deleted | boolean | Optional | |
medicalConditions[].id | string | Optional | |
medicalConditions[].modified | int64 | Optional | |
medicalConditions[].name | string | Optional | |
medicalConditions[].updated | boolean | Optional | |
medicinal | boolean | Optional | |
name | string |
product name |
|
overrideMetrcCategoryId | string | Optional | |
priceIncludesALExcise | boolean | Optional | |
priceIncludesExcise | boolean | Optional | |
priceRanges[] | array | Optional | |
priceRanges[].assignedPrice | number | Optional | |
priceRanges[].id | string | Optional | |
priceRanges[].price | number | Optional | |
priceRanges[].priority | int32 | Optional | |
priceRanges[].salePrice | number | Optional | |
priceRanges[].weightTolerance | object | ProductWeightTolerance | Optional |
priceRanges[].weightTolerance.companyId | string | Optional | |
priceRanges[].weightTolerance.created | int64 | Optional | |
priceRanges[].weightTolerance.deleted | boolean | Optional | |
priceRanges[].weightTolerance.enabled | boolean | Optional | |
priceRanges[].weightTolerance.endWeight | number | Optional | |
priceRanges[].weightTolerance.id | string | Optional | |
priceRanges[].weightTolerance.modified | int64 | Optional | |
priceRanges[].weightTolerance.name | string | Optional | |
priceRanges[].weightTolerance.priority | int32 | Optional | |
priceRanges[].weightTolerance.startWeight | number | Optional | |
priceRanges[].weightTolerance.unitValue | number | Optional | |
priceRanges[].weightTolerance.updated | boolean | Optional | |
priceRanges[].weightTolerance.weightKey | string |
Possible values are:
|
Optional |
priceRanges[].weightTolerance.weightValue | number | Optional | |
priceRanges[].weightToleranceId | string | Optional | |
pricingTemplateId | string | Optional | |
producerAddress | object | Address | Optional |
producerAddress.address | string | Optional | |
producerAddress.addressLine2 | string | Optional | |
producerAddress.city | string | Optional | |
producerAddress.companyId | string | Optional | |
producerAddress.country | string | Optional | |
producerAddress.created | int64 | Optional | |
producerAddress.deleted | boolean | Optional | |
producerAddress.id | string | Optional | |
producerAddress.latitude | number | Optional | |
producerAddress.longitude | number | Optional | |
producerAddress.modified | int64 | Optional | |
producerAddress.state | string | Optional | |
producerAddress.updated | boolean | Optional | |
producerAddress.zipCode | string | Optional | |
producerLicense | string | Optional | |
producerMfg | string | Optional | |
productSaleType | string |
Possible values are:
|
Optional |
productType | string |
Possible values are:
|
Optional |
reOrderLevel | number | Optional | |
secondaryVendors[] | array of string | Optional | |
sellable | boolean | Optional | |
showInWidget | boolean | Optional | |
sku | string | Optional | |
tags[] | array of string | Optional | |
toleranceId | string | Optional | |
unitPrice | number | Optional | |
usableMarijuana | number | Optional | |
vendorId | string | Optional | |
vendorImportId | string | Optional | |
weightPerUnit | string |
Possible values are:
|
Optional |
wmThreshold | number | Optional |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK successful operation |
Product |