Update Product

Replaces the full product record. All fields are overwritten with the values in the request body — fields omitted from the body will be cleared.

Use PATCH to update only a subset of fields.

SecurityOAuth2-Production or OAuth2-Demo
Request
path Parameters
merchant_id
required
string

The merchant identifier the product belongs to.

product_id
required
string

The Carriyo-assigned product identifier.

header Parameters
x-api-key
required
string

Your Carriyo API key for authentication.

tenant-id
required
string

Your unique tenant identifier in Carriyo.

Request Body schema: application/json
required
product_ref
string

Your reference for the product. Recommended to be unique within a merchant.

sku
string

Stock keeping unit.

description
string

Human-readable product description.

barcode
string

Barcode (e.g., EAN, UPC).

image_link
string

URL to a product image.

hs_code
string

Harmonised System code. Often required for cross-border shipments.

origin_country
string

ISO 3166-1 alpha-2 country code of origin.

manufacturer_id
string

Manufacturer reference. Required by some carriers in certain destinations.

material_composition
string

Material details (e.g., "100% cotton"). Relevant for textile customs classification.

category
string

Product category.

dangerous_goods
boolean

Whether the product is classified as dangerous goods.

object (Battery)

Battery details. Usually required for cross-border shipments containing batteries.

digital
boolean

Whether the product is a digital good (no physical shipment).

non_returnable
boolean

Whether the product is excluded from returns.

status
string (Status)

Lifecycle status of the product.

Enum: "ACTIVE" "INACTIVE" "DELETED"
object (Weight)
object (Dimension)
do_not_place_above
boolean

Stacking constraint — must not be placed above other items.

do_not_place_below
boolean

Stacking constraint — must not be placed below other items.

Array of objects (Carriyo Metadata)

Custom name/value pairs for storing additional product attributes.

Responses
200

The updated product record.

404

No product found for the supplied ID.

put/products/{merchant_id}/{product_id}
Request samples
application/json
{
  • "product_ref": "string",
  • "sku": "string",
  • "description": "string",
  • "barcode": "string",
  • "image_link": "string",
  • "hs_code": "string",
  • "origin_country": "string",
  • "manufacturer_id": "string",
  • "material_composition": "string",
  • "category": "string",
  • "dangerous_goods": true,
  • "battery": {
    },
  • "digital": true,
  • "non_returnable": true,
  • "status": "ACTIVE",
  • "weight": {
    },
  • "dimension": {
    },
  • "do_not_place_above": true,
  • "do_not_place_below": true,
  • "carriyo_metadata": [
    ]
}
Response samples
application/json
{
  • "tenant": "string",
  • "merchant": "string",
  • "product_id": "string",
  • "product_ref": "string",
  • "sku": "string",
  • "description": "string",
  • "barcode": "string",
  • "image_link": "string",
  • "hs_code": "string",
  • "origin_country": "string",
  • "manufacturer_id": "string",
  • "material_composition": "string",
  • "category": "string",
  • "dangerous_goods": true,
  • "battery": {
    },
  • "digital": true,
  • "non_returnable": true,
  • "status": "ACTIVE",
  • "weight": {
    },
  • "dimension": {
    },
  • "do_not_place_above": true,
  • "do_not_place_below": true,
  • "carriyo_metadata": [
    ],
  • "creation_date": "2019-08-24T14:15:22Z",
  • "update_date": "2019-08-24T14:15:22Z",
  • "creation_source": {
    },
  • "update_source": {
    }
}