Create a product

Requires write_products access scope.
For more info, refer to:
access permission.
POST https://{handle}.myshopline.com/admin/openapi/v20260901/products/products.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 .
Create a new product in the store.
TIP
The API does not support direct management of product SEO information. Product SEO details are managed via metafields. For operation instructions, refer to Editing SEO information for the corresponding resource page through metafield's Open API.
When creating a product via this API, the initial value for seoTitle is assigned through title, and the initial value for seoDescription is assigned through body_html.
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 eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
Request Body
  • productobject
    Product information.
  • activated_at string
    The date and time when the product was put on the shelves, which must not be earlier than created_at. Format: ISO 8601.
    When setting this field, the product status must be set to active; otherwise, this field will be invalid.
    Example: 2025-03-06T02:20:26+08:00
  • body_html string
    The product description.
    Maximum size: 512 KB
    Example: This is a description
  • created_at string
    The date and time when the product was created, which must be no earlier than 1990-01-01T00:00:00+08:00. Format: ISO 8601.
    If not provided, the time defaults to when this API call is received.
    Example: 2025-03-06T02:20:26+08:00
  • handle string
    The semantically unique identifier for the product, which is generated based on title by default.
    Maximum length: 255
    Example: product-handle
  • imagesobject[]
    A list of product images.
    Maximum size: 502
  • alt string
    The alternative textual description of the product image, usually a word or phrase with the characteristics or content of the image.
    Maximum length: 512
  • src string
    The link to the product image, represented as a URL.
    Maximum length: 255
    Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • optionsobject[]
    A list of product options.
    Maximum size: 5
  • name string
    The name of the option.
    Maximum length: 255
    Example: Color
  • 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"}
  • path string
    The relative path of the product page.
    Maximum length: 512
    Example: /products/clothes
  • product_category string
    The product category customized by the merchant.
    Maximum length: 255
    Example: Electronic
  • published_at string
    The date and time when the product was published to the online store. Format: ISO 8601.
    Example: 2025-03-06T02:20:26+08:00
  • published_scope string
    The published scope of product sales channels. The value of this field is fixed to web, indicating an online store.
  • spu string
    The identifier customized for the product by the merchant. It is distinct from product.id returned by SHOPLINE.
    Example: S000001
  • status string
    The status of the product. Valid values are:
    • active: products on shelves
    • draft: products off shelves
    • archived: products archiving
    Default value: draft
  • subtitle string
    The subtitle of the product.
    Maximum length: 400
    Example: This is a subtitle.
  • tags array
    A list of tags of the product.
    Maximum size: 250
    Maximum length per string: 255
    Example: ["tag1, tag2"]
  • template_path string
    The theme template of the product.
    Example: templates/product.product_template_name.json
  • title string
    The title of the product.
    Maximum length: 255
    Example: This is a product title
  • variantsobject[]
    A list of product variants.
    Maximum size: 500
  • barcode string
    The barcode of the variant.
    Maximum length: 255
    Example: T0000001
  • compare_at_price string
    The original price of the variant. The value is rounded to two decimal places.
    Default value: 0
    Example: 129.99
  • 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.
    Maximum length: 512
    Example: This is an image alt
  • src string
    The link to the variant image, represented as a URL.
    Maximum length: 255
    Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • inventory_policy string
    Indicates whether the variant is allowed to be oversold.
    • deny: overselling not allowed
    • continue: overselling allowed
    Default value: deny
  • inventory_tracker boolean
    Indicates whether the inventory tracking is enabled.
    • true: Inventory tracking is enabled.
    • false: Inventory tracking is not enabled.
    Default value: true
  • option1 string
    Information of the first option of the variant.
    Maximum length: 255
    Example: red
  • option2 string
    Information of the second option of the variant.
    Maximum length: 255
    Example: xl
  • option3 string
    Information of the third option of the variant.
    Maximum length: 255
    Example: cotton
  • option4 string
    Information of the fourth option of the variant.
    Maximum length: 255
    Example: short
  • option5 string
    Information of the fifth option of the variant.
    Maximum length: 255
    Example: short
  • price string
    The selling price of the variant. The value is rounded to two decimal places.
    Default value: 0
    Example: 90.22
  • required_shipping boolean
    Indicates whether the variant is required to be shipped.
    • true: Shipping is required.
    • false: Shipping is not required.
    Default value: true
  • sku string
    The product SKU. It is distinct from variant.id returned by SHOPLINE.
    Maximum size: 255
    Example: S000000001
  • taxable boolean
    Indicates whether the variant is subject to tax.
    • true: Tax is required.
    • false: Tax is not required.
    Default value: true
  • weight string
    The weight of the variant. The value is required to be greater than 0，and rounded to 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
    Default value: g
  • vendor string
    The brand or vendor of the product.
    Maximum length: 255
    Example: SHOPLINE
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
  • productobject
    Product information.
  • activated_at string
    The date and time when the product was put on the shelves. Format: ISO 8601.
    Example: 2025-03-06T02:20:26+08:00
  • body_html string
    The product description.
  • created_at string
    The date and time when the product was created. Format: ISO 8601.
    Example: 2025-03-06T02:20:26+08:00
  • handle string
    The semantically unique identifier for the product, which is generated based on title by default.
    Example: product-handle
  • id string
    The unique identifier for the product.
    Example: 16050375155238626683133099
  • imageobject
    The cover image of the product.
  • alt string
    The alternative textual description of the image, usually a word or phrase with the characteristics or content of the image.
    Example: This is an image alt.
  • id string
    The unique identifier for the image.
    Example: 5759070976424132652
  • src string
    The link to the image, represented as a URL.
    Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • 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.
  • id string
    The unique identifier for the product image.
    Example: 5759070976424132652
  • src string
    The link to the product image, represented as a URL.
    Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • optionsobject[]
    A list of product options.
  • id string
    The unique identifier for the option.
    Example: 16150375907221969070413099
  • name string
    The name of the option.
    Example: Color
  • option_valuesobject[]
    A list of product option values.
  • id string
    The unique identifier for the option value.
    Example: 16050375155238626683133099
  • value string
    The option value.
    Example: red
  • product_id string
    The unique identifier for the product corresponding to the option.
    Example: 16050375155238626683133099
  • 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"}
  • product_behavior string
    Used to identify the special behavior of the product. This field returns a value only under certain conditions.
    For example, if the product has potential risks, the field returns a value.
    Example: RISK, HIDDEN
  • product_category string
    The product category customized by the merchant.
    Example: Electronics
  • product_type string
    The source of the product. Valid values are:
    • NORMAL : products maintained in the SHOPLINE Admin
    • POD_TEMPORARY : temporary products on the Product Option Customizer&ProductBundler app
    • TEMPORARY : other temporary products
  • published_at string
    The date and time when the product was published to the online store. Format:ISO 8601.
    Example: 2025-03-06T02:20:26+08:00
  • published_scope string
    The published scope of product sales channels. The value of this field is fixed to web, indicating an online store.
  • spu string
    The identifier customized for the product by the merchant. It is distinct from product.id returned by SHOPLINE.
    Example: S000001
  • status string
    The status of the product. Valid values are:
    • active: products on shelves
    • draft: products off shelves
    • archived: products archiving
  • subtitle string
    The subtitle of the product.
    Example: This is a subtitle
  • 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
  • title string
    The title of the product.
    Example: This is a product title
  • updated_at string
    The date and time when the product was last updated. Format: ISO 8601.
    Example: 2025-03-06T02:20:26+08:00
  • variantsobject[]
    A list of product variants.
  • barcode string
    The barcode of the variant.
    Example: T0000001
  • 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 variant was created. Format: ISO 8601.
    Example: 2025-03-06T02:20:26+08:00
  • id string
    The unique identifier for the variant.
    Example: 18050375907221969070393099
  • 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.
  • id string
    The unique identifier for the variant image.
    Example: 5759070976424132652
  • 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: 5705499385037070868
  • inventory_policy string
    Indicates whether the variant is allowed to be oversold.
    • deny: overselling not allowed
    • continue: overselling allowed
  • inventory_quantity integer
    The total inventory quantity at all storage locations.
    Example: 99
  • inventory_tracker boolean
    Indicates whether the inventory tracking is enabled.
    • true: Inventory tracking is enabled.
    • false: Inventory tracking is not enabled.
  • option1 string
    Information of the first option of the variant.
    Example: red
  • option2 string
    Information of the second option of the variant.
    Example: xl
  • option3 string
    Information of the third option of the variant.
    Example: cotton
  • option4 string
    Information of the fourth option of the variant.
    Example: short
  • option5 string
    Information of the fifth option of the variant.
    Example: casual
  • price string
    The selling price of the variant. The value is rounded to two decimal places.
    Example: 90.22
  • product_id string
    The unique identifier for the product corresponding to the variant.
    Example: 16050375155238626683133099
  • required_shipping boolean
    Indicates whether the variant is required to be shipped.
    • true: Shipping is required.
    • false: Shipping is not required.
  • sku string
    The product SKU. It is distinct from variant.id returned by SHOPLINE.
    Example: S000000001
  • taxable boolean
    Indicates whether the variant is subject to tax.
    • true: Tax is required.
    • false: Tax is not required.
  • title string
    The title of the variant, assembled from the option values of the variant.
    Example: red · xl
  • updated_at string
    The date and time when the variant was last updated. Format: ISO 8601.
    Example: 2025-03-06T02:20:26+08:00
  • 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
  • vendor string
    The brand or vendor of the product.
    Example: SHOPLINE
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260901

