SHOPLINE Open API

https://open-api.docs.shoplineapp.com/
Admin
SHOPLINE Open API is a comprehensive e-commerce API platform that enables developers to manage...
Tokens:436,152
Snippets:3,347
Trust Score:9.4
Update:1 week ago
Show doc for...
Tokens:
Raw
### GET /v1/settings/users - Response Example

Source: https://open-api.docs.shoplineapp.com/docs/get-users-setting

Example JSON response from the Get Users Setting endpoint, showing fields like pos_apply_credit, minimum_age_limit, and various verification settings.

```json
{
    "pos_apply_credit": false,
    "minimum_age_limit": "13",
    "enable_member_point": true,
    "enable_user_credit": true,
    "line_login": {
      "status": "active"
    },
    "email_verification": { "status": "true" },
    "email_login_with_verification": { "status": "true" },
    "sms_verification": {  
      "status": "true",
      "supported_countries": ["*"]  
    },
    "birthday_format": "YYYY/MM/DD"
}
```

--------------------------------

### Get Token Info response example

Source: https://open-api.docs.shoplineapp.com/docs/get-token-info

Full response example for the Get Token Info endpoint, containing staff, merchant, and user objects.

```json
{
    "staff": {
        "_id": "5ec5e201d8aedd002d744537",
        "email": "archer@gmail.com",
        "locale_code": "en",
        "merchant_ids": [
            "58e4736a9a76f0174c000278",
            "5e840cae77cb07003243f7c7"
        ],
        "name": "archer1"
    },
    "merchant": {
        "_id": "5e840cae77cb07003243f7c7",
        "email": "archer@shoplineapp.com",
        "handle": "archertesttest",
        "name": "Archer Tester"
    },
    "user": {
        "_id": "5e840cae77cb07003243f7c7",
        "email": "archer@shoplineapp.com",
        "name": "Archer Tester"
    }
}
```

--------------------------------

### Response example for Get Product Subscriptions

Source: https://open-api.docs.shoplineapp.com/docs/get-product-subscriptions

Example response for the Get Product Subscriptions endpoint. Shows subscription details including product names in multiple locales and pagination metadata.

```json
{
    "items": [
        {
            "id": "609bece6395f98004436b504",
            "recurring_count": 1,
            "duration": 30,
            "duration_type": "day",
            "next_billing_at": "2021-06-10T16:00:00.000+00:00",
            "status": "active",
            "customer_name": "王小Ｖ",
            "customer_email": "vivi+202105111@shoplineapp.com",
            "product_name": {
                "zh-hant": "<~!@#$%^&*()_+test~~~~~~~>",
                "en": "(product name）",
                "zh-cn": "简体中文",
                "th": "ภาษาจีนตัวย่อ",
                "vi": "Tiếng Trung giản thể"
            },
            "initial_billing_at": "2019-09-26T09:56:16.803+00:00",
            "created_at": "2019-09-26T09:56:16.803+00:00",
            "updated_at": "2019-09-26T09:56:16.803+00:00",
        },
        {
            "id": "5f8fba8ae38809e23367b923",
            "recurring_count": 1,
            "duration": 30,
            "duration_type": "day",
            "next_billing_at": "2020-11-19T16:00:00.000+00:00",
            "status": "active",
            "customer_name": "王小Ｖ",
            "customer_email": "vivi@shoplineapp.com",
            "product_name": {
                "zh-hant": "定期購"
            },
            "initial_billing_at": "2019-09-26T09:56:16.803+00:00",
            "created_at": "2019-09-26T09:56:16.803+00:00",
            "updated_at": "2019-09-26T09:56:16.803+00:00",
        }
    ],
    "pagination": {
        "current_page": 1,
        "per_page": 24,
        "total_count": 2,
        "total_pages": 1
    }
}
```

--------------------------------

### Get Order Setting Response Example

Source: https://open-api.docs.shoplineapp.com/docs/get-order-setting

Full response example for the Get Order Setting endpoint. Shows all fields including invoice_activation, current_invoice_service_provider, invoice, invoice_tradevan, customer_cancel_order, and customer_return_order.

