chore(docs): Generated API Reference (#3262)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
67f9429293
commit
4fb22e8ba5
@@ -1,10 +1,21 @@
|
||||
title: Store
|
||||
description: Holds settings for the Store, such as name, currencies, etc.
|
||||
type: object
|
||||
required:
|
||||
- created_at
|
||||
- default_currency_code
|
||||
- default_location_id
|
||||
- id
|
||||
- invite_link_template
|
||||
- metadata
|
||||
- name
|
||||
- payment_link_template
|
||||
- swap_link_template
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The store's ID
|
||||
type: string
|
||||
example: store_01G1G5V21KADXNGH29BJMAJ4B4
|
||||
name:
|
||||
description: The name of the Store - this may be displayed to the Customer.
|
||||
@@ -19,6 +30,7 @@ properties:
|
||||
description: See a list of codes.
|
||||
default_currency:
|
||||
description: Available if the relation `default_currency` is expanded.
|
||||
nullable: true
|
||||
$ref: ./Currency.yaml
|
||||
currencies:
|
||||
description: >-
|
||||
@@ -31,29 +43,48 @@ properties:
|
||||
description: >-
|
||||
A template to generate Swap links from. Use {{cart_id}} to include the
|
||||
Swap's `cart_id` in the link.
|
||||
nullable: true
|
||||
type: string
|
||||
example: null
|
||||
payment_link_template:
|
||||
description: >-
|
||||
A template to generate Payment links from. Use {{cart_id}} to include the
|
||||
payment's `cart_id` in the link.
|
||||
nullable: true
|
||||
type: string
|
||||
example: null
|
||||
invite_link_template:
|
||||
description: A template to generate Invite links from
|
||||
nullable: true
|
||||
type: string
|
||||
example: null
|
||||
default_location_id:
|
||||
description: The location ID the store is associated with.
|
||||
nullable: true
|
||||
type: string
|
||||
example: null
|
||||
default_sales_channel_id:
|
||||
type: string
|
||||
description: The sales channel ID the cart is associated with.
|
||||
nullable: true
|
||||
type: string
|
||||
example: null
|
||||
default_sales_channel:
|
||||
description: >-
|
||||
A sales channel object. Available if the relation `default_sales_channel`
|
||||
is expanded.
|
||||
type: object
|
||||
nullable: true
|
||||
$ref: ./SalesChannel.yaml
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
description: The date with timezone at which the resource was updated.
|
||||
type: string
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: An optional key-value map with additional details
|
||||
nullable: true
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
|
||||
Reference in New Issue
Block a user