Get products
GET https://{handle}.myshopline.com/admin/openapi/v20260301/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 .Get a list of products. Specify query parameters to define the product query scope.
Query Parameters
- collection_id stringThe unique identifier for the product collection.
Maximum length:64Example:12248721639068681442230282 - created_at_max stringSpecify the latest creation time for the product to be queried. Products created on or before this time will be returned. Format: ISO 8601.Example:
2021-09-02T14:11:54+00:00 - created_at_min stringSpecify the earliest creation time for the product to be queried. Products created on or after this time will be returned. Format: ISO 8601.Example:
2021-09-03T14:11:54+00:00 - fields stringSpecify the fields to be returned, with multiple fields separated by commas. For available fields, refer to the top-level child parameters under the
productobject in the response.Example:title,id,created_at - handle stringThe semantically unique identifier for the product, which is generated based on
titleby default.
Maximum length: 255Example:product-handle - ids stringThe unique identifiers for products to query, with multiple IDs separated by commas.Example:
16057850264845250791280282,16057850264845250333280282 - limit integerThe quantity limit of products to be queried.
Value range: 1-250
Default Value:50 - order_by stringThe sorting rule based on product creation time. Valid values are:
created_at_asc: Sort products from the earliest to the latest creation time.created_at_desc: Sort products from the earliest to the latest creation time.
Example:created_at_desc - page_info stringThe unique identifier for pagination queries, used to locate a specific page.This parameter value is obtained from the
linkvalue in the response header of this API after you have queried the pagination information.For example, if thelinkvalue you obtained is<https://{handle}.myshopline.com/admin/openapi/{version}/products/products.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next", the value ofpage_infoiseyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9. For more information on how to use pagination, refer to Paging Mechanism. - product_category stringThe product category customized by the merchant.
Maximum length: 255Example:Electronics - since_id stringThe ID of a specific product. Start querying products from this specified ID.Example:
16057850264845250791280282 - status stringThe status of the product. Valid values are:
active: products on shelvesdraft: products off shelvesarchived: products archiving
- title stringThe title of the product.
Maximum length: 255Example:This is a title. - updated_at_max stringSpecify the latest update time for the product to be queried. Products updated on or before this time will be returned. Format: ISO 8601.Example:
2021-09-02T14:11:54+00:00 - updated_at_min stringSpecify the earliest update time for the product to be queried. Products updated on or after this time will be returned. Format: ISO 8601.Example:
2021-09-03T14:11:54+00:00 - vendor stringThe brand or vendor of the product.
Maximum length: 255Example:SHOPLINE
Request Headers
- Content-Type string requiredThe field must be set to the fixed value
application/json; charset=utf-8. - Authorization string requiredThe 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
Status Codes
- 200
- 401
- 429
For the complete list of codes and messages, see Http status code.
Response Headers
link
The URL link that provides the pagination data. You can obtainpage_infofrom this parameter for subsequent pagination requests.This parameter is returned when the requested page has a previous or next page.For more information on how to use pagination, refer to Paging Mechanism.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
productsobject[]
A list of products.vendor stringThe brand or vendor of the product.Example:SHOPLINEpublished_scope stringThe published scope of product sales channels. The value of this field is fixed toweb, indicating an online store.imageobject
The cover image of the product.id stringThe unique identifier for the image.Example:5785060242207917075src stringThe link to the image, represented as a URL.Example:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.pngalt stringThe 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.optionsobject[]
A list of product options.values arrayA list of option values.Example:["[\"red\", \"green\", \"white\"]"]values_images mapThe mapping relationship between the option value and the corresponding image URL.Example:{}id stringThe unique identifier for the option.Example:16158068291703878544960282name stringThe name of the option.Example:Coloroption_valuesobject[]
A list of product option values.id stringThe unique identifier for the option value.Example:16050375155238626683133099value stringThe option value.Example:redproduct_id stringThe unique identifier for the product corresponding to the option.Example:16057850264845250791280282path stringThe relative path of the product page.Example:/products/clothespublished_at stringThe date and time when the product was published to the online store. Format:ISO 8601.Example:2025-03-06T02:20:26+08:00id stringThe unique identifier for the product.Example:16057850264845250791280282variantsobject[]
A list of product variants.id stringThe unique identifier for the variant.Example:18057850264851626133510282weight_unit stringThe unit of weight for the variant. Valid values are:g: gramkg: kilogramlb: poundoz: ouncezh_kg: kilogram
option1 stringInformation of the first option of the variant.Example:redbarcode stringThe barcode of the variant.Example:T0000001taxable booleanIndicates whether the variant is subject to tax.true: Tax is required.false: Tax is not required.
required_shipping booleanIndicates whether the variant is required to be shipped.true: Shipping is required.false: Shipping is not required.
inventory_policy stringIndicates whether the variant is allowed to be oversold.deny: Does not allow overselling.continue: Allow overselling.
inventory_tracker booleanIndicates whether the inventory tracking is enabled.true: Inventory tracking is enabled.false: Inventory tracking is not enabled.
option3 stringInformation of the third option of the variant.Example:cottonoption4 stringInformation of the fourth option of the variant.Example:shortposition integerThe ordering position of the variant within the variant list.Example:1imageobject
The image of the variant.src stringThe link to the variant image, represented as a URL.Example:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.pngalt stringThe 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 stringThe unique identifier for the variant image.Example:5785060242207917075title stringThe title of the variant, assembled from the option value of the variant.Example:red · xlinventory_item_id stringThe unique identifier for the inventory item.Example:5785060242375689228option5 stringInformation of the fifth option of the variant.Example:casualcompare_at_price stringThe original price of the variant. The value is rounded to two decimal places.Example:129.99inventory_quantity integerThe total inventory quantity at all storage locations.Example:99sku stringThe product SKU. It is distinct fromvariant.idreturned by SHOPLINE.Example:S000000001weight stringThe weight of the variant. The value is rounded up if it exceeds two decimal places.Example:0.23price stringThe selling price of the variant. The value is rounded to two decimal places.Example:90.22product_id stringThe unique identifier for the product corresponding to the variant.Example:16057850264845250791280282option2 stringInformation of the second option of the variant.Example:xlimagesobject[]
A list of product images.id stringThe unique identifier for the product image.Example:5785060242207917075src stringThe link to the product image, represented as a URL.Example:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.pngalt stringThe 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.product_behavior stringUsed 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, HIDDENstatus stringThe status of the product. Valid values are:active: products on shelvesdraft: products off shelvesarchived: products archiving
handle stringThe semantically unique identifier for the product, which is generated based ontitleby default.Example:product-handlesubtitle stringThe subtitle of the product.Example:This is a subtitletags stringA list of tags of the product.Example:tag1, tag2template_path stringThe theme template of the product.Example:templates/product.product_template_name.jsonupdated_at stringThe date and time when the product was last updated. Format: ISO 8601.Example:2025-03-06T02:20:26+08:00title stringThe title of the product.Example:This is a Product titlecreated_at stringThe date and time when the product was created. Format: ISO 8601.Example:2025-03-06T02:20:26+08:00body_html stringThe product description.product_type stringThe source of the product. Valid values are:NORMAL: products maintained in the SHOPLINE AdminPOD_TEMPORARY: temporary products on the Product Option Customizer&ProductBundler appTEMPORARY: other temporary products
spu stringThe identifier customized for the product by the merchant. It is distinct fromproduct.idreturned by SHOPLINE.Example:S00000001product_category stringThe product category customized by the merchant.Example:Electronics
API Explorer
Debugger
Examples
Was this article helpful to you?