Create product

Requires write_products access scope.
For more info , refer to:
POST https://{handle}.myshopline.com/admin/openapi/v20250601/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 product.
Request Headers
  • Content-Type required
    The value of this field is fixed to application/json; charset=utf-8
  • Authorization string required
    The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
Request Body
  • productobject
    Product object
  • activated_at string
    Shelf Time (format: ISO 8601), effective when status is set to active, and must not be earlier than the creation time. When provided, the created_at parameter is required.
    Example: 2024-08-23T16:04:42.527+08:00
  • body_html string
    Description of the product, limited to 512k.
    Example: This is a description
  • created_at string
    Creation Time (format: ISO 8601), must not be later than the current time. Defaults to the data write time if not provided.
    Example: 2024-08-22T16:03:42.527+08:00
  • handle string
    Globally unique product handle, default is the product title, limited to 255 characters.
    Example: a-product-title
  • imagesobject[]
    List of product images, up to 502 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 product options, up to 5.
  • name string
    The name of product option , limited to 255 characters.
    Example: Color
  • values_images map
    The image of option value.
    Example: [object Object]
  • path string
    The relative path of the product URL in the online store, max 512 characters.
    Example: /my_product
  • product_category string
    The category of product.
    Example: Electronic
  • published_at string
    Time Published to Online Store (format: ISO 8601), effective when published_scope is set to web, and must not be earlier than the creation time. When provided, the created_at parameter is required.
    Example: 2024-08-23T16:04:42.527+08:00
  • 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., limited to 255 characters.
    Example: S000001
  • status string
    The product's status.
    valuedescription
    activeIndicates that the product is ready for sale can be released on applications and sales channels.
    draftThe product is not yet ready for sale and cannot be offered to customers through applications and sales channels.
    archivedIndicates that the product is not for sale and cannot be provided to customers through applications and sales channels.
    Example: active
  • subtitle string
    Product summary, limited to 255 characters.
    Example: This is a subtitle
  • tags array
    Product tags, up to a maximum of 250 tags, with each tag limited to a maximum of 255 characters.
    Example: tag1, tag2
  • title string
    Product's title , limited to 255 characters
    Example: A product title
  • variantsobject[]
    Variants belonging to a product, with a maximum of 500 variants.
  • barcode string
    Barcode of the product variant, limited to 255 characters.
    Example: B000000001
  • compare_at_price string
    The original price of the variant, default is empty.
    Example: 11.2
  • 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_policy string
    Valid values for a product variant's inventory policy when it is sold out.
    parameterdescription
    denyAfter it's sold out, customers can't purchase the product variant.
    continueCustomers can purchase the product variant once it is sold out.
    Example: deny
  • inventory_tracker boolean
    Indicates whether to enable tracking of inventory for this product, defaulting to not tracked.
    Example: true
  • option1 string
    The variant corresponds to the value of the option1 limited to 255 characters
    Example: Red
  • option2 string
    The variant corresponds to the value of the option2 limited to 255 characters
    Example: L
  • option3 string
    The variant corresponds to the value of the option3 limited to 255 characters
  • option4 string
    The variant corresponds to the value of the option4 limited to 255 characters
  • option5 string
    The variant corresponds to the value of the option5 limited to 255 characters
  • price string
    The default price of the variant is 0.
    Example: 10.11
  • required_shipping boolean
    Indicate whether shipping is required.
    Example: true
  • sku string
    Variant SKU code, limited to 255 characters.
    Example: T0000000001
  • taxable boolean
    Indicate whether taxes are required.
    Example: true
  • weight string
    The weight of the variant, required to be greater than 0, and rounded up to the nearest hundredth decimal place.
    Example: 1.2
  • weight_unit string
    The measurement unit for the weight of the variant. If weight_unit is not specified, the default measurement unit is g.
    EnumDescription
    gRepresents the unit in grams
    kgRepresents the unit in kilograms
    lbRepresents the unit in pounds
    ozRepresents the unit in ounces
    zh_kgRepresents the unit in kilograms
    Example: kg
  • vendor string
    The vendor of product, limited to 255 characters.
    Example: Shopline
Response
For more information about status codes, see Http status code.
Response Headers
  • traceId
    traceId
