Products
Last updated
Was this helpful?
Last updated
Was this helpful?
Was this helpful?
GET /v1/core/products HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Accept: */*
{
"app": "text",
"service": "text",
"warnings": [
{}
],
"instanceId": "text",
"requestId": "text",
"data": {
"items": [
{
"image": "text",
"price": 1,
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"calories": 1,
"sort": 1,
"allergies": [
"text"
],
"active": true,
"type": "combo",
"sku": "text",
"inventory": true,
"primaryUomUid": "text",
"uid": "text",
"id": "text",
"categoryId": "text",
"taxGroupUid": "text",
"category": {
"image": "text",
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"sort": 1,
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"uid": "text",
"id": "text"
},
"bomUid": "text",
"listUids": [
"text"
],
"comboGroups": [
{
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"min": 1,
"max": 1,
"uid": "text",
"options": [
{
"upcharge": 1,
"selected": true,
"uid": "text",
"productUid": "text"
}
]
}
]
}
]
}
}POST /v1/core/products HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 432
{
"params": {
"type": "combo",
"categoryId": "text",
"image": "text",
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"price": 1,
"calories": 1,
"sort": 1,
"allergies": [
"text"
],
"active": true,
"posImageUrl": "text",
"taxGroupUid": "text",
"inventory": true,
"primaryUomUid": "text",
"comboGroups": [
{
"locales": {
"ar": {},
"en": {}
},
"min": 1,
"max": 1,
"options": [
{
"productUid": "text",
"upcharge": 1,
"selected": true
}
]
}
]
}
}{
"app": "text",
"service": "text",
"warnings": [
{}
],
"instanceId": "text",
"requestId": "text",
"data": {
"item": {
"image": "text",
"price": 1,
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"calories": 1,
"sort": 1,
"allergies": [
"text"
],
"active": true,
"type": "combo",
"sku": "text",
"inventory": true,
"primaryUomUid": "text",
"uid": "text",
"id": "text",
"category": {
"image": "text",
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"sort": 1,
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"uid": "text",
"id": "text"
},
"modifiers": [
{
"minSelection": 1,
"maxSelection": 1,
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"options": [
{
"defaultQuantity": 1,
"uid": "text",
"id": "text",
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"price": 1,
"isActive": true,
"sortNumber": 1,
"multiple": true,
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"uomAssignmentUid": "text",
"uomUid": "text",
"productUid": "text",
"modifierOption": "text"
}
]
}
],
"taxGroupUid": "text",
"bomUid": "text",
"listUids": [
"text"
],
"uomAssignments": [
{
"conversionRate": 1,
"purchasable": true,
"barcode": "text",
"uid": "text",
"uomUid": "text"
}
],
"comboGroups": [
{
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"min": 1,
"max": 1,
"uid": "text",
"options": [
{
"upcharge": 1,
"selected": true,
"uid": "text",
"productUid": "text"
}
]
}
]
}
}
}GET /v1/core/products/{uid} HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Accept: */*
{
"app": "text",
"service": "text",
"warnings": [
{}
],
"instanceId": "text",
"requestId": "text",
"data": {
"item": {
"image": "text",
"price": 1,
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"calories": 1,
"sort": 1,
"allergies": [
"text"
],
"active": true,
"type": "combo",
"sku": "text",
"inventory": true,
"primaryUomUid": "text",
"uid": "text",
"id": "text",
"category": {
"image": "text",
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"sort": 1,
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"uid": "text",
"id": "text"
},
"modifiers": [
{
"minSelection": 1,
"maxSelection": 1,
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"options": [
{
"defaultQuantity": 1,
"uid": "text",
"id": "text",
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"price": 1,
"isActive": true,
"sortNumber": 1,
"multiple": true,
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"uomAssignmentUid": "text",
"uomUid": "text",
"productUid": "text",
"modifierOption": "text"
}
]
}
],
"taxGroupUid": "text",
"bomUid": "text",
"listUids": [
"text"
],
"uomAssignments": [
{
"conversionRate": 1,
"purchasable": true,
"barcode": "text",
"uid": "text",
"uomUid": "text"
}
],
"comboGroups": [
{
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"min": 1,
"max": 1,
"uid": "text",
"options": [
{
"upcharge": 1,
"selected": true,
"uid": "text",
"productUid": "text"
}
]
}
]
}
}
}DELETE /v1/core/products/{uid} HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Accept: */*
{
"params": {
"id": "text"
}
}PATCH /v1/core/products/{uid} HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 469
{
"params": {
"categoryId": "text",
"image": "text",
"locales": {},
"price": 1,
"calories": 1,
"sort": 1,
"allergies": {},
"active": true,
"type": "combo",
"taxGroupUid": "text",
"sku": "text",
"bomUid": "text",
"inventory": true,
"primaryUomUid": "text",
"uomAssingments": [
{
"uomUid": "text",
"conversionRate": 1,
"purchasable": true,
"barcode": "text"
}
],
"comboGroups": [
{
"uid": "text",
"locales": {
"ar": {},
"en": {}
},
"min": 1,
"max": 1,
"options": [
{
"uid": "text",
"productUid": "text",
"upcharge": 1,
"selected": true
}
]
}
]
}
}{
"app": "text",
"service": "text",
"warnings": [
{}
],
"instanceId": "text",
"requestId": "text",
"data": {
"item": {
"image": "text",
"price": 1,
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"calories": 1,
"sort": 1,
"allergies": [
"text"
],
"active": true,
"type": "combo",
"sku": "text",
"inventory": true,
"primaryUomUid": "text",
"uid": "text",
"id": "text",
"category": {
"image": "text",
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"sort": 1,
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"uid": "text",
"id": "text"
},
"modifiers": [
{
"minSelection": 1,
"maxSelection": 1,
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"options": [
{
"defaultQuantity": 1,
"uid": "text",
"id": "text",
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"price": 1,
"isActive": true,
"sortNumber": 1,
"multiple": true,
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"uomAssignmentUid": "text",
"uomUid": "text",
"productUid": "text",
"modifierOption": "text"
}
]
}
],
"taxGroupUid": "text",
"bomUid": "text",
"listUids": [
"text"
],
"uomAssignments": [
{
"conversionRate": 1,
"purchasable": true,
"barcode": "text",
"uid": "text",
"uomUid": "text"
}
],
"comboGroups": [
{
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"min": 1,
"max": 1,
"uid": "text",
"options": [
{
"upcharge": 1,
"selected": true,
"uid": "text",
"productUid": "text"
}
]
}
]
}
}
}GET /v1/core/products/export HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Accept: */*
{
"app": "text",
"service": "text",
"warnings": [
{}
],
"instanceId": "text",
"requestId": "text",
"data": {
"items": [
{
"image": "text",
"price": 1,
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"calories": 1,
"sort": 1,
"allergies": [
"text"
],
"active": true,
"type": "combo",
"sku": "text",
"inventory": true,
"primaryUomUid": "text",
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"uid": "text",
"id": "text",
"categoryId": "text",
"taxGroupUid": "text",
"bomUid": "text",
"listUids": [
"text"
],
"comboGroups": [
{
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"min": 1,
"max": 1,
"uid": "text",
"options": [
{
"upcharge": 1,
"selected": true,
"uid": "text",
"productUid": "text"
}
]
}
],
"modifiers": [
{
"minSelection": 1,
"maxSelection": 1,
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"id": "text",
"options": [
{
"defaultQuantity": 1,
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"id": "text"
}
]
}
]
}
],
"next": "text"
}
}