POST api/Lists

Request Information

URI Parameters

None.

Body Parameters

Name	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": "2da30061-c43a-45ed-a1fc-3c07b5c408ff",
      "Id": "f19a4e0f-154a-45eb-87d2-29dd99df398a",
      "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-09-08T06:57:35.1713382+00:00"
    },
    {
      "CustListId": "2da30061-c43a-45ed-a1fc-3c07b5c408ff",
      "Id": "f19a4e0f-154a-45eb-87d2-29dd99df398a",
      "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-09-08T06:57:35.1713382+00:00"
    }
  ],
  "hasUploadedFile": true,
  "Id": "236a24ed-1b49-4f07-b622-2e7bc91a7178",
  "Comments": "sample string 6",
  "DateCreated": "2025-09-08T06:57:35.1713382+00:00",
  "DateModified": "2025-09-08T06:57:35.1713382+00:00"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustList'.

Response Information

Resource Description

DataResultOfCustList

Name	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": "363c357a-c7e4-4bf7-b095-58194ad3e776",
        "Id": "7960b68d-6c59-4f44-afe8-df704984d169",
        "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-09-08T06:57:35.1713382+00:00"
      },
      {
        "CustListId": "363c357a-c7e4-4bf7-b095-58194ad3e776",
        "Id": "7960b68d-6c59-4f44-afe8-df704984d169",
        "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-09-08T06:57:35.1713382+00:00"
      }
    ],
    "hasUploadedFile": true,
    "Id": "f8b1ffe1-2be0-4d46-8558-4795686be292",
    "Comments": "sample string 6",
    "DateCreated": "2025-09-08T06:57:35.1713382+00:00",
    "DateModified": "2025-09-08T06:57:35.1713382+00:00"
  }
}