Skip to main content
Version: 202201

Update Product

PUT 
/openapi/2022-01/products/:product_id

Update an existing product with the provided details.

Request​

Path Parameters

    product_id stringrequired

    Product's ID

Body

    no_entityboolean

    If no_entity is true, it will return empty object while update successfully

    Default value: false
    product object
    titlestring

    Product's title

    briefstring

    Product's briefing description

    descriptionstring

    Product's description

    publishedboolean

    Whether it is published or not

    requires_shippingboolean

    Whether it is required to shipping

    taxablestring

    Whether it is taxable

    tagsstring

    Tags, separated by comma, for example: tag1,tag2

    vendorstring

    Vendor's name

    vendor_urlstring

    Vendor's URL

    notestring
    seo_titlestring

    SEO title

    seo_descriptionstring

    SEO description

    seo_keywordsstring

    SEO keywords, separated by comma, for example: key1,key2

    handlestring

    Product's handle

    has_only_default_variantboolean

    Whether it is a single variant

    inventory_trackingboolean

    Whether to tracking inventory

    inventory_policystring

    Inventory policy: continue, deny, auto_unpublished, required while inventory_tracking is true

    need_variant_imageboolean

    Whether variant image is needed. It's required if has_only_default_variant is false

    spustring

    Product's SPU

    fake_salesint32

    Product's fake sales

    display_fake_salesboolean

    Whether to display fake sales

    options object[]
  • Array [
    • namestringrequired

    Option's name, for example: "color","size".

    valuesstring[]required

    Option's values, for example: ["red", "black"],["small", "large"]

    Default value: []
  • ]
    • images object[]
  • Array [
    • idstring

    The id of the image.

    srcstring

    Image's URL

    widthint32

    Image's width in px

    heightint32

    Image's height in px

    altstring

    Image's alt

  • ]
    • variants object[]
  • Array [
    • option1string

    Option 1

    option2string

    Option 2

    option3string

    Option 3

    image object

    Variant's images, e.g.: {"src":"//cn.cdn.shoplazza.com/c8bf5695d347092d7a010f00182581f7.jpeg"}

    srcstring

    Image's URL

    widthint32

    Image's width in px

    heightint32

    Image's height in px

    altstring

    Image's alt

    Default value: image's alt
    positionint32
    compare_at_pricestring

    Compare at price ( original price )

    pricestring

    Price, set it to "0.00" if you want to leave the price empty.

    skustring
    barcodestring

    The barcode of the variant.

    notestring
    inventory_quantityint32
    weightstring
    weight_unitstring

    Unit of weight, possible value are: kg, g, lb, oz

    cost_pricestring
    wholesale_price object
    pricestring
    min_quantityint32

    Mini Order Quantity

    extend object
    widthfloat
    lengthfloat
    heightfloat
    dimension_unitstring
    origin_country_codestring

    Country of origin code of the product.

    hs_codestring

    HS codes are the international standard for commodity classification, and Shoplazza can automatically generate HS codes based on commodity information.

  • ]

Responses​

200

Schema
    product object
    briefstring
    Example: shirt
    created_atstring
    Example: 2024-04-17T02:15:18Z
    descriptionstring
    Example: <p>Desc</p>
    display_fake_salesboolean
    Default value: true
    Example: true
    fake_salesinteger
    Default value: 0
    Example: 10
    handlestring
    Example: shirt
    has_only_default_variantboolean
    Default value: true
    Example: false
    idstring
    Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
    image object
    srcstring
    Example: //cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg
    widthinteger
    Default value: 0
    Example: 174
    heightinteger
    Default value: 0
    Example: 180
    pathstring
    Example: ccf0794c594bad32a320eea0d6bfe40c.jpeg
    altstring
    Example:
    images object[]
  • Array [
    • idstring
    Example: 8ef098c5-5a08-44b4-b5fb-89214bb507dc
    product_idstring
    Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
    positioninteger
    Default value: 0
    Example: 1
    srcstring
    Example: //cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg
    widthinteger
    Default value: 0
    Example: 174
    heightinteger
    Default value: 0
    Example: 180
    altstring
    Example:
    created_atstring
    Example: 2024-04-17T02:15:18Z
    updated_atstring
    Example: 2024-04-17T02:15:35Z
  • ]
    • inventory_policystring
    Example: continue
    inventory_quantityinteger
    Default value: 0
    Example: 72
    inventory_trackingboolean
    Default value: true
    Example: true
    mixed_wholesaleboolean
    Default value: true
    Example: false
    need_variant_imageboolean
    Default value: true
    Example: true
    notestring
    Example:
    options object[]
  • Array [
    • idstring
    Example: a4fc1abf-86fb-4e45-b774-9ff3b3f8ef90
    product_idstring
    Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
    positioninteger
    Default value: 0
    Example: 1
    namestring
    Example: size
    valuesstring[]
  • ]
    • publishedboolean
    Default value: true
    Example: false
    published_atstring
    Example: 1970-01-01T00:00:00Z
    requires_shippingboolean
    Default value: true
    Example: true
    seo_descriptionstring
    Example: Desc
    seo_keywordsstring
    Example:
    seo_titlestring
    Example: shirt
    spustring
    Example: T-M
    tagsstring
    Example: s1-s2
    taxableboolean
    Default value: true
    Example: true
    titlestring
    Example: shirt
    updated_atstring
    Example: 2024-04-17T02:15:35Z
    variants object[]
  • Array [
    • idstring
    Example: 88e68830-4ef5-4125-bf7d-aef8047176b2
    product_idstring
    Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
    image_idstring
    Example: 8ef098c5-5a08-44b4-b5fb-89214bb507dc
    created_atstring
    Example: 2024-04-17T02:15:18Z
    updated_atstring
    Example: 2024-04-17T02:15:35Z
    titlestring
    Example: S-blue-T
    option1string
    Example: S
    option2string
    Example: blue
    option3string
    Example: T
    image object
    srcstring
    Example: //cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg
    widthinteger
    Default value: 0
    Example: 174
    heightinteger
    Default value: 0
    Example: 180
    pathstring
    Example: ccf0794c594bad32a320eea0d6bfe40c.jpeg
    altstring
    Example:
    positioninteger
    Default value: 0
    Example: 1
    compare_at_pricestring
    Example: 12.10
    pricestring
    Example: 10.10
    skustring
    Example: T-M-S-blue-T-A001004
    barcodestring
    Example: 6929000212340
    notestring
    Example: node
    inventory_quantityinteger
    Default value: 0
    Example: 10
    weightstring
    Example: 1.10
    weight_unitstring
    Example: kg
    cost_pricestring
    Example: 1.10
    wholesale_price object[]
  • Array [
    • pricestring
    Example: 10.10
    min_quantityinteger
    Default value: 0
    Example: 1
  • ]
    • extend object
    lengthinteger
    Default value: 0
    Example: 10
    widthinteger
    Default value: 0
    Example: 10
    heightinteger
    Default value: 0
    Example: 10
    dimension_unitstring
    Example: in
    origin_country_codestring
    Example: AG
    hs_codestring
    Example: 62114390
  • ]
    • vendorstring
    Example: shoplazza
    vendor_urlstring
    Example: https://shoplazza.com