```JSON
{
  "invoice_activation": 'active',
  "current_invoice_service_provider":"tradevan",
  "invoice":{
    "tax_id":"24973192",
    "oversea_tax_type":"2",
    "tax_type":"1",
    "n_p_o_b_a_n":{
      "name":"社團法人中華民國晴天社會福利協會",
      "code":"9595995",
      "short_name":"晴天協會",
      "tax_id":"26661737",
      "county":"桃園市"
    },
    "source":{
      "business_group_code":"SL24973192",
      "business_type_code":"SLFTP"
    }
  },
  "invoice_tradevan":{
    "tax_id":"24973192",
    "oversea_tax_type":"2",
    "tax_type":"1",
    "n_p_o_b_a_n":{
      "name":"社團法人中華民國晴天社會福利協會",
      "code":"9595995",
      "short_name":"晴天協會",
      "tax_id":"26661737",
      "county":"桃園市"
    },
    "source":{
      "business_group_code":"SL24973192",
      "business_type_code":"SLFTP"
    },
    "no_duplicate_uniform_invoice": false,
  },
  "customer_cancel_order": {
    "enabled": true,
    "auto_revert_credit": false
  },
  "customer_return_order": {
    "enabled": true,
    "available_return_days": "7"
  }
}
```

--------------------------------

### Get Promotions response example

Source: https://open-api.docs.shoplineapp.com/docs/get-promotions

Example JSON response for the Get Promotions endpoint, showing two promotion items with fields like id, discount_type, and status.

```json
{
    "items": [
        {
            "id": "5f06c48a436e2b004b471613",
            "discount_percentage": null,
            "discount_amount": null,
            "discountable_quantity": null,
            "discounted_point": 10000,
            "discounted_price": null,
            "discountable_product_ids": [
                "5f06a6ad2a051a0048caec6f"
            ],
            "conditions": [],
            "created_at": "2020-07-09T07:17:30.145+00:00",
            "updated_at": "2020-07-09T07:17:30.145+00:00",
            "title_translations": {
                "en": "Points Campaign",
                "zh-hant": "點數兌換活動"
            },
            "discount_on": "order",
            "discountable_category_ids": [],
            "discount_type": "member_point_redeem_gift",
            "is_accumulated": false,
            "codes": null,
            "membership_tier_id": null,
            "requires_membership": false,
            "whitelisted_membership_tier_ids": [],
            "user_max_use_count": 0,
            "max_use_count": 0,
            "use_count": 0,
            "sum_use_count": 0,
            "drew_coupon_count": 0,
            "whitelisted_delivery_option_ids": [],
            "whitelisted_payment_ids": [],
            "start_at": "2020-07-08T16:00:00.000+00:00",
            "end_at": "2021-12-22T16:00:00.000+00:00",
            "status": "active",
            "usable": true,
            "for_affiliate_campaign": false,
            "is_contain_campaign": false,
            "seo_keywords": null,
            "seo_description_translations": {},
            "seo_title_translations": {},
            "link": null,
            "extended_promotion_id": "5f06c489b84a7c19fe5cfa10",
            "extend_promotions": []
        },
        {
          "id": "5f06c489b84a7c19fe5cfa10",
          "discount_percentage": null,
          "discount_amount": null,
          "discountable_quantity": null,
          "discounted_point": null,
          "discounted_price": null,
          "discountable_product_ids": ["5f06a6ad2a051a0048caec6f"],
          "conditions": [],
          "created_at": "2020-07-09T07:17:29.971+00:00",
          "updated_at": "2020-07-09T07:17:29.971+00:00",
          "title_translations": {
            "en": "Points Campaign",
            "zh-hant": "點數兌換活動"
          },
          "discount_on": "order",
          "discountable_category_ids": [],
```

--------------------------------

### Shell request example

Source: https://open-api.docs.shoplineapp.com/reference/order-item-app-metafields

Example request for the GET /v1/orders/{order_id}/items/app_metafields endpoint using Shell.

```Shell
curl --request GET \
  --url 'https://open.shopline.io/v1/orders/{order_id}/items/app_metafields'
```

--------------------------------

### Request parameter examples for Get Customers

Source: https://open-api.docs.shoplineapp.com/docs/get-customers

Examples of query parameter values for the Get Customers endpoint. updated_after and updated_before use UTC time. per_page defaults to 24, page defaults to 1. Use either page or previous_id for pagination. sort_by defaults to desc.

```ruby
updated_after=2018-01-01 00:00:00 
```

```ruby
updated_before=2018-01-01 00:00:00 
```

