118 lines
3.4 KiB
YAML
118 lines
3.4 KiB
YAML
get:
|
|
operationId: GetStore
|
|
summary: Get Store details
|
|
description: Retrieves the Store details
|
|
x-authenticated: true
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/store/getundefined
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/store/getundefined
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Store
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
store:
|
|
$ref: ../components/schemas/store.yaml
|
|
'400':
|
|
$ref: ../components/responses/400_error.yaml
|
|
'401':
|
|
$ref: ../components/responses/unauthorized.yaml
|
|
'404':
|
|
$ref: ../components/responses/not_found_error.yaml
|
|
'409':
|
|
$ref: ../components/responses/invalid_state_error.yaml
|
|
'422':
|
|
$ref: ../components/responses/invalid_request_error.yaml
|
|
'500':
|
|
$ref: ../components/responses/500_error.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
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/store/postundefined
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/store/postundefined
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Store
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
store:
|
|
$ref: ../components/schemas/store.yaml
|
|
'400':
|
|
$ref: ../components/responses/400_error.yaml
|
|
'401':
|
|
$ref: ../components/responses/unauthorized.yaml
|
|
'404':
|
|
$ref: ../components/responses/not_found_error.yaml
|
|
'409':
|
|
$ref: ../components/responses/invalid_state_error.yaml
|
|
'422':
|
|
$ref: ../components/responses/invalid_request_error.yaml
|
|
'500':
|
|
$ref: ../components/responses/500_error.yaml
|