Upsert a Product Extension

post/integrate/PX

Creates or updates a product extension.

To add a new product extension that does not exist, specify the sku and name (category) parameter in the request.

To update an existing product extension, specify the name and sku or typedId parameters of the existing product extension. The /integrate method performs a partial update – it does not delete values from fields that have not been specified in the update request.

Use the /integrate/{TypeCode}/returnolddata endpoint to return also the data of the previous version in the response.


Please note

This method is intended to be used with one or two objects and it allows you to update particular fields. The request will overwrite the existing data of the record being updated, regardless of other changes. To work with more customers in bulk please use the /loaddata/P endpoint.


This operation is particularly useful if the caller does not (and should not) know about typed IDs and other internal data fields, i.e. typically in an integration scenario.

The only mandatory pre-requisite for this operation is that the object's defined business key fields (vary per object type) are present in every request. No typed ID or version fields are required. This also means that no version checking is performed, thus the request will overwrite existing data of that record, regardless of other changes.


Information

You can upsert multiple records using within request. To do so, add multiple data objects into your JSON.


Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
required
object
sku
required
string non-empty
name
required
string non-empty
attribute1
string non-empty
attribute2
string non-empty
Responses
200

Returns full record details.

Response Schema: application/json
object or object
Any of:
Array of objects (Product) non-empty unique

The Product object. The Type code is P.

Array (non-empty)
createDate
string <date-time>
createdBy
integer
currency
string or null <= 255 characters
formulaName
string or null <= 255 characters
image
boolean or null
label
string <= 255 characters
lastUpdateBy
integer
lastUpdateDate
string <date-time>
sku
string <= 255 characters
typedId
string
unitOfMeasure
string or null <= 255 characters
userGroupEdit
string or null <= 255 characters
userGroupViewDetails
string or null <= 255 characters
version
integer
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
(integer or null) or (string or null) or (number or null) or (string or null) or (string or null) or (string or null)
status
number
Request samples
application/json
{
  • "data": {
    • "sku": "111111",
    • "name": "ProductX",
    • "attribute1": "prdct",
    • "attribute2": "USD"
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "node",
    • "startRow": 0,
    • "data": [
      • {
        • "version": 8,
        • "label": "Label One",
        • "attribute1": "23"
        },
      • {
        • "version": 11,
        • "label": "Label Two",
        • "attribute1": "33"
        },
      • {
        • "version": 8,
        • "label": "Label Three",
        • "attribute1": "56"
        },
      • {
        • "version": 13,
        • "label": "Label Four",
        • "attribute1": "20"
        },
      • {
        • "version": 0,
        • "label": "Label Five",
        • "attribute1": "123"
        },
      • {
        • "version": 0,
        • "label": "Tofu",
        • "attribute1": "2"
        }
      ],
    • "endRow": 8,
    • "totalRows": 8,
    • "status": 0
    }
}