| Action | Description | Request | Response |
|---|
Upsert Product | Updates or creates a product.
If the product does not exist yet, at least the "sku" must be specified in the payload. | /pricefx/{partition}/integrate/P | Code Block |
|---|
| {
"data":{
"typedId":"10947740.P",
"sku":"P-12535",
"attribute2":"20"
}
} |
|
| Code Block |
|---|
| title | Response |
|---|
| collapse | true |
|---|
| {
"response": {
"node": "user1",
"data": [
{
"version": 1,
"typedId": "10947740.P",
"sku": "P-12535",
"label": null,
"unitOfMeasure": null,
"userGroupEdit": null,
"userGroupViewDetails": null,
"currency": null,
"formulaName": null,
"image": null,
"createDate": "2020-11-25T13:03:35",
"createdBy": 5351,
"lastUpdateDate": "2020-11-25T13:03:35",
"lastUpdateBy": 5351,
"attribute1": null,
"attribute2": "20",
"attribute3": null,
"attribute4": null,
"attribute5": null,
"attribute6": null,
"attribute7": null,
"attribute8": null,
"attribute9": null,
"attribute10": null,
"attribute11": null,
"attribute12": null,
"attribute13": null,
"attribute14": null,
"attribute15": null,
"attribute16": null,
"attribute17": null,
"attribute18": null,
"attribute19": null,
"attribute20": null,
"attribute21": null,
"attribute22": null,
"attribute23": null,
"attribute24": null,
"attribute25": null,
"attribute26": null,
"attribute27": null,
"attribute28": null,
"attribute29": null,
"attribute30": null
}
],
"status": 0
}
} |
|
Upsert Multiple Products | Updates or creates several products simultaneously.
If a product does not exist yet, at least the "sku" must be specified in the payload. | /pricefx/{partition}/integrate/P | Code Block |
|---|
| [
{ "data":{
"sku":"PC-150001",
"label":"PC-150001",
"attribute2":"20"
}
},
{"data":{
"sku":"PC-150002",
"label":"PC-150002",
"attribute2":"20"
}
}
] |
|
| Code Block |
|---|
| title | Response |
|---|
| collapse | true |
|---|
| [
{
"response": {
"node": "user1",
"data": [
{
"version": 1,
"typedId": "2172502967.P",
"sku": "PC-150001",
"label": "PC-150001",
"unitOfMeasure": null,
"userGroupEdit": null,
"userGroupViewDetails": null,
"currency": null,
"formulaName": null,
"image": null,
"createDate": "2021-05-10T11:57:30",
"createdBy": 5351,
"lastUpdateDate": "2021-05-10T11:57:30",
"lastUpdateBy": 5351,
"attribute1": null,
"attribute2": "20",
"attribute3": null,
"attribute4": null,
"attribute5": null,
"attribute6": null,
"attribute7": null,
"attribute8": null,
"attribute9": null,
"attribute10": null,
"attribute11": null,
"attribute12": null,
"attribute13": null,
"attribute14": null,
"attribute15": null,
"attribute16": null,
"attribute17": null,
"attribute18": null,
"attribute19": null,
"attribute20": null,
"attribute21": null,
"attribute22": null,
"attribute23": null,
"attribute24": null,
"attribute25": null,
"attribute26": null,
"attribute27": null,
"attribute28": null,
"attribute29": null,
"attribute30": null
}
],
"status": 0
}
},
{
"response": {
"node": "user1",
"data": [
{
"version": 1,
"typedId": "2172502968.P",
"sku": "PC-150002",
"label": "PC-150002",
"unitOfMeasure": null,
"userGroupEdit": null,
"userGroupViewDetails": null,
"currency": null,
"formulaName": null,
"image": null,
"createDate": "2021-05-10T11:57:30",
"createdBy": 5351,
"lastUpdateDate": "2021-05-10T11:57:30",
"lastUpdateBy": 5351,
"attribute1": null,
"attribute2": "20",
"attribute3": null,
"attribute4": null,
"attribute5": null,
"attribute6": null,
"attribute7": null,
"attribute8": null,
"attribute9": null,
"attribute10": null,
"attribute11": null,
"attribute12": null,
"attribute13": null,
"attribute14": null,
"attribute15": null,
"attribute16": null,
"attribute17": null,
"attribute18": null,
"attribute19": null,
"attribute20": null,
"attribute21": null,
"attribute22": null,
"attribute23": null,
"attribute24": null,
"attribute25": null,
"attribute26": null,
"attribute27": null,
"attribute28": null,
"attribute29": null,
"attribute30": null
}
],
"status": 0
}
}
] |
|
Delete Product | Deletes a product specified by its typedId. | /pricefx/{partition}/delete/P | Code Block |
|---|
| {
"data":{
"typedId":"2166210775.P"
}
} |
|
| Code Block |
|---|
| title | Response |
|---|
| collapse | true |
|---|
| {
"response": {
"node": "user1",
"data": [
{
"version": 0,
"typedId": "2166210775.P",
"sku": "PP100232",
"label": "Product 01",
"unitOfMeasure": null,
"userGroupEdit": null,
"userGroupViewDetails": null,
"currency": null,
"formulaName": null,
"image": false,
"createDate": "2020-09-15T11:52:39",
"createdBy": 5351,
"lastUpdateDate": "2020-09-15T11:54:38",
"lastUpdateBy": 5351,
"attribute1": null,
"attribute2": null,
"attribute3": null,
"attribute4": null,
"attribute5": null,
"attribute6": null,
"attribute7": null,
"attribute8": null,
"attribute9": null,
"attribute10": null,
"attribute11": null,
"attribute12": null,
"attribute13": null,
"attribute14": null,
"attribute15": null,
"attribute16": null,
"attribute17": null,
"attribute18": null,
"attribute19": null,
"attribute20": null,
"attribute21": null,
"attribute22": null,
"attribute23": null,
"attribute24": null,
"attribute25": null,
"attribute26": null,
"attribute27": null,
"attribute28": null,
"attribute29": null,
"attribute30": null
}
],
"status": 0
}
} |
|
Add Product image | Adds the specified image to the specified product. | This is a little tricky but you can try to use (after necessary customization) our example that comes as a: There are variables whose values you must set (SERVER, PARTITION, UPLOAD_SLOT, SKU, etc.). Then you have to specify the file that you want to upload. In the Postman collection, you select a file in the Upload Picture step on the Body tab. |
|
Upsert Customer | Updates or creates a customer.
If the customer does not exist yet, at least the "customerId" must be specified in the payload. | /pricefx/{partition}/integrate/C | Code Block |
|---|
| {
"data":{
"customerId":"Customer007",
"attribute1":"25"
}
} |
|
| Code Block |
|---|
| title | Response |
|---|
| collapse | true |
|---|
| {
"response": {
"node": "user1",
"data": [
{
"version": 1,
"typedId": "2154738392.C",
"customerId": "Customer007",
"name": null,
"parentId": null,
"userGroupEdit": null,
"userGroupViewDetails": null,
"nodeId": 2154738392,
"createDate": "2020-11-25T13:35:11",
"createdBy": 5351,
"lastUpdateDate": "2020-11-25T13:35:11",
"lastUpdateBy": 5351,
"attribute1": "25",
"attribute2": null,
"attribute3": null,
"attribute4": null,
"attribute5": null,
"attribute6": null,
"attribute7": null,
"attribute8": null,
"attribute9": null,
"attribute10": null,
"attribute11": null,
"attribute12": null,
"attribute13": null,
"attribute14": null,
"attribute15": null,
"attribute16": null,
"attribute17": null,
"attribute18": null,
"attribute19": null,
"attribute20": null,
"attribute21": null,
"attribute22": null,
"attribute23": null,
"attribute24": null,
"attribute25": null,
"attribute26": null,
"attribute27": null,
"attribute28": null,
"attribute29": null,
"attribute30": null,
"isParent": false
}
],
"status": 0
}
} |
|
Delete Customer | Deletes a customer specified by its typedId. | /pricefx/{partition}/delete/C | Code Block |
|---|
| {
"data":{
"typedId":"2153963199.C"
}
} |
|
| Code Block |
|---|
| title | Response |
|---|
| collapse | true |
|---|
| {
"response": {
"node": "user1",
"data": [
{
"version": 0,
"typedId": "2153963199.C",
"customerId": "Customer01",
"name": "Customer 01",
"parentId": null,
"userGroupEdit": null,
"userGroupViewDetails": null,
"nodeId": 2153963199,
"createDate": "2020-09-15T13:06:54",
"createdBy": 5351,
"lastUpdateDate": "2020-09-15T13:08:08",
"lastUpdateBy": 5351,
"attribute1": null,
"attribute2": null,
"attribute3": null,
"attribute4": null,
"attribute5": null,
"attribute6": null,
"attribute7": null,
"attribute8": null,
"attribute9": null,
"attribute10": null,
"attribute11": null,
"attribute12": null,
"attribute13": null,
"attribute14": null,
"attribute15": null,
"attribute16": null,
"attribute17": null,
"attribute18": null,
"attribute19": null,
"attribute20": null,
"attribute21": null,
"attribute22": null,
"attribute23": null,
"attribute24": null,
"attribute25": null,
"attribute26": null,
"attribute27": null,
"attribute28": null,
"attribute29": null,
"attribute30": null,
"isParent": false
}
],
"status": 0
}
} |
|
Upsert Product Extension | Updates or creates a Product Extension. The payload must specify at least the PX "name" (category) and the product's "sku". | /pricefx/{partition}/integrate/PX
| Code Block |
|---|
| {
"data":{
"sku":"PC-145927",
"name":"ProductClass",
"attribute1":"High"
}
} |
|
| Code Block |
|---|
| title | Response |
|---|
| collapse | true |
|---|
| {
"response": {
"node": "user1",
"data": [
{
"version": 1,
"typedId": "2211858234.PX30",
"name": "ProductClass",
"sku": "PC-145927",
"createDate": "2020-11-25T14:27:29",
"createdBy": 5351,
"lastUpdateDate": "2020-11-25T14:27:29",
"lastUpdateBy": 5351,
"attribute1": "High",
"attribute2": null,
"attribute3": null,
"attribute4": null,
"attribute5": null,
"attribute6": null,
"attribute7": null,
"attribute8": null,
"attribute9": null,
"attribute10": null,
"attribute11": null,
"attribute12": null,
"attribute13": null,
"attribute14": null,
"attribute15": null,
"attribute16": null,
"attribute17": null,
"attribute18": null,
"attribute19": null,
"attribute20": null,
"attribute21": null,
"attribute22": null,
"attribute23": null,
"attribute24": null,
"attribute25": null,
"attribute26": null,
"attribute27": null,
"attribute28": null,
"attribute29": null,
"attribute30": null
}
],
"status": 0
}
} |
|
Delete Product Extension | Deletes a Product Extension specified by its typedId. | /pricefx/{partition}/delete/PX | Code Block |
|---|
| {
"data":{
"typedId":"6561099.PX10"
}
} |
|
| Code Block |
|---|
| title | Response |
|---|
| collapse | true |
|---|
| {
"response": {
"node": "user1",
"data": [
{
"version": 0,
"typedId": "6561099.PX10",
"name": "Performance",
"sku": "ProductXT01",
"createDate": "2020-09-15T13:12:56",
"createdBy": 5351,
"lastUpdateDate": "2020-09-15T13:12:56",
"lastUpdateBy": 5351,
"attribute1": null,
"attribute2": null,
"attribute3": null,
"attribute4": null,
"attribute5": null,
"attribute6": null,
"attribute7": null,
"attribute8": null,
"attribute9": null,
"attribute10": null
}
],
"status": 0
}
} |
|
Upsert Customer Extension | Updates or creates a customer extension. The payload must specify the CX "name" (category) and "customerId". | /pricefx/{partition}/integrate/CX
| Code Block |
|---|
| {
"data":{
"name":"CustomerType",
"customerId":"customer_02",
"attribute1":"Restaurant"
}
} |
|
| Code Block |
|---|
| title | Response |
|---|
| collapse | true |
|---|
| {
"response": {
"node": "user1",
"data": [
{
"version": 1,
"typedId": "2148099377.CX30",
"name": "CustomerType",
"customerId": "customer_02",
"createDate": "2020-11-25T14:07:15",
"createdBy": 5351,
"lastUpdateDate": "2020-11-25T14:07:15",
"lastUpdateBy": 5351,
"attribute1": "Restaurant",
"attribute2": null,
"attribute3": null,
"attribute4": null,
"attribute5": null,
"attribute6": null,
"attribute7": null,
"attribute8": null,
"attribute9": null,
"attribute10": null,
"attribute11": null,
"attribute12": null,
"attribute13": null,
"attribute14": null,
"attribute15": null,
"attribute16": null,
"attribute17": null,
"attribute18": null,
"attribute19": null,
"attribute20": null,
"attribute21": null,
"attribute22": null,
"attribute23": null,
"attribute24": null,
"attribute25": null,
"attribute26": null,
"attribute27": null,
"attribute28": null,
"attribute29": null,
"attribute30": null
}
],
"status": 0
}
} |
|
Delete Customer Extension | Deletes a Customer Extension specified by its typedId. | /pricefx/{partition}/delete/CX | Code Block |
|---|
| {
"data":{
"typedId":"2148099220.CX30"
}
} |
|
| Code Block |
|---|
| title | Response |
|---|
| collapse | true |
|---|
| {
"response": {
"node": "user1",
"data": [
{
"version": 0,
"typedId": "2148099220.CX30",
"name": "Ondrej_test",
"customerId": "CustomerXT01",
"createDate": "2020-09-15T13:39:32",
"createdBy": 5351,
"lastUpdateDate": "2020-09-15T13:39:32",
"lastUpdateBy": 5351,
"attribute1": null,
"attribute2": null,
"attribute3": null,
"attribute4": null,
"attribute5": null,
"attribute6": null,
"attribute7": null,
"attribute8": null,
"attribute9": null,
"attribute10": null,
"attribute11": null,
"attribute12": null,
"attribute13": null,
"attribute14": null,
"attribute15": null,
"attribute16": null,
"attribute17": null,
"attribute18": null,
"attribute19": null,
"attribute20": null,
"attribute21": null,
"attribute22": null,
"attribute23": null,
"attribute24": null,
"attribute25": null,
"attribute26": null,
"attribute27": null,
"attribute28": null,
"attribute29": null,
"attribute30": null
}
],
"status": 0
}
} |
|
Upsert Price Parameter value | Updates a Price Parameter value or creates a new name-value pair. The URL contains the PP table ID. | /pricefx/{partition}/lookuptablemanager.integrate/{tableId} | Code Block |
|---|
| {
"data":{
"name":"Beef",
"value":"0.05"
}
} |
|
| Code Block |
|---|
| title | Response |
|---|
| collapse | true |
|---|
| {
"response": {
"node": "user1",
"data": [
{
"version": 2,
"typedId": "2148090891.LTV",
"name": "Beef",
"value": "405",
"lowerBound": null,
"upperBound": null,
"lastUpdateByName": "admin",
"createdByName": "admin",
"tableId": 2147488006,
"type": "SIMPLE",
"valueType": "STRING",
"rawValue": "405",
"createDate": "2020-11-25T14:48:08",
"createdBy": 5351,
"lastUpdateDate": "2020-11-25T14:49:29",
"lastUpdateBy": 5351
}
],
"status": 0
}
} |
|
Delete Price Parameter value | Updates a value in a Price Parameter. The URL contains the PP table ID. In the payload example, we specify the new "null" value for attribute3 in the data section. In the oldValues section we can see that the current value is "101". In the response, the value of attribute3 is already "null". | /pricefx/{partition}/lookuptablemanager.update/{tableId} | Code Block |
|---|
| //deleting the value of attribute3
{
"data": {
"typedId": "1849972.MLTV",
"valueattribute3": "406"null
},
"oldValues": {
"version": 2,
"typedId": "1849972.MLTV",
"lastUpdateByName": "User101",
"createdByName": null,
"tableId": 31705,
"type": "MATRIX",
"valueType": "MATRIX",
"lookupTableTypedId": "31705.LT",
"createDate": "2015-10-29T10:19:34.000",
"createdBy": 51,
"lastUpdateDate": "2020-09-15T14:33:41.000",
"lastUpdateBy": 5351,
"attribute1": "3",
"attribute2": null,
"attribute3": "101",
"attribute4": null,
"attribute5": null,
"attribute6": null,
"attribute7": null,
"attribute8": null,
"attribute9": null,
"attribute10": null,
"attribute11": null,
"attribute12": null,
"attribute13": null,
"attribute14": null,
"attribute15": null,
"attribute16": null,
"attribute17": null,
"attribute18": null,
"attribute19": null,
"attribute20": null,
"attribute21": null,
"attribute22": null,
"attribute23": null,
"attribute24": null,
"attribute25": null,
"attribute26": null,
"attribute27": null,
"attribute28": null,
"attribute29": null,
"attribute30": null,
"name": "3"
}
} |
|
| Code Block |
|---|
| title | Response |
|---|
| collapse | true |
|---|
| {
"response": {
"node": "user1",
"data": [
{
"version": 3,
"typedId": "1849972.MLTV",
"lastUpdateByName": "User101",
"createdByName": null,
"tableId": 31705,
"type": "MATRIX",
"valueType": "MATRIX",
"lookupTableTypedId": "31705.LT",
"createDate": "2015-10-29T10:19:34",
"createdBy": 51,
"lastUpdateDate": "2020-09-15T14:34:35",
"lastUpdateBy": 5351,
"attribute1": "3",
"attribute2": null,
"attribute3": null,
"attribute4": null,
"attribute5": null,
"attribute6": null,
"attribute7": null,
"attribute8": null,
"attribute9": null,
"attribute10": null,
"attribute11": null,
"attribute12": null,
"attribute13": null,
"attribute14": null,
"attribute15": null,
"attribute16": null,
"attribute17": null,
"attribute18": null,
"attribute19": null,
"attribute20": null,
"attribute21": null,
"attribute22": null,
"attribute23": null,
"attribute24": null,
"attribute25": null,
"attribute26": null,
"attribute27": null,
"attribute28": null,
"attribute29": null,
"attribute30": null,
"name": "3"
}
],
"status": 0
}
} |
|