Update an item
PUT/commerce/{connection_id}/item/{id}
Updates the CommerceItem identified by id. Provide the unified CommerceItem fields to change in the request body.
Parameters
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Item
Payload
idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
The item's (product's) name
public_namestring
slugstring
descriptionstring
global_codestring
public_descriptionstring
is_activeboolean
is_taxableboolean
vendor_namestring
typestring
product, service, digital-download, ...
is_visibleboolean
is_featuredboolean
weightnumber
weight_unit enum
Valid values:
"g"
"kg"
"oz"
"lb"
requires_shippingboolean
inventory_idstring
total_stocknumber
tagsstring array
account_idstring
Reference to Accounting Account (reference to AccountingAccount)
taxrate_idstring
references AccountingTaxrate
location_idstring
(reference to CommerceLocation)
durationnumber
minutes
Returns
| Response field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | The item's (product's) name |
public_name | string | No | |
slug | string | No | |
description | string | No | |
global_code | string | No | |
public_description | string | No | |
is_active | boolean | No | |
is_taxable | boolean | No | |
vendor_name | string | No | |
type | string | No | product, service, digital-download, ... |
is_visible | boolean | No | |
is_featured | boolean | No | |
weight | number | No | |
weight_unit | enum | No | Values: g, kg, oz, lb |
requires_shipping | boolean | No | |
prices | CommerceItemPrice[] | No | |
prices[].price | number | Yes | |
prices[].compare_at_price | number | No | The original price of the item before an adjustment or a sale. |
prices[].currency | string | No | |
inventory_id | string | No | |
total_stock | number | No | |
tags | string[] | No | |
media | CommerceItemMedia[] | No | |
media[].id | string | No | |
media[].url | string | Yes | |
media[].alt | string | No | |
media[].type | enum | No | Values: image, video |
media[].height | number | No | |
media[].width | number | No | |
media[].position | number | No | 1 is the first |
media[].metadata | CommerceMetadata[] | No | |
media[].metadata[].id | string | No | The ID of the custom field definition (from the metadata/metadata endpoint). |
media[].metadata[].value | object | No | The field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string. |
media[].metadata[].namespace | string | No | |
media[].metadata[].format | enum | No | The data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
media[].metadata[].extra_data | object | No | |
media[].metadata[].slug | string | No | The integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration. |
media[].metadata[].description | string | No | |
media[].metadata[].is_required | boolean | No | |
account_id | string | No | Reference to Accounting Account (reference to AccountingAccount) |
metadata | CommerceMetadata[] | No | |
metadata[].id | string | No | The ID of the custom field definition (from the metadata/metadata endpoint). |
metadata[].value | object | No | The field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string. |
metadata[].namespace | string | No | |
metadata[].format | enum | No | The data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | |
metadata[].slug | string | No | The integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration. |
metadata[].description | string | No | |
metadata[].is_required | boolean | No | |
collections | CommerceReference[] | No | points to Collection with id, name, and type fields |
collections[].id | string | No | |
collections[].name | string | No | |
collections[].type | string | No | |
taxrate_id | string | No | references AccountingTaxrate |
location_id | string | No | (reference to CommerceLocation) |
duration | number | No | minutes |
Errors
Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).
{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to unified.to API; max requests per minute: N"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not supported by this integration. |
Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.
429 Too Many Requests
A 429 has two possible sources:
- The integration's own rate limit, passed through.
- Unified's workspace limit: a rolling 60 seconds, set by plan, with the message
Too many requests to unified.to API; max requests per minute: N.
const options = {
method: 'PUT',
url: 'https://api.unified.to/commerce/5de520f96e439b002043d8dc/item/5de520f96e439b002043d8d8',
headers: {
authorization: 'bearer .....'
},
data: undefined,
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know
Was this page helpful?