v2.order.handle_prescription_check
POST /api/v2/order/handle_prescription_check
Use this API to approve or reject a prescription
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/order/handle_prescription_check
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| order_sn | string | True | Shopee's unique identifier for an order. | |
| is_approved | boolean | True | Approve or reject the prescription. Available values: TRUE, FALSE. | |
| reject_reason_code | int | False | Reject reason code. Available values: 1 = Invalid Prescription (counterfeit/incorrect format) 2 = Incorrect Dosage 3 = No Prescription 4 = Unclear Image 5 = Free Text | |
| items | object[] | False | The list of invalid items that make the prescription get rejected | |
| item_id | int | True | Shopee's unique identifier for an item. | |
| model_id | int | True | Shopee's unique identifier for a model of an item. | |
| group_id | int | True | The identify of product promotion. For items in one same add on deal promotion, the group_id should share the same id. For items not in add on deal promotion, the group_id should be 0. And the data is from group_id of shopee.orders.GetOrderDetails. | |
| pharmacist_name | string | False | Full name of the pharmacist. Required for PH and ID Prescription Orders. | |
| free_text | string | False | The reason for rejecting the prescription. Only usable when the reject_reason_code = 5. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| response | object | Detail informations you are querying. | |
| is_success | boolean | This is to indicate whether the request has been executed successfully. | |
| request_id | string | 31e9243595ff6f0ddd375106e8d18920 | The identifier for an API request for error tracking. |
| message | string | Indicate error details if hit error. Empty if no error happened. | |
| error | string | Indicate error type if hit error. Empty if no error happened. |