GET api/Products/GetProducts?CatalogueID={CatalogueID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CatalogueID | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of Product| Name | Description | Type | Additional information |
|---|---|---|---|
| Barcode | string |
String length: inclusive between 0 and 18 |
|
| CatalogueProviderProductCode | string |
None. |
|
| Chilled | boolean |
None. |
|
| DateAdded | date |
None. |
|
| DateAvailable | date |
None. |
|
| DateDeleted | date |
None. |
|
| DateModified | date |
None. |
|
| Description | string |
Required Data type: MultilineText |
|
| Ethical | boolean |
None. |
|
| FairTrade | boolean |
None. |
|
| MPN | string |
String length: inclusive between 0 and 64 |
|
| Name | string |
Required String length: inclusive between 0 and 128 |
|
| Organic | boolean |
None. |
|
| OuterBarcode | string |
String length: inclusive between 0 and 32 |
|
| ProductId | globally unique identifier |
None. |
|
| SKUCostPrice | decimal number |
Data type: Currency |
|
| SKUSellingPrice | decimal number |
Data type: Currency |
|
| Status | eProductStatus |
None. |
|
| SupplierProductCode | string |
Required String length: inclusive between 0 and 64 |
|
| UnitCostPrice | decimal number |
Data type: Currency |
|
| UnitSellingPrice | decimal number |
Data type: Currency |
|
| Categories | Collection of Category |
None. |
|
| Tax | Tax |
None. |
|
| Brand | Brand |
None. |
|
| SKU | SKU |
None. |
|
| Catalogue | Catalogue |
None. |
|
| Supplier | Supplier |
None. |
|
| Parent | Product |
None. |
|
| Children | Collection of Product |
None. |
|
| PriceChanges | Collection of ProductPriceChange |
None. |
|
| Temperature | Temperature |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.