PATCH product/{productId}

This call allows to PATCH product. All null/empty fields will be ignored.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
productId integer Required

Body Parameters

Product patch you want to perform

ProductPatchModel
NameDescriptionTypeAdditional information
PricingInformation Product pricing info for instance: Price, RRP ProductPatchPricingInfoModel None.
WarehouseInformation This contains warehouse information like Weight, Packagin etc. ProductPatchWarehouseInformationModel None.
ProductSpecialAttribute The Products Special Attribute. string None.
Discontinued Whether the product is discontinued. Leave null to leave unchanged. boolean None.
Archived Whether the product is archived. Leave null to leave unchanged. boolean None.
CustomAttributes Custom attributes to add or update on the product. Each entry identifies a custom attribute by CustomAttributeID or CustomAttributeName. If the product already has that attribute the value is updated; otherwise the attribute is assigned to the product with the supplied value. Attributes not included are left untouched. Custom attributes CANNOT be removed via PATCH - use the PUT product endpoint to remove them. Omit this field to leave custom attributes unchanged. Collection of ProductCustomAttributeModel None.

Request Formats

application/json, text/json

Sample: 
{
  "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"
    }
  ]
}

application/xml, text/xml

Sample: 
<ProductPatchModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PricingInformation>
    <Price>10.99</Price>
    <RRP>12.99</RRP>
  </PricingInformation>
  <WarehouseInformation>
    <IsCpscRegulated xsi:nil="true" />
    <Weight>0.5</Weight>
    <Dimensions>
      <HeightMM>100</HeightMM>
      <WidthMM>102.76</WidthMM>
      <LengthMM>50</LengthMM>
    </Dimensions>
    <PackagingId>5</PackagingId>
    <PackagingQuantity>1</PackagingQuantity>
    <ShippingCost>2.50</ShippingCost>
    <ProductHarmonizedCode>123456</ProductHarmonizedCode>
    <CountryOfManufacture>GB</CountryOfManufacture>
    <StockLocations>
      <Mode>Add</Mode>
      <Locations>
        <StockLocationIDTypeModel>
          <IDType>StockLocationReference</IDType>
          <Value>A-1</Value>
        </StockLocationIDTypeModel>
      </Locations>
    </StockLocations>
  </WarehouseInformation>
  <ProductSpecialAttribute>Special Attribute</ProductSpecialAttribute>
  <Discontinued xsi:nil="true" />
  <Archived>false</Archived>
  <CustomAttributes>
    <ProductCustomAttributeModel>
      <CustomAttribute>
        <CustomAttributeID xsi:nil="true" />
        <CustomAttributeName>Colour</CustomAttributeName>
      </CustomAttribute>
      <Value>Red</Value>
    </ProductCustomAttributeModel>
  </CustomAttributes>
</ProductPatchModel>

Response Information

Resource Description

This call allows to PATCH product. All null/empty fields will be ignored.

ProductPatchModelResponse
NameDescriptionTypeAdditional information
ProductPatch ProductPatchModelId None.
Success Whether the action was successful boolean None.
Error Any errors that were received Success will always be false if an error is returned. string None.

Response Formats

application/json, text/json

Sample: 
{
  "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"
        }
      ]
    }
  },
  "Success": true
}