This API is used to resend the card details to the recipient where the mode of delivery was ‘Email’ or ‘SMS’. Using this API you may modify the name, email and telephone to resend the order. The card details will be sent to the updated email id and telephone.
Method: POST
URL/Path: baseurl/rest/v3/order/{id}/cards/?offset={offset}&limit={limit}
E.g.: extapi12.budgetree .in/rest/v3/order/id/cards/?offset=offset&limit=limit
Request Header:
Content-Type | application/json |
Accept | */* |
Request URL Parameters
Field Name | Data Type | Mandatory/Optional | Description | Example |
---|---|---|---|---|
increment_id | string | Mandatory | Valid Order ID for which the card details need to be resent to the recipients. | 1000000028 |
Sample Request Body for Order placed by logged in User where cards are delivered to individual recipients
{
"cards": [
{
"id" : 208,
"name": "ABC XYZ",
"telephone" : "+911234567890",
"email" : "abc@xyz.com"
},
{
"id" : 207,
"name" : "BCD WXY",
"telephone" : "+911234567800",
"email" : "def@xyz.com"
}
]
}
Request Parameters
Field Name | Mandatory/Optional | Data Type | Description | Example |
---|---|---|---|---|
cards | object | |||
id | Mandatory | int | Card ID, This value will be provided in the Activated Cards API response in the "cardId" key. | 208 |
name | Optional | string | Updated name | John |
telephone | Optional | string | Update Telephone number in (E164) format. | +911234567899 |
Optional | string | Updated Email | abcd@xyz.com |
Note: If Name, telephone, email parameters are not passed in the request then the card details will be sent to the original
email and telephone captured during order placement.
Sample Request Body for Consolidated Order where card details are sent to a single email id as a consolidated file
{
"firstname": "ABC",
"lastname": "XYZ",
"telephone": "+911234567890",
"email": "abc@xyz.com"
}
Request Parameters
Field Name | Data Type | Mandatory/Optional | Description | Example |
---|---|---|---|---|
firstname | string | Optional | Updated Firstname | ABC |
lastname | string | Optional | Updated Last Name | XYZ |
telephone | string | Optional | Updated Telephone number in (E164) format. | +911234567899 |
string | Optional | Updated email | abc@xyz.com |
Note: Although all the parameters are optional, however at least one parameter is required to be passed for calling the API
Sample Request Body for Order placed by Guest User(without login)
{
"firstname": "ABC",
"lastname": "XYZ",
"telephone": "+911234567890",
"email": "abc@xyz.com"
}
Request Parameters
Field Name | Data Type | Mandatory/Optional | Description | Example |
---|---|---|---|---|
firstname | string | Optional | Updated Firstname | ABC |
lastname | string | Optional | Updated Last Name | XYZ |
telephone | string | Optional | Updated Telephone number in (E164) format. | +911234567899 |
string | Optional | Updated email | abc@xyz.com |
Note: Although all the parameters are optional, however at least one parameter is required to be passed for calling the API
Sample Response
Sample Response: 202
{
"message": "Successfully resend card details to customer."
}
Response Parameters
Field Name | Data Type | Mandatory/Optional | Description | Example |
---|---|---|---|---|
message | string | Mandatory | Resend response message | Successfully resend card details to customer |
Status Code | Message | Description |
---|---|---|
200 | Ok | This indicates card details are resent successfully |
400 | Bad Request | This indicates request validations are failed |
401 | Unauthorized | This indicates Oauth authorization failed to validate |
403 | Forbidden | This indicates API access is revoked or insufficient permissions |
500 | Internal Server Error | This indicates an internal server error occurred. |
Status Code | Description |
---|---|
5320 | Order not available |
6053 | Could not process your request. Please try again later. |
5352 | Cannot be allowed for the delivery option |
Last updated on: