Files
medusa-store/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml
github-actions[bot] 7ac734ca21 chore(docs): Updated API Reference (automated) (#12826)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-06-25 12:18:41 +00:00

72 lines
1.6 KiB
YAML

type: object
description: The promotion's details.
x-schemaName: AdminPromotion
required:
- id
- created_at
- updated_at
- deleted_at
properties:
application_method:
$ref: ./AdminApplicationMethod.yaml
rules:
type: array
description: The promotion's rules.
items:
$ref: ./AdminPromotionRule.yaml
id:
type: string
title: id
description: The promotion's ID.
code:
type: string
title: code
description: The promotion's code.
example: OFF50
type:
type: string
description: The promotion's type.
enum:
- standard
- buyget
is_automatic:
type: boolean
title: is_automatic
description: >-
Whether the promotion is applied on a cart automatically if it matches the
promotion's rules.
campaign_id:
type: string
title: campaign_id
description: The ID of the campaign this promotion belongs to.
campaign:
$ref: ./AdminCampaign.yaml
created_at:
type: string
format: date-time
title: created_at
description: The date the promotion was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the promotion was updated.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The date the promotion was deleted.
status:
type: string
description: The promotion's status.
enum:
- draft
- active
- inactive
is_tax_inclusive:
type: boolean
title: is_tax_inclusive
description: >-
Whether the promotion is tax inclusive. If enabled, the promotion is
applied after tax is calculated.