GET items?categoryId={categoryId}&merchantId={merchantId}&brandId={brandId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
categoryId

integer

None.

merchantId

globally unique identifier

None.

brandId

globally unique identifier

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Item
NameDescriptionTypeAdditional information
id

globally unique identifier

None.

name

string

None.

price

decimal number

None.

categoryId

integer

None.

categoryName

string

None.

categories

Collection of integer

None.

brandId

globally unique identifier

None.

optionId

globally unique identifier

None.

optionIsActive

boolean

None.

size

integer

None.

customSize

string

None.

colorId

globally unique identifier

None.

color

string

None.

isLiked

boolean

None.

discount

decimal number

None.

discountEnd

date

None.

balance

integer

None.

imageUrl

string

None.

note

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": "2f925ebf-d831-4719-8d8e-37448d08afaf",
    "name": "sample string 1",
    "price": 2.1,
    "categoryId": 1,
    "categoryName": "sample string 3",
    "categories": [
      1,
      2
    ],
    "brandId": "c648beb0-2f21-42df-ac17-e5c922275da4",
    "optionId": "c4182474-ddef-4e39-9fad-f3e1cc445d34",
    "optionIsActive": true,
    "size": 5,
    "customSize": "sample string 6",
    "colorId": "f95f86cc-c667-47ba-b32f-61afe5550580",
    "color": "sample string 7",
    "isLiked": true,
    "discount": 9.1,
    "discountEnd": "2026-06-02T00:41:32.5434094+08:00",
    "balance": 10,
    "imageUrl": "sample string 11",
    "note": "sample string 12"
  },
  {
    "id": "2f925ebf-d831-4719-8d8e-37448d08afaf",
    "name": "sample string 1",
    "price": 2.1,
    "categoryId": 1,
    "categoryName": "sample string 3",
    "categories": [
      1,
      2
    ],
    "brandId": "c648beb0-2f21-42df-ac17-e5c922275da4",
    "optionId": "c4182474-ddef-4e39-9fad-f3e1cc445d34",
    "optionIsActive": true,
    "size": 5,
    "customSize": "sample string 6",
    "colorId": "f95f86cc-c667-47ba-b32f-61afe5550580",
    "color": "sample string 7",
    "isLiked": true,
    "discount": 9.1,
    "discountEnd": "2026-06-02T00:41:32.5434094+08:00",
    "balance": 10,
    "imageUrl": "sample string 11",
    "note": "sample string 12"
  }
]

application/xml, text/xml

Sample:
<ArrayOfItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Careby.Api.Models">
  <Item>
    <balance>10</balance>
    <brandId>c648beb0-2f21-42df-ac17-e5c922275da4</brandId>
    <categories xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </categories>
    <categoryId>1</categoryId>
    <categoryName>sample string 3</categoryName>
    <color>sample string 7</color>
    <colorId>f95f86cc-c667-47ba-b32f-61afe5550580</colorId>
    <customSize>sample string 6</customSize>
    <discount>9.1</discount>
    <discountEnd>2026-06-02T00:41:32.5434094+08:00</discountEnd>
    <id>2f925ebf-d831-4719-8d8e-37448d08afaf</id>
    <imageUrl>sample string 11</imageUrl>
    <isLiked>true</isLiked>
    <name>sample string 1</name>
    <note>sample string 12</note>
    <optionId>c4182474-ddef-4e39-9fad-f3e1cc445d34</optionId>
    <optionIsActive>true</optionIsActive>
    <price>2.1</price>
    <size>5</size>
  </Item>
  <Item>
    <balance>10</balance>
    <brandId>c648beb0-2f21-42df-ac17-e5c922275da4</brandId>
    <categories xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </categories>
    <categoryId>1</categoryId>
    <categoryName>sample string 3</categoryName>
    <color>sample string 7</color>
    <colorId>f95f86cc-c667-47ba-b32f-61afe5550580</colorId>
    <customSize>sample string 6</customSize>
    <discount>9.1</discount>
    <discountEnd>2026-06-02T00:41:32.5434094+08:00</discountEnd>
    <id>2f925ebf-d831-4719-8d8e-37448d08afaf</id>
    <imageUrl>sample string 11</imageUrl>
    <isLiked>true</isLiked>
    <name>sample string 1</name>
    <note>sample string 12</note>
    <optionId>c4182474-ddef-4e39-9fad-f3e1cc445d34</optionId>
    <optionIsActive>true</optionIsActive>
    <price>2.1</price>
    <size>5</size>
  </Item>
</ArrayOfItem>