PATCH products

This call allows to PATCH multiple products up to 10 products. Null fields are ignored, and so are empty ones apart from the customs text fields: an empty CPSC, ProductMidCode or NonStandardMidCode value clears it, and an empty PgaReferenceNumber removes the PGA reference.

Request Information

URI Parameters

None.

Body Parameters

The collection of product patch you want to perform

Collection of ProductPatchModelId

Name	Description	Type	Additional 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,
        "ShippingCost": 2.5,
        "ProductHarmonizedCode": "123456",
        "CountryOfManufacture": "GB",
        "StockLocations": {
          "Mode": "Add",
          "Locations": [
            {
              "IDType": "StockLocationReference",
              "Value": "A-1"
            }
          ]
        }
      },
      "ProductSpecialAttribute": "Special Attribute",
      "Archived": false,
      "CustomAttributes": [
        {
          "CustomAttribute": {
            "CustomAttributeName": "Colour"
          },
          "Value": "Red"
        }
      ],
      "Description": "Product description",
      "ProductImages": [
        {
          "Image": {
            "SourceType": "URL",
            "SourceValue": "https://example.com/image.jpg"
          }
        }
      ]
    }
  }
]

Response Information

Resource Description

ProductPatchModelCollectionResponse

Name	Type	Additional 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,
            "ShippingCost": 2.5,
            "ProductHarmonizedCode": "123456",
            "CountryOfManufacture": "GB",
            "StockLocations": {
              "Mode": "Add",
              "Locations": [
                {
                  "IDType": "StockLocationReference",
                  "Value": "A-1"
                }
              ]
            }
          },
          "ProductSpecialAttribute": "Special Attribute",
          "Archived": false,
          "CustomAttributes": [
            {
              "CustomAttribute": {
                "CustomAttributeName": "Colour"
              },
              "Value": "Red"
            }
          ],
          "Description": "Product description",
          "ProductImages": [
            {
              "Image": {
                "SourceType": "URL",
                "SourceValue": "https://example.com/image.jpg"
              }
            }
          ]
        }
      },
      "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,
            "ShippingCost": 2.5,
            "ProductHarmonizedCode": "123456",
            "CountryOfManufacture": "GB",
            "StockLocations": {
              "Mode": "Add",
              "Locations": [
                {
                  "IDType": "StockLocationReference",
                  "Value": "A-1"
                }
              ]
            }
          },
          "ProductSpecialAttribute": "Special Attribute",
          "Archived": false,
          "CustomAttributes": [
            {
              "CustomAttribute": {
                "CustomAttributeName": "Colour"
              },
              "Value": "Red"
            }
          ],
          "Description": "Product description",
          "ProductImages": [
            {
              "Image": {
                "SourceType": "URL",
                "SourceValue": "https://example.com/image.jpg"
              }
            }
          ]
        }
      },
      "Success": false,
      "Error": "Product not found or you do not have permission to access it."
    }
  ]
}