daea35fe73
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
1.9 KiB
1.9 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: AdminPostGiftCardsReq
internal.internal.AdminPostGiftCardsReq
Schema
AdminPostGiftCardsReq type: object required:
- region_id
properties:
value:
type: integer
description: The value (excluding VAT) that the Gift Card should represent.
is_disabled:
type: boolean
description: Whether the Gift Card is disabled on creation. If set to
true, the gift card will not be available for customers. ends_at: type: string format: date-time description: The date and time at which the Gift Card should no longer be available. region_id: description: The ID of the Region in which the Gift Card can be used. type: string metadata: description: An optional set of key-value pairs to hold additional information. type: object externalDocs: description: "Learn about the metadata attribute, and how to delete and update it." url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute"
Properties
ends_at
• Optional ends_at: Date
Defined in
packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:92
is_disabled
• Optional is_disabled: boolean
Defined in
packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:93
metadata
• Optional metadata: Record<string, unknown>
Defined in
packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:95
region_id
• region_id: string
Defined in
packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:94
value
• Optional value: number
Defined in
packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:91