/dailymed/labels/packaging

POST /api/dailymed/labels/packaging

Price: 1 credit

Get the marketed products and package NDC codes of a DailyMed label

How to use it

One row per marketed product of the label, with every package NDC under it and the human package description ('2 mL in 1 SYRINGE, GLASS', '2 in 1 CARTON'). A co-packaged kit adds a row per component, carrying `kit_ndc_product_code` and `quantity_in_kit`; a component the label gives no NDC of its own has a null `ndc_product_code` and is identified by name and ingredients. Use it when the question is which NDC codes or pack sizes a label covers; the label endpoint returns the same products inside a much larger document, and it also carries marketing dates and inactive ingredients that this one does not.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• setid string required — DailyMed SPL set id (UUID), or a DailyMed drugInfo URL containing it (examples: "595f437d-2729-40bb-9c62-c8ece1f82780"; minLength: 1)

Response

• @type string (default: "DailymedPackagingProduct")
• setid string required
• ndc_product_code string nullable
• name string nullable
• label_title string nullable
• generic_name string nullable
• version integer nullable
• published_at integer nullable
• kit_ndc_product_code string nullable
• quantity_in_kit string nullable
• active_ingredients array (default: [])
  • @type string (default: "DailymedPackagingIngredient")
  • name string required
  • strength string nullable
• packages array (default: [])
  • @type string (default: "DailymedPackagingPackage")
  • ndc string required
  • package_descriptions array (default: [])
• web_url string (default: "")

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Label not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.