v1

latestOpenAPI 3.0.02026-08-064842333.5 MB
Products

Upsert a Product

Upserts a product.<p>

  • To add a new product that does not exist, specify the sku parameter in the request.<p>
  • To update an existing product, specify the sku or typedId parameter of the existing product. The /integrate method performs a partial update – it does not delete values from fields that have not been specified in the update request.<p> Use the /integrate/{TypeCode}/returnolddata endpoint to return also the data of the previous version in the response.

<!-- theme: warning -->

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 products 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.<p> 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.

<!-- theme: note -->

Information: You can upsert multiple records using one request. To do so, add multiple data objects into your JSON. See the example below.

[
  {
    "data": {
      "sku": "111111",
      "typedId": "2147501227.P",
      "label": "The New Label",
      "unitOfMeasure": "EA",
      "currency": "USD",
      "formulaName": "priceLogic2",
      "attribute1": "1",
      "attribute2": "2",
      "userGroupEdit": "Administrators",
      "userGroupViewDetails": "PricingManagers"
    }
  },
  {
    "data": {
      "sku": "222222",
      "label": "The New Label 2",
      "unitOfMeasure": "EA",
      "currency": "EUR",
      "formulaName": "priceLogic2",
      "attribute1": "1",
      "attribute2": "2",
      "userGroupEdit": "Administrators",
      "userGroupViewDetails": "PricingManagers"
    }
  }
]

post/integrate/P

Request body

Response

Returns full record details.