Update Product

Required permission: write_products

Update details of an existing product for your organization or client.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

The ID of the product to update.

Body Params

An object containing the fields to update in the product.

string | null

The name of the product.

string | null

A description of the product.

string | null

The barcode of the product. Must be unique among the client's products.

float | null
≥ 0

The value of the product.

float | null
≥ 0

The declared customs value of the product.

float | null
≥ 0

The price of the product.

integer | null
≥ 0

The minimum quantity of the product to maintain in stock.

integer | null
≥ 0

The quantity of the product to reserve.

float | null
≥ 0

The weight of the product in ounces.

float | null
≥ 0

The length of the product in inches.

float | null
≥ 0

The width of the product in inches.

float | null
≥ 0

The height of the product in inches.

boolean | null

Whether the product requires lot tracking. The lot requirement cannot be changed on UOM products or on products that currently have inventory.

boolean | null

Whether the product is non-shippable. Bundle components cannot be made non-shippable.

boolean | null

Whether the product is archived.

string | null

The tariff code for customs purposes.

string | null

The country where the product is manufactured.

string | null

A note about the product.

string | null

A note about packing the product.

string | null

A note about returning the product.

tags
array of strings | null

Overwrites all existing tags on the product with the provided list. Cannot be used together with add_tags or remove_tags.

tags
add_tags
array of strings | null

Appends tags to the product without affecting existing tags. Duplicate tags are ignored. Cannot be used together with tags.

add_tags
remove_tags
array of strings | null

Removes the specified tags from the product. Tags that are not present on the product are ignored. Cannot be used together with tags.

remove_tags
string | null

Custom field 1 for storing additional product information.

string | null

Custom field 2 for storing additional product information.

string | null

Custom field 3 for storing additional product information.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json