Menu Close
    Hire us Request quote Reading list Switch to dark mode

    Product API: Multi-Vendor Marketplace for Shopify

    Product API

    Multivendor Product API: Product API is the resource that lets you update and create products in a merchant’s store.

    Base URL: https://mvmapi.webkul.com

    What you can do with Multivendor Product API

    Multivendor Product API lets you do the following functions on the products:

    • GET /api/v2/products.json
      Get all products of a store
    • POST /api/v2/products.json
      Create/Add a new product to the store
    • GET /api/v2/products/count.json
      Get count of all products
    • GET /api/v2/products/{productId}.json
      Get product by product id
    • PUT /api/v2/products/{productId}.json
      Update product by product id
    • DELETE /api/v2/products/{productId}.json
      Delete product by product id
    • DELETE /api/v2/products/{productId}/variants/{variantId}.json
      Delete product variant by product id & variant id
    • POST /api/v2/products/{productId}/variants.json
      Create/Add a new variant for a product
    • GET /api/v2/products/{productId}/collections.json
      -Get all collections by product id
    • GET /api/v2/products/{productId}/images.json
      Get all images by product id
    • GET /api/v2/products/{productId}/variants.json
      -Get all variants by product id
    • GET /api/v2/products/{productId}/variants/{variantId}.json
      -Get variant by product id & variant id
    • PUT /api/v2/products/{productId}/variants/{variantId}.json
      -Update variant by product id & variant id

    Product Properties

    idThis is the product ID, a unique human-friendly string for the product.
    main_id_shopThis is the admin store’s unique ID.
    seller_idVendor ID
    product_nameThis returns the name of the product.
    product_typeA categorization for the product used for filtering and searching products.
    product_descriptionReturns the description of the product.
    product_tagA string of comma-separated tags that are used for filtering and search. A product can have up to 250 tags. Each tag can have up to 255 characters.
    handleA unique human-friendly string for the product. Automatically generated from the product’s title.
    product_meta_infoMetafields are extra pieces of data that apps can attach to products.
    priceThe price of the product.
    compare_at_priceThe original price of the item before an adjustment or a sale.
    sales_priceThis returns the sales price. If off the value will be -1.
    handling_chargesThis returns the handling charges of the product.
    transaction_chargesThis returns the transaction charges of the product.
    track_inventoryReturns if the fulfillment service tracks the number of items in stock for the product variant or not.
    Valid values:
    0: Doesn’t Track
    1: Track
    quantityThis returns the product quantity.
    inventory_policyWhether customers are allowed to place an order for the product variant when it’s out of stock.
    Valid values:
    0: Customers are not allowed to place orders for the product variant if it’s out of stock.
    1: Customers are allowed to place orders for the product variant if it’s out of stock.
    Default value: 0.
    activeValue- 0/1. Returns the product status as live or not.
    skuA unique identifier for the product variant in the shop. Required in order to connect to a Fulfillment Service.
    barcodeThe barcode, UPC, or ISBN number for the product.
    has_default_shippingThis returns 0/1, i.e., if product has shipping (1) or not (0).
    has_multiple_optionsReturns 1 if the product has variants. (In case of digital product returns 0)
    charge_taxesWhether a tax is charged when the product is sold. Valid values are 0 & 1.
    tax_typeReturns the tax type.
    hsnReturn the product HSN value. (Only for GST Feature App)
    cgstReturn the product CGST value. (Only for GST Feature App)
    sgstReturn the product SGST value. (Only for GST Feature App)
    gstReturn the product GST value. (Only for GST Feature App)
    product_policyReturns if the product includes policy or not.
    id_parentReturns global product ID.
    product_urlThis is for Directory Listing feature of the app.
    expiry_dateThis is for the product expiry feature.
    design_idThis is for the Artist Product Design feature.
    date_addThe date and time when the product was created.
    typeThis returns the product type as Normal or Digital.
    “type”: {
                    “id”: 1,
                    “type_name”: “normal”
                },

    Variant Properties

    idAn unsigned 64-bit integer that’s used as a unique identifier for the variant.
    product_idThis is a unique product ID.
    shopify_product_idThis is a unique Shopify product ID.
    shopify_variant_idThis is a unique Shopify variant ID.
    image_idThis is a unique image ID of the variant’s image.
    weightThe weight of the product variant in the unit system.
    track_inventoryReturns if the fulfillment service tracks the number of items in stock for the product variant or not.
    Valid values:
    0: Doesn’t Track
    1: Track
    quantityThis returns the variant quantity.
    date_addThe date and time when the product was created.
    dimensionThis returns the dimensions of the variants added in the store. (json format)
    inventory_policyWhether customers are allowed to place an order for the product variant when it’s out of stock.
    Valid values:
    0: Customers are not allowed to place orders for the product variant if it’s out of stock.
    1: Customers are allowed to place orders for the product variant if it’s out of stock.
    Default value: 0.
    id_parentReturns global product ID.
    combinationsReturns store attributes.
    “combinations”: [
    {
    “id”: 1000001,
    “variant_id”: 10001,
    “option_value”: “Default Title”
    }
    inventory_locationsReturns the location of variant’s inventory, i.e., location, location ID & quantity.
    “inventory_locations”: [
    {
    “id”: 1001,
    “product_id”: 10001,
    “variant_id”: 100001,
    “variant_quantity”: 10,
    “location_id”: 11,
    “location_name”: “India”,
    “shopify_location_id”: 100000000001
    }
    ]

    Options Properties

    idAn unsigned 64-bit integer that’s used as a unique identifier for the option.
    nameThe custom properties that a shop owner uses to define product variants. You can define three options for a product: option1option2option3.
    product_idThis is a unique product ID.
    valuesReturns the values like id, option id & value of the option.
    “values”: [
    {
    “id”: 10001,
    “option_id”: 100001,
    “value”: “Default Title”
    }
    ]

    Image Properties

    idThe unique numeric identifier for a product’s image. The image must be associated to the same product as the variant.
    product_idThis is a unique product ID.
    activeStatus of the image that whether it is live or not.
    positionReturns the position of the image.
    img_urlReturns the image URL.
    img_smReturns the image URL.
    img_mdReturns the image URL.
    img_lgReturns the image URL.
    img_altReturns the image alt text.
    process_statusIf the image is updated on our S3, it will return processed otherwise in-process.

    Collection Properties

    idAn unsigned 64-bit integer that’s used as a unique identifier for the collection.
    product_idThis is a unique product ID.
    shopify_category_idThis is the Shopify’s unique ID for collection.
    category_nameThis returns the name of the collection.
    handleA unique human-friendly string for the product. Automatically generated from the collection’s title.
    levelReturns 1 if the collection has subcategories. Else, returns o.
    id_parentIf level=1, it returns the ID of the parent category.
    activereturns the status of the category. 0 for active, 1 for not active.

    End Points

    GET/api/v2/products.json

    Get all the products of a store

    Parameters

    Name

    page
    integer
    (query)

    limit
    integer
    (query)

    sort_by
    string
    (query)

    sort_order
    string
    (query)

    filter
    string
    (query)

    Description

    Return a specific page of results.
    Default value: 1

    ⠀⠀⠀

    Return up to this many results per page. (maximum: 250)
    Default value: 50

    Determines the parameter by which the products are sorted in the response. Available parameters are id, product_name, id_shop, price, quantity, date_add.
    Default value: date_add

    Determines the sorting order. 1).asc-> ascending 2).desc-> descending
    Default value: desc

    Searches only for the products with the specified ‘id’, ‘product_name’, ‘id_shop’, ‘price’, ‘type’, ‘handle’, ‘product_type’, ‘platform’.
    Example:

    RESPONSE

    GET  /api/v2/products/count.json

    Get the count of all products of a store

    Parameters

    Name

    seller_id
    integer
    (query)

    filter
    string
    (query)

    Description

    Filter response by seller id

    ⠀⠀⠀

    ⠀⠀⠀

    Count Products with their ‘type’, 1 for normal, 2 for digital, 3 for global product or with platform id ,’platform_id’, 2:’Woo-commerce’, 3:’Etsy’, 4:’Magento’, 5:’Prestashop’.
    Example:

    RESPONSE

    GET /api/v2/products/{productId}.json

    Get product by product id

    Parameters

    Name

    productId  *required
    string
    (path)

    Description

    This is the product ID, a unique human-friendly string for the product.

    RESPONSE

    POST /api/v2/products.json

    Create/Add a new product to the store

    Parameters

    Name

    Products
    json
    (body)

    Description

    Create/Add a new product to the store

    Example Value

    Parameter content-type: application/json

    RESPONSE

    PUT /api/v2/products/{productId}.json

    Update product information by their Id

    Parameters

    Name

    Product
    json
    (body)

    ⠀⠀⠀⠀

    ⠀⠀⠀⠀

    ⠀⠀⠀⠀

    ⠀⠀⠀⠀

    ⠀⠀⠀⠀

    productId *required
    string
    (path)

    Description

    Using this API, you can make changes to the product details. Remember that, no changes can be made to the variants using this API

    Example Value

    Parameter content-type: application/json

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    RESPONSE

    DELETE /api/v2/products/{productId}.json

    Delete product by product id

    Parameters

    Name

    productId *required
    string
    (path)

    Description

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    RESPONSE

    DELETE  /api/v2/products/{productId}/variants/{variantId}.json

    Delete product variant by product id & variant id

    Parameters

    Name

    productId *required
    string
    (path)

    variantId *required
    string
    (path)

    Description

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    An unsigned 64-bit integer that’s used as a unique identifier for the variant.

    RESPONSE

    POST /api/v2/products/{productId}/variants.json

    Create/Add a new variant for a product

    Parameters

    Name

    Variants
    json
    (body)

    productId *required
    string
    (path)

    Description

    Using this API, you can make changes to the variant details.

    Example Value

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    RESPONSE

    GET /api/v2/products/{productId}/variants/{variantId}.json

    Get variant by product id & variant id

    Parameters

    Name

    productId *required
    string
    (path)

    variantId *required
    string
    (path)

    Description

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    An unsigned 64-bit integer that’s used as a unique identifier for the variant.

    RESPONSE

    GET /api/v2/products/{productId}/variants.json

    Get all variants by product id

    Parameters

    Name

    productId *required
    string
    (path)

    Description

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    RESPONSE

    GET /api/v2/products/{productId}/images.json

    Get all images by product id

    Parameters

    Name

    productId *required
    string
    (path)

    Description

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    RESPONSE

    GET /api/v2/products/{productId}/collections.json

    Get all collections by product id

    Parameters

    Name

    productId *required
    string
    (path)

    Description

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    RESPONSE

    PUT /api/v2/products/{productId}/variants/{variantId}.json

    Update variant by product id & variant id

    Parameters

    Name

    productId *required
    string
    (path)

    variantId *required
    string
    (path)

    Variants
    json
    (body)

    Description

    An unsigned 64-bit integer that’s used as a unique identifier for the product.

    An unsigned 64-bit integer that’s used as a unique identifier for the variant.

    Using this API, you can make changes to the variant details.

    Example Value

    RESPONSE

    Need Help regarding Multivendor Product API?

    Drop your query/suggestion at support@webkul.com or create your ticket at Webkul UV Desk.

    . . .

    Comment

    Add Your Comment

    Be the first to comment.

    Back to Top
    css.php
    Hire Us!
    Brief us about your requirements and we'll get back to you.
    Woo! Hooy!
    We have just received your message and our expert will get back to you shortly.
    Send Again
    Close