api

Cancel Fill Request

Cancel a Fill Request whose request_id field matches the respective user provided text parameter

post/api/v1/cancel_request

Request

Request body

request_idstring required

Request id

Example request

{
  "request_id": "fill_request_5c4b21b9aecaea155d67"
}

Response

OK

request_idstring
timestampinteger
statusstring

Example response

{
  "request_id": "cancel_request_a11d9497b96e188365e41fecadb947df",
  "status": "success",
  "details": {
    "code": "03",
    "description": "Fill Request Cancelled by Customer Request",
    "message": "Accepted: Fill Request fill_request_5c4b21b9aecaea155d67 has been cancelled.",
    "cancelled_medications": [
      {
        "prescription_token": "e61e324f9018"
      }
    ],
    "failed_medications": [
      {
        "prescription_token": "e61e324f9018",
        "reason": "Medication already cancelled or cancellation failed"
      }
    ],
    "cancelled_otc_products": [
      {
        "sku": "SKU-123-456"
      }
    ],
    "failed_otc_products": [
      {
        "sku": "SKU-123-456",
        "reason": "OTC Product already cancelled or cancellation failed"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.