KIBO OMS DOCUMENTATION

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.

Version2.0
Callhttps://integration.shopatron.com/api/v2/order/action/changeGiftInformation/
Supported FormatsJSON
HTTP MethodPOST
Schemahttps://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 here — or go directly to 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:

ParameterTypeDescription
orderIDintegerA unique identifier for the order. The minimum value is "1".
recipientstringThe 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:

ParameterTypeDescription
messagestringA message to the gift recipient. The maximum length is 16384.
emailstringThe email address of the recipient.
phonestringThe 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.


Megan MayfieldOMS Dev: Change Gift Information