SetGiftAsPurchased

post

https://api.myregistry.com/MerchantApi/1/0/json/SetGiftAsPurchased

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

When a visitor successfully makes a purchase of an item for a registrant, you want to mark that item as purchased so that duplicate purchases are not made. You can use the SetGiftAsPurchased end point to perform this action.

This APIs is designed for server-to-server communication only, attempting to call the APIs directly from JavaScript in a browser will fail.

Body Params

registryId

integer

required

MyRegistry Registry Id
Information provided by MyRegistry.com

orderNumber

string

required

Order Number

purchaserFirstName

string

Purchaser First Name

purchaserLastName

string

Purchaser Last Name

purchaserEmail

string

Purchaser Email

saleDate

string

The sale date (optional)
By default date of the day

trackingInfo

string

The tracking Information token
Information provided by MyRegistry.com
This parameter is highly recommended for tracking purposes, and mandatory for Group Gifting flows

storeId

string

Identification of the store (optional)
For physical store purchase

employeeId

string

The employee identifier (optional)
For physical store purchase

purchasedGifts

array of objects

required

List of purchased gifts (JSON object)

purchasedGifts*

source

string

Source of the Purchase (optional)
Online: (default) - Purchase placed through the merchant website
Retail: - Purchase placed in person at a physical store location

cultureCode

string

Culture Code used during the transaction (based on RFC4646 )
E.g.: “en-US” or “fr-CA”

websiteId

number

Website Id to scope the request
Only used by partners with multiple websites or internal to MR

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200