GET api/product?offset={offset}&count={count}&search={search}&category_uids={category_uids}&sort_by={sort_by}&sort_direction={sort_direction}&include_expired={include_expired}

Get List of Products from All Category which is on sale Product is sorted according to Product's Creation Date

Request Information

URI Parameters

NameDescriptionTypeAdditional information
offset

Offset of the list, default is 0

integer

Default value is 0

count

Number of product in the list, default is 10

integer

Default value is 10

search

Searching keyword. Case Insensitive. Default is null

string

None.

category_uids

List of category uids. Separate with comma (,) without spaces.

string

None.

sort_by

sortiing field. allowed values are 'uid', 'name', 'view', 'create', 'rating' and 'price'.

string

Default value is uid

sort_direction

sorting direction

string

Default value is desc

include_expired

sorting direction

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

The List of Products

GCSListByUidResponseDTOOfYSHProductDTO
NameDescriptionTypeAdditional information
total

integer

None.

offset

integer

None.

count

integer

None.

next

integer

None.

result

Collection of YSHProductDTO

None.

no_more_result

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "total": 1,
  "offset": 1,
  "count": 2,
  "next": 1,
  "result": [
    {
      "product_uid": 1,
      "product_name": "sample string 2",
      "product_price": 3.1,
      "seller_uid": 4,
      "seller_display_name": "sample string 5",
      "seller_rating": 1.1,
      "buyer_uid": 1,
      "buyer_display_name": "sample string 6",
      "category_uid": 7,
      "category_name": "sample string 8",
      "current_state_uid": 9,
      "product_desc": "sample string 10",
      "image_1_uid": 1,
      "image_2_uid": 1,
      "image_3_uid": 1,
      "image_1_path": "sample string 11",
      "image_2_path": "sample string 12",
      "image_3_path": "sample string 13",
      "view_count": 14,
      "shipping_is_face_to_face": true,
      "shipping_face_to_face_detail": "sample string 16",
      "shipping_is_post": true,
      "shipping_post_detail": "sample string 18",
      "shipping_is_other": true,
      "shipping_other_detail": "sample string 20",
      "product_create_date": "2018-01-23T02:14:47.7799342+08:00",
      "product_sold_date": "2018-01-23T02:14:47.7799342+08:00",
      "product_expiry_date": "2018-01-23T02:14:47.7799342+08:00",
      "product_last_order_date": "2018-01-23T02:14:47.7799342+08:00",
      "orders": [
        {
          "order_uid": 1,
          "product_uid": 2,
          "product_name": "sample string 3",
          "product_image_name": "sample string 4",
          "product_create_date": "2018-01-23T02:14:47.7799342+08:00",
          "product_expiry_date": "2018-01-23T02:14:47.7799342+08:00",
          "actual_price": 7.1,
          "current_state_uid": 8,
          "buyer_uid": 9,
          "buyer_display_name": "sample string 10",
          "buyer_fb_picture": "sample string 11",
          "seller_uid": 12,
          "seller_display_name": "sample string 13",
          "order_create_date": "2018-01-23T02:14:47.7799342+08:00",
          "order_last_update_date": "2018-01-23T02:14:47.7799342+08:00",
          "order_finish_date": "2018-01-23T02:14:47.7799342+08:00",
          "is_buyer_read": true,
          "is_seller_read": true
        },
        {
          "order_uid": 1,
          "product_uid": 2,
          "product_name": "sample string 3",
          "product_image_name": "sample string 4",
          "product_create_date": "2018-01-23T02:14:47.7799342+08:00",
          "product_expiry_date": "2018-01-23T02:14:47.7799342+08:00",
          "actual_price": 7.1,
          "current_state_uid": 8,
          "buyer_uid": 9,
          "buyer_display_name": "sample string 10",
          "buyer_fb_picture": "sample string 11",
          "seller_uid": 12,
          "seller_display_name": "sample string 13",
          "order_create_date": "2018-01-23T02:14:47.7799342+08:00",
          "order_last_update_date": "2018-01-23T02:14:47.7799342+08:00",
          "order_finish_date": "2018-01-23T02:14:47.7799342+08:00",
          "is_buyer_read": true,
          "is_seller_read": true
        }
      ],
      "is_activated_chat": true,
      "is_seller_read": true
    },
    {
      "product_uid": 1,
      "product_name": "sample string 2",
      "product_price": 3.1,
      "seller_uid": 4,
      "seller_display_name": "sample string 5",
      "seller_rating": 1.1,
      "buyer_uid": 1,
      "buyer_display_name": "sample string 6",
      "category_uid": 7,
      "category_name": "sample string 8",
      "current_state_uid": 9,
      "product_desc": "sample string 10",
      "image_1_uid": 1,
      "image_2_uid": 1,
      "image_3_uid": 1,
      "image_1_path": "sample string 11",
      "image_2_path": "sample string 12",
      "image_3_path": "sample string 13",
      "view_count": 14,
      "shipping_is_face_to_face": true,
      "shipping_face_to_face_detail": "sample string 16",
      "shipping_is_post": true,
      "shipping_post_detail": "sample string 18",
      "shipping_is_other": true,
      "shipping_other_detail": "sample string 20",
      "product_create_date": "2018-01-23T02:14:47.7799342+08:00",
      "product_sold_date": "2018-01-23T02:14:47.7799342+08:00",
      "product_expiry_date": "2018-01-23T02:14:47.7799342+08:00",
      "product_last_order_date": "2018-01-23T02:14:47.7799342+08:00",
      "orders": [
        {
          "order_uid": 1,
          "product_uid": 2,
          "product_name": "sample string 3",
          "product_image_name": "sample string 4",
          "product_create_date": "2018-01-23T02:14:47.7799342+08:00",
          "product_expiry_date": "2018-01-23T02:14:47.7799342+08:00",
          "actual_price": 7.1,
          "current_state_uid": 8,
          "buyer_uid": 9,
          "buyer_display_name": "sample string 10",
          "buyer_fb_picture": "sample string 11",
          "seller_uid": 12,
          "seller_display_name": "sample string 13",
          "order_create_date": "2018-01-23T02:14:47.7799342+08:00",
          "order_last_update_date": "2018-01-23T02:14:47.7799342+08:00",
          "order_finish_date": "2018-01-23T02:14:47.7799342+08:00",
          "is_buyer_read": true,
          "is_seller_read": true
        },
        {
          "order_uid": 1,
          "product_uid": 2,
          "product_name": "sample string 3",
          "product_image_name": "sample string 4",
          "product_create_date": "2018-01-23T02:14:47.7799342+08:00",
          "product_expiry_date": "2018-01-23T02:14:47.7799342+08:00",
          "actual_price": 7.1,
          "current_state_uid": 8,
          "buyer_uid": 9,
          "buyer_display_name": "sample string 10",
          "buyer_fb_picture": "sample string 11",
          "seller_uid": 12,
          "seller_display_name": "sample string 13",
          "order_create_date": "2018-01-23T02:14:47.7799342+08:00",
          "order_last_update_date": "2018-01-23T02:14:47.7799342+08:00",
          "order_finish_date": "2018-01-23T02:14:47.7799342+08:00",
          "is_buyer_read": true,
          "is_seller_read": true
        }
      ],
      "is_activated_chat": true,
      "is_seller_read": true
    }
  ],
  "no_more_result": true
}