Basic information

PATCH /{shopId}/products/{productId}

Updates information for a single product with partial data according to RFC 6902. You can either add or remove certain attributes.

Supported JSON-PATCH operations
- add (sets or replaces an attribute)
- remove (unsets an attribute)
- replace³ (replaces an attribute value)

Attribute paths that allow updates via PATCH
- /productNumber¹
- /name
- /shortDescription
- /description
- /manufacturer
- /upc
- /ean
- /essentialFeatures
- /searchKeywords
- /priceInfo/price/amount
- /priceInfo/manufacturerPrice/amount
- /priceInfo/depositPrice/amount
- /deliveryPeriod
- /minStocklevel
- /manufacturerProductNumber
- /productLength
- /productWidth
- /productHeight
- /priceInfo/taxClass/taxClassId³
- /productImage¹
- /stocklevel²
- /visible¹

¹ supports add only
² value will not be replaced, but changed, i.e. if the stocklevel is 3 and you add 1, you will get 4; if you add -5, you will get -2.
³ used for taxClassId only

Authorisation

OAuth 2.0 Token required with scopes:

products_write

URI parameters

Name Type Description
shopId string

The unique identifier of the shop.

Required: true
Example: DemoShop
productId string

The unique identifier of the product.

Required: true
Example: 52F221E0-36F6-DC4E-384A-AC1504050C04

Query parameters

Name Type Description
locale string

Represents the language code according to ISO 639-1 and the country code according to ISO 3166-1. If not provided, the shop’s default language is used. We recommend to always send this parameter with your request. If the default language had been changed in the administration, it might take up to 1 day until this change affects the shop.

Required: false
Example: en_US
currency string

Represents the currency code according to ISO 4217.

Required: false
Example: EUR

Request attributes

Name Type Description

array of jsonPatch

Request body

Media type application/json-patch+json

[{
  "op": "add",
  "path": "/name",
  "value": "BRAND NEW: Dr.Boom - Star Wars Edition"
},
{
  "op": "add",
  "path": "/shortDescription",
  "value": "new arrival"
}]

Response attributes

Name Type Description

object of product

Response

HTTP 200

Media type application/json

{
  "productId": "51E7F905-2E4C-78C2-30C2-AC14145FA4E5",
  "name": "BRAND NEW: Dr.Boom - Star Wars Edition",
  "visible": true,
  "productVariationType": "regular",
  "productVariationMasterName": null,
  "productVariationMasterId": null,
  "manufacturerProductNumber": "HP-003",
  "productLength": null,
  "productWidth": null,
  "productHeight": null,
  "productVariationSelection": null,
  "shortDescription": "new arrival",
  "description": "<ul>\n\t<li>Surround Sound</li>\n\t<li>Acoustic Noise Cancelling</li>\n\t<li>Correct fit",
  "title": "BRAND NEW: Dr.Boom - Star Wars Edition - Technic365",
  "productImage": "014-headphone-starwars.jpg",
  "images": [
    {
        "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F905/2E4C/78C2/30C2/AC14/145F/A4E5/013-headphone-red_h.jpg",
        "classifier": "HotDeal",
        "isZoomEnabled": true,
        "width": 149,
        "height": 84,
        "fileSize": 5168
    },
   {
      "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F905/2E4C/78C2/30C2/AC14/145F/A4E5/013-headphone-red_m.jpg",
      "classifier": "Medium",
      "isZoomEnabled": true,
      "width": 500,
      "height": 281,
      "fileSize": 47289
    },
    {
      "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F905/2E4C/78C2/30C2/AC14/145F/A4E5/013-headphone-red.jpg",
      "classifier": "Large",
      "isZoomEnabled": true,
      "width": 1920,
      "height": 1080,
      "fileSize": 636262
    },
    {
      "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F905/2E4C/78C2/30C2/AC14/145F/A4E5/013-headphone-red_s.jpg",
      "classifier": "Small",
      "isZoomEnabled": true,
      "width": 100,
      "height": 56,
      "fileSize": 2498
    },
    {
      "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F905/2E4C/78C2/30C2/AC14/145F/A4E5/013-headphone-red_xs.jpg",
      "classifier": "Thumbnail",
      "isZoomEnabled": true,
      "width": 50,
      "height": 28,
      "fileSize": 1031
    }
  ],
  "priceInfo": {
    "quantity": {
      "amount": 1,
      "unit": "piece(s)"
    },
    "taxClass": {
      "name": "standard",
      "percentage": 19
    },
    "price": {
      "taxType": "NET",
      "formatted": "54.62 €",
      "amount": 54.62,
      "currency": "EUR"
    },
    "depositPrice": null,
    "priceWithDeposits": {
      "taxType": "NET",
      "formatted": "54.62 €",
      "amount": 54.62,
      "currency": "EUR"
    },
    "lowestPrice": null,
    "highestPrice": null,
    "manufacturerPrice": null,
    "basePrice": null
  },
  "forSale": true,
  "specialOffer": false,
  "deliveryWeight": {
    "amount": 260,
    "unit": "g"
  },
  "shippingMethodsRestrictedTo": null,
  "availabilityText": "In stock<br />can be shipped within 3-5 days",
  "availability": "OnStock",
  "energyLabelsString": "A+++,G",
  "energyLabelsMaxEfficiencyString": "A+++",
  "energyLabelSourceFile": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/Products/be_40401/label-1-9dee74f24e1.png",
  "productDataSheet": null,
  "sfUrl": "http://pm.epages.com/epages/apidocu.sf/?ObjectPath=/Shops/apidocu/Products/HP-003",
  "productNumber": "HP-003",
  "manufacturer": "Bass by Dr.Boom",
  "upc": null,
  "ean": null,
  "essentialFeatures": null,
  "searchKeywords": [
    "Brilliant Sound",
    "Noise Cancelling",
    "Carrying Box"
  ],
  "stocklevel": 100,
  "minStocklevel": 10,
  "videos": [],
  "links": [
    {
      "rel": "self",
      "href": "https://pm.epages.com/rs/shops/apidocu/products/51E7F905-2E4C-78C2-30C2-AC14145FA4E5"
    },
    {
      "rel": "categories",
      "href": "https://pm.epages.com/rs/shops/apidocu/categories/?productId=51E7F905-2E4C-78C2-30C2-AC14145FA4E5"
    }
  ]
}