DSLD Label API

API for accessing and searching label data stored in the Dietary Supplement Label Database (DSLD). When testing through SwaggerHub, please note that the API returns large result sets. In this case it is recommended to lower the size parameter to 10.
More information: https://dsld.od.nih.gov/api-guide
Contact Info: ODScomments@mail.nih.gov
Version: 9.4.0
BasePath:/dsld/
CC0 1.0 Universal (CC0 1.0)
https://creativecommons.org/publicdomain/zero/1.0/

Access

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up 
get /v9/brand-products
View Products by Brand (brandProducts)
Allows API consumer to retrieve a paginated list of label info by product name, or a paginated list based on a query term executed against product name for a given brand

Query parameters

q (required)
Query Parameter — Brand name for which products are to be listed.
from (optional)
Query Parameter — Number of start record for pagination, default is 0. default: 0 format: int32
size (optional)
Query Parameter — Number of records to return, starting at 'from' value (see above). default: 1000 format: int32

Return type

brandProductResult

Example data

Content-Type: application/json
{
      "hits" : [ {
        "_index" : "_index",
        "_type" : "_type",
        "_source" : "{}",
        "_id" : "_id",
        "sort" : [ "sort", "sort" ],
        "_score" : 6.02745618307040320615897144307382404804229736328125
      }, {
        "_index" : "_index",
        "_type" : "_type",
        "_source" : "{}",
        "_id" : "_id",
        "sort" : [ "sort", "sort" ],
        "_score" : 6.02745618307040320615897144307382404804229736328125
      } ],
      "total" : "{}",
      "max_score" : 0.80082819046101150206595775671303272247314453125
    }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

search results matching criteria brandProductResult

500

bad input parameter
Up 
get /v9/browse-brands
Browse by Brand Name(s) (browseBrands)
Allows API consumer to retrieve a paginated list of brands by brand name, or a paginated list based on a query term executed against brand name by keyword or letter

Query parameters

method (required)
Query Parameter — Specifies search method.
q (optional)
Query Parameter — Query term; single letter, keyword, or 'Other' for brands beginning with a number.
from (optional)
Query Parameter — Number of start record for pagination, default is 0. default: 0 format: int32
size (optional)
Query Parameter — Number of records to return, starting at 'from' value (see above). default: 1000 format: int32

Return type

browseBrandResult

Example data

Content-Type: application/json
{
            "hits" : [ {
              "_index" : "_index",
              "_type" : "_type",
              "_source" : "{}",
              "_id" : "_id",
              "sort" : [ "sort", "sort" ],
              "_score" : 6.02745618307040320615897144307382404804229736328125
            }, {
              "_index" : "_index",
              "_type" : "_type",
              "_source" : "{}",
              "_id" : "_id",
              "sort" : [ "sort", "sort" ],
              "_score" : 6.02745618307040320615897144307382404804229736328125
            } ],
            "total" : "{}",
            "max_score" : 0.80082819046101150206595775671303272247314453125
          }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

search results matching criteria browseBrandResult

500

bad input parameter
Up 
get /v9/ingredient-groups
Browse by Ingredient Name(s) (browseIngredientGroups)
Allows API consumer to retrieve a paginated list of ingredient groups, or a paginated list based on a query term executed against ingredient group names browsing by keyword or letter.

Query parameters

term (required)
Query Parameter — Query term, single letter or 'Other'
method (required)
Query Parameter — Specifies search method. Selecting 'factsheet' matches query term against synonyms for each ingredient group.
from (optional)
Query Parameter — Number of start record for pagination, default is 0. default: 0 format: int32
size (optional)
Query Parameter — Number of records to return, starting at 'from' value (see above). default: 1000 format: int32

Return type

IngredientGroupResult

Example data

Content-Type: application/json
{
      "total": {},
      "max_score": 5.4117074,
      "hits": [
        {
          "_index": "_index",
          "_type": "_doc",
          "_id": "200",
          "_score": 5.4117074,
          "_source": {}
        }
      ]
    }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

search results matching criteria IngredientGroupResult

500

bad input parameter
Up 
get /v9/browse-products
Browse by Product Name(s) (browseProducts)
Allows API consumer to retrieve a paginated list of labels by product name, or a paginated list based on a query term executed against product name by keyword or letter

Query parameters

