GET ProShop/all_bybranch?offset={offset}&length={length}&branch={branch}&stocked={stocked}
Gets data of all items of a branch.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
offset |
Indicates how many result skip |
integer |
Required |
length |
Indicates how many result keep |
integer |
Required |
branch |
Indicates the id of the branch |
decimal number |
Required |
stocked |
Indicates whether to select only items with stock (optional). |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
Array of data received and processed
Collection of ItemName | Description | Type | Additional information |
---|---|---|---|
id | string |
None. |
|
code | string |
None. |
|
description | string |
None. |
|
note | string |
None. |
|
categoryid | decimal number |
None. |
|
brandid | decimal number |
None. |
|
activityid | decimal number |
None. |
|
stock | boolean |
None. |
|
supplierid | decimal number |
None. |
|
type | string |
None. |
|
ecommerceallow | boolean |
None. |
|
ecommercedescription | string |
None. |
|
eancode | string |
None. |
|
price | decimal number |
None. |
|
ext_1 | string |
None. |
|
taxgroupid | decimal number |
None. |
|
itemstock | Collection of ItemStock |
None. |
|
branches | Collection of Branch |
None. |
Response Formats
application/json, text/json
Sample:
[ { "id": "sample string 1", "code": "sample string 2", "description": "sample string 3", "note": "sample string 4", "categoryid": 5.0, "brandid": 1.0, "activityid": 1.0, "stock": true, "supplierid": 1.0, "type": "sample string 7", "ecommerceallow": true, "ecommercedescription": "sample string 9", "eancode": "sample string 10", "price": 11.0, "ext_1": "sample string 12", "taxgroupid": 1.0, "itemstock": [ { "warehouse": { "id": "sample string 1", "name": "sample string 2", "description": "sample string 3" }, "quantity": 1.1 }, { "warehouse": { "id": "sample string 1", "name": "sample string 2", "description": "sample string 3" }, "quantity": 1.1 } ], "branches": [ { "id": "sample string 1", "name": "sample string 2", "ecomm_name": "sample string 3" }, { "id": "sample string 1", "name": "sample string 2", "ecomm_name": "sample string 3" } ] }, { "id": "sample string 1", "code": "sample string 2", "description": "sample string 3", "note": "sample string 4", "categoryid": 5.0, "brandid": 1.0, "activityid": 1.0, "stock": true, "supplierid": 1.0, "type": "sample string 7", "ecommerceallow": true, "ecommercedescription": "sample string 9", "eancode": "sample string 10", "price": 11.0, "ext_1": "sample string 12", "taxgroupid": 1.0, "itemstock": [ { "warehouse": { "id": "sample string 1", "name": "sample string 2", "description": "sample string 3" }, "quantity": 1.1 }, { "warehouse": { "id": "sample string 1", "name": "sample string 2", "description": "sample string 3" }, "quantity": 1.1 } ], "branches": [ { "id": "sample string 1", "name": "sample string 2", "ecomm_name": "sample string 3" }, { "id": "sample string 1", "name": "sample string 2", "ecomm_name": "sample string 3" } ] } ]
application/xml, text/xml
Sample:
<ArrayOfItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sportrick.ApiModel"> <Item> <activityid>1</activityid> <branches> <Branch> <ecomm_name>sample string 3</ecomm_name> <id>sample string 1</id> <name>sample string 2</name> </Branch> <Branch> <ecomm_name>sample string 3</ecomm_name> <id>sample string 1</id> <name>sample string 2</name> </Branch> </branches> <brandid>1</brandid> <categoryid>5</categoryid> <code>sample string 2</code> <description>sample string 3</description> <eancode>sample string 10</eancode> <ecommerceallow>true</ecommerceallow> <ecommercedescription>sample string 9</ecommercedescription> <ext_1>sample string 12</ext_1> <id>sample string 1</id> <itemstock> <ItemStock> <quantity>1.1</quantity> <warehouse> <description>sample string 3</description> <id>sample string 1</id> <name>sample string 2</name> </warehouse> </ItemStock> <ItemStock> <quantity>1.1</quantity> <warehouse> <description>sample string 3</description> <id>sample string 1</id> <name>sample string 2</name> </warehouse> </ItemStock> </itemstock> <note>sample string 4</note> <price>11</price> <stock>true</stock> <supplierid>1</supplierid> <taxgroupid>1</taxgroupid> <type>sample string 7</type> </Item> <Item> <activityid>1</activityid> <branches> <Branch> <ecomm_name>sample string 3</ecomm_name> <id>sample string 1</id> <name>sample string 2</name> </Branch> <Branch> <ecomm_name>sample string 3</ecomm_name> <id>sample string 1</id> <name>sample string 2</name> </Branch> </branches> <brandid>1</brandid> <categoryid>5</categoryid> <code>sample string 2</code> <description>sample string 3</description> <eancode>sample string 10</eancode> <ecommerceallow>true</ecommerceallow> <ecommercedescription>sample string 9</ecommercedescription> <ext_1>sample string 12</ext_1> <id>sample string 1</id> <itemstock> <ItemStock> <quantity>1.1</quantity> <warehouse> <description>sample string 3</description> <id>sample string 1</id> <name>sample string 2</name> </warehouse> </ItemStock> <ItemStock> <quantity>1.1</quantity> <warehouse> <description>sample string 3</description> <id>sample string 1</id> <name>sample string 2</name> </warehouse> </ItemStock> </itemstock> <note>sample string 4</note> <price>11</price> <stock>true</stock> <supplierid>1</supplierid> <taxgroupid>1</taxgroupid> <type>sample string 7</type> </Item> </ArrayOfItem>