How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Medusa Gift Cards API

A gift card is a prepaid card that can be used to pay for items during checkout.Gift cards can be purchased by customers, or created by admin users. When a gift card is redeemed, its amount is added to the customer's store credit account, which can then be used to pay for items during checkout.These API routes allow admin users to manage gift cards, transfer gift cards between customers, and more.Gift Card routes are only available through the [Loyalty Plugin](https://docs.medusajs.com/resources/commerce-modules/loyalty).

Medusa Gift Cards API is one of 82 APIs that Medusa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Gift Cards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 6 operations across 4 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 2.19.0.

Requests are made against 2 base URLs: http://localhost:9000, https://api.medusajs.com.

6 operations 4 paths 37 schemas 4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.19.0
Base URL
https://{medusa-backend-domain}
Authentication
HTTP Basic, HTTP Bearer, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 4

Medusa Gift Cards API declares 4 security schemes for authenticating requests. It accepts HTTP basic authentication (api_token). It accepts HTTP bearer tokens (jwt_token). An API key is passed in the cookie as connect.sid (cookie_auth). It accepts HTTP bearer tokens (reset_password).

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Gift Cards 6

A gift card is a prepaid card that can be used to pay for items during checkout. Gift cards can be purchased by customers, or created by admin users. When a gift card is redeemed,…

GET
/admin/gift-cards
List Gift Cards
GetGiftCards 11 params → 200400401404409422500
POST
/admin/gift-cards
Create Gift Card
PostGiftCards body → 200400401404409422500
GET
/admin/gift-cards/{id}
Get a Gift Card
GetGiftCardsId 1 param → 200400401404409422500
POST
/admin/gift-cards/{id}
Update a Gift Card
PostGiftCardsId 1 param body → 200400401404409422500
GET
/admin/gift-cards/{id}/orders
List Gift Card's Orders
GetGiftCardsIdOrders 1 param → 200400401404409422500
GET
/store/gift-cards/{idOrCode}
Get a Gift Card
GetGiftCardsIdorcode 5 params → 200400401404409422500

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are AdminOrderLineItem (44 properties), AdminProduct (34 properties), BaseProduct (31 properties), AdminProductVariant (31 properties). Each schema is shown below with its type and property counts.

AdminProductOptionValue
object
The product option value's details.
9 properties 2 required
AdminProductType
object
The product type's details.
8 properties 4 required
BaseCollection
object
The product collection's details.
9 properties 7 required
AdminShippingProfile
object
The shipping profile's details..
7 properties 7 required
AdminProductVariantInventoryItemLink
object
An association between a product variant and an inventory item.
6 properties 3 required
AdminProductCategory
object
The product category's details.
15 properties 13 required
BaseProductType
object
The product type's details.
7 properties 4 required
AdminProductVariant
object
The product variant's details.
31 properties 22 required
BaseProductOption
object
The product option's details.
9 properties 3 required
AdminCustomer
object
The customer's details.
16 properties 9 required
BaseProductCategory
object
The product category's details.
15 properties 13 required
AdminGiftCard
object
The gift card's details.
14 properties 14 required
Error
object
3 properties
AdminProductOption
object
The product option's details.
9 properties 3 required
AdminProductTag
object
The product tag's details.
8 properties 4 required
BaseOrderLineItemAdjustment
object
The adjustment's details.
11 properties 7 required
AdminCustomerGroup
object
The customer group's details.
6 properties 6 required
AdminInventoryItem
object
The inventory item's details.
18 properties 4 required
AdminCustomerAddress
object
The customer's address.
18 properties 18 required
BaseProductOptionValue
object
The product option value's details.
9 properties 2 required
AdminOrderLineItem
object
The item's details.
44 properties 39 required
BaseCalculatedPriceSet
object
The calculated price's details.
14 properties 6 required
BaseProductTag
object
The product tag's details.
7 properties 4 required
BaseProductImage
object
The image's details.
7 properties 3 required
AdminPrice
object
The price's details.
11 properties 11 required
AdminCreateGiftCardParams
object
The details of the gift card to create.
9 properties 9 required
AdminInventoryLevel
object
The location level's location levels.
12 properties 11 required
BaseOrderLineItemTaxLine
object
The tax line's tax lines.
12 properties 9 required
AdminSalesChannel
object
The sales channel's details.
8 properties 8 required
AdminProductImage
object
The image's details.
9 properties 3 required
AdminGiftCardResponse
object
The gift card's details.
1 property 1 required
AdminTranslation
object
The translation's details.
8 properties 8 required
BaseProduct
object
The product's details.
31 properties 26 required
AdminGiftCardsResponse
object
The paginated list of gift cards.
5 properties 4 required
AdminUpdateGiftCardParams
object
The details to update in the gift card.
7 properties
AdminProduct
object
The product's details.
34 properties 27 required
AdminCollection
object
The product collection's details.
10 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

medusa-gift-cards-api-openapi.yml Raw ↑

Other APIs Medusa publishes across the network.

Medusa GraphQL API
Medusa MCP Remote Server
Medusa Api Keys API
Medusa Auth API
Medusa [auth Provider] API
Medusa Campaigns API
Medusa Carts API
Medusa Claims API
Medusa Collections API
Medusa Currencies API
Medusa Customer Groups API
Medusa Customers API
Where this information came from

This is an independent, third-party profile of Medusa Gift Cards API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.