method (required)
Query Parameter — Specifies search method.
q (optional)
Query Parameter — Query term; single letter, keyword, or 'Other' for products beginning with a number.
size (optional)
Query Parameter — Number of records to return, starting at 'from' value (see below). default: 1000 format: int32
from (optional)
Query Parameter — Number of start record for pagination, default is 0 default: 0 format: int32

Return type

browseProductResult

Example data

Content-Type: application/json
          
            {
              "hits" : [ {
                "_index" : "_index",
                "_type" : "_type",
                "_source" : "{}",
                "_id" : "_id",
                "sort" : [ "sort", "sort" ],
                "_score" : 6.02745618307040320615897144307382404804229736328125
              }, {
                "_index" : "_index",
                "_type" : "_type",
                "_source" : "{}",
                "_id" : "_id",
                "sort" : [ "sort", "sort" ],
                "_score" : 6.02745618307040320615897144307382404804229736328125
              } ],
              "total" : "{}",
              "max_score" : 0.80082819046101150206595775671303272247314453125
            }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

search results matching criteria browseProductResult

500

bad input parameter
Up 
get /v9/label/{id}
Get data for a label (getLabel)
Retrieves a label by unique DSLD ID.

Path parameters

id (required)
Path Parameter — DSLD (label) ID

Return type

Label

Example data

Content-Type: application/json
      {
      "src": "01-raw/2022-10-25/data/label_25.json",
      "id": 25,
      "nhanesId": "",
      "bundleName": "",
      "fullName": "Vitamins For The Hair",
      "brandName": "Nature's Bounty",
      "brandIpSymbol": "®",
      "upcSku": "0 74312 02100 8",
      "productVersionCode": "Prod. No. 2100 05A B2101",
      "pdf": "",
      "thumbnail": "",
      "servingsPerContainer": null,
      "hasOuterCarton": false,
      "percentDvFootnote": "Not Present",
      "labelRelationships": [],
      "contacts": [
          {
              "contactId": 2212,
              "text": "Visit us on the Web",
              "types": [
                  "Other"
              ],
              "contactDetails": {
                  "src": "01-raw/2022-10-25/data/contact_1.json",
                  "id": 2212,
                  "name": "",
                  "streetAddress": "",
                  "city": "",
                  "state": "",
                  "country": "",
                  "zipCode": "",
                  "phoneNumber": "",
                  "email": "",
                  "webAddress": "www.NaturesBounty.com"
              }
          }
      ],
      "netContents": [
          {
              "order": 1,
              "quantity": 65,
              "unit": "Tablet(s)",
              "display": "65 Tablet(s)"
          }
      ],
      "physicalState": {
          "langualCode": "E0155",
          "langualCodeDescription": "Tablet or Pill"
      },
      "servingSizes": [
          {
              "order": 1,
              "minQuantity": 1,
              "maxQuantity": 1,
              "minDailyServings": 1,
              "maxDailyServings": 1,
              "unit": "Tablet(s)",
              "inSFB": true
          }
      ],
      "targetGroups": [
          "Vegetarian",
          "Adult (18 - 50 Years)"
      ],
      "productType": {
          "langualCode": "A1325",
          "langualCodeDescription": "Other Combinations"
      },
      "statements": [
          {
              "type": "FDA Statement of Identity",
              "notes": "DIETARY SUPPLEMENT"
          },
          {
              "type": "General Statements: All Other Content",
              "notes": "Provides a combination of nutrients consistently found in healthy hair."
          },
          {
              "type": "Seals/Symbols",
              "notes": "NATURE'S BOUNTY(R)"
          },
          {
              "type": "Precautions re: All Other",
              "notes": "Avoid this product if you have Wilson's disease or are allergic to yeast."
          }
      ],
      "claims": [
          {
              "langualCode": "P0115",
              "langualCodeDescription": "All Other"
          }
      ],
      "events": [
          {
              "date": "2011-01-01",
              "type": "Off Market"
          },
          {
              "date": "2012-01-25",
              "type": "Date entered into DSLD"
          }
      ],
      "userGroups": [
          {
              "dailyValueTargetGroupName": "Adults and children 4 or more years of age",
              "langualCode": "P0250",
              "langualCodeDescription": "Adults and Children 4 years and above"
          }
      ],
      "ingredientRows": [
          {
              "order": 1,
              "ingredientId": 280871,
              "description": null,
              "notes": "Pantothenic Acid (Form: as D-Calcium Pantothenate) ",
              "quantity": [
                  {
                      "servingSizeOrder": 1,
                      "servingSizeQuantity": 1,
                      "operator": "=",
                      "quantity": 100,
                      "unit": "mg",
                      "dailyValueTargetGroup": [
                          {
                              "name": "Adults and children 4 or more years of age",
                              "operator": "=",
                              "percent": 1000,
                              "footnote": null
                          }
                      ],
                      "servingSizeUnit": "Tablet(s)"
                  }
              ],
              "nestedRows": [],
              "name": "Pantothenic Acid",
              "category": "vitamin",
              "ingredientGroup": "Pantothenic Acid (Vitamin B5)",
              "uniiCode": "19F5HK2737",
              "alternateNames": [],
              "forms": [
                  {
                      "order": 1,
                      "ingredientId": 293281,
                      "prefix": null,
                      "percent": null,
                      "name": "D-Calcium Pantothenate"
                  }
              ]
          },
          {
              "order": 2,
              "ingredientId": 292597,
              "description": null,
              "notes": null,
              "quantity": [
                  {
                      "servingSizeOrder": 1,
                      "servingSizeQuantity": 1,
                      "operator": "=",
                      "quantity": 5,
                      "unit": "mg",
                      "dailyValueTargetGroup": [
                          {
                              "name": "Adults and children 4 or more years of age",
                              "operator": "<",
                              "percent": 1,
                              "footnote": null
                          }
                      ],
                      "servingSizeUnit": "Tablet(s)"
                  }
              ],
              "nestedRows": [],
              "name": "Sodium",
              "category": "mineral",
              "ingredientGroup": "Sodium",
              "uniiCode": "9NEZ333N27",
              "alternateNames": [
                  "Na"
              ],
              "forms": []
          }
      ],
      "otheringredients": {
          "text": null,
          "ingredients": [
              {
                  "order": 1,
                  "ingredientId": 15302,
                  "name": "Cellulose",
                  "category": "fiber",
                  "ingredientGroup": "Cellulose",
                  "uniiCode": null,
                  "alternateNames": [],
                  "forms": []
              },
              {
                  "order": 2,
                  "ingredientId": 18961,
                  "name": "Dicalcium Phosphate",
                  "category": "mineral",
                  "ingredientGroup": "Calcium",
                  "uniiCode": null,
                  "alternateNames": [],
                  "forms": []
              },
              {
                  "order": 3,
                  "ingredientId": 3690,
                  "name": "Croscarmellose",
                  "category": "other",
                  "ingredientGroup": "Croscarmellose",
                  "uniiCode": null,
                  "alternateNames": [],
                  "forms": []
              }
          ]
      },
      "offMarket": 1,
      "entryDate": "2012-01-25"
    }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

