Update Product by ID

The “Update Product by ID” API allows modifying information for a specific product using its unique identifier. Use this endpoint to update details for a single product based on the provided product ID.

PUT https://services.leadconnectorhq.com/products/{productId}

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Path parameters

string

default:"6578278e879ad2646715ba9c"

required

ID or the slug of the product that needs to be returned

Body

string

default:"Awesome Product"

required

The name of the product.

string

default:"3SwdhCsvxI8Au3KsPJt6"

required

The unique identifier for the account.

string

default:"Product description goes here."

A brief description of the product.

string

required

Posibles valores: ‘DIGITAL’, ‘PHYSICAL’, ‘SERVICE’, ‘PHYSICAL/DIGITAL’

string

The URL for the product image.

string

default:"abcde"

The statement descriptor for the product.

boolean

default:"True"

Indicates whether the product is available in-store.

object[]

An array of medias for the product.

Show cada item

string

default:"fzrgusiuu0m"

required

The unique identifier for the media.

string

default:"1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png"

The title of the media file.

string

required

The URL where the media file is stored.

string

default:"image"

required

The type of the media file (e.g., image, video will be supporting soon). Posibles valores: ‘image’, ‘video’

boolean

default:"True"

Indicates whether the media is featured.

array[]

default:"6578278e879ad2646715ba9c"

Mongo ObjectIds of the prices for which the media is assigned

object[]

An array of variants for the product.

Show cada item

string

default:"38s63qmxfr4"

required

A unique identifier for the variant.

string

default:"Size"

required

The name of the variant.

object[]

required

An array of options for the variant.

Show cada item

string

default:"h4z7u0im2q8"

required

The unique identifier for the option.

string

default:"XL"

required

The name of the option.

string[]

An array of category Ids for the product

boolean

default:"True"

Are there any taxes attached to the product. If this is true, taxes array cannot be empty.

string[]

List of ids of Taxes attached to the Product. If taxes are passed, isTaxesEnabled should be true.

string

default:"65d71377c326ea78e1c47df5"

Tax category ID for Automatic taxes calculation.

boolean

default:"True"

Is the product label enabled. If this is true, label object cannot be empty.

object

Details for Product Label

string

default:"awesome-product"

The slug using which the product navigation will be handled

object

SEO data for the product that will be displayed in the preview

boolean

default:"True"

Whether the taxes should be included in the purchase price

string[]

The prices of the product

Respuestas

200 - Successful response

string

default:"655b33a82209e60b6adb87a5"

required

The unique identifier for the product.

string

default:"This is a really awesome product"

product description

object[]

An array of variants for the product.

Show cada item

string

default:"38s63qmxfr4"

required

A unique identifier for the variant.

string

default:"Size"

required

The name of the variant.

object[]

required

An array of options for the variant.

Show cada item

string

default:"h4z7u0im2q8"

required

The unique identifier for the option.

string

default:"XL"

required

The name of the option.

string

default:"3SwdhCsvxI8Au3KsPJt6"

required

The unique identifier for the account.

string

default:"Awesome Product"

required

The name of the product.

string

default:"PHYSICAL"

required

The type of the product (e.g., PHYSICAL).

boolean

default:"True"

Indicates whether the product is available in-store.

string

default:"2023-11-20T10:23:36.515Z"

required

The creation timestamp of the product.

string

default:"2024-01-23T09:57:04.846Z"

required

The last update timestamp of the product.

string

default:"abcde"

The statement descriptor for the product.

string

The URL for the product image.

string[]

An array of category Ids for the product

boolean

default:"True"

The field indicates whether taxes are enabled for the product or not.

string[]

An array of ids of Taxes attached to the Product. If the expand query includes tax, the taxes will be of type ProductTaxDto. Please refer to the ProductTaxDto for additional details.

string

default:"65d71377c326ea78e1c47df5"

Tax category ID for Automatic taxes calculation.

object

The Product label details

string

default:"washing-machine"

The slug of the product by which the product will be navigated

{
  "_id": "655b33a82209e60b6adb87a5",
  "description": "This is a really awesome product",
  "variants": [
    {
      "id": "38s63qmxfr4",
      "name": "Size",
      "options": [
        {}
      ]
    }
  ],
  "locationId": "3SwdhCsvxI8Au3KsPJt6",
  "name": "Awesome Product",
  "productType": "PHYSICAL",
  "availableInStore": true,
  "createdAt": "2023-11-20T10:23:36.515Z",
  "updatedAt": "2024-01-23T09:57:04.846Z",
  "statementDescriptor": "abcde",
  "image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png",
  "collectionIds": [
    "65d71377c326ea78e1c47df5",
    "65d71377c326ea78e1c47d34"
  ],
  "isTaxesEnabled": true,
  "taxes": [
    "654492a4e6bef380114de15a"
  ],
  "automaticTaxCategoryId": "65d71377c326ea78e1c47df5",
  "slug": "washing-machine"
}

