PATCH products

This call allows to PATCH multiple products up to 10 products. All null/empty fields will be ignored.

Request Information

URI Parameters

None.

Body Parameters

The collection of product patch you want to perform

Collection of ProductPatchModelId
NameDescriptionTypeAdditional information
ProductIDType The product that you wish to update. Leave null to create a new product. ProductIDTypeModel Required
Product Product data to PATCH, only include the fields you wish to update. ProductPatchModel None.

Request Formats

application/json, text/json

Sample:
[
  {
    "ProductIDType": {
      "IDType": "SKU",
      "Value": "SKU123"
    },
    "Product": {
      "PricingInformation": {
        "Price": 10.99,
        "RRP": 12.99
      },
      "WarehouseInformation": {
        "Weight": 0.5,
        "Dimensions": {
          "HeightMM": 100.0,
          "WidthMM": 102.76,
          "LengthMM": 50.0
        },
        "PackagingId": 5,
        "PackagingQuantity": 1,
        "ProductHarmonizedCode": "123456",
        "CountryOfManufacture": "GB"
      },
      "ProductSpecialAttribute": "Special Attribute"
    }
  }
]

Response Information

Resource Description

This call allows to PATCH multiple products up to 10 products. All null/empty fields will be ignored.

ProductPatchModelCollectionResponse
NameDescriptionTypeAdditional information
TotalItemsProcessed integer None.
Successful integer None.
Failed integer None.
Responses Collection of ProductPatchModelResponse None.

Response Formats

application/json, text/json

Sample:
{
  "TotalItemsProcessed": 2,
  "Successful": 1,
  "Failed": 1,
  "Responses": [
    {
      "ProductPatch": {
        "ProductIDType": {
          "IDType": "SKU",
          "Value": "SKU123"
        },
        "Product": {
          "PricingInformation": {
            "Price": 10.99,
            "RRP": 12.99
          },
          "WarehouseInformation": {
            "Weight": 0.5,
            "Dimensions": {
              "HeightMM": 100.0,
              "WidthMM": 102.76,
              "LengthMM": 50.0
            },
            "PackagingId": 5,
            "PackagingQuantity": 1,
            "ProductHarmonizedCode": "123456",
            "CountryOfManufacture": "GB"
          },
          "ProductSpecialAttribute": "Special Attribute"
        }
      },
      "Success": true
    },
    {
      "ProductPatch": {
        "ProductIDType": {
          "IDType": "SKU",
          "Value": "SKU123"
        },
        "Product": {
          "PricingInformation": {
            "Price": 10.99,
            "RRP": 12.99
          },
          "WarehouseInformation": {
            "Weight": 0.5,
            "Dimensions": {
              "HeightMM": 100.0,
              "WidthMM": 102.76,
              "LengthMM": 50.0
            },
            "PackagingId": 5,
            "PackagingQuantity": 1,
            "ProductHarmonizedCode": "123456",
            "CountryOfManufacture": "GB"
          },
          "ProductSpecialAttribute": "Special Attribute"
        }
      },
      "Success": false,
      "Error": "Product not found or you do not have permission to access it."
    }
  ]
}