Merchant API

API Use Case

These API End points allow you as a partner to integrate your backend with MyRegistry.com to enable automation of the registry items purchase process. These endpoints allow you to automate the following:

  • to get the shipping address of the registrant when an Item is being purchased
  • mark the item as purchased, when the Order is processed

Important Integration Requirement: Server-Side Access Only

These APIs are designed for server-to-server communication and CANNOT be called directly from a client-side environment (such as a web browser or mobile application).

Why Server-Side Integration is Required

  • Security (CORS & Origin Control): For security purposes, these APIs enforce strict Cross-Origin Resource Sharing (CORS) policies and origin checks. Direct calls from a browser will result in an Access Denied or CORS/Strict Origin error.
  • Authentication & Credential Protection: A server-side integration is necessary to securely store and use your API keys and credentials, preventing their exposure in client-side code, which is susceptible to inspection.

How to Integrate

To successfully use these APIs, you must build a server-side integration (also known as a backend or proxy server) that acts as an intermediary:

  1. Your client-side application (browser, mobile app) calls your secure backend server.
  2. Your backend server then securely makes the required call to our API.
  3. The response is processed by your backend and sent back to your client-side application.

Attempting to call these APIs directly from JavaScript in a browser will fail.