Files
medusa-store/docs/api/admin/paths/store.yaml
2022-08-05 14:06:12 +02:00

70 lines
2.0 KiB
YAML

get:
operationId: GetStore
summary: Retrieve Store details.
description: Retrieves the Store details
x-authenticated: true
tags:
- Store
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
store:
$ref: ../components/schemas/store.yaml
post:
operationId: PostStore
summary: Update Store details.
description: Updates the Store details
x-authenticated: true
requestBody:
content:
application/json:
schema:
properties:
name:
description: The name of the Store
type: string
swap_link_template:
description: >-
A template for Swap links - use `{{cart_id}}` to insert the Swap
Cart id
type: string
payment_link_template:
description: >-
A template for payment links links - use `{{cart_id}}` to insert
the Cart id
type: string
invite_link_template:
description: >-
A template for invite links - use `{{invite_token}}` to insert
the invite token
type: string
default_currency_code:
description: The default currency code for the Store.
type: string
externalDocs:
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
description: See a list of codes.
currencies:
description: Array of currencies in 2 character ISO code format.
type: array
items:
type: string
metadata:
description: An optional set of key-value pairs with additional information.
type: object
tags:
- Store
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
store:
$ref: ../components/schemas/store.yaml