This API allows the gift information of an order to be edited. The recipient and message of the gift can be specified, and even the recipient’s email and phone number can be provided if desired.
Note that the request body and parameter schemas outlined in this guide are the exact same as in the previous version of OMS, as the Unified Commerce platform supports backwards compatibility for this API. The only change to this request is the format of the base endpoint, as shown in the below table. Remember to provide the x-vol-tenant key for authentication in the headers.
| Production URL | https://{tenantId}-translation.mozu.com/api/v2/order/action/changeGiftInformation/ |
| Sandbox URL | https://{tenantId}-translation.sandbox.mozu.com/api/v2/order/action/changeGiftInformation/ |
| Supported Formats | JSON |
| HTTP Method | POST |
Example
The example case will apply the following gift properties to an order:
- Order ID 012345
- Set as a gift to John Doe
- Includes placeholder gift message
Required Parameters
The required information for this request includes:
| Parameter | Type | Description |
| orderID | integer | A unique identifier for the order. The minimum value is “1”. |
| recipient | string | The name of the gift recipient. The maximum length is 100. |
Optional Parameters
The additional properties that can be added to further define gift information are:
| Parameter | Type | Description |
| message | string | A message to the gift recipient. The maximum length is 16384. |
| string | The email address of the recipient. | |
| phone | string | The phone number. The minimum length is 1 and the maximum length is 20. |
The Full Request
This is the entire request that will edit the order’s gift information.
{
"orderID": 012345,
"recipient": "John Doe",
"message": "this is the gift message"
}The returned response follows the same structure as the Get Order API, providing information about the order that was edited.