POST /api/v1/subscriptions

Create Subscription

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

Note that you can also create subscriptions by sending an EPCIS file containing a subscription 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 subscription. The subscription will not return records dated before this date.

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

DELETE /api/v1/subscriptions/{id}

Delete Subscription

This method allows you to delete a subscription.

GET /api/v1/subscriptions

List Subscriptions

This method allows you to retrieve the details for all of your subscriptions.

GET /api/v1/subscriptions/{id}

Show Subscription

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

PUT /api/v1/subscriptions/{id}

Update Subscription

This method allows you to update a subscription. The EPCIS files that correspond to the subscription will be sent to you via the communication path you have specified for your company as they are generated.

Note that you can also update subscriptions by sending an EPCIS file containing a subscription to us as a message.

Required fields: Id and one of NPI, NDC, GLN, GTIN or SGTIN is required.

Id Integer. The id of the subscription.

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 subscription. The subscription will not return records dated before this date.

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