asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Updated API Reference (v2) (#9033)

Browse Source 
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>
This commit is contained in:
github-actions[bot]
2024-09-06 12:25:48 +00:00
committed by GitHub
parent 20545b194e
commit cf3c25addf
535 changed files with 3668 additions and 23178 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml
View File

@@ -152,35 +152,6 @@ post:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
security:
- api_token: []
- cookie_auth: []
@@ -191,7 +162,7 @@ post:
schema:
allOf:
- type: object
description: SUMMARY
description: The campaign's details.
required:
- name
- campaign_identifier
@@ -207,14 +178,16 @@ post:
campaign_identifier:
type: string
title: campaign_identifier
description: The campaign's campaign identifier.
description: The campaign's identifier.
description:
type: string
title: description
description: The campaign's description.
budget:
type: object
description: The campaign's budget.
description: >-
The campaign's budget which, when crossed, ends the
campaign.
required:
- type
- limit
@@ -222,42 +195,51 @@ post:
properties:
type:
type: string
title: type
description: >
The budget's type. This can't be edited later. Use
`spend` to set a limit on the total amount discounted by
the campaign's promotions. Use `usage` to set a limit on
the total number of times the campaign's promotions can
be used.
enum:
- spend
- usage
limit:
type: number
title: limit
description: The budget's limit.
description: The campaign budget's limit.
currency_code:
type: string
title: currency_code
description: The budget's currency code.
description: >-
The campaign budget's currency code. This can't be
edited later.
starts_at:
type: string
title: starts_at
description: The campaign's starts at.
description: The campaign's start date.
format: date-time
ends_at:
type: string
title: ends_at
description: The campaign's ends at.
description: The campaign's end date.
format: date-time
promotions:
type: array
description: The campaign's promotions.
items:
type: object
description: The promotion's promotions.
description: The promotions to add to the campaign.
required:
- id
properties:
id:
type: string
title: id
description: The promotion's ID.
description: A promotion's ID.
- type: object
description: SUMMARY
description: The campaign's details.
properties:
additional_data:
type: object
@@ -265,7 +247,7 @@ post:
Pass additional custom data to the API route. This data is
passed to the underlying workflow under the
`additional_data` parameter.
description: SUMMARY
description: The campaign's details.
x-codeSamples:
- lang: Shell
label: cURL