Update Product

PUT /commerce/products/:productId

Update product for a specified user and credential set

Request

Path Parameters

productId stringrequired

Query Parameters

credentialId stringrequired

The ID of the credential.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

application/json

Body

productType string

The type of product.

productName stringrequired

A string used to retrieve products with a specific product name.

description stringrequired

A string used to retrieve products with a specific description.

productStatus stringrequired

Possible values: [DRAFT, ACTIVE, INACTIVE, UNLISTED]

A string used to retrieve products with a specific product status.

tags string[]

An array of tags associated with the product.

vendor string

A string used to retrieve products from a specific vendor.

remoteFields json

An object containing remote fields that are not supported by the common model. The keys are the names of the fields of the corresponding resource in the remote app, and the values can be strings, numbers, arrays or objects.

Responses

200

application/json

Schema
Result

Schema

any

{
  "product": {
    "remoteId": "1234567890123",
    "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
    "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:17:53.264Z",
    "updatedAt": "2024-02-22T13:54:03.445Z"
    "productType": "Apparel",
    "productName": "Example Shirt",
    "description": "A stylish shirt for all occasions.",
    "images": [],
    "productStatus": "ACTIVE",
    "tags": ["Fashion", "Comfort"],
    "vendor": "Example Vendor",
    "productUrl": "https://example.com/products/example-shirt",
    "id": "00112233-4455-6677-8899-aabbccddeeff",
    "variants": [
      {
        "remoteId": "200100200100",
        "productId": "00112233-4455-6677-8899-aabbccddeeff",
        "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
        "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
        "remoteDeleted": false,
        "createdAt": "2024-02-22T11:17:53.264Z",
        "updatedAt": "2024-02-22T13:54:03.445Z"
        "title": "Medium",
        "price": "25.00",
        "sku": "SHIRT-M",
        "optionValues": [
          {
            "name": "Size", 
            "value": "Medium"
          }
        ],
        "inventory": {"totalCount": 50},
        "weight": [
          {
            "value": 9.525451098148434,
            "unit": "kg"
          },
          {
            "value": 9525.451098148435,
            "unit": "g"
          },
          {
            "value": 336.00076203608785,
            "unit": "oz"
          },
          {
            "value": 20.999999999999996,
            "unit": "lb"
          }
        ],
        "id": "11001100-1122-3344-5566-77889900aabb"
      }
    ]
  }
}

400

application/json

Schema
Example (from schema)
Result

Schema

object

{}

{}