POST api/Lists
Request Information
URI Parameters
None.
Body Parameters
CustListName | Description | Type | Additional information |
---|---|---|---|
ListName | string |
None. |
|
NoOfAddedItems | integer |
None. |
|
ListDetails | Collection of ListDetail |
None. |
|
hasUploadedFile | boolean |
None. |
|
Id | globally unique identifier |
None. |
|
Comments | string |
None. |
|
DateCreated | date |
None. |
|
DateModified | date |
None. |
Request Formats
application/json, text/json
Sample:
{ "ListName": "sample string 1", "NoOfAddedItems": 2, "ListDetails": [ { "CustListId": "f147245e-6f30-4a5c-8f81-3f5b699f9559", "Id": "f64e4eb2-b60a-4842-a045-a643a237c406", "UnitPrice": "sample string 4", "Quantity": 5, "MaterialID": "sample string 6", "Material": { "MaterialID": "sample string 1", "Description": "sample string 2", "Family": "sample string 3", "SubFamily": "sample string 4", "Brand": "sample string 5", "DisplayUPC": "sample string 6", "GTIN": "sample string 7", "ShelfLife": "sample string 8", "CodeDating": "sample string 9", "RefrigerationText": "sample string 10", "Establishment": "sample string 11", "Characteristics": "sample string 12", "Allergens": "sample string 13", "UMConversions": "sample string 14", "Package": "sample string 15", "Case": "sample string 16", "CaseWeightType": "sample string 17", "CaseWt": "sample string 18", "ShippingWt": "sample string 19", "Pallet": "sample string 20", "SellingRestriction": "sample string 21", "CaseUPC": "sample string 22", "ImageUrl": "sample string 23", "NutritionFactsUrl": "sample string 24", "SellingUnit": "sample string 25", "ConversionFactor": "sample string 26" }, "DateAdded": "2025-07-07T09:34:28.7248541+00:00" }, { "CustListId": "f147245e-6f30-4a5c-8f81-3f5b699f9559", "Id": "f64e4eb2-b60a-4842-a045-a643a237c406", "UnitPrice": "sample string 4", "Quantity": 5, "MaterialID": "sample string 6", "Material": { "MaterialID": "sample string 1", "Description": "sample string 2", "Family": "sample string 3", "SubFamily": "sample string 4", "Brand": "sample string 5", "DisplayUPC": "sample string 6", "GTIN": "sample string 7", "ShelfLife": "sample string 8", "CodeDating": "sample string 9", "RefrigerationText": "sample string 10", "Establishment": "sample string 11", "Characteristics": "sample string 12", "Allergens": "sample string 13", "UMConversions": "sample string 14", "Package": "sample string 15", "Case": "sample string 16", "CaseWeightType": "sample string 17", "CaseWt": "sample string 18", "ShippingWt": "sample string 19", "Pallet": "sample string 20", "SellingRestriction": "sample string 21", "CaseUPC": "sample string 22", "ImageUrl": "sample string 23", "NutritionFactsUrl": "sample string 24", "SellingUnit": "sample string 25", "ConversionFactor": "sample string 26" }, "DateAdded": "2025-07-07T09:34:28.7248541+00:00" } ], "hasUploadedFile": true, "Id": "21eb3c7f-d06d-454c-b4c4-d9b05b995c46", "Comments": "sample string 6", "DateCreated": "2025-07-07T09:34:28.7248541+00:00", "DateModified": "2025-07-07T09:34:28.7248541+00:00" }
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
DataResultOfCustListName | Description | Type | Additional information |
---|---|---|---|
Value | RetVal |
None. |
|
Message | string |
None. |
|
Data | CustList |
None. |
Response Formats
application/json, text/json
Sample:
{ "Value": 0, "Message": "sample string 1", "Data": { "ListName": "sample string 1", "NoOfAddedItems": 2, "ListDetails": [ { "CustListId": "3d550653-8dc6-4cb0-a7e8-a4aa4a99097c", "Id": "e4654d98-c74a-426b-98cb-2d30fab894c7", "UnitPrice": "sample string 4", "Quantity": 5, "MaterialID": "sample string 6", "Material": { "MaterialID": "sample string 1", "Description": "sample string 2", "Family": "sample string 3", "SubFamily": "sample string 4", "Brand": "sample string 5", "DisplayUPC": "sample string 6", "GTIN": "sample string 7", "ShelfLife": "sample string 8", "CodeDating": "sample string 9", "RefrigerationText": "sample string 10", "Establishment": "sample string 11", "Characteristics": "sample string 12", "Allergens": "sample string 13", "UMConversions": "sample string 14", "Package": "sample string 15", "Case": "sample string 16", "CaseWeightType": "sample string 17", "CaseWt": "sample string 18", "ShippingWt": "sample string 19", "Pallet": "sample string 20", "SellingRestriction": "sample string 21", "CaseUPC": "sample string 22", "ImageUrl": "sample string 23", "NutritionFactsUrl": "sample string 24", "SellingUnit": "sample string 25", "ConversionFactor": "sample string 26" }, "DateAdded": "2025-07-07T09:34:28.7248541+00:00" }, { "CustListId": "3d550653-8dc6-4cb0-a7e8-a4aa4a99097c", "Id": "e4654d98-c74a-426b-98cb-2d30fab894c7", "UnitPrice": "sample string 4", "Quantity": 5, "MaterialID": "sample string 6", "Material": { "MaterialID": "sample string 1", "Description": "sample string 2", "Family": "sample string 3", "SubFamily": "sample string 4", "Brand": "sample string 5", "DisplayUPC": "sample string 6", "GTIN": "sample string 7", "ShelfLife": "sample string 8", "CodeDating": "sample string 9", "RefrigerationText": "sample string 10", "Establishment": "sample string 11", "Characteristics": "sample string 12", "Allergens": "sample string 13", "UMConversions": "sample string 14", "Package": "sample string 15", "Case": "sample string 16", "CaseWeightType": "sample string 17", "CaseWt": "sample string 18", "ShippingWt": "sample string 19", "Pallet": "sample string 20", "SellingRestriction": "sample string 21", "CaseUPC": "sample string 22", "ImageUrl": "sample string 23", "NutritionFactsUrl": "sample string 24", "SellingUnit": "sample string 25", "ConversionFactor": "sample string 26" }, "DateAdded": "2025-07-07T09:34:28.7248541+00:00" } ], "hasUploadedFile": true, "Id": "6f1d7175-0194-4ef2-8997-7465e54eec98", "Comments": "sample string 6", "DateCreated": "2025-07-07T09:34:28.7248541+00:00", "DateModified": "2025-07-07T09:34:28.7248541+00:00" } }