Skip to main content

Get Product variants

Version: 1.0

This API will help you get information of product variants which were used by product card type in chat bot

Authenticated access scopes: social.read_bot

Request URI​

  • GET https://apis.harasocial.com/social/bot/product_card/variants.json

Example Request​

curl -X 'GET' \
  'https://apis.harasocial.com/social/bot/product_card/variants.json?page=1&limit=100&updated_at_min=2014-04-25T16%3A15%3A47&updated_at_max=2023-04-25T16%3A15%3A47' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer {token}'

Parameters​

page: int

"page" = 1

Page to show the result

limit: int

"limit" = 100

Page to show the result

updated_at_min: datetime

"updated_at_min" = "2014-04-25T16:15:47"

Show results which last updated after date (format: 2021-10-20T14:07:45.084Z)

updated_at_max: datetime

"updated_at_max" = "2023-04-25T16:15:47"

Show results which last updated before date (format: 2021-10-20T14:07:45.084Z)

Response​

A successful API request returns a JSON string containing information of product variants which were used by product card type in chat bot.

Example​

{
  "data": [
    {
      "product_id": 10040782473,
      "product_variant_id": 142032358,
      "name": "Variant A",
      "image_url": "{product_variant_image_url}",
      "variant_title": "XSS",
      "product_buyer_url": "{product_buyer_url}",
      "price": 769000,
      "updated_time": "2022-08-19T08:03:40.463Z"
    },
    {
      "product_id": 10040720341,
      "product_variant_id": 141957574,
      "name": "Variant B",
      "image_url": "{product_variant_image_url}",
      "variant_title": "S / cam",
      "product_buyer_url": "{product_buyer_url}",
      "price": 769000,
      "updated_time": "2022-08-19T08:03:40.459Z"
    }
  ],
  "has_error": false,
  "error_code": null,
  "error_message": null
}

Properties​

data: List<Product Card Variant Object>

Contains list variant's info. See Product Card Variant Object below.

has_error: bool

True if the request does not meet requirement or validation

error_code: string

The error code information

error_message: string

The error message information

Product Card Variant Object​

product_id: long?

"product_id": 10040782473

Product Id

product_variant_id: long?

"product_variant_id": 142032358

Product variant Id

name: string

"name": "Variant A"

Name of product

image_url: string

"image_url": "{product_variant_image_url}"

Image url of product

variant_title: string

"variant_title": "XSS"

Product variant title

product_buyer_url: string

"product_buyer_url": "{product_buyer_url}"

The url of product on web

price: decimal?

"price": 769000

Price of product variant

updated_time: datetime

"updated_time": "2022-08-19T08:03:40.459Z"

Indicate last updated time of this product card