```ruby
per_page: 24
```

```ruby
page: 1
```

```ruby
sort_by=desc
sort_by=asc
```

--------------------------------

### Get Warehouse Request Parameter Examples

Source: https://open-api.docs.shoplineapp.com/docs/get-warehouse

Example values for the request parameters page, per_page, excludes, and fields.

```text
`page=1`
```

```text
`per_page=24`
```

```text
`excludes[]=items.status`
```

```text
`fields[]=items.status`
```

--------------------------------

### cURL request example

Source: https://open-api.docs.shoplineapp.com/reference/get_products-product-id-promotions

Example request using the Shell language. The endpoint is GET https://{handle}.shoplineapp.com/storefront-api/v1/products/{product_id}/promotions.

```Shell
curl --request GET \
     --url https://{handle}.shoplineapp.com/storefront-api/v1/products/{product_id}/promotions \
     --header 'accept: application/json' \
     --header 'x-shopline-api-version: 2024-01-01'
```

--------------------------------

### Get Warehouse API Request Example

Source: https://open-api.docs.shoplineapp.com/docs/get-warehouse

Example request parameters for the Get Warehouse endpoint. Shows how to use page, per_page, excludes, and fields query parameters.

```http
GET `https://open.shopline.io/v1/warehouses`
```

--------------------------------

### Create Product Request Body Examples (JSON)

Source: https://open-api.docs.shoplineapp.com/docs/create-product

Two JSON request body examples for creating a product. The first is a minimal example with only basic fields (category_ids, description_translations, images, price, status, title_translations). The second is a more complete example that includes variants, cost, detail_images, hide_price, link, price_sale, same_price, SEO fields, unlimited_quantity, and variant options. Both are shown under the 'Request Example' heading with tabs for 'With variations and variants' and 'With product image'.

```json
{
  "product": {
    "category_ids": [],
    "description_translations": {
      "en": "We are a product design-led company that aims to create products that are simple and stylish, and that focus on the needs of the general public.",
      "zh-hant": "我們是一家以產品設計為主導的公司， 旨在打造款式簡潔時尚且關注社會大眾需求的產品。 "
    },
    "images": [
      "https://shopline.tw/blog/wp-content/uploads/2015/11/logo-shopline-white.png"
    ],
    "price": 9999,
    "status": false,
    "title_translations": {
      "en": "Shopline",
      "zh-hant": "商線科技"
    }
  }
}
```

```json
{
  "product": {
    "category_ids": [],
    "cost": 609,
    "description_translations": {
      "en": "No transaction fees. No design or technical skills required. Integrated with multiple payment and logistic options. With over 120,000 merchants online. Everything you need for your e-commerce store.",
      "zh-hant": "我們是一家以產品設計為主導的公司， 旨在打造款式簡潔時尚且關注社會大眾需求的產品。 公司聚集了一批來自哈佛大學設計學院 以及麻省理工商學院的優秀設計團隊。 我們致力於設計獨特新穎的創新產品， 適合不同年齡，性別人士使用。 在執著追求產品優化同時，注重履行企業社會責任。"
    },
    "detail_images": [
      "https://shopline.tw/blog/wp-content/uploads/2015/11/logo-shopline-white.png"
    ],
    "hide_price": false,
    "images": [
      "https://shopline.tw/blog/wp-content/uploads/2015/11/logo-shopline-white.png"
    ],
    "link": "shopline",
    "price": 1000,
    "price_sale": 689,
    "same_price": true,
    "seo_description_translations": {
      "en": "No transaction fees. No design or technical skills required. Integrated with multiple payment and logistic options. With over 120,000 merchants online. Everything you need for your e-commerce store.",
      "zh-hant": "我們是一家以產品設計為主導的公司， 旨在打造款式簡潔時尚且關注社會大眾需求的產品。 公司聚集了一批來自哈佛大學設計學院 以及麻省理工商學院的優秀設計團隊。 我們致力於設計獨特新穎的創新產品， 適合不同年齡，性別人士使用。 在執著追求產品優化同時，注重履行企業社會責任。"
    },
    "seo_keywords": "電商, 開店, 創業",
    "seo_title_translations": {
      "en": "SHOPLINE",
      "zh-hant": "商線科技"
    },
    "status": true,
    "title_translations": {
      "en": "Shopline.co",
      "zh-hant": "商線科技"
    },
    "unlimited_quantity": true,
    "variant_custom_type_translations": [
      {
        "name_translations": {
          "en": "Custom1",
          "zh-hant": "自訂1"
        },
        "type": "custom_1"
      }
    ],
    "variant_options": [
      {
        "name_translations": {
          "en": "green",
          "zh-hant": "綠"
        },
        "type": "color"
      },
      {
        "name_translations": {
          "en": "Red",
          "zh-hant": "紅"
        },
        "type": "color"
      },
      {
        "name_translations": {
          "en": "L1",
          "zh-hant": "大1"
        },
        "type": "custom_1"
      },
      {
        "name_translations": {
          "en": "S1",
          "zh-hant": "小1"
        },
        "type": "custom_1"
      }
    ]
  }
}
```

--------------------------------

### Request Parameters Example Values

Source: https://open-api.docs.shoplineapp.com/docs/add-a-variation-product

Shows example values for the request parameters in the Add Product Variation API. The first example sets default_show_image_selector to false, and the second shows a sample product_id value.

```ruby
default_show_image_selector: false
```

```ruby
5d3594c276e7ec003b7021c0
```

--------------------------------

### Get Tax Setting Response Example

Source: https://open-api.docs.shoplineapp.com/docs/get-tax-setting

Example response from the Get Tax Setting endpoint. The products_taxable field is a Boolean that indicates whether tax is applied to all products.

```json
{
    "products_taxable": false
}
```

--------------------------------

### Response Example

Source: https://open-api.docs.shoplineapp.com/docs/search-promotions

JSON sample of the promotion list response. Shows the structure of items, pagination, and promotion data fields returned by the API.

```json
{
  "items": [
    {
      "id": "5f06c48a436e2b004b471613",
      "discount_percentage": null,
      "discount_amount": null,
      "discountable_quantity": null,
      "discounted_point": 10000,
      "discounted_price": null,
      "discountable_product_ids": ["5f06a6ad2a051a0048caec6f"],
      "conditions": [],
      "created_at": "2020-07-09T07:17:30.145+00:00",
      "updated_at": "2020-07-09T07:17:30.145+00:00",
      "title_translations": {
        "en": "Points Campaign",
        "zh-hant": "點數兌換活動"
      },
      "discount_on": "order",
      "discountable_category_ids": [],
      "discount_type": "member_point_redeem_gift",
      "is_accumulated": false,
      "codes": null,
      "membership_tier_id": null,
      "requires_membership": false
    }
```

--------------------------------

### Get Channel response example

Source: https://open-api.docs.shoplineapp.com/docs/get-channel

Example JSON response for the Get Channel endpoint. Shows the channel id, localized names, and other fields returned when the request succeeds.

```json
{
    "id": "5ea1d91de388091641f1a6cf",
    "name": {
        "en": "半夜測試中專用店",
        "zh-hant": "半夜測試中專用店"
    }
}
```

--------------------------------

### Request Parameter Examples

Source: https://open-api.docs.shoplineapp.com/docs/search-products

Example values for each request parameter of the search products endpoint. These are query parameters that can be combined to filter the product list.

```ruby
page=1
```

```ruby
per_page=10
```

```ruby
query=productName1
```

```ruby
category_id=sed3398d01cda31bfb00000c,
sec1362f01cda3329300004d
```

```ruby
status=draft
status=active
status=in:hidden,active
```

```ruby
sort_type=created_at
sort_type=lowest_price
sort_type=quantity_sold
sort_type=custom_sorting
```

```ruby
sort_by=desc
sort_by=asc
```

```ruby
sku=sku_123
sku=not:sku_123
sku=in:sku_13,sku_456
```

```ruby
barcode=gtin_123
barcode=not:gtin_123
barcode=in:gtin_13,gtin_456
```

```ruby
is_preorder=true
is_preorder=false
```

```ruby
quantity=100
quantity=not:100
quantity=lt:100
quantity=lte:100
quantity=gt:100
quantity=gte:100
```

```ruby
variation_quantity=100
variation_quantity=not:100
variation_quantity=lt:100
variation_quantity=lte:100
variation_quantity=gt:100
variation_quantity=gte:100
```

```ruby
unlimited_quantity=true
unlimited_quantity=false
```

```ruby
created_at=2018-11-11 12:30:30
created_at=not:2018-11-11 12:30:30
created_at=lt:2018-11-11 12:30:30
created_at=lte:2018-11-11 12:30:30
created_at=gt:2018-11-11 12:30:30
created_at=gte:2018-11-11 12:30:30
```

```ruby
updated_at=2018-11-11 12:30:30
updated_at=not:2018-11-11 12:30:30
updated_at=lt:2018-11-11 12:30:30
updated_at=lte:2018-11-11 12:30:30
updated_at=gt:2018-11-11 12:30:30
updated_at=gte:2018-11-11 12:30:30
```

```ruby
title_translations=Product_Title
```

```ruby
summary_translations=Product_Summary
```

```ruby
tags=shopline
```

```ruby
retail_status=active
```

```ruby
purchasable=true
```

```ruby
excludes[]=items.status
```

--------------------------------

### Response example for Add Product Images

Source: https://open-api.docs.shoplineapp.com/docs/add-product-images

Example response body for the Add Product Images endpoint, identical to the Get Product response. Shows the full product object including translations, pricing, media images with multiple sizes, and other product fields.

```json
{
    "id": "5d3594c276e7ec003b7021c0",
    "status": "active",
    "title_translations": {
        "en": "testing SL-8049",
        "zh-hant": "測試 SL-8049 round 2"
    },
    "price": {
        "cents": 3444,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$3,444",
        "dollars": 3444
    },
    "price_sale": {
        "cents": 689,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$689",
        "dollars": 689
    },
    "lowest_price": {
        "cents": 689,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$689",
        "dollars": 689
    },
    "hide_price": false,
    "same_price": true,
    "cost": {
        "cents": 609,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$609",
        "dollars": 609
    },
    "member_price": {
        "cents": 500,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$500",
        "dollars": 500
    },
    "is_preorder": false,
    "preorder_note_translations": {
        "en": "Shipping starts April 20th, 1971, preorder NOW!",
        "zh-hant": "1971/04/20 開始出貨, 立即訂購!"
    },
    "weight": 123.99,
    "quantity": 87,
    "unlimited_quantity": false,
    "medias": [
        {
            "images": {
                "original": {
                    "width": 580,
                    "height": 580,
                    "url": "https://img.shoplineapp.com/media/image_clips/5d47b4b8c9922900234d5527/original.jpg?1564980407"
                },
                "source": {
                    "width": 580,
                    "height": 580,
                    "url": "https://img.shoplineapp.com/media/image_clips/5d47b4b8c9922900234d5527/source.jpg?1564980407"
                },
                "thumb": {
                    "width": 200,
                    "height": 200,
                    "url": "https://img.shoplineapp.com/media/image_clips/5d47b4b8c9922900234d5527/thumb.jpg?1564980407"
                },
                "large": {
                    "width": 500,
                    "height": 500,
                    "url": "https://img.shoplineapp.com/media/image_clips/5d47b4b8c9922900234d5527/large.jpg?1564980407"
                },
                "xlarge": {
                    "width": 580,
                    "height": 580,
                    "url": "https://img.shoplineapp.com/media/image_clips/5d47b4b8c9922900234d5527/xlarge.jpg?1564980407"
                },
                "favicon_small": {
                    "width": 200,
                    "height": 200,
                    "url": "https://img.shoplineapp.com/media/image_clips/5d47b4b8c9922900234d5527/thumb.jpg?1564980407"
                },
                "favicon": {
                    "width": 200,
                    "height": 200,
                    "url": "https://img.shoplineapp.com/media/image_clips/5d47b4b8c9922900234d5527/thumb.jpg?1564980407"
                },
                "favicon_large": {
                    "width": 200,
                    "height": 200,
                    "url": "https://img.shoplineapp.com/media/image_clips/5d47b4b8c9922900234d5527/thumb.jpg?1564980407"
                },
                "transparent_thumb": {
                    "width": 200,
                    "height": 200,
                    "url": "https://img.shoplineapp.com/media/image_clips/5d47b4b8c9922900234d5527/thumb.jpg?1564980407"
                }
            }
        }
    ]
}
```

--------------------------------

### GET /v1/agents Response Example

Source: https://open-api.docs.shoplineapp.com/docs/get-agents

Example JSON response returned by the Get Agents endpoint. It contains an items array with agent details such as id, name, email, phone, and is_working.

```json
{
  "items": [
    {
      "id": "58c1362e01cda33293000048",
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "+886912345678",
      "is_working": true
    }
  ]
}
```

--------------------------------

### Request parameter examples for Add Product Images

Source: https://open-api.docs.shoplineapp.com/docs/add-product-images

Example values for the request parameters: urls (array of image URLs), image_type (main or detail), and is_replace (boolean). The urls parameter supports multiple URLs in the array. image_type defaults to main; is_replace defaults to false.

```ruby
"urls":["http://i.imgur.com/4CV6QpV.jpg"]
```

```ruby
"image_type": "main"
"image_type": "detail"
```

```ruby
"is_replace": true
"is_replace": false
```

--------------------------------

### Get Webhook Response Example

Source: https://open-api.docs.shoplineapp.com/docs/get-webhook

Example JSON response returned by the Get Webhook endpoint, showing the webhook details including id, format, address, status, merchant_id, timestamps, and topics.

```json
{
    "id": "5f8e5dc08a8bb70a5c9cd93c",
    "format": "json",
    "address": "http://abc.com/webhooks",
    "status": "active",
    "merchant_id": "5e840cae77cb07003243f7c7",
    "created_at": "2020-10-20T03:50:00.323+00:00",
    "updated_at": "2020-10-23T08:43:00.369+00:00",
    "topics": [
        "order/create"
    ]
}
```

--------------------------------

### Get Conversations response examples for shop_messages and order_messages

Source: https://open-api.docs.shoplineapp.com/docs/get-conversations

Response examples for the Get Conversations endpoint, shown in tabs for shop_messages and order_messages platforms. The shop_messages response includes pagination and items with last_message details; the order_messages response includes additional order fields such as order_number, system_order_number, merchant_order_number, and order_id. These examples illustrate the structure returned when calling GET https://open.shopline.io/v1/conversations.

```json
{
    "pagination": {
        "current_page": 1,
        "per_page": 24,
        "total_count": 8,
        "total_pages": 1
    },
    "items": [
        {
            "id": "622090c66775a37b9fa60799",
            "type": "shop_messages",
            "customer_id": "622090c67895b5731f2c53c5",
            "last_message": {
                "id": "622090c66775a37b9fa6079b",
                "sender_id": "622090c67895b5731f2c53c5",
                "sender_type": "User",
                "created_at": "2022-03-03T09:56:22.559Z",
                "value": "你好",
                "type": "text"
            }
        },
        {
            "id": "600d713291f6530044eab0d5",
            "type": "shop_messages",
            "customer_id": "600d71329888be544e4f27fb",
            "last_message": {
                "id": "600d723a91f6530044eab0d9",
                "sender_id": "600d71329888be544e4f27fb",
                "sender_type": "User",
                "created_at": "2021-01-24T13:12:26.282Z",
                "value": null,
                "type": "image"
            }
        }
    ]
}
```

```json
{
    "pagination": {
        "current_page": 1,
        "per_page": 5,
        "total_count": 115,
        "total_pages": 23
    },
    "items": [
        {
            "id": "600f6e0d8e9f8a1afe47c51b",
            "type": "order_messages",
            "customer_id": "600f6e0bbd33f1064c090c97",
            "order_number": null,
            "system_order_number": null,
            "merchant_order_number": null,
            "order_id": "600f6e0d8e9f8a1afe47c51b",
            "last_message": {
                "id": "600f6e458e9f8a1afe47c526",
                "sender_id": "600f6e0bbd33f1064c090c97",
                "sender_type": "User",
                "created_at": "2021-01-26T01:20:05.801Z",
                "value": "Hi",
                "type": "text"
            }
        }
    ]
}
```

--------------------------------

### Create Product Request Example

Source: https://open-api.docs.shoplineapp.com/docs/create-product

Example request body for creating a product with basic fields such as title, description, price, and status.

```APIDOC
## Create Product Request Example

### Description
Example request body for creating a product with basic fields such as title, description, price, and status.

### Request Body
- **product** (object) - Required - The product object containing all product details.
  - **category_ids** (array) - Required - List of category IDs for the product.
  - **description_translations** (object) - Required - Translations of the product description.
    - **en** (string) - Required - English description.
    - **zh-hant** (string) - Required - Traditional Chinese description.
  - **images** (array) - Required - List of image URLs for the product.
  - **price** (number) - Required - The price of the product.
  - **status** (boolean) - Required - Whether the product is active.
  - **title_translations** (object) - Required - Translations of the product title.
    - **en** (string) - Required - English title.
    - **zh-hant** (string) - Required - Traditional Chinese title.

### Request Example
```json
{
  "product": {
    "category_ids": [],
    "description_translations": {
      "en": "We are a product design-led company that aims to create products that are simple and stylish, and that focus on the needs of the general public.",
      "zh-hant": "我們是一家以產品設計為主導的公司， 旨在打造款式簡潔時尚且關注社會大眾需求的產品。 "
    },
    "images": [
      "https://shopline.tw/blog/wp-content/uploads/2015/11/logo-shopline-white.png"
    ],
    "price": 9999,
    "status": false,
    "title_translations": {
      "en": "Shopline",
      "zh-hant": "商線科技"
    }
  }
}
```
```

--------------------------------

### Bulk Create Product Review Comments - Response Example

Source: https://open-api.docs.shoplineapp.com/docs/bulk-create-product-review-comments

Example response from the bulk create endpoint, showing a success result and the count of created comments.

```json
{
  "result": "success",
  "count": 2
}
```

--------------------------------

### Get Cart - Node

Source: https://open-api.docs.shoplineapp.com/reference/get_carts-id

Use this Node.js example to call the Get Cart endpoint. It sends a GET request to the cart URL with the Bearer token.

```Node
const axios = require('axios');

const options = {
  method: 'GET',
  url: 'https://open.shopline.io/v1/carts/{id}',
  headers: {accept: 'application/json', authorization: 'Bearer {access_token}'}
};

axios
  .request(options)
  .then(function (response) {
    console.log(response.data);
  })
  .catch(function (error) {
    console.error(error);
  });
```

--------------------------------

### Get Custom Fields Response Example

Source: https://open-api.docs.shoplineapp.com/docs/get-customfields

Example response from the GET /v1/custom_fields endpoint. Shows a custom field with type text, name translations in Traditional Chinese and English, a hint translation, and a field ID.

```json
[
    {
        "type": "text",
        "name_translations": {
            "zh-hant": "測試欄位",
            "en": "Test Field"
        },
      	"hint_translations": {
            "zh-hant": "請填入答案"
        },
        "field_id": "5ad86757e38809441400001b"
    }
]
```

--------------------------------

### JSON Response Sample for Create AddonProducts

Source: https://open-api.docs.shoplineapp.com/docs/create-addonproducts

Sample JSON response returned by POST /v1/addon_products. Shows the created addon product object with cost, main_products, media, and other fields.

```json
{
  "_id" : "608b7d0c93919a0046b4337a",
  "cost" : {
    "cents" : 1200,
    "currency_iso" : "HKD",
    "currency_symbol" : "HK$",
    "dollars" : 12,
    "label" : "HK$12.00"
  },
  "created_at" : "2021-04-30T03:44:12.935Z",
  "description_translations" : null,
  "end_at" : "2022-03-03T09:57:09.193+00:00",
  "location_id" : "AB-001",
  "main_products" : [
    {
      "_id" : "5f86b369e388097aeebc59aa",
      "addon_price" : {
        "cents" : 1200,
        "currency_iso" : "HKD",
        "currency_symbol" : "HK$",
        "dollars" : 12,
        "label" : "HK$12.00"
      },
      "field_titles" : [],
      "lowest_price" : {
        "cents" : 1200,
        "currency_iso" : "HKD",
        "currency_symbol" : "HK$",
        "dollars" : 12,
        "label" : "HK$12.00"
      },
      "media" : [
        {
          "_id" : "5f86b34fe388097aeebc59a9",
          "images" : {
            "original" : {
              "url" : "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/5f86b34fe388097aeebc59a9/original.jpg?1602663247"
            },
            "thumb" : {
              "url" : "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/5f86b34fe388097aeebc59a9/original.jpg?1602663247"
            }
          }
        }
      ],
      "price" : {
        "cents" : 1200,
        "currency_iso" : "HKD",
        "currency_symbol" : "HK$",
        "dollars" : 12,
        "label" : "HK$12.00"
      },
      "price_max" : {
        "cents" : 0,
        "currency_iso" : "HKD",
        "currency_symbol" : "HK$",
        "dollars" : 0,
        "label" : ""
      },
      "price_range" : "",
      "price_sale" : {
        "cents" : 0,
        "currency_iso" : "HKD",
        "currency_symbol" : "HK$",
        "dollars" : 0,
        "label" : ""
      },
      "same_price" : false,
      "title_translations" : {
        "en" : "pencil1"
      }
    },
    {
      "_id" : "5fa61682e388093728f76a6c",
      "addon_price" : {
        "cents" : 1200,
        "currency_iso" : "HKD",
        "currency_symbol" : "HK$",
        "dollars" : 12,
        "label" : "HK$12.00"
      },
      "field_titles" : [
        {
          "index" : 0,
          "key" : "custom",
          "label" : "Custom",
          "name_translations" : {
            "en" : "Custom1",
            "zh-hant" : "èªè¨1"
          },
          "selectorEnabled" : true,
          "type_num" : "1"
        },
        {
          "index" : 1,
          "key" : "custom",
          "label" : "Custom",
          "name_translations" : {
            "en" : "Custom",
            "th" : "à¸à¸³à¸«à¸à¸à¹à¸à¸"
          },
          "selectorEnabled" : false,
          "type_num" : "2"
        }
      ],
      "lowest_price" : {
        "cents" : 68900,
        "currency_iso" : "HKD",
        "currency_symbol" : "HK$",
        "dollars" : 689,
        "label" : "HK$689.00"
      },
      "price" : {
        "cents" : 68900,
        "currency_iso" : "HKD",
        "currency_symbol" : "HK$",
        "dollars" : 689,
        "label" : "HK$689.00"
      },
      "price_max" : {
        "cents" : 68900,
        "currency_iso" : "HKD",
        "currency_symbol" : "HK$",
        "dollars" : 689,
        "label" : "HK$689.00"
      },
      "price_range" : "",
      "price_sale" : {
        "cents" : 0,
        "currency_iso" : "HKD",
        "currency_symbol" : "HK$",
        "dollars" : 0,
        "label" : ""
      },
      "same_price" : false,
      "title_translations" : {
        "en" : "pencil2"
      }
    }
  ],
  "media" : [
    {
      "_id" : "603f06f7f6ba0c00451d0f12",
      "images" : {
        "original" : {
          "url" : "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/603f06f7f6ba0c00451d0f12/original.jpg?1614823038"
        },
        "thumb" : {
          "url" : "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/603f06f7f6ba0c00451d0f12/original.jpg?1614823038"
        }
      }
    }
  ],
  "sku" : "SKU-456344881",
  "start_at" : "2021-03-03T09:57:09.193+00:00",
  "tax_type" : null,
  "title_translations" : {
    "en" : "create by open api"
  },
  "unlimited_quantity" : true,
  "updated_at" : "2021-04-30T03:44:12.935Z",
  "weight" : 12.1
}
```

--------------------------------

### GET /v1/conversations

Source: https://open-api.docs.shoplineapp.com/reference/get_conversations-1

API documentation for the Get Conversations endpoint, including query parameters and example request.

```APIDOC
## [GET] /v1/conversations

### Description
Retrieves a list of conversations from the Shopline platform. The conversations can be filtered by platform type (shop or order messages) and customer ID, with pagination support.

### Method
GET

### Endpoint
https://open.shopline.io/v1/conversations

### Parameters
#### Query Parameters
- **platform** (string, enum) - Required - Conversation from shop or order. Allowed values: `shop_messages`, `order_messages`, `return_order_messages` (note: `return_order_messages` is not yet open).
- **customer_id** (string) - Optional - Customer ID.
- **page** (integer) - Optional - Page number.
- **per_page** (integer) - Optional - Number of conversations per page.

### Request Example
```
curl --request GET \
     --url 'https://open.shopline.io/v1/conversations?platform=shop_messages' \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
OK

#### Error Response (500)
Server error

```

--------------------------------

### Node request example

Source: https://open-api.docs.shoplineapp.com/reference/order-item-app-metafields

Example request for the GET /v1/orders/{order_id}/items/app_metafields endpoint using Node.

```Node
const http = require('http');

const options = {
  hostname: 'open.shopline.io',
  path: '/v1/orders/{order_id}/items/app_metafields',
  method: 'GET'
};

const req = http.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => { data += chunk; });
  res.on('end', () => { console.log(data); });
});

req.end();
```
Tokens:
Raw