Change Gift Information

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.

Version	2.0
Call	https://integration.shopatron.com/api/v2/order/action/changeGiftInformation/
Supported Formats	JSON
HTTP Method	POST
Schema	https://integration.shopatron.com/api/v2/schema/order/action/changeGiftInformation.json

The .json address above can be used to access the schema within Postman. An example use of the Change Gift Information API follows below, or view the schema or the sample Postman Collection.

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.
email	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.