Add a product to a sales channel

Requires write_product_listings access scope.
For more info, refer to:
access permission.
PUT https://{handle}.myshopline.com/admin/openapi/v20270301/product_listings/:product_listing_id.json
handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .
Add a product to the designated sales channel. Once added successfully, the product will be displayed on the corresponding sales channel.
Path Parameters
  • product_listing_id string required
    The unique identifier for the product.
    Maximum length：64
    Example: 16049619743346320200470282
Request Headers
  • Content-Type string required
    The field must be set to the fixed value application/json; charset=utf-8.
  • Authorization string required
    The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
    Example:
    Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA
Request Body
  • product_listingobject
    Product information.
  • product_id string
    The unique identifier for the product.
    Maximum length：64
    Example: 16049619743346320200470282
  • sale_channel string
    The unique identifier for the sales channel.
    Example: web
Status Codes
For the complete list of codes and messages, see Http status code.
Response Headers
  • traceId
    A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.
Response Body
  • product_listingobject
    Product information.
  • body_html string
    The product description.
  • imagesobject[]
    A list of product images.
  • alt string
    The alternative textual description of the product image, usually a word or phrase with the characteristics or content of the image.
    Example: This is an image alt.
  • src string
    The link to the product image, represented as a URL.
    Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • spu string
    The identifier customized for the product by the merchant.
    Example: S00000001
  • subtitle string
    The subtitle of the product.
    Example: This is a subtitle
  • variantsobject[]
    A list of product variants.
  • inventory_tracker boolean
    Indicates whether the inventory tracking is enabled.
    • true: Inventory tracking is enabled.
    • false: Inventory tracking is not enabled.
  • barcode string
    The barcode of the variant.
    Example: T00000001
  • inventory_policy string
    Indicates whether the variant is allowed to be oversold.
    • deny: Does not allow overselling.
    • continue: Allow overselling.
  • option4 string
    Information of the fourth option of the variant.
    Example: short
  • sku string
    The identifier customized for the product variant by the merchant.
    Example: S00000001
  • weight string
    The weight of the variant. The value is rounded up if it exceeds two decimal places.
    Example: 0.23
  • weight_unit string
    The unit of weight for the variant. Valid values are:
    • g: gram
    • kg: kilogram
    • lb: pound
    • oz: ounce
    • zh_kg: kilogram
  • imageobject
    The image of the variant.
  • alt string
    The alternative textual description of the variant image, usually a word or phrase with the characteristics or content of the image.
    Example: This is an image alt.
  • src string
    The link to the variant image, represented as a URL.
    Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • inventory_item_id string
    The unique identifier for the inventory item.
    Example: 59854602422372317075
  • option1 string
    Information of the first option of the variant.
    Example: red
  • option5 string
    Information of the fifth option of the variant.
    Example: casual
  • product_id string
    The unique identifier for the product corresponding to the variant.
    Example: 16057039432335097907370282
  • title string
    The title of the variant, assembled from the option value of the variant.
    Example: red · xl
  • id string
    The unique identifier for the variant.
    Example: 18057039439794751459380282
  • inventory_quantity integer
    The total inventory quantity at all storage locations.
    Example: 99
  • option2 string
    Information of the second option of the variant.
    Example: xl
  • option3 string
    Information of the third option of the variant.
    Example: cotton
  • price string
    The selling price of the variant. The value is rounded to two decimal places.
    Example: 90.22
  • compare_at_price string
    The original price of the variant. The value is rounded to two decimal places.
    Example: 129.99
  • created_at string
    The date and time when the product was created. Format: ISO 8601.
    Example: 2025-03-06T02:20:26+08:00
  • optionsobject[]
    A list of product options.
  • id string
    The unique identifier for the option.
    Example: 16158068291703878544960282
  • name string
    The name of the option.
    Example: Color
  • product_id string
    The unique identifier for the product corresponding to the option.
    Example: 16057850264845250791280282
  • values array
    A list of option values.
    Example: ["[\"red\", \"green\", \"white\"]"]
  • values_images map
    The mapping relationship between the option value and the corresponding image URL.
    Example: {"red":"https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"}
  • vendor string
    The brand or vendor of the product.
    Example: SHOPLINE
  • title string
    The title of the product.
    Example: This is a product title
  • handle string
    The semantically unique identifier for the product, which is generated based on title by default.
    Example: product-handle
  • status string
    The status of the product. Valid values are:
    • active: products on shelves
    • draft: products off shelves
    • archived: products archiving
  • tags string
    A list of tags of the product.
    Example: tag1, tag2
  • template_path string
    The theme template of the product.
    Example: templates/product.product_template_name.json
  • updated_at string
    The date and time when the product was last updated. Format: ISO 8601.
    Example: 2025-03-06T02:20:26+08:00
  • product_id string
    The unique identifier for the product.
    Example: 16057850264845250791280282
  • published_at string
    The date and time when the product was published. Format: ISO 8601.
    Example: 2025-03-06T02:20:26+08:00
  • published_scope string
    The published scope of product sales channels.
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20270301

ParamOptions

— path required
— header required

Body

required
{
  "sale_channel": "web",
  "product_listing": {
    "product_id": "16049619743346320200470282"
  }
}

Language

curl --request PUT \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20270301/product_listings/product_listing_id.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
Add a product to the online store sales channel
Request
{
  "product_listing": {
    "product_id": "16073187380346473690812340"
  },
  "sale_channel": "web"
}
Response
{
  "product_listing": {
    "options": [
      {
        "product_id": "16060878769549874798573144",
        "values": [
          "L"
        ],
        "values_images": {},
        "id": "16160878769553398014013144",
        "name": "Size"
      },
      {
        "product_id": "16060878769549874798573144",
        "values": [
          "White"
        ],
        "values_images": {},
        "id": "16160878769553398014043144",
        "name": "Color"
      }
    ],
    "images": [
      {
        "alt": "This is an alt",
        "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
      }
    ],
    "published_scope": "web",
    "status": "active",
    "title": "My Product 2",
    "created_at": "2023-08-28T11:37:32+08:00",
    "product_id": "16060878769549874798573144",
    "published_at": "2023-08-28T11:37:32+08:00",
    "tags": "T shirt,Spring",
    "template_path": "templates/products/detail.html",
    "updated_at": "2023-08-28T19:18:17+08:00",
    "vendor": "Shopline",
    "spu": "S000000001",
    "subtitle": "This is a subtitle",
    "variants": [
      {
        "compare_at_price": "120.00",
        "inventory_policy": "continue",
        "inventory_tracker": true,
        "weight": "10.00",
        "price": "100.00",
        "sku": "S00000000101",
        "barcode": "T00000001",
        "id": "18060878769553398013993144",
        "image": {
          "alt": "This is an alt",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
        },
        "option2": "White",
        "product_id": "16060878769549874798573144",
        "weight_unit": "g",
        "inventory_item_id": "6087876956094755808",
        "inventory_quantity": 580,
        "option1": "L",
        "title": "L · White"
      }
    ],
    "body_html": "<p>This is a desription</p>",
    "handle": "my-product-2"
  }
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2026 SHOPLINE Limited.