data for a single label Label

500

bad input parameter
Up 
get /version
API version (getVersion)
Retrieves API version information

Return type

Version

Example data

Content-Type: application/json
      
        {
          "title": "DSLD API",
          "config": "production",
          "version": "9.2.0",
          "versionTimeStamp": "November 2023",
          "esIndexProcessed": "dsldnxt_labels-2023-09-23f and dsldnxt_ing_groups-2023-09-23f"
        }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Version information for API Version

500

server error
Up 
get /v9/search-filter
Search for Label(s) (searchFilter)
Allows API consumer to retrieve a set of labels by product name matching a complex combination of search terms and filters

Query parameters

q (required)
Query Parameter — Query term. Will search for submitted terms across all label fields. Use quotes to find exact multi token matches. Use * for term-less search.
sort_by (optional)
Query Parameter — Specifies field to sort on. Use _score to sort on "best match", entryDate to sort by date, and fullName.keyword to sort by product name.
sort_order (optional)
Query Parameter — Specifies sort order.
status (optional)
Query Parameter — Market status. 2 - all, 1 - on market, 0 - off market
date_start (optional)
Query Parameter — Entry date start year. Use 4 digit year YYYY (e.g., 2020).
date_end (optional)
Query Parameter — Entry date end year. Use 4 digit year YYYY (e.g., 2020).
product_name (optional)
Query Parameter — Product name(s), one or more separated by comma. Requires product name to contain token submitted in search bar.
product_type (optional)
Query Parameter — Product type, one or more codes separated by comma. Codes are a1305 (Amino Acid/Protein), a1306 (Botanical), a1326 (Fiber and Other Nutrients), a1310 (Omega 3 and Other Fatty Acids), a1302 (Vitamin), a1299 (Mineral), a1316 (Single Vitamin and Mineral), a1315 (Multi-Vitamin and Mineral [MVM]), a1317 (Botanicals with Nutrients), a1309 (Non-Nutrient/Non-Botanical), a1325 (Other Combinations).
ingredient_name (optional)
Query Parameter — Ingredient name, one or more separated by comma. Requires ingredient name to contain term submitted in search bar, or the ingredient to be synonymous with term submitted in search bar.
apply_synonyms (optional)
Query Parameter — Include synonyms/alternate names for ingredients? There are two ways to filter for ingredients - with and without synonyms and alternate names. Select ‘Yes’ (default) to include synonyms and alternative names in your search as well as exact matches for your ingredient name(s). Select ‘No’ to only retrieve exact matches of your ingredient name(s).
ingredient_category (optional)
Query Parameter — Ingredient category, one or more categories separated by comma. Categories are amino_acid, animal_part_or_source, blend, botanical, sugars, complex_carbohydrate, enzyme, fat, fatty_acid, fiber, hormone, chemical (Non-nutrient/non-botanical), bacteria, protein, vitamin, mineral, other, tbd.
brand (optional)
Query Parameter — Brand name, one or more separated by comma. Requires brand name to contain term submitted in search bar.
target_group (optional)
Query Parameter — Product target group, one ore more codes separated by comma. Codes are p0250 (All Adults and Children Four Years and Above), p0192 (Children 1 to 4 Years), p0266 (Infants), p0253 (Pregnant and Lactating).
supplement_form (optional)
Query Parameter — Product supplement form, one ore more codes separated by comma. Codes are e0164 (Bars), e0159 (Capsules), e0161 (Softgel Capsules), e0155 (Tablets and Pills), e0176 (Gummies and Jellies), e0165 (Liquids), e0174 (Lozenges), e0162 (Powders), e0172 (Other; e.g. tea bag), e0177 (Unknown).
claim_type (optional)
Query Parameter — Claim type present on label, one ore more codes separated by comma. Codes are p0065 (Nutrient), p0265 (Structure/Function), p0124 (Approved Health), p0264 (Qualified Health), p0115 (All Other), p0276 (No Claims).
label_claim (optional)
Query Parameter — Dietary claim, one or more separated by comma. Requires dietary claim to contain term submitted in search bar.

