Skip to content

Update Product

Request

Update an existing product.

Security
oAuth2ClientCredentials
Path
product_idstring, (uuid)(Product Id)required
Bodyapplication/jsonrequired
codestring, <= 255 characters(Code)

Code of the product. Use it as the reference to the product in your system.

Default:""
Example:"UN1090"
descriptionstring, <= 255 characters(Description)

Free-text description of the product.

Default:""
Example:"Acetone, flammable liquid"
namestring, <= 255 characters(Name)required

Name of the product.

Example:"Acetone"
product_typeobject(ProductTypeReference)required

Product type the product belongs to. A product can't move to another product type.

parent_productProductReference (object) or null
Any of:

Parent product. The parent must belong to the same product type and can't have a parent itself. Set to null to remove the parent.

{
  "code": "UN1090",
  "description": "Acetone, flammable liquid",
  "name": "Acetone",
  "product_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "parent_product": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Responses

Successful Response

Bodyapplication/json
codestring, <= 255 characters(Code)

Code of the product. Use it as the reference to the product in your system.

Default:""
Example:"UN1090"
descriptionstring, <= 255 characters(Description)

Free-text description of the product.

Default:""
Example:"Acetone, flammable liquid"
idstring, (uuid)(Id)required

Unique identifier of the product.

namestring(Name)required

Name of the product.

Example:"Acetone"
is_archivedboolean(Is Archived)required

Whether the product is archived. Archived products can't be used on new orders.

product_typeobject(ProductTypeSummary)required

Product type the product belongs to.

parent_productProductSummary (object) or null
Any of:

Parent product, if any.

Response
{
  "code": "UN1090",
  "description": "Acetone, flammable liquid",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Acetone",
  "is_archived": true,
  "product_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "Chemicals",
    "code": "CHEM"
  },
  "parent_product": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "Acetone",
    "code": "UN1090"
  }
}