Response Body
  • productobject
    Product object
  • activated_at string
    Shelf Time (format: ISO 8601), effective when status is set to active, and must not be earlier than the creation time. When provided, the created_at parameter is required.
    Example: 2024-08-23T16:04:42.527+08:00
  • body_html string
    Description of the product.
    Example: This is a description
  • created_at string
    Creation Time (format: ISO 8601), must not be later than the current time. Defaults to the data write time if not provided.
    Example: 2024-08-22T16:03:42.527+08:00
  • handle string
    Global unique Product handle.
    Example: a-product-title
  • id string
    The ID of product.
    Example: 16050375155238626683133099
  • 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
  • id string
    The ID of image.
    Example: 5759070976424132652
  • 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
  • id string
    The ID of image.
    Example: 5759070976424132652
  • src string
    The image's location represented as a URL.
    Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • optionsobject[]
    List of product options, up to 5.
  • id string
    The ID of product option.
  • name string
    The name of product option.
  • product_id string
    The ID of product.
    Example: 16050375155238626683133099
  • values array
    The list of option value.
    Example: Red, Green, White
  • values_images map
    The image of option value.
    Example: [object Object]
  • product_behavior string
    Some actions of the product.
  • product_category string
    The category of product.
    Example: Electronic
  • product_type string
    The type of product:
    • NORMAL
    • POD_TEMPORARY
    • TEMPORARY
    Example: NORMAL
  • published_at string
    Time to post to the online store
    Example: 2024-08-22T16:03:42.527+08:00
  • 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., limited to 255 characters.
    Example: S000001
  • status string
    The product's status.
    valuedescription
    activeIndicates that the product is ready for sale can be released on applications and sales channels.
    draftThe product is not yet ready for sale and cannot be offered to customers through applications and sales channels.
    archivedIndicates that the product is not for sale and cannot be provided to customers through applications and sales channels.
    Example: active
  • subtitle string
    Product summary.
    Example: This is a subtitle
  • tags string
    The tags of product.
    Example: tag1, tag2
  • template_path string
    The template of theme.
    Example: templates/product.json
  • title string
    The title of product.
    Example: A product title
  • updated_at string
    The last modified date and time of the product.
    Example: 2024-08-22T16:03:42.527+08:00
  • variantsobject[]
    Variants belonging to a product.
  • barcode string
    Barcode of the product variant, limited to 255 characters.
    Example: B000000001
  • compare_at_price string
    The original price of the variant, default is empty.
    Example: 11.2
  • created_at string
    The creation date and time of the product variant.
    Example: 2024-08-22T16:03:42.527+08:00
  • id string
    The ID of product variant.
    Example: 18050375907221969070393099
  • 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
  • id string
    The ID of image.
    Example: 5759070976424132652
  • src string
    The image's location represented as a URL.
    Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • inventory_item_id string
    The ID of inventory item.
    Example: 5705499385037070868
  • inventory_policy string
    Valid values for a product variant's inventory policy when it is sold out.
    Example: deny
  • inventory_quantity integer
    Inventory quantity summary across all locations.
    Example: 90
  • inventory_tracker boolean
    Indicates whether to enable tracking of inventory for this product, defaulting to not tracked.
    Example: true
  • option1 string
    The variant corresponds to the value of the option1 limited to 255 characters
    Example: Red
  • option2 string
    The variant corresponds to the value of the option2 limited to 255 characters
    Example: L
  • option3 string
    The variant corresponds to the value of the option3 limited to 255 characters
  • option4 string
    The variant corresponds to the value of the option4 limited to 255 characters
  • option5 string
    The variant corresponds to the value of the option5 limited to 255 characters
  • price string
    The default price of the variant is 0.
    Example: 10.11
  • product_id string
    The ID of product.
    Example: 16050375155238626683133099
  • required_shipping boolean
    Indicate whether shipping is required.
    Example: true
  • sku string
    The SKU code of product variant.
    Example: T0000000001
  • taxable boolean
    Indicate whether taxes are required.
    Example: true
  • title string
    The title of product variant.
    Example: Red/L
  • updated_at string
    The last modified date and time of the product variant.
    Example: 2024-08-22T17:03:42.527+08:00
  • weight string
    The weight of the variant.
    Example: 1.2
  • weight_unit string
    The measurement unit for the weight of the variant. If weight_unit is not specified, the store's default measurement unit will be applied.
    Example: kg
  • vendor string
    The vendor of product, limited to 255 characters.
    Example: Shopline
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

— header required

Body

required
{
  "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": "a-product-title",
    "images": [
      {
        "alt": "This is a image alt",
        "src": "https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"
      }
    ],
    "options": [
      {
        "name": "Color",
        "values_images": {}
      }
    ],
    "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 a 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"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/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'
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.