Return type

SearchResult

Example data

Content-Type: application/json
{
            "hits" : [ {
              "_index" : "_index",
              "_type" : "_type",
              "_source" : "{}",
              "_id" : "_id",
              "sort" : [ "sort", "sort" ],
              "_score" : 6.02745618307040320615897144307382404804229736328125
            }, {
              "_index" : "_index",
              "_type" : "_type",
              "_source" : "{}",
              "_id" : "_id",
              "sort" : [ "sort", "sort" ],
              "_score" : 6.02745618307040320615897144307382404804229736328125
            } ],
            "stats" : {
				"count": 95500
				"pct: 0.62
			}
          }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

search results matching criteria SearchResult

500

bad input parameter
Up 
get /v9/search-filter-histogram
Histogram of Search Results (searchFilterHistogram)

Generates histogram of labels over time based on selection criterica.

Allows API consumer to retrieve a of labels by product name matching a complex combination of search terms and filters

Query parameters

q (required)
Query Parameter — Query term. Will search for submitted terms across all label fields. Use quotes to find exact multi token matches. Use * for term-less search.
sort_by (optional)
Query Parameter — Specifies field to sort on. Use _score to sort on "best match", entryDate to sort by date, and fullName.keyword to sort by product name.
sort_order (optional)
Query Parameter — Specifies sort order.
status (optional)
Query Parameter — Market status. 2 - all, 1 - on market, 0 - off market
product_name (optional)
Query Parameter — Product name(s), one or more separated by comma. Requires product name to contain token submitted in search bar.
product_type (optional)
Query Parameter — Product type, one or more codes separated by comma. Codes are a1305 (Amino Acid/Protein), a1306 (Botanical), a1326 (Fiber and Other Nutrients), a1310 (Omega 3 and Other Fatty Acids), a1302 (Vitamin), a1299 (Mineral), a1316 (Single Vitamin and Mineral), a1315 (Multi-Vitamin and Mineral [MVM]), a1317 (Botanicals with Nutrients), a1309 (Non-Nutrient/Non-Botanical), a1325 (Other Combinations).
ingredient_name (optional)
Query Parameter — Ingredient name, one or more separated by comma. Requires ingredient name to contain term submitted in search bar, or the ingredient to be synonymous with term submitted in search bar.
apply_synonyms (optional)
Query Parameter — Include synonyms/alternate names for ingredients? There are two ways to filter for ingredients - with and without synonyms and alternate names. Select ‘Yes’ (default) to include synonyms and alternative names in your search as well as exact matches for your ingredient name(s). Select ‘No’ to only retrieve exact matches of your ingredient name(s).
ingredient_category (optional)
Query Parameter — Ingredient category, one ore more categories separated by comma. Categories are amino_acid, animal_part_or_source, blend, botanical, sugars, complex_carbohydrate, enzyme, fat, fatty_acid, fiber, hormone, chemical (Non-nutrient/non-botanical), bacteria, protein, vitamin, mineral, other, tbd.
brand (optional)
Query Parameter — Brand name, one or more separated by comma. Requires brand name to contain term submitted in search bar.
target_group (optional)
Query Parameter — Product target group, one ore more codes separated by comma. Codes are p0250 (All Adults and Children Four Years and Above), p0192 (Children 1 to 4 Years), p0266 (Infants), p0253 (Pregnant and Lactating).
supplement_form (optional)
Query Parameter — Product supplement form, one ore more codes separated by comma. Codes are e0164 (Bars), e0159 (Capsules), e0161 (Softgel Capsules), e0155 (Tablets and Pills), e0176 (Gummies and Jellies), e0165 (Liquids), e0174 (Lozenges), e0162 (Powders), e0172 (Other; e.g. tea bag), e0177 (Unknown).
claim_type (optional)
Query Parameter — Claim type present on label, one ore more codes separated by comma. Codes are p0065 (Nutrient), p0265 (Structure/Function),p0124 (Approved Health), p0264 (Qualified Health), p0115 (All Other), p0276 (No Claims).
label_claim (optional)
Query Parameter — Dietary claim, one or more separated by comma. Requires dietary claim to contain term submitted in search bar.

