GET shop/home

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Shop

Name	Type	Additional information
categories	Collection of Category	None.
brands	Collection of Brand	None.
groups	Collection of ShopGroup	None.
items	Collection of Item	None.
fields	Collection of ItemField	None.
images	Collection of ItemImage	None.

Response Formats

application/json, text/json

Sample:

{
  "categories": [
    {
      "id": 1,
      "name": "sample string 2",
      "parentId": 1,
      "icon": "sample string 3",
      "count": 4,
      "isActive": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "parentId": 1,
      "icon": "sample string 3",
      "count": 4,
      "isActive": true
    }
  ],
  "brands": [
    {
      "id": "4f62ce12-5d2c-43f1-982e-f19aaf6b0b85",
      "merchantId": "c3eed0a6-329d-42d2-ab70-ec79facc4ca5",
      "name": "sample string 1",
      "logoUrl": "sample string 2",
      "webLink": "sample string 3"
    },
    {
      "id": "4f62ce12-5d2c-43f1-982e-f19aaf6b0b85",
      "merchantId": "c3eed0a6-329d-42d2-ab70-ec79facc4ca5",
      "name": "sample string 1",
      "logoUrl": "sample string 2",
      "webLink": "sample string 3"
    }
  ],
  "groups": [
    {
      "route": "sample string 1",
      "name": "sample string 2",
      "items": [
        {
          "id": "3b637f65-81e5-4856-9cc7-f94114973f13",
          "name": "sample string 1",
          "price": 2.1,
          "categoryId": 1,
          "categoryName": "sample string 3",
          "categories": [
            1,
            2
          ],
          "brandId": "9effbc93-398c-4912-ab3f-a71cf8f40c40",
          "optionId": "eafa7809-6210-4a3c-af92-ef43b1fec665",
          "optionIsActive": true,
          "size": 5,
          "customSize": "sample string 6",
          "colorId": "540382b4-c0e2-40fa-a33a-4bf63843caae",
          "color": "sample string 7",
          "isLiked": true,
          "discount": 9.1,
          "discountEnd": "2026-06-02T02:10:00.984813+08:00",
          "balance": 10,
          "imageUrl": "sample string 11",
          "note": "sample string 12"
        },
        {
          "id": "3b637f65-81e5-4856-9cc7-f94114973f13",
          "name": "sample string 1",
          "price": 2.1,
          "categoryId": 1,
          "categoryName": "sample string 3",
          "categories": [
            1,
            2
          ],
          "brandId": "9effbc93-398c-4912-ab3f-a71cf8f40c40",
          "optionId": "eafa7809-6210-4a3c-af92-ef43b1fec665",
          "optionIsActive": true,
          "size": 5,
          "customSize": "sample string 6",
          "colorId": "540382b4-c0e2-40fa-a33a-4bf63843caae",
          "color": "sample string 7",
          "isLiked": true,
          "discount": 9.1,
          "discountEnd": "2026-06-02T02:10:00.984813+08:00",
          "balance": 10,
          "imageUrl": "sample string 11",
          "note": "sample string 12"
        }
      ]
    },
    {
      "route": "sample string 1",
      "name": "sample string 2",
      "items": [
        {
          "id": "3b637f65-81e5-4856-9cc7-f94114973f13",
          "name": "sample string 1",
          "price": 2.1,
          "categoryId": 1,
          "categoryName": "sample string 3",
          "categories": [
            1,
            2
          ],
          "brandId": "9effbc93-398c-4912-ab3f-a71cf8f40c40",
          "optionId": "eafa7809-6210-4a3c-af92-ef43b1fec665",
          "optionIsActive": true,
          "size": 5,
          "customSize": "sample string 6",
          "colorId": "540382b4-c0e2-40fa-a33a-4bf63843caae",
          "color": "sample string 7",
          "isLiked": true,
          "discount": 9.1,
          "discountEnd": "2026-06-02T02:10:00.984813+08:00",
          "balance": 10,
          "imageUrl": "sample string 11",
          "note": "sample string 12"
        },
        {
          "id": "3b637f65-81e5-4856-9cc7-f94114973f13",
          "name": "sample string 1",
          "price": 2.1,
          "categoryId": 1,
          "categoryName": "sample string 3",
          "categories": [
            1,
            2
          ],
          "brandId": "9effbc93-398c-4912-ab3f-a71cf8f40c40",
          "optionId": "eafa7809-6210-4a3c-af92-ef43b1fec665",
          "optionIsActive": true,
          "size": 5,
          "customSize": "sample string 6",
          "colorId": "540382b4-c0e2-40fa-a33a-4bf63843caae",
          "color": "sample string 7",
          "isLiked": true,
          "discount": 9.1,
          "discountEnd": "2026-06-02T02:10:00.984813+08:00",
          "balance": 10,
          "imageUrl": "sample string 11",
          "note": "sample string 12"
        }
      ]
    }
  ],
  "items": [
    {
      "id": "3b637f65-81e5-4856-9cc7-f94114973f13",
      "name": "sample string 1",
      "price": 2.1,
      "categoryId": 1,
      "categoryName": "sample string 3",
      "categories": [
        1,
        2
      ],
      "brandId": "9effbc93-398c-4912-ab3f-a71cf8f40c40",
      "optionId": "eafa7809-6210-4a3c-af92-ef43b1fec665",
      "optionIsActive": true,
      "size": 5,
      "customSize": "sample string 6",
      "colorId": "540382b4-c0e2-40fa-a33a-4bf63843caae",
      "color": "sample string 7",
      "isLiked": true,
      "discount": 9.1,
      "discountEnd": "2026-06-02T02:10:00.984813+08:00",
      "balance": 10,
      "imageUrl": "sample string 11",
      "note": "sample string 12"
    },
    {
      "id": "3b637f65-81e5-4856-9cc7-f94114973f13",
      "name": "sample string 1",
      "price": 2.1,
      "categoryId": 1,
      "categoryName": "sample string 3",
      "categories": [
        1,
        2
      ],
      "brandId": "9effbc93-398c-4912-ab3f-a71cf8f40c40",
      "optionId": "eafa7809-6210-4a3c-af92-ef43b1fec665",
      "optionIsActive": true,
      "size": 5,
      "customSize": "sample string 6",
      "colorId": "540382b4-c0e2-40fa-a33a-4bf63843caae",
      "color": "sample string 7",
      "isLiked": true,
      "discount": 9.1,
      "discountEnd": "2026-06-02T02:10:00.984813+08:00",
      "balance": 10,
      "imageUrl": "sample string 11",
      "note": "sample string 12"
    }
  ],
  "fields": [
    {
      "id": "6e32e872-b07d-4e8b-af89-fae3667cc00e",
      "itemId": "aa7eccec-fc39-40fa-9ba0-6a4074a3ea8d",
      "fieldId": "39f5d4d0-9f0c-41ca-844b-bdeeb51f7340",
      "fieldName": "sample string 1",
      "fieldType": 2,
      "value": "sample string 3"
    },
    {
      "id": "6e32e872-b07d-4e8b-af89-fae3667cc00e",
      "itemId": "aa7eccec-fc39-40fa-9ba0-6a4074a3ea8d",
      "fieldId": "39f5d4d0-9f0c-41ca-844b-bdeeb51f7340",
      "fieldName": "sample string 1",
      "fieldType": 2,
      "value": "sample string 3"
    }
  ],
  "images": [
    {
      "id": "e2d78aff-0e10-478e-8746-bba75d2738f1",
      "itemId": "0cddd9df-eb25-4353-914c-46b07f0797a5",
      "url": "sample string 1",
      "isMain": true,
      "colorId": "91021976-b43e-4777-a4ed-3e35a0566114",
      "color": "sample string 3"
    },
    {
      "id": "e2d78aff-0e10-478e-8746-bba75d2738f1",
      "itemId": "0cddd9df-eb25-4353-914c-46b07f0797a5",
      "url": "sample string 1",
      "isMain": true,
      "colorId": "91021976-b43e-4777-a4ed-3e35a0566114",
      "color": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<Shop xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Careby.Api.Models">
  <brands>
    <Brand>
      <id>4f62ce12-5d2c-43f1-982e-f19aaf6b0b85</id>
      <logoUrl>sample string 2</logoUrl>
      <merchantId>c3eed0a6-329d-42d2-ab70-ec79facc4ca5</merchantId>
      <name>sample string 1</name>
      <webLink>sample string 3</webLink>
    </Brand>
    <Brand>
      <id>4f62ce12-5d2c-43f1-982e-f19aaf6b0b85</id>
      <logoUrl>sample string 2</logoUrl>
      <merchantId>c3eed0a6-329d-42d2-ab70-ec79facc4ca5</merchantId>
      <name>sample string 1</name>
      <webLink>sample string 3</webLink>
    </Brand>
  </brands>
  <categories>
    <Category>
      <count>4</count>
      <icon>sample string 3</icon>
      <id>1</id>
      <isActive>true</isActive>
      <name>sample string 2</name>
      <parentId>1</parentId>
    </Category>
    <Category>
      <count>4</count>
      <icon>sample string 3</icon>
      <id>1</id>
      <isActive>true</isActive>
      <name>sample string 2</name>
      <parentId>1</parentId>
    </Category>
  </categories>
  <fields>
    <ItemField>
      <fieldId>39f5d4d0-9f0c-41ca-844b-bdeeb51f7340</fieldId>
      <fieldName>sample string 1</fieldName>
      <fieldType>2</fieldType>
      <id>6e32e872-b07d-4e8b-af89-fae3667cc00e</id>
      <itemId>aa7eccec-fc39-40fa-9ba0-6a4074a3ea8d</itemId>
      <value>sample string 3</value>
    </ItemField>
    <ItemField>
      <fieldId>39f5d4d0-9f0c-41ca-844b-bdeeb51f7340</fieldId>
      <fieldName>sample string 1</fieldName>
      <fieldType>2</fieldType>
      <id>6e32e872-b07d-4e8b-af89-fae3667cc00e</id>
      <itemId>aa7eccec-fc39-40fa-9ba0-6a4074a3ea8d</itemId>
      <value>sample string 3</value>
    </ItemField>
  </fields>
  <groups>
    <ShopGroup>
      <items>
        <Item>
          <balance>10</balance>
          <brandId>9effbc93-398c-4912-ab3f-a71cf8f40c40</brandId>
          <categories xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </categories>
          <categoryId>1</categoryId>
          <categoryName>sample string 3</categoryName>
          <color>sample string 7</color>
          <colorId>540382b4-c0e2-40fa-a33a-4bf63843caae</colorId>
          <customSize>sample string 6</customSize>
          <discount>9.1</discount>
          <discountEnd>2026-06-02T02:10:00.984813+08:00</discountEnd>
          <id>3b637f65-81e5-4856-9cc7-f94114973f13</id>
          <imageUrl>sample string 11</imageUrl>
          <isLiked>true</isLiked>
          <name>sample string 1</name>
          <note>sample string 12</note>
          <optionId>eafa7809-6210-4a3c-af92-ef43b1fec665</optionId>
          <optionIsActive>true</optionIsActive>
          <price>2.1</price>
          <size>5</size>
        </Item>
        <Item>
          <balance>10</balance>
          <brandId>9effbc93-398c-4912-ab3f-a71cf8f40c40</brandId>
          <categories xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </categories>
          <categoryId>1</categoryId>
          <categoryName>sample string 3</categoryName>
          <color>sample string 7</color>
          <colorId>540382b4-c0e2-40fa-a33a-4bf63843caae</colorId>
          <customSize>sample string 6</customSize>
          <discount>9.1</discount>
          <discountEnd>2026-06-02T02:10:00.984813+08:00</discountEnd>
          <id>3b637f65-81e5-4856-9cc7-f94114973f13</id>
          <imageUrl>sample string 11</imageUrl>
          <isLiked>true</isLiked>
          <name>sample string 1</name>
          <note>sample string 12</note>
          <optionId>eafa7809-6210-4a3c-af92-ef43b1fec665</optionId>
          <optionIsActive>true</optionIsActive>
          <price>2.1</price>
          <size>5</size>
        </Item>
      </items>
      <name>sample string 2</name>
      <route>sample string 1</route>
    </ShopGroup>
    <ShopGroup>
      <items>
        <Item>
          <balance>10</balance>
          <brandId>9effbc93-398c-4912-ab3f-a71cf8f40c40</brandId>
          <categories xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </categories>
          <categoryId>1</categoryId>
          <categoryName>sample string 3</categoryName>
          <color>sample string 7</color>
          <colorId>540382b4-c0e2-40fa-a33a-4bf63843caae</colorId>
          <customSize>sample string 6</customSize>
          <discount>9.1</discount>
          <discountEnd>2026-06-02T02:10:00.984813+08:00</discountEnd>
          <id>3b637f65-81e5-4856-9cc7-f94114973f13</id>
          <imageUrl>sample string 11</imageUrl>
          <isLiked>true</isLiked>
          <name>sample string 1</name>
          <note>sample string 12</note>
          <optionId>eafa7809-6210-4a3c-af92-ef43b1fec665</optionId>
          <optionIsActive>true</optionIsActive>
          <price>2.1</price>
          <size>5</size>
        </Item>
        <Item>
          <balance>10</balance>
          <brandId>9effbc93-398c-4912-ab3f-a71cf8f40c40</brandId>
          <categories xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </categories>
          <categoryId>1</categoryId>
          <categoryName>sample string 3</categoryName>
          <color>sample string 7</color>
          <colorId>540382b4-c0e2-40fa-a33a-4bf63843caae</colorId>
          <customSize>sample string 6</customSize>
          <discount>9.1</discount>
          <discountEnd>2026-06-02T02:10:00.984813+08:00</discountEnd>
          <id>3b637f65-81e5-4856-9cc7-f94114973f13</id>
          <imageUrl>sample string 11</imageUrl>
          <isLiked>true</isLiked>
          <name>sample string 1</name>
          <note>sample string 12</note>
          <optionId>eafa7809-6210-4a3c-af92-ef43b1fec665</optionId>
          <optionIsActive>true</optionIsActive>
          <price>2.1</price>
          <size>5</size>
        </Item>
      </items>
      <name>sample string 2</name>
      <route>sample string 1</route>
    </ShopGroup>
  </groups>
  <images>
    <ItemImage>
      <color>sample string 3</color>
      <colorId>91021976-b43e-4777-a4ed-3e35a0566114</colorId>
      <id>e2d78aff-0e10-478e-8746-bba75d2738f1</id>
      <isMain>true</isMain>
      <itemId>0cddd9df-eb25-4353-914c-46b07f0797a5</itemId>
      <url>sample string 1</url>
    </ItemImage>
    <ItemImage>
      <color>sample string 3</color>
      <colorId>91021976-b43e-4777-a4ed-3e35a0566114</colorId>
      <id>e2d78aff-0e10-478e-8746-bba75d2738f1</id>
      <isMain>true</isMain>
      <itemId>0cddd9df-eb25-4353-914c-46b07f0797a5</itemId>
      <url>sample string 1</url>
    </ItemImage>
  </images>
  <items>
    <Item>
      <balance>10</balance>
      <brandId>9effbc93-398c-4912-ab3f-a71cf8f40c40</brandId>
      <categories xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </categories>
      <categoryId>1</categoryId>
      <categoryName>sample string 3</categoryName>
      <color>sample string 7</color>
      <colorId>540382b4-c0e2-40fa-a33a-4bf63843caae</colorId>
      <customSize>sample string 6</customSize>
      <discount>9.1</discount>
      <discountEnd>2026-06-02T02:10:00.984813+08:00</discountEnd>
      <id>3b637f65-81e5-4856-9cc7-f94114973f13</id>
      <imageUrl>sample string 11</imageUrl>
      <isLiked>true</isLiked>
      <name>sample string 1</name>
      <note>sample string 12</note>
      <optionId>eafa7809-6210-4a3c-af92-ef43b1fec665</optionId>
      <optionIsActive>true</optionIsActive>
      <price>2.1</price>
      <size>5</size>
    </Item>
    <Item>
      <balance>10</balance>
      <brandId>9effbc93-398c-4912-ab3f-a71cf8f40c40</brandId>
      <categories xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </categories>
      <categoryId>1</categoryId>
      <categoryName>sample string 3</categoryName>
      <color>sample string 7</color>
      <colorId>540382b4-c0e2-40fa-a33a-4bf63843caae</colorId>
      <customSize>sample string 6</customSize>
      <discount>9.1</discount>
      <discountEnd>2026-06-02T02:10:00.984813+08:00</discountEnd>
      <id>3b637f65-81e5-4856-9cc7-f94114973f13</id>
      <imageUrl>sample string 11</imageUrl>
      <isLiked>true</isLiked>
      <name>sample string 1</name>
      <note>sample string 12</note>
      <optionId>eafa7809-6210-4a3c-af92-ef43b1fec665</optionId>
      <optionIsActive>true</optionIsActive>
      <price>2.1</price>
      <size>5</size>
    </Item>
  </items>
</Shop>