ParamOptions

— header required

Body

required
{
  "product": {
    "activated_at": "2025-03-06T02:20:26+08:00",
    "body_html": "This is a description",
    "created_at": "2025-03-06T02:20:26+08:00",
    "handle": "product-handle",
    "images": [
      {
        "alt": null,
        "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
      }
    ],
    "options": [
      {
        "name": "Color",
        "values_images": {
          "red": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
        }
      }
    ],
    "path": "/products/clothes",
    "product_category": "Electronic",
    "published_at": "2025-03-06T02:20:26+08:00",
    "published_scope": null,
    "spu": "S000001",
    "status": null,
    "subtitle": "This is a subtitle.",
    "tags": [
      "tag1, tag2"
    ],
    "template_path": "templates/product.product_template_name.json",
    "title": "This is a product title",
    "variants": [
      {
        "barcode": "T0000001",
        "compare_at_price": "129.99",
        "image": {
          "alt": "This is an image alt",
          "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
        },
        "inventory_policy": null,
        "inventory_tracker": null,
        "option1": "red",
        "option2": "xl",
        "option3": "cotton",
        "option4": "short",
        "option5": "short",
        "price": "90.22",
        "required_shipping": null,
        "sku": "S000000001",
        "taxable": null,
        "weight": "0.23",
        "weight_unit": null
      }
    ],
    "vendor": "SHOPLINE"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260901/products/products.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
Create a product
Request
{
  "product": {
    "activated_at": "2024-08-23T16:04:42.527+08:00",
    "body_html": "This is a description",
    "created_at": "2024-08-22T16:03:42.527+08:00",
    "handle": "shopline-2026-1-18",
    "images": [
      {
        "alt": "This is an image alt",
        "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
      }
    ],
    "options": [
      {
        "name": "Color",
        "values_images": {
          "Red": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
        }
      },
      {
        "name": "Size",
        "values_images": {
          "L": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
        }
      }
    ],
    "path": "/my_product",
    "product_category": "Electronic",
    "published_at": "2024-08-23T16:04:42.527+08:00",
    "published_scope": "web",
    "spu": "S000001",
    "status": "active",
    "subtitle": "This is a subtitle",
    "tags": [
      "tag1, tag2"
    ],
    "title": "A product title",
    "variants": [
      {
        "barcode": "B000000001",
        "compare_at_price": "11.2",
        "image": {
          "alt": "This is an image alt",
          "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
        },
        "inventory_policy": "deny",
        "inventory_tracker": true,
        "option1": "Red",
        "option2": "L",
        "option3": "",
        "option4": "",
        "option5": "",
        "price": "10.11",
        "required_shipping": true,
        "sku": "T0000000001",
        "taxable": true,
        "weight": "1.2",
        "weight_unit": "kg"
      }
    ],
    "vendor": "SHOPLINE"
  }
}
Response
{
  "product": {
    "activated_at": "2024-08-23T16:04:42+08:00",
    "body_html": "This is a description",
    "created_at": "2024-08-22T16:03:42+08:00",
    "handle": "shopline-2026-1-18",
    "id": "16073547122319952933092340",
    "image": {
      "alt": "This is an image alt",
      "id": "7354712230602743469",
      "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
    },
    "images": [
      {
        "alt": "This is an image alt",
        "id": "7354712230602743469",
        "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
      }
    ],
    "options": [
      {
        "id": "16173547122327502680382340",
        "name": "Color",
        "option_values": [
          {
            "id": "16273547122327502680392340",
            "value": "Red"
          }
        ],
        "product_id": "16073547122319952933092340",
        "values": [
          "Red"
        ],
        "values_images": {
          "Red": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
        }
      },
      {
        "id": "16173547122327502680412340",
        "name": "Size",
        "option_values": [
          {
            "id": "16273547122327502680422340",
            "value": "L"
          }
        ],
        "product_id": "16073547122319952933092340",
        "values": [
          "L"
        ],
        "values_images": {
          "L": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
        }
      }
    ],
    "product_behavior": "",
    "product_category": "Electronic",
    "product_type": "NORMAL",
    "published_at": "2024-08-23T16:04:42+08:00",
    "published_scope": "web",
    "spu": "S000001",
    "status": "active",
    "subtitle": "This is a subtitle",
    "tags": "tag1 tag2",
    "template_path": null,
    "title": "A product title",
    "updated_at": "2026-01-18T10:25:19+08:00",
    "variants": [
      {
        "barcode": "B000000001",
        "compare_at_price": "11.20",
        "created_at": "2026-01-18T10:25:19+08:00",
        "id": "18073547122327502680362340",
        "image": {
          "alt": "This is an image alt",
          "id": "7354712230602743469",
          "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
        },
        "inventory_item_id": "7354712234662831675",
        "inventory_policy": "deny",
        "inventory_quantity": 0,
        "inventory_tracker": true,
        "option1": "Red",
        "option2": "L",
        "option3": null,
        "option4": null,
        "option5": null,
        "price": "10.11",
        "product_id": "16073547122319952933092340",
        "required_shipping": true,
        "sku": "T0000000001",
        "taxable": true,
        "title": "Red · L",
        "updated_at": "2026-01-18T10:25:19+08:00",
        "weight": "1.20",
        "weight_unit": "kg"
      }
    ],
    "vendor": "SHOPLINE"
  }
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2026 SHOPLINE Limited.