400 - Bad Request

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Ejemplo

curl -X PUT 'https://services.leadconnectorhq.com/products/YOUR_productId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Awesome Product",
  "locationId": "3SwdhCsvxI8Au3KsPJt6",
  "description": "Product description goes here.",
  "productType": "DIGITAL",
  "image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png",
  "statementDescriptor": "abcde",
  "availableInStore": true,
  "medias": [
    {
      "id": "fzrgusiuu0m",
      "title": "1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png",
      "url": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/sample.png",
      "type": "image",
      "isFeatured": true,
      "priceIds": "6578278e879ad2646715ba9c"
    }
  ],
  "variants": [
    {
      "id": "38s63qmxfr4",
      "name": "Size",
      "options": [
        {}
      ]
    }
  ],
  "collectionIds": [
    "65d71377c326ea78e1c47df5",
    "65d71377c326ea78e1c47d34"
  ],
  "isTaxesEnabled": true,
  "taxes": [
    "654492a4e6bef380114de15a"
  ],
  "automaticTaxCategoryId": "65d71377c326ea78e1c47df5",
  "isLabelEnabled": true,
  "slug": "awesome-product",
  "taxInclusive": true,
  "prices": [
    "string"
  ]
}'

const response = await fetch('https://services.leadconnectorhq.com/products/YOUR_productId', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"name": "Awesome Product", "locationId": "3SwdhCsvxI8Au3KsPJt6", "description": "Product description goes here.", "productType": "DIGITAL", "image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png", "statementDescriptor": "abcde", "availableInStore": true, "medias": [{"id": "fzrgusiuu0m", "title": "1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png", "url": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/sample.png", "type": "image", "isFeatured": true, "priceIds": "6578278e879ad2646715ba9c"}], "variants": [{"id": "38s63qmxfr4", "name": "Size", "options": [{}]}], "collectionIds": ["65d71377c326ea78e1c47df5", "65d71377c326ea78e1c47d34"], "isTaxesEnabled": true, "taxes": ["654492a4e6bef380114de15a"], "automaticTaxCategoryId": "65d71377c326ea78e1c47df5", "isLabelEnabled": true, "slug": "awesome-product", "taxInclusive": true, "prices": ["string"]}),
});
const data = await response.json();

import os, requests
response = requests.request(
    'PUT',
    'https://services.leadconnectorhq.com/products/YOUR_productId',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
        'Content-Type': 'application/json',
    },
    json={"name": "Awesome Product", "locationId": "3SwdhCsvxI8Au3KsPJt6", "description": "Product description goes here.", "productType": "DIGITAL", "image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png", "statementDescriptor": "abcde", "availableInStore": true, "medias": [{"id": "fzrgusiuu0m", "title": "1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png", "url": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/sample.png", "type": "image", "isFeatured": true, "priceIds": "6578278e879ad2646715ba9c"}], "variants": [{"id": "38s63qmxfr4", "name": "Size", "options": [{}]}], "collectionIds": ["65d71377c326ea78e1c47df5", "65d71377c326ea78e1c47d34"], "isTaxesEnabled": true, "taxes": ["654492a4e6bef380114de15a"], "automaticTaxCategoryId": "65d71377c326ea78e1c47df5", "isLabelEnabled": true, "slug": "awesome-product", "taxInclusive": true, "prices": ["string"]},
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/products/YOUR_productId');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode({'name': 'Awesome Product', 'locationId': '3SwdhCsvxI8Au3KsPJt6', 'description': 'Product description goes here.', 'productType': 'DIGITAL', 'image': 'https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png', 'statementDescriptor': 'abcde', 'availableInStore': true, 'medias': [{'id': 'fzrgusiuu0m', 'title': '1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png', 'url': 'https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/sample.png', 'type': 'image', 'isFeatured': true, 'priceIds': '6578278e879ad2646715ba9c'}], 'variants': [{'id': '38s63qmxfr4', 'name': 'Size', 'options': [{}]}], 'collectionIds': ['65d71377c326ea78e1c47df5', '65d71377c326ea78e1c47d34'], 'isTaxesEnabled': true, 'taxes': ['654492a4e6bef380114de15a'], 'automaticTaxCategoryId': '65d71377c326ea78e1c47df5', 'isLabelEnabled': true, 'slug': 'awesome-product', 'taxInclusive': true, 'prices': ['string']}),
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Autorización

Path parameters

Body

Respuestas

Ejemplo

​Autorización

​Path parameters

​Body

​Respuestas

​Ejemplo

Autorización

Path parameters

Body

Respuestas

Ejemplo