Create product

Event GroupEvent Identification
productsproducts/create
After executing the product creation, you will receive this notification. You can obtain the returned product creation information.
For details on how to subscribe to Webhooks and how to respond after receiving a Webhook, please refer to the Webhook Overview.
Request Headers
  • X-Shopline-Topic string required
    The unique identifier for the event.
    Example: orders/edited
  • X-Shopline-Hmac-Sha256 string required
    The signature of the request. Upon receiving the request, you must verify the signature to confirm the authenticity and integrity of the data.
    Example: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
  • X-Shopline-Shop-Domain string required
    The store domain.
    Example: example.myshopline.com
  • X-Shopline-Shop-Id string required
    The store ID.
    Example: 1610418123456
  • X-Shopline-Merchant-Id string required
    The merchant ID.
    Example: 2000001234
  • X-Shopline-API-Version string required
    The API version.
    Example: v20250601
  • X-Shopline-Webhook-Id string required
    The ID of this Webhook event.
    Example: b54557e48a5fbf7d70bcd043
Request Body
  • body_html string
    Description of product. Maximum size: 512k
    Example: This is a description
  • created_at string
    The date and time when the product was created. The value of this field follows the ISO 8601 standard time format.
    Example: 2023-03-02T18:18:42.883+0800
  • handle string
    The handle of Product, a unique identifier automatically generated based on the product title.
    Example: spring-women's-clothing
  • id string
    Unique product identifier. Maximum length：64
    Example: 16058287356753569620272670
  • imageobject
    Main Image of the Product.
  • alt string
    Words or phrases that share the characteristics or content of images.
    Example: This is a image alt
  • src string
    The image's location represented as a URL.
    Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • imagesobject[]
    List of Product Images.
  • alt string
    Words or phrases that share the characteristics or content of images.
    Example: This is a image alt
  • src string
    The image's location represented as a URL.
    Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • optionsobject[]
    List of options.
  • id string
    Unique option identifier.
    Example: 16158288104774469113452670
  • name string
    The name of product option.
    Example: Color
  • option_valuesobject[]
    List of option values.
  • id string
    The ID of option value.
    Example: 16247051995358890915900034
  • value string
    The option value.
    Example: Red
  • product_id string
    Unique product identifier. Maximum length：64
    Example: 16058287356753569620272670
  • values array
    The list of option value.
    Example: ["[\"Red\", \"Green\", \"White\"]"]
  • values_images map
    The image of option value.
    Example: {}
  • product_behavior string
    The behavior of product.
    Example: RISK,HIDDEN
  • product_category string
    The category of product.
    Example: Electronic
  • product_type string
    The type of product. Valid values are：
    • NORMAL
    • POD_TEMPORARY
    • TEMPORARY
    Example: Electronic
  • published_at string
    The time when the product is published to the online stores. The value of this field follows the ISO 8601 standard time format.
    Example: 2023-03-02T18:18:42.883+0800
  • published_scope string
    Set the sales channel , when the value is " web " , it means online stores.
    Example: web
  • spu string
    The product's SPU code.
    Example: S000001
  • status string
    Product status. Valid values are:
    • activated: On shelves
    • deactivated: Off shelves
    • archived: Filing
    Example: active
  • subtitle string
    The subtitle of product.
    Example: This is a subtitle
  • tags string
    The tags of product.
    Maximum size：250
    Maximum length per string: 255
    Example: tag1,tag2
  • template_path string
    The theme template of product.
    Example: templates/products/detail.json
  • title string
    The title of product.
    Maximum length：255
    Example: spring women's clothing
  • updated_at string
    Update time. The value of this field follows the ISO 8601 standard time format.
    Example: 2023-03-02T18:18:42.883+0800
  • variantsobject[]
    The list of product variants.
  • barcode string
    The barcode of product.
    Example: B000000001
  • compare_at_price string
    The original price of product variant. The price value is rounded to two decimal places.
    Example: 10
  • id string
    The ID of product variant.
    Example: 18054026339558906501791422
  • imageobject
    The image of product variant.
  • alt string
    Words or phrases that share the characteristics or content of images.
    Example: This is a image alt
  • src string
    The image's location represented as a URL.
    Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • inventory_item_id string
    Unique inventory identifier.
    Maximum length：64
    Example: 5482608456602009969
  • inventory_policy string
    Valid values for a product variant's inventory policy when it is sold out.
    • continue：Customers can still place orders even when the product variant's inventory is sold out.
    • deny：Customers cannot continue to order when the product variant's inventory is completely sold out.
    Default value: deny
    Example: continue
  • inventory_quantity integer
    The quantity of inventory items.
    Example: 100
  • inventory_tracker boolean
    Track the inventory or not.
    • true：Tracking enabled
    • false：Tracking disabled
    Default value : false.
    Example: true
  • option1 string
    The variant corresponds to the value of the option 1.
    Example: Red
  • option2 string
    The variant corresponds to the value of the option 2.
    Example: L
  • option3 string
    The variant corresponds to the value of the option 3.
  • option4 string
    The variant corresponds to the value of the option 4.
  • option5 string
    The variant corresponds to the value of the option 5.
  • price string
    The price of product variant. The price value is rounded to two decimal places.
    Example: 20
  • product_id string
    Unique product identifier. Maximum length：64
    Example: 16058287356753569620272670
  • required_shipping boolean
    Shipping or not.
    • true：Requires shipping
    • false：Does not require shipping
    Default value
    .
  • sku string
    The SKU code of product variant.
    Example: T000001
  • taxable boolean
    Tax collection or not required.
    • true：Required
    • false：Not required
    Default value : true.
  • title string
    The title of product variant.
    Example: Red/L
  • weight string
    The product variant's weight in the unit defined by weight_unit.
    Example: 10
  • weight_unit string
    The measurement unit for the weight of the variant.
    ValueDescription
    ggrams
    kgkilograms
    lbpounds
    ozounces
    zh_kgkilograms
    Example: g
  • vendor string
    The vendor of product.
    Example: Shopline
Status Codes
After receiving a webhook notification from SHOPLINE, you must respond with the following format:
HTTP/1.1 200 OK
For more information about how to subscribe to webhooks and webhook response rules, refer to Webhook overview.
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.