Return type

SearchHistogramResult

Example data

Content-Type: application/json
[
      {
          "key_as_string": "2016-01-01T00:00:00.000Z",
          "key": 1451606400000,
          "doc_count": 2485
      },
      {
          "key_as_string": "2017-01-01T00:00:00.000Z",
          "key": 1483228800000,
          "doc_count": 2312
      },
      {
          "key_as_string": "2018-01-01T00:00:00.000Z",
          "key": 1514764800000,
          "doc_count": 1828
      },
      {
          "key_as_string": "2019-01-01T00:00:00.000Z",
          "key": 1546300800000,
          "doc_count": 3440
      },
      {
          "key_as_string": "2020-01-01T00:00:00.000Z",
          "key": 1577836800000,
          "doc_count": 6385
      }
  ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

search results matching criteria SearchHistogramResult

500

bad input parameter

Models

[ Jump to Methods ]

Table of Contents

  1. Contact -
  2. Contact_contactDetails -
  3. HistogramEntry -
  4. IngredientGroupDoc -
  5. IngredientGroupDoc_factsheets -
  6. IngredientGroupDoc_nutrientInfo -
  7. IngredientGroupHit -
  8. IngredientGroupResult -
  9. Label -
  10. Label_dailyValueTargetGroup -
  11. Label_ingredientRows -
  12. Label_nestedRows -
  13. Label_otheringredients -
  14. Label_otheringredients_ingredients -
  15. Label_quantity -
  16. Label_quantity_1 -
  17. SearchHistogramResult -
  18. SearchResult -
  19. SearchResultHit -
  20. Stats -
  21. TruncatedBrowseBrandLabel -
  22. Version -
  23. brandProductHit -
  24. brandProductResult -
  25. browseBrandHit -
  26. browseBrandResult -
  27. browseProductHit -
  28. browseProductResult -
  29. claims -
  30. events -
  31. forms -
  32. labelRelationship -
  33. labelStatements -
  34. netContents -
  35. physicalState -
  36. productType -
  37. searchTotal -
  38. servingSize -
  39. truncatedBrowseProductLabel -
  40. truncatedServingSize -
  41. userGroups -

Contact - Up

contactId (optional)
Integer
text (optional)
String
types (optional)
array[Object]
contactDetails (optional)
Contact_contactDetails

Contact_contactDetails - Up

src (optional)
String
id (optional)
Integer
name (optional)
String
streetAddress (optional)
String
city (optional)
String
state (optional)
String
country (optional)
String
zipCode (optional)
String
phoneNumber (optional)
String
email (optional)
String
webAddress (optional)
String

HistogramEntry - Up

key_as_string (optional)
String date labels were added
key (optional)
Integer elasticsearch encoding of date labels were added
doc_count (optional)
Integer label count

IngredientGroupDoc - Up

groupId (optional)
String
groupName (optional)
String
category (optional)
array[String]
synonyms (optional)
array[String]
factsheets (optional)
array[IngredientGroupDoc_factsheets]
nutrientInfo (optional)
array[IngredientGroupDoc_nutrientInfo]

IngredientGroupDoc_factsheets - Up

link (optional)
String
name (optional)
String

IngredientGroupDoc_nutrientInfo - Up

cas (optional)
String
identity (optional)
String
nutrient (optional)
String
iupacNomenclature (optional)
String

IngredientGroupHit - Up

_index (optional)
String Elasticsearch index used.
_type (optional)
String expect '_doc'
_id (optional)
String unique id, see dsldId
_score (optional)
BigDecimal match score or null
_source (optional)
Object

IngredientGroupResult - Up

total (optional)
Object
max_score (optional)
BigDecimal maximum elasticsearch match score
hits (optional)
array[IngredientGroupHit]

Label - Up

src (optional)
String
id
Integer
nhanesId (optional)
String
bundleName (optional)
String
fullName (optional)
String
brandName (optional)
String
brandIpSymbol (optional)
String
upcSku (optional)
String
productVersionCode (optional)
String
pdf (optional)
String
thumbnail (optional)
String
servingsPerContainer (optional)
String
hasOuterCarton (optional)
Boolean
percentDvFootnote (optional)
String
labelRelationships (optional)
array[labelRelationship]
contacts (optional)
array[Contact]
netContents (optional)
array[netContents]
physicalState (optional)
physicalState
servingSizes (optional)
array[servingSize]
targetGroups (optional)
array[Object]
example: "Adult (18 - 50 Years)"
productType (optional)
productType
statements (optional)
array[labelStatements]
claims (optional)
array[claims]
events (optional)
array[events]
userGroups (optional)
array[userGroups]
ingredientRows (optional)
array[Label_ingredientRows]
otheringredients (optional)
Label_otheringredients
offMarket (optional)
Integer
entryDate (optional)
String

Label_dailyValueTargetGroup - Up

footnote (optional)
String
name (optional)
String
operator (optional)
String
percent (optional)
Integer

Label_ingredientRows - Up

order (optional)
Integer
ingredientId (optional)
Integer
description (optional)
String
notes (optional)
String
quantity (optional)
array[Label_quantity]
nestedRows (optional)
array[Label_nestedRows]
name (optional)
String
category (optional)
String
ingredientGroup (optional)
String
uniiCode (optional)
String
alternateNames (optional)
array[Object]
forms (optional)
array[forms]

Label_nestedRows - Up

quantity (optional)
array[Label_quantity_1]
order (optional)
Integer
ingredientId (optional)
Integer
description (optional)
String
notes (optional)
String

Label_otheringredients - Up

text (optional)
String
ingredients (optional)
array[Label_otheringredients_ingredients]

Label_otheringredients_ingredients - Up

order (optional)
Integer
ingredientId (optional)
Integer
name (optional)
String
category (optional)
String
ingredientGroup (optional)
String
uniiCode (optional)
String
alternateNames (optional)
array[Object]
forms (optional)
array[forms]

Label_quantity - Up

servingSizeOrder (optional)
Integer
servingSizeQuantity (optional)
Integer
operator (optional)
String
quantity (optional)
Integer
unit (optional)
String
dailyValueTargetGroup (optional)
array[Label_dailyValueTargetGroup]
servingSizeUnit (optional)
String

Label_quantity_1 - Up

servingSizeQuantity (optional)
Integer
operator (optional)
String
quantity (optional)
Integer
unit (optional)
String
servingSizeOrder (optional)
Integer

SearchHistogramResult - Up

SearchResult - Up

hits (optional)
array[SearchResultHit]
stats (optional)
Object

SearchResultHit - Up

_index (optional)
String Elasticsearch index used.
_type (optional)
String expect '_doc'
_id (optional)
String unique id, see dsldId
_score (optional)
BigDecimal match score or null
_source (optional)
Object

Stats - Up

count (optional)
Integer
pct (optional)
BigDecimal

TruncatedBrowseBrandLabel - Up

brand (optional)
String

Version - Up

title (optional)
String
config (optional)
String
version (optional)
String
versionTimeStamp (optional)
String
esIndexProcessed (optional)
String

brandProductHit - Up

_index (optional)
String Elasticsearch index used.
_type (optional)
String expect '_doc'
_id (optional)
String unique id, see label id
_score (optional)
BigDecimal match score or null
_source (optional)
Object

brandProductResult - Up

total (optional)
Object
max_score (optional)
BigDecimal maximum elasticsearch match score
hits (optional)
array[brandProductHit]

browseBrandHit - Up

_index (optional)
String Elasticsearch index used.
_type (optional)
String expect '_doc'
_id (optional)
String unique id, see dsldId
_score (optional)
BigDecimal match score or null
_source (optional)
Object
sort (optional)
array[String]

browseBrandResult - Up

total (optional)
Object
max_score (optional)
BigDecimal maximum elasticsearch match score
hits (optional)
array[browseBrandHit]

browseProductHit - Up

_index (optional)
String Elasticsearch index used.
_type (optional)
String expect '_doc'
_id (optional)
String unique id, see dsldId
_score (optional)
BigDecimal match score or null
_source (optional)
Object
sort (optional)
array[String]

browseProductResult - Up

total (optional)
Object
max_score (optional)
BigDecimal maximum elasticsearch match score
hits (optional)
array[browseProductHit]

claims - Up

langualCode (optional)
String
langualCodeDescription (optional)
String

events - Up

date (optional)
String
type (optional)
String

forms - Up

order (optional)
BigDecimal
ingredientId (optional)
String
prefix (optional)
String
percent (optional)
BigDecimal
name (optional)
String

labelRelationship - Up

type (optional)
String
labelId (optional)
BigDecimal

labelStatements - Up

type (optional)
String
notes (optional)
String

netContents - Up

order (optional)
BigDecimal
quantity (optional)
BigDecimal
unit (optional)
String
display (optional)
String

physicalState - Up

langualCode (optional)
String
langualCodeDescription (optional)
String

productType - Up

langualCode (optional)
String
langualCodeDescription (optional)
String

searchTotal - Up

value (optional)
Integer
relation (optional)
String relation in the response will indicate if the value returned is accurate ("eq") or a lower bound of the total ("gte")
Enum:
gte
eq

servingSize - Up

order (optional)
BigDecimal
minQuantity (optional)
BigDecimal
maxQuantity (optional)
BigDecimal
minDailyServings (optional)
BigDecimal
maxDailyServings (optional)
BigDecimal
unit (optional)
String
notes (optional)
String
inSFB (optional)
Boolean

truncatedBrowseProductLabel - Up

servingSizes (optional)
array[truncatedServingSize]
brandName (optional)
String
physicalState (optional)
physicalState
fullName (optional)
String
upcSku (optional)
String
netContents (optional)
array[netContents]
events (optional)
array[events]
sort (optional)
array[String]

truncatedServingSize - Up

order (optional)
BigDecimal
minQuantity (optional)
BigDecimal
maxQuantity (optional)
BigDecimal
minDailyServings (optional)
BigDecimal
maxDailyServings (optional)
BigDecimal
unit (optional)
String
inSFB (optional)
Boolean

userGroups - Up

dailyValueTargetGroupName (optional)
String
langualCode (optional)
String
langualCodeDescription (optional)
String