InStockRx - DSCSA

POST /api/v1/queries

Create Query

This method allows you to create a query. The EPCIS files that correspond to the query will be sent to you via the communication path you have specified for your company.

Note that you can also create queries by sending an EPCIS file containing a query to us as a message.

Required fields: One of NPI, NDC, GLN, GTIN or SGTIN is required.

NPI: String. The 10 digit national provider identifier number for a pharmacy.

NDC: String. The 11 digit national drug code for a medication without dashes.

GLN: String. The 13 digit GS1 global location number for a pharmacy.

GTIN: String. The 14 digit GS1 global trade item number for a medication.

SGTIN: String. The GS1 serialized global trade item number for a specific instance of a medication.

Lot: String. The lot number for a medication. Note that one of NDC, GTIN or SGTIN must be specified if lot is also used.

Starting Date: Date (YYYY-MM-DD). The starting date for your query. The query will not return records dated before this date.

Ending Date: Date (YYYY-MM-DD). The ending date for your query. The query will not return records dated after this date.

Request

POST

/api/v1/queries


    curl --location 'epcis.instockrx.com/api/v1/queries' \
    --header 'Authorization: Bearer {token}' \
    --form 'query[npi]="{npi}"' \
    --form 'query[ndc]="{ndc}"' \
    --form 'query[gln]="{gln}"' \
    --form 'query[gtin]="{gtin}"' \
    --form 'query[sgtin]="{sgtin}"' \
    --form 'query[lot]="{lot}"' \
    --form 'query[starting_date]="{starting_date}"' \
    --form 'query[ending_date]="{ending_date}"' \



curl --location 'epcis.instockrx.com/api/v1/queries' \
	--header 'Authorization: Bearer {token}' \
	--form 'query[npi]="{npi}"' \
	--form 'query[ndc]="{ndc}"' \
	--form 'query[gln]="{gln}"' \
	--form 'query[gtin]="{gtin}"' \
	--form 'query[sgtin]="{sgtin}"' \
	--form 'query[lot]="{lot}"' \
	--form 'query[starting_date]="{starting_date}"' \
	--form 'query[ending_date]="{ending_date}"' \

Response


{
  "query": {
    "id": {id},
    "company_id": {company_id},
    "npi": {npi},
    "ndc": {ndc},
    "gln": {gln},
    "gtin": {gtin},
    "lot": {lot},
    "sgtin": {sgtin},
    "starting_date": {starting_date},
    "ending_date": {ending_date,
    "created_at": {created_at},
    "updated_at": {updated_at}
  }
}



{
  "query": {
    "id": {id},
    "company_id": {company_id},
    "npi": {npi},
    "ndc": {ndc},
    "gln": {gln},
    "gtin": {gtin},
    "lot": {lot},
    "sgtin": {sgtin},
    "starting_date": {starting_date},
    "ending_date": {ending_date,
    "created_at": {created_at},
    "updated_at": {updated_at}
  }
}

GET /api/v1/queries/{id}

Show Query

This method allows you to retrieve the details for a query.

Request

GET

/api/v1/queries/{id}


    curl --location 'https://epcis.instockrx.com/api/v1/queries/{id}' \
    --header 'Authorization: Bearer {token}'



curl --location 'https://epcis.instockrx.com/api/v1/queries/{id}' \
	--header 'Authorization: Bearer {token}'

Response


{
  "query": {
    "id": {id},
    "company_id": {company_id},
    "npi": {npi},
    "ndc": {ndc},
    "gln": {gln},
    "gtin": {gtin},
    "lot": {lot},
    "sgtin": {sgtin},
    "starting_date": {starting_date},
    "ending_date": {ending_date,
    "created_at": {created_at},
    "updated_at": {updated_at}
  }
}



{
  "query": {
    "id": {id},
    "company_id": {company_id},
    "npi": {npi},
    "ndc": {ndc},
    "gln": {gln},
    "gtin": {gtin},
    "lot": {lot},
    "sgtin": {sgtin},
    "starting_date": {starting_date},
    "ending_date": {ending_date,
    "created_at": {created_at},
    "updated_at": {updated_at}
  }
}