Update a Product

Edit Product

PUT https://{workspace}.myeshopbox.com/product-engine/api/v1/products/{sku}

This endpoint updating an existing product.

Path Parameters

Name
Type
Description

sku

string

A SKU is a unique code that identifies characteristics about each product, source: client

Headers

Name
Type
Description

Authentication

string

Bearer token to grant the access of the API

Request Body

Name
Type
Description

weightUnit

string

The Weight unit of the product Enum: g, lb, kg, ml, invalid

type

string

Defines a type of the product(Base, Kit, Virtual Combo)

vertical

string

Product category code

brand

string

Product brand

description

string

Description of product

mrp

number

Maximum retail price of product

unitPrice

number

Unit price of product

dimensionLength

number

A characteristic of a product in terms of its length

dimesnionWidth

number

A characteristic of a product in terms of its width

dimensionHeight

number

A characteristic of a product in terms of its height

dimesnsionUnit

string

Dimension unit

weight

number

Weight of a product without any packaging

components

array

Unit of virtual combo and kit. It is null for base product

hsnCode

string

It is used for the classification of goods in a systematic and logical manner

taxCode

string

Product tax code

groupCode

string

It used for grouping of multiple SKU

imageUrl

string

Product image

additionalNames

object

Additional names of the product(EAN,UPC, GTIN, Others)

specification

array

It describes the nature of the product(Fragile, Dangerous, Liquid, A battery or contains one, Media)

properties

array

Client defined attribute of the product

{
    "type": "BASE",
    "sku": "73682939-172882-32",
    "groupCode": "73682939-172882",
    "vertical": "APL",
    "brand": "Kapas Kraft",
    "description": "Rust Regular Fit Bundi",
    "specification": [
        "Fragile",
        "Dangerous",
        "Liquid"
    ],
    "additionalNames": {
        "ean": "89027189271829",
        "upc": "87162143127",
        "gtin": "8276174829301",
        "others": [
            "57182_Brown_32"
        ]
    },
    "imageUrl": "https://cdn.filestackcontent.com/hdYluVCqSADCASjjjcuaeC",
    "mrp": 1499.0,
    "unitPrice": 799.0,
    "hsnCode": "6101112",
    "weight": 167.0,
    "dimensionLength": 5.0,
    "dimensionWidth": 5.0,
    "dimensionHeight": 5.0,
    "dimensionUnit": "cm",
    "status": "ACTIVE",
    "createdAt": "2020-03-06T10:33:42.000Z",
    "updatedAt": "2020-03-06T10:40:43.275Z",
    "esin": "STDXE3FMCZA",
    "parentEsin": "STDXE3FMCZA",
    "properties": [
        {
            "label": "season",
            "internalName": "season",
            "value": [
                "winter"
            ]
        },
        {
            "label": "fabric",
            "internalName": "fabric",
            "value": [
                "cotton",
                "silk"
            ]
        }
    ],
    "tax": [
        "5.0",
        "12.0"
    ],
    "taxCode": "ESBGST1",
    "weightUnit": "g",
    "verticalName": "Apparels",
    "availableOn" : [
        "CH4321"
    ]
}
curl --location --request PUT 'https://{workspace}.myeshopbox.com/product-engine/api/v1/products/{productSku}' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "imageUrl": "https://cdn.filestackcontent.com/hdYluVCqSADCASjjjcuaeC",
    "mrp": 1499.0,
    "unitPrice": 799.0,
    "hsnCode": "6101112",
    "weight": 167.0,
    "dimensionLength": 5.0,
    "dimensionWidth": 5.0,
    "dimensionHeight": 5.0,
    "dimensionUnit": "cm"
}'

Note :

  • It is not mandatory to pass all of the existing properties while updating or adding new properties, only those which are required to be updated or added should be there in the request.

Last updated