Introduction

Overview How to call Authentication Request Response Pagination Filtering Sorting

API Reference

Linked Products

(ms.linked_products)

Linked Products allow sellers on your store to specify different pricing of the same product.

Fields
EndPoints

Fields

Value Description
product_id   
Type: string
Required
The id of the product for which linked products is to be added.
5c616c176138843d8f975833
product_name   
Type: string
The name of the product for which linked products is to be added.
Famella skirt
variant_id   
Type: string
The id of the product variant for which linked products is to be added.
5c616c176138843d8f975831
price   
Type: number
Required
The specified price of your product.
2500
compare_price   
Type: number
The listing price of the product.
2000
publish   
Type: string
Enabling the flag makes the product visible on frontend.
1
shipping_cost   
Type: string
The shipping cost for the product.
50
inventory_management   
Type: string
Allows to manage the inventory of the product.
1
inventory_allow_out_of_stock   
Type: string
By enabling it, order can be placed for the particular product even if it is Out of Stock.
1
inventory_quantity   
Type: number
The total number of product available in the stock for sale.
15

Commands (Endpoints)

POST /api/1/entity/ms.linked_products   
Creates a new linked product
DEL /api/1/entity/ms.linked_products/{resource_id}   
Deletes a linked product
PUT /api/1/entity/ms.linked_products/{resource_id}   
Updates an existing linked product
GET /api/1/entity/ms.linked_products/{resource_id}   
Retrieves a single linked product
GET /api/1/entity/ms.linked_products   
Retrieves a list of linked products