docs: generate OAS for v2 (#7883)

2024-07-01 15:35:45 +03:00
1 parent 8fde57263f
commit b9036eca1a
@@ -28,12 +28,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -52,12 +58,16 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -65,6 +75,33 @@
 * tags:
 *   - Carts
 * responses:
+ *   "200":
+ *     description: OK
+ *     content:
+ *       application/json:
+ *         schema:
+ *           type: object
+ *           description: SUMMARY
+ *           required:
+ *             - id
+ *             - object
+ *             - deleted
+ *           properties:
+ *             id:
+ *               type: string
+ *               title: id
+ *               description: The cart's ID.
+ *             object:
+ *               type: string
+ *               title: object
+ *               description: The cart's object.
+ *             deleted:
+ *               type: boolean
+ *               title: deleted
+ *               description: The cart's deleted.
+ *             parent:
+ *               type: object
+ *               description: The cart's parent.
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -77,10 +114,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema: {}
 * 
 */

@@ -22,12 +22,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -46,12 +52,16 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -59,6 +69,8 @@
 * tags:
 *   - Carts
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -71,21 +83,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema:
- *         type: object
- *         required:
- *           - promo_codes
- *         properties:
- *           promo_codes:
- *             type: array
- *             description: The cart's promo codes.
- *             items:
- *               type: string
- *               title: promo_codes
- *               description: The promo code's promo codes.
 * 
 */

@@ -4,7 +4,7 @@
 * summary: Remove Addresses from Customer
 * description: Remove a list of addresses from a customer. This doesn't delete the
 *   Address, only the association between the Address and the customer.
- * x-authenticated: false
+ * x-authenticated: true
 * parameters:
 *   - name: address_id
 *     in: path
@@ -22,12 +22,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -46,19 +52,30 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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:
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
- *     source: curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}'
+ *     source: |-
+ *       curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \
+ *       -H 'Authorization: Bearer {access_token}'
 * tags:
 *   - Customers
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -71,10 +88,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema: {}
 * 
 */

@@ -22,12 +22,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -46,12 +52,16 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -59,6 +69,8 @@
 * tags:
 *   - Carts
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -71,10 +83,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema: {}
 * 
 */

@@ -16,12 +16,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -40,12 +46,16 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -53,6 +63,8 @@
 * tags:
 *   - Collections
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -65,10 +77,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema: {}
 * 
 */

@@ -22,12 +22,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -46,12 +52,16 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -59,6 +69,8 @@
 * tags:
 *   - Collections
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -71,10 +83,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema: {}
 * 
 */

@@ -16,12 +16,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -40,12 +46,16 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -53,6 +63,8 @@
 * tags:
 *   - Currencies
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -65,10 +77,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema: {}
 * 
 */

@@ -22,12 +22,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -46,12 +52,16 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -59,6 +69,8 @@
 * tags:
 *   - Currencies
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -71,10 +83,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema: {}
 * 
 */

@@ -4,7 +4,7 @@
 * summary: List Customers
 * description: Retrieve a list of customers. The customers can be filtered by
 *   fields such as `id`. The customers can also be sorted or paginated.
- * x-authenticated: false
+ * x-authenticated: true
 * parameters:
 *   - name: expand
 *     in: query
@@ -16,12 +16,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -40,19 +46,30 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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:
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
- *     source: curl '{backend_url}/store/customers/me'
+ *     source: |-
+ *       curl '{backend_url}/store/customers/me' \
+ *       -H 'Authorization: Bearer {access_token}'
 * tags:
 *   - Customers
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -65,18 +82,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema:
- *         type: object
- *         required:
- *           - fields
- *         properties:
- *           fields:
- *             type: string
- *             title: fields
- *             description: The customer's fields.
 * 
 */

@@ -4,7 +4,7 @@
 * summary: List Customers
 * description: Retrieve a list of customers. The customers can be filtered by
 *   fields such as `id`. The customers can also be sorted or paginated.
- * x-authenticated: false
+ * x-authenticated: true
 * parameters:
 *   - name: expand
 *     in: query
@@ -16,12 +16,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -40,19 +46,141 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
+ *   - name: metadata
+ *     in: query
+ *     description: The customer's metadata.
+ *     required: true
+ *     schema:
+ *       type: object
+ *       description: The customer's metadata.
+ *   - name: first_name
+ *     in: query
+ *     description: The customer's first name.
+ *     required: true
+ *     schema:
+ *       type: string
+ *       title: first_name
+ *       description: The customer's first name.
+ *   - name: last_name
+ *     in: query
+ *     description: The customer's last name.
+ *     required: true
+ *     schema:
+ *       type: string
+ *       title: last_name
+ *       description: The customer's last name.
+ *   - name: phone
+ *     in: query
+ *     description: The customer's phone.
+ *     required: true
+ *     schema:
+ *       type: string
+ *       title: phone
+ *       description: The customer's phone.
+ *   - name: company
+ *     in: query
+ *     description: The customer's company.
+ *     required: true
+ *     schema:
+ *       type: string
+ *       title: company
+ *       description: The customer's company.
+ *   - name: address_1
+ *     in: query
+ *     description: The customer's address 1.
+ *     required: true
+ *     schema:
+ *       type: string
+ *       title: address_1
+ *       description: The customer's address 1.
+ *   - name: address_2
+ *     in: query
+ *     description: The customer's address 2.
+ *     required: true
+ *     schema:
+ *       type: string
+ *       title: address_2
+ *       description: The customer's address 2.
+ *   - name: city
+ *     in: query
+ *     description: The customer's city.
+ *     required: true
+ *     schema:
+ *       type: string
+ *       title: city
+ *       description: The customer's city.
+ *   - name: country_code
+ *     in: query
+ *     description: The customer's country code.
+ *     required: true
+ *     schema:
+ *       type: string
+ *       title: country_code
+ *       description: The customer's country code.
+ *   - name: province
+ *     in: query
+ *     description: The customer's province.
+ *     required: true
+ *     schema:
+ *       type: string
+ *       title: province
+ *       description: The customer's province.
+ *   - name: postal_code
+ *     in: query
+ *     description: The customer's postal code.
+ *     required: true
+ *     schema:
+ *       type: string
+ *       title: postal_code
+ *       description: The customer's postal code.
+ *   - name: address_name
+ *     in: query
+ *     description: The customer's address name.
+ *     required: true
+ *     schema:
+ *       type: string
+ *       title: address_name
+ *       description: The customer's address name.
+ *   - name: is_default_shipping
+ *     in: query
+ *     description: The customer's is default shipping.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: is_default_shipping
+ *       description: The customer's is default shipping.
+ *   - name: is_default_billing
+ *     in: query
+ *     description: The customer's is default billing.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: is_default_billing
+ *       description: The customer's is default billing.
+ * security:
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
- *     source: curl '{backend_url}/store/customers/me/addresses'
+ *     source: |-
+ *       curl '{backend_url}/store/customers/me/addresses' \
+ *       -H 'Authorization: Bearer {access_token}'
 * tags:
 *   - Customers
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -65,83 +193,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema:
- *         type: object
- *         required:
- *           - metadata
- *           - first_name
- *           - last_name
- *           - phone
- *           - company
- *           - address_1
- *           - address_2
- *           - city
- *           - country_code
- *           - province
- *           - postal_code
- *           - address_name
- *           - is_default_shipping
- *           - is_default_billing
- *         properties:
- *           metadata:
- *             type: object
- *             description: The customer's metadata.
- *             properties: {}
- *           first_name:
- *             type: string
- *             title: first_name
- *             description: The customer's first name.
- *           last_name:
- *             type: string
- *             title: last_name
- *             description: The customer's last name.
- *           phone:
- *             type: string
- *             title: phone
- *             description: The customer's phone.
- *           company:
- *             type: string
- *             title: company
- *             description: The customer's company.
- *           address_1:
- *             type: string
- *             title: address_1
- *             description: The customer's address 1.
- *           address_2:
- *             type: string
- *             title: address_2
- *             description: The customer's address 2.
- *           city:
- *             type: string
- *             title: city
- *             description: The customer's city.
- *           country_code:
- *             type: string
- *             title: country_code
- *             description: The customer's country code.
- *           province:
- *             type: string
- *             title: province
- *             description: The customer's province.
- *           postal_code:
- *             type: string
- *             title: postal_code
- *             description: The customer's postal code.
- *           address_name:
- *             type: string
- *             title: address_name
- *             description: The customer's address name.
- *           is_default_shipping:
- *             type: boolean
- *             title: is_default_shipping
- *             description: The customer's is default shipping.
- *           is_default_billing:
- *             type: boolean
- *             title: is_default_billing
- *             description: The customer's is default billing.
 * 
 */

@@ -4,7 +4,7 @@
 * summary: List Addresses
 * description: Retrieve a list of addresses in a customer. The addresses can be
 *   filtered by fields like FILTER FIELDS. The addresses can also be paginated.
- * x-authenticated: false
+ * x-authenticated: true
 * parameters:
 *   - name: address_id
 *     in: path
@@ -22,12 +22,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -46,19 +52,30 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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:
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
- *     source: curl '{backend_url}/store/customers/me/addresses/{address_id}'
+ *     source: |-
+ *       curl '{backend_url}/store/customers/me/addresses/{address_id}' \
+ *       -H 'Authorization: Bearer {access_token}'
 * tags:
 *   - Customers
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -71,18 +88,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema:
- *         type: object
- *         required:
- *           - fields
- *         properties:
- *           fields:
- *             type: string
- *             title: fields
- *             description: The customer's fields.
 * 
 */

@@ -0,0 +1,118 @@
+/**
+ * @oas [get] /store/orders
+ * operationId: GetOrders
+ * summary: List Orders
+ * description: Retrieve a list of orders. The orders can be filtered by fields
+ *   such as `id`. The orders can also be sorted or paginated.
+ * x-authenticated: false
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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
+ *         `-`.
+ *   - name: id
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: id
+ *           description: The order's ID.
+ *         - type: array
+ *           description: The order's ID.
+ *           items:
+ *             type: string
+ *             title: id
+ *             description: The id's ID.
+ *   - name: name
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: name
+ *           description: The order's name.
+ *         - type: array
+ *           description: The order's name.
+ *           items:
+ *             type: string
+ *             title: name
+ *             description: The name's details.
+ *   - name: $and
+ *     in: query
+ *     required: false
+ *     schema: {}
+ *   - name: $or
+ *     in: query
+ *     required: false
+ *     schema: {}
+ * x-codeSamples:
+ *   - lang: Shell
+ *     label: cURL
+ *     source: curl '{backend_url}/store/orders'
+ * tags:
+ *   - Orders
+ * responses:
+ *   "200":
+ *     description: OK
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ * 
+*/
+
@@ -0,0 +1,124 @@
+/**
+ * @oas [get] /store/orders/{id}
+ * operationId: GetOrdersId
+ * summary: Get a Order
+ * description: Retrieve a order by its ID. You can expand the order's relations or
+ *   select the fields that should be returned.
+ * x-authenticated: false
+ * parameters:
+ *   - name: id
+ *     in: path
+ *     description: The order's ID.
+ *     required: true
+ *     schema:
+ *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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
+ *         `-`.
+ *   - name: id
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: id
+ *           description: The order's ID.
+ *         - type: array
+ *           description: The order's ID.
+ *           items:
+ *             type: string
+ *             title: id
+ *             description: The id's ID.
+ *   - name: status
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: status
+ *           description: The order's status.
+ *         - type: array
+ *           description: The order's status.
+ *           items:
+ *             type: string
+ *             title: status
+ *             description: The status's details.
+ *   - name: $and
+ *     in: query
+ *     required: false
+ *     schema: {}
+ *   - name: $or
+ *     in: query
+ *     required: false
+ *     schema: {}
+ * x-codeSamples:
+ *   - lang: Shell
+ *     label: cURL
+ *     source: curl '{backend_url}/store/orders/{id}'
+ * tags:
+ *   - Orders
+ * responses:
+ *   "200":
+ *     description: OK
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ * 
+*/
+
@@ -0,0 +1,121 @@
+/**
+ * @oas [get] /store/payment-providers
+ * operationId: GetPaymentProviders
+ * summary: List Payment Providers
+ * description: Retrieve a list of payment providers. The payment providers can be
+ *   filtered by fields such as `id`. The payment providers can also be sorted or
+ *   paginated.
+ * x-authenticated: false
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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
+ *         `-`.
+ *   - name: region_id
+ *     in: query
+ *     description: The payment provider's region id.
+ *     required: true
+ *     schema:
+ *       type: string
+ *       title: region_id
+ *       description: The payment provider's region id.
+ *   - name: id
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: id
+ *           description: The payment provider's ID.
+ *         - type: array
+ *           description: The payment provider's ID.
+ *           items:
+ *             type: string
+ *             title: id
+ *             description: The id's ID.
+ *   - name: is_enabled
+ *     in: query
+ *     description: The payment provider's is enabled.
+ *     required: false
+ *     schema:
+ *       type: boolean
+ *       title: is_enabled
+ *       description: The payment provider's is enabled.
+ *   - name: $and
+ *     in: query
+ *     required: false
+ *     schema: {}
+ *   - name: $or
+ *     in: query
+ *     required: false
+ *     schema: {}
+ * x-codeSamples:
+ *   - lang: Shell
+ *     label: cURL
+ *     source: curl '{backend_url}/store/payment-providers'
+ * tags:
+ *   - Payment Providers
+ * responses:
+ *   "200":
+ *     description: OK
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ * 
+*/
+
@@ -17,12 +17,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -41,12 +47,203 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
+ *   - name: q
+ *     in: query
+ *     description: The product category's q.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: q
+ *       description: The product category's q.
+ *   - name: id
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: id
+ *           description: The product category's ID.
+ *         - type: array
+ *           description: The product category's ID.
+ *           items:
+ *             type: string
+ *             title: id
+ *             description: The id's ID.
+ *   - name: description
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: description
+ *           description: The product category's description.
+ *         - type: array
+ *           description: The product category's description.
+ *           items:
+ *             type: string
+ *             title: description
+ *             description: The description's details.
+ *   - name: handle
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: handle
+ *           description: The product category's handle.
+ *         - type: array
+ *           description: The product category's handle.
+ *           items:
+ *             type: string
+ *             title: handle
+ *             description: The handle's details.
+ *   - name: parent_category_id
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: parent_category_id
+ *           description: The product category's parent category id.
+ *         - type: array
+ *           description: The product category's parent category id.
+ *           items:
+ *             type: string
+ *             title: parent_category_id
+ *             description: The parent category id's details.
+ *   - name: include_ancestors_tree
+ *     in: query
+ *     description: The product category's include ancestors tree.
+ *     required: true
+ *     schema:
+ *       type: boolean
+ *       title: include_ancestors_tree
+ *       description: The product category's include ancestors tree.
+ *   - name: include_descendants_tree
+ *     in: query
+ *     description: The product category's include descendants tree.
+ *     required: true
+ *     schema:
+ *       type: boolean
+ *       title: include_descendants_tree
+ *       description: The product category's include descendants tree.
+ *   - name: created_at
+ *     in: query
+ *     description: The product category's created at.
+ *     required: false
+ *     schema:
+ *       type: object
+ *       description: The product category's created at.
+ *       required:
+ *         - $eq
+ *         - $ne
+ *         - $in
+ *         - $nin
+ *         - $like
+ *         - $ilike
+ *         - $re
+ *         - $contains
+ *         - $gt
+ *         - $gte
+ *         - $lt
+ *         - $lte
+ *       properties:
+ *         $eq: {}
+ *         $ne: {}
+ *         $in: {}
+ *         $nin: {}
+ *         $like: {}
+ *         $ilike: {}
+ *         $re: {}
+ *         $contains: {}
+ *         $gt: {}
+ *         $gte: {}
+ *         $lt: {}
+ *         $lte: {}
+ *   - name: updated_at
+ *     in: query
+ *     description: The product category's updated at.
+ *     required: false
+ *     schema:
+ *       type: object
+ *       description: The product category's updated at.
+ *       required:
+ *         - $eq
+ *         - $ne
+ *         - $in
+ *         - $nin
+ *         - $like
+ *         - $ilike
+ *         - $re
+ *         - $contains
+ *         - $gt
+ *         - $gte
+ *         - $lt
+ *         - $lte
+ *       properties:
+ *         $eq: {}
+ *         $ne: {}
+ *         $in: {}
+ *         $nin: {}
+ *         $like: {}
+ *         $ilike: {}
+ *         $re: {}
+ *         $contains: {}
+ *         $gt: {}
+ *         $gte: {}
+ *         $lt: {}
+ *         $lte: {}
+ *   - name: deleted_at
+ *     in: query
+ *     description: The product category's deleted at.
+ *     required: false
+ *     schema:
+ *       type: object
+ *       description: The product category's deleted at.
+ *       required:
+ *         - $eq
+ *         - $ne
+ *         - $in
+ *         - $nin
+ *         - $like
+ *         - $ilike
+ *         - $re
+ *         - $contains
+ *         - $gt
+ *         - $gte
+ *         - $lt
+ *         - $lte
+ *       properties:
+ *         $eq: {}
+ *         $ne: {}
+ *         $in: {}
+ *         $nin: {}
+ *         $like: {}
+ *         $ilike: {}
+ *         $re: {}
+ *         $contains: {}
+ *         $gt: {}
+ *         $gte: {}
+ *         $lt: {}
+ *         $lte: {}
+ *   - name: $and
+ *     in: query
+ *     required: false
+ *     schema: {}
+ *   - name: $or
+ *     in: query
+ *     required: false
+ *     schema: {}
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -72,10 +269,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema: {}
 * 
 */

@@ -22,12 +22,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -46,46 +52,36 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
- * requestBody:
- *   content:
- *     application/json:
- *       schema:
- *         type: object
- *         description: SUMMARY
- *         required:
- *           - fields
- *           - include_ancestors_tree
- *           - include_descendants_tree
- *         properties:
- *           fields:
- *             type: string
- *             title: fields
- *             description: The product category's fields.
- *           include_ancestors_tree:
- *             type: boolean
- *             title: include_ancestors_tree
- *             description: The product category's include ancestors tree.
- *           include_descendants_tree:
- *             type: boolean
- *             title: include_descendants_tree
- *             description: The product category's include descendants tree.
+ *       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
+ *         `-`.
+ *   - name: include_ancestors_tree
+ *     in: query
+ *     description: The product category's include ancestors tree.
+ *     required: true
+ *     schema:
+ *       type: boolean
+ *       title: include_ancestors_tree
+ *       description: The product category's include ancestors tree.
+ *   - name: include_descendants_tree
+ *     in: query
+ *     description: The product category's include descendants tree.
+ *     required: true
+ *     schema:
+ *       type: boolean
+ *       title: include_descendants_tree
+ *       description: The product category's include descendants tree.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
- *     source: |-
- *       curl '{backend_url}/store/product-categories/{id}' \
- *       -H 'Content-Type: application/json' \
- *       --data-raw '{
- *         "fields": "{value}",
- *         "include_ancestors_tree": true,
- *         "include_descendants_tree": false
- *       }'
+ *     source: curl '{backend_url}/store/product-categories/{id}'
 * tags:
 *   - Product Categories
 * responses:
@@ -16,12 +16,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -40,12 +46,275 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
+ *   - name: currency_code
+ *     in: query
+ *     description: The product's currency code.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: currency_code
+ *       description: The product's currency code.
+ *   - name: region_id
+ *     in: query
+ *     description: The product's region id.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: region_id
+ *       description: The product's region id.
+ *   - name: $and
+ *     in: query
+ *     required: false
+ *     schema: {}
+ *   - name: $or
+ *     in: query
+ *     required: false
+ *     schema: {}
+ *   - name: variants
+ *     in: query
+ *     description: The product's variants.
+ *     required: false
+ *     schema:
+ *       type: object
+ *       description: The product's variants.
+ *       properties:
+ *         status:
+ *           type: array
+ *           description: The variant's status.
+ *           items:
+ *             type: string
+ *             enum:
+ *               - draft
+ *               - proposed
+ *               - published
+ *               - rejected
+ *         options:
+ *           type: object
+ *           description: The variant's options.
+ *           required:
+ *             - value
+ *             - option_id
+ *           properties:
+ *             value:
+ *               type: string
+ *               title: value
+ *               description: The option's value.
+ *             option_id:
+ *               type: string
+ *               title: option_id
+ *               description: The option's option id.
+ *         $and: {}
+ *         $or: {}
+ *   - name: q
+ *     in: query
+ *     description: The product's q.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: q
+ *       description: The product's q.
+ *   - name: id
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: id
+ *           description: The product's ID.
+ *         - type: array
+ *           description: The product's ID.
+ *           items:
+ *             type: string
+ *             title: id
+ *             description: The id's ID.
+ *   - name: title
+ *     in: query
+ *     description: The product's title.
+ *     required: true
+ *     schema:
+ *       type: string
+ *       title: title
+ *       description: The product's title.
+ *   - name: handle
+ *     in: query
+ *     description: The product's handle.
+ *     required: true
+ *     schema:
+ *       type: string
+ *       title: handle
+ *       description: The product's handle.
+ *   - name: is_giftcard
+ *     in: query
+ *     description: The product's is giftcard.
+ *     required: true
+ *     schema:
+ *       type: boolean
+ *       title: is_giftcard
+ *       description: The product's is giftcard.
+ *   - name: category_id
+ *     in: query
+ *     description: The product's category id.
+ *     required: true
+ *     schema:
+ *       type: array
+ *       description: The product's category id.
+ *       items:
+ *         type: string
+ *         title: category_id
+ *         description: The category id's details.
+ *   - name: sales_channel_id
+ *     in: query
+ *     description: The product's sales channel id.
+ *     required: true
+ *     schema:
+ *       type: array
+ *       description: The product's sales channel id.
+ *       items:
+ *         type: string
+ *         title: sales_channel_id
+ *         description: The sales channel id's details.
+ *   - name: collection_id
+ *     in: query
+ *     description: The product's collection id.
+ *     required: true
+ *     schema:
+ *       type: array
+ *       description: The product's collection id.
+ *       items:
+ *         type: string
+ *         title: collection_id
+ *         description: The collection id's details.
+ *   - name: tags
+ *     in: query
+ *     description: The product's tags.
+ *     required: false
+ *     schema:
+ *       type: array
+ *       description: The product's tags.
+ *       items:
+ *         type: string
+ *         title: tags
+ *         description: The tag's tags.
+ *   - name: type_id
+ *     in: query
+ *     description: The product's type id.
+ *     required: false
+ *     schema:
+ *       type: array
+ *       description: The product's type id.
+ *       items:
+ *         type: string
+ *         title: type_id
+ *         description: The type id's details.
+ *   - name: created_at
+ *     in: query
+ *     description: The product's created at.
+ *     required: false
+ *     schema:
+ *       type: object
+ *       description: The product's created at.
+ *       required:
+ *         - $eq
+ *         - $ne
+ *         - $in
+ *         - $nin
+ *         - $like
+ *         - $ilike
+ *         - $re
+ *         - $contains
+ *         - $gt
+ *         - $gte
+ *         - $lt
+ *         - $lte
+ *       properties:
+ *         $eq: {}
+ *         $ne: {}
+ *         $in: {}
+ *         $nin: {}
+ *         $like: {}
+ *         $ilike: {}
+ *         $re: {}
+ *         $contains: {}
+ *         $gt: {}
+ *         $gte: {}
+ *         $lt: {}
+ *         $lte: {}
+ *   - name: updated_at
+ *     in: query
+ *     description: The product's updated at.
+ *     required: false
+ *     schema:
+ *       type: object
+ *       description: The product's updated at.
+ *       required:
+ *         - $eq
+ *         - $ne
+ *         - $in
+ *         - $nin
+ *         - $like
+ *         - $ilike
+ *         - $re
+ *         - $contains
+ *         - $gt
+ *         - $gte
+ *         - $lt
+ *         - $lte
+ *       properties:
+ *         $eq: {}
+ *         $ne: {}
+ *         $in: {}
+ *         $nin: {}
+ *         $like: {}
+ *         $ilike: {}
+ *         $re: {}
+ *         $contains: {}
+ *         $gt: {}
+ *         $gte: {}
+ *         $lt: {}
+ *         $lte: {}
+ *   - name: deleted_at
+ *     in: query
+ *     description: The product's deleted at.
+ *     required: false
+ *     schema:
+ *       type: object
+ *       description: The product's deleted at.
+ *       required:
+ *         - $eq
+ *         - $ne
+ *         - $in
+ *         - $nin
+ *         - $like
+ *         - $ilike
+ *         - $re
+ *         - $contains
+ *         - $gt
+ *         - $gte
+ *         - $lt
+ *         - $lte
+ *       properties:
+ *         $eq: {}
+ *         $ne: {}
+ *         $in: {}
+ *         $nin: {}
+ *         $like: {}
+ *         $ilike: {}
+ *         $re: {}
+ *         $contains: {}
+ *         $gt: {}
+ *         $gte: {}
+ *         $lt: {}
+ *         $lte: {}
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -53,6 +322,8 @@
 * tags:
 *   - Products
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -65,10 +336,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema: {}
 * 
 */

@@ -22,12 +22,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -46,12 +52,275 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
+ *   - name: currency_code
+ *     in: query
+ *     description: The product's currency code.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: currency_code
+ *       description: The product's currency code.
+ *   - name: region_id
+ *     in: query
+ *     description: The product's region id.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: region_id
+ *       description: The product's region id.
+ *   - name: $and
+ *     in: query
+ *     required: false
+ *     schema: {}
+ *   - name: $or
+ *     in: query
+ *     required: false
+ *     schema: {}
+ *   - name: variants
+ *     in: query
+ *     description: The product's variants.
+ *     required: false
+ *     schema:
+ *       type: object
+ *       description: The product's variants.
+ *       properties:
+ *         status:
+ *           type: array
+ *           description: The variant's status.
+ *           items:
+ *             type: string
+ *             enum:
+ *               - draft
+ *               - proposed
+ *               - published
+ *               - rejected
+ *         options:
+ *           type: object
+ *           description: The variant's options.
+ *           required:
+ *             - value
+ *             - option_id
+ *           properties:
+ *             value:
+ *               type: string
+ *               title: value
+ *               description: The option's value.
+ *             option_id:
+ *               type: string
+ *               title: option_id
+ *               description: The option's option id.
+ *         $and: {}
+ *         $or: {}
+ *   - name: q
+ *     in: query
+ *     description: The product's q.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: q
+ *       description: The product's q.
+ *   - name: id
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: id
+ *           description: The product's ID.
+ *         - type: array
+ *           description: The product's ID.
+ *           items:
+ *             type: string
+ *             title: id
+ *             description: The id's ID.
+ *   - name: title
+ *     in: query
+ *     description: The product's title.
+ *     required: true
+ *     schema:
+ *       type: string
+ *       title: title
+ *       description: The product's title.
+ *   - name: handle
+ *     in: query
+ *     description: The product's handle.
+ *     required: true
+ *     schema:
+ *       type: string
+ *       title: handle
+ *       description: The product's handle.
+ *   - name: is_giftcard
+ *     in: query
+ *     description: The product's is giftcard.
+ *     required: true
+ *     schema:
+ *       type: boolean
+ *       title: is_giftcard
+ *       description: The product's is giftcard.
+ *   - name: category_id
+ *     in: query
+ *     description: The product's category id.
+ *     required: true
+ *     schema:
+ *       type: array
+ *       description: The product's category id.
+ *       items:
+ *         type: string
+ *         title: category_id
+ *         description: The category id's details.
+ *   - name: sales_channel_id
+ *     in: query
+ *     description: The product's sales channel id.
+ *     required: true
+ *     schema:
+ *       type: array
+ *       description: The product's sales channel id.
+ *       items:
+ *         type: string
+ *         title: sales_channel_id
+ *         description: The sales channel id's details.
+ *   - name: collection_id
+ *     in: query
+ *     description: The product's collection id.
+ *     required: true
+ *     schema:
+ *       type: array
+ *       description: The product's collection id.
+ *       items:
+ *         type: string
+ *         title: collection_id
+ *         description: The collection id's details.
+ *   - name: tags
+ *     in: query
+ *     description: The product's tags.
+ *     required: false
+ *     schema:
+ *       type: array
+ *       description: The product's tags.
+ *       items:
+ *         type: string
+ *         title: tags
+ *         description: The tag's tags.
+ *   - name: type_id
+ *     in: query
+ *     description: The product's type id.
+ *     required: false
+ *     schema:
+ *       type: array
+ *       description: The product's type id.
+ *       items:
+ *         type: string
+ *         title: type_id
+ *         description: The type id's details.
+ *   - name: created_at
+ *     in: query
+ *     description: The product's created at.
+ *     required: false
+ *     schema:
+ *       type: object
+ *       description: The product's created at.
+ *       required:
+ *         - $eq
+ *         - $ne
+ *         - $in
+ *         - $nin
+ *         - $like
+ *         - $ilike
+ *         - $re
+ *         - $contains
+ *         - $gt
+ *         - $gte
+ *         - $lt
+ *         - $lte
+ *       properties:
+ *         $eq: {}
+ *         $ne: {}
+ *         $in: {}
+ *         $nin: {}
+ *         $like: {}
+ *         $ilike: {}
+ *         $re: {}
+ *         $contains: {}
+ *         $gt: {}
+ *         $gte: {}
+ *         $lt: {}
+ *         $lte: {}
+ *   - name: updated_at
+ *     in: query
+ *     description: The product's updated at.
+ *     required: false
+ *     schema:
+ *       type: object
+ *       description: The product's updated at.
+ *       required:
+ *         - $eq
+ *         - $ne
+ *         - $in
+ *         - $nin
+ *         - $like
+ *         - $ilike
+ *         - $re
+ *         - $contains
+ *         - $gt
+ *         - $gte
+ *         - $lt
+ *         - $lte
+ *       properties:
+ *         $eq: {}
+ *         $ne: {}
+ *         $in: {}
+ *         $nin: {}
+ *         $like: {}
+ *         $ilike: {}
+ *         $re: {}
+ *         $contains: {}
+ *         $gt: {}
+ *         $gte: {}
+ *         $lt: {}
+ *         $lte: {}
+ *   - name: deleted_at
+ *     in: query
+ *     description: The product's deleted at.
+ *     required: false
+ *     schema:
+ *       type: object
+ *       description: The product's deleted at.
+ *       required:
+ *         - $eq
+ *         - $ne
+ *         - $in
+ *         - $nin
+ *         - $like
+ *         - $ilike
+ *         - $re
+ *         - $contains
+ *         - $gt
+ *         - $gte
+ *         - $lt
+ *         - $lte
+ *       properties:
+ *         $eq: {}
+ *         $ne: {}
+ *         $in: {}
+ *         $nin: {}
+ *         $like: {}
+ *         $ilike: {}
+ *         $re: {}
+ *         $contains: {}
+ *         $gt: {}
+ *         $gte: {}
+ *         $lt: {}
+ *         $lte: {}
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -59,6 +328,8 @@
 * tags:
 *   - Products
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -71,10 +342,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema: {}
 * 
 */

@@ -16,12 +16,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -40,12 +46,16 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -53,6 +63,8 @@
 * tags:
 *   - Regions
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -65,10 +77,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema: {}
 * 
 */

@@ -22,12 +22,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -46,12 +52,16 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -59,6 +69,8 @@
 * tags:
 *   - Regions
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -71,10 +83,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema: {}
 * 
 */

@@ -0,0 +1,83 @@
+/**
+ * @oas [get] /store/return-reasons
+ * operationId: GetReturnReasons
+ * summary: List Return Reasons
+ * description: Retrieve a list of return reasons. The return reasons can be
+ *   filtered by fields such as `id`. The return reasons can also be sorted or
+ *   paginated.
+ * x-authenticated: false
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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
+ *         `-`.
+ * x-codeSamples:
+ *   - lang: Shell
+ *     label: cURL
+ *     source: curl '{backend_url}/store/return-reasons'
+ * tags:
+ *   - Return Reasons
+ * responses:
+ *   "200":
+ *     description: OK
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ * 
+*/
+
@@ -0,0 +1,88 @@
+/**
+ * @oas [get] /store/return-reasons/{id}
+ * operationId: GetReturnReasonsId
+ * summary: Get a Return Reason
+ * description: Retrieve a return reason by its ID. You can expand the return
+ *   reason's relations or select the fields that should be returned.
+ * x-authenticated: false
+ * parameters:
+ *   - name: id
+ *     in: path
+ *     description: The return reason's ID.
+ *     required: true
+ *     schema:
+ *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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
+ *         `-`.
+ * x-codeSamples:
+ *   - lang: Shell
+ *     label: cURL
+ *     source: curl '{backend_url}/store/return-reasons/{id}'
+ * tags:
+ *   - Return Reasons
+ * responses:
+ *   "200":
+ *     description: OK
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ * 
+*/
+
@@ -1,17 +1,12 @@
 /**
- * @oas [get] /store/shipping-options/{cart_id}
- * operationId: GetShippingOptionsCart_id
- * summary: Get a Shipping Option
- * description: Retrieve a shipping option by its ID. You can expand the shipping
- *   option's relations or select the fields that should be returned.
+ * @oas [get] /store/shipping-options
+ * operationId: GetShippingOptions
+ * summary: List Shipping Options
+ * description: Retrieve a list of shipping options. The shipping options can be
+ *   filtered by fields such as `id`. The shipping options can also be sorted or
+ *   paginated.
 * x-authenticated: false
 * parameters:
- *   - name: cart_id
- *     in: path
- *     description: The shipping option's cart id.
- *     required: true
- *     schema:
- *       type: string
 *   - name: expand
 *     in: query
 *     description: Comma-separated relations that should be expanded in the returned data.
@@ -22,12 +17,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -46,19 +47,25 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
- *     source: curl '{backend_url}/store/shipping-options/{cart_id}'
+ *     source: curl '{backend_url}/store/shipping-options'
 * tags:
 *   - Shipping Options
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -71,10 +78,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema: {}
 * 
 */

@@ -15,12 +15,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -39,12 +45,16 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
 * requestBody:
 *   content:
 *     application/json:
@@ -57,6 +67,8 @@
 * tags:
 *   - Carts
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -21,12 +21,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -45,12 +51,16 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
 * requestBody:
 *   content:
 *     application/json:
@@ -63,6 +73,8 @@
 * tags:
 *   - Carts
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -21,12 +21,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -45,20 +51,22 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
 * requestBody:
 *   content:
 *     application/json:
 *       schema:
 *         type: object
 *         description: SUMMARY
- *         required:
- *           - idempotency_key
 *         properties:
 *           idempotency_key:
 *             type: string
@@ -67,15 +75,12 @@
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
- *     source: |-
- *       curl -X POST '{backend_url}/store/carts/{id}/complete' \
- *       -H 'Content-Type: application/json' \
- *       --data-raw '{
- *         "idempotency_key": "{value}"
- *       }'
+ *     source: curl -X POST '{backend_url}/store/carts/{id}/complete'
 * tags:
 *   - Carts
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -21,12 +21,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -45,19 +51,37 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/StoreAddCartLineItem"
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
- *     source: curl -X POST '{backend_url}/store/carts/{id}/line-items'
+ *     source: |-
+ *       curl -X POST '{backend_url}/store/carts/{id}/line-items' \
+ *       -H 'Content-Type: application/json' \
+ *       --data-raw '{
+ *         "variant_id": "{value}",
+ *         "quantity": 3360689747918848,
+ *         "metadata": {}
+ *       }'
 * tags:
 *   - Carts
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -70,28 +94,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema:
- *         type: object
- *         required:
- *           - variant_id
- *           - quantity
- *           - metadata
- *         properties:
- *           variant_id:
- *             type: string
- *             title: variant_id
- *             description: The cart's variant id.
- *           quantity:
- *             type: number
- *             title: quantity
- *             description: The cart's quantity.
- *           metadata:
- *             type: object
- *             description: The cart's metadata.
- *             properties: {}
 * 
 */

@@ -27,12 +27,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -51,19 +57,36 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/StoreUpdateCartLineItem"
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
- *     source: curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}'
+ *     source: |-
+ *       curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' \
+ *       -H 'Content-Type: application/json' \
+ *       --data-raw '{
+ *         "quantity": 8980402259623936,
+ *         "metadata": {}
+ *       }'
 * tags:
 *   - Carts
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -76,23 +99,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema:
- *         type: object
- *         required:
- *           - quantity
- *           - metadata
- *         properties:
- *           quantity:
- *             type: number
- *             title: quantity
- *             description: The cart's quantity.
- *           metadata:
- *             type: object
- *             description: The cart's metadata.
- *             properties: {}
 * 
 */

@@ -1,253 +0,0 @@
-/**
- * @oas [post] /store/carts/{id}/payment-collections
- * operationId: PostCartsIdPaymentCollections
- * summary: Add Payment Collections to Cart
- * description: Add a list of payment collections to a cart.
- * x-authenticated: false
- * parameters:
- *   - name: id
- *     in: path
- *     description: The cart's ID.
- *     required: true
- *     schema:
- *       type: string
- *   - name: expand
- *     in: query
- *     description: Comma-separated relations that should be expanded in the returned data.
- *     required: false
- *     schema:
- *       type: string
- *       title: expand
- *       description: Comma-separated relations that should be expanded in the returned data.
- *   - name: fields
- *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
- *     required: false
- *     schema:
- *       type: string
- *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
- *   - 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: Field to sort items in the list by.
- *     required: false
- *     schema:
- *       type: string
- *       title: order
- *       description: Field to sort items in the list by.
- * requestBody:
- *   content:
- *     application/json:
- *       schema:
- *         type: object
- *         description: SUMMARY
- *         required:
- *           - region_id
- *           - email
- *           - billing_address
- *           - shipping_address
- *           - sales_channel_id
- *           - metadata
- *           - promo_codes
- *         properties:
- *           region_id:
- *             type: string
- *             title: region_id
- *             description: The cart's region id.
- *           email:
- *             type: string
- *             title: email
- *             description: The cart's email.
- *             format: email
- *           billing_address:
- *             oneOf:
- *               - type: string
- *                 title: billing_address
- *                 description: The cart's billing address.
- *               - type: object
- *                 description: The cart's billing address.
- *                 required:
- *                   - first_name
- *                   - last_name
- *                   - phone
- *                   - company
- *                   - address_1
- *                   - address_2
- *                   - city
- *                   - country_code
- *                   - province
- *                   - postal_code
- *                   - metadata
- *                 properties:
- *                   first_name:
- *                     type: string
- *                     title: first_name
- *                     description: The billing address's first name.
- *                   last_name:
- *                     type: string
- *                     title: last_name
- *                     description: The billing address's last name.
- *                   phone:
- *                     type: string
- *                     title: phone
- *                     description: The billing address's phone.
- *                   company:
- *                     type: string
- *                     title: company
- *                     description: The billing address's company.
- *                   address_1:
- *                     type: string
- *                     title: address_1
- *                     description: The billing address's address 1.
- *                   address_2:
- *                     type: string
- *                     title: address_2
- *                     description: The billing address's address 2.
- *                   city:
- *                     type: string
- *                     title: city
- *                     description: The billing address's city.
- *                   country_code:
- *                     type: string
- *                     title: country_code
- *                     description: The billing address's country code.
- *                   province:
- *                     type: string
- *                     title: province
- *                     description: The billing address's province.
- *                   postal_code:
- *                     type: string
- *                     title: postal_code
- *                     description: The billing address's postal code.
- *                   metadata:
- *                     type: object
- *                     description: The billing address's metadata.
- *                     properties: {}
- *           shipping_address:
- *             oneOf:
- *               - type: string
- *                 title: shipping_address
- *                 description: The cart's shipping address.
- *               - type: object
- *                 description: The cart's shipping address.
- *                 required:
- *                   - first_name
- *                   - last_name
- *                   - phone
- *                   - company
- *                   - address_1
- *                   - address_2
- *                   - city
- *                   - country_code
- *                   - province
- *                   - postal_code
- *                   - metadata
- *                 properties:
- *                   first_name:
- *                     type: string
- *                     title: first_name
- *                     description: The shipping address's first name.
- *                   last_name:
- *                     type: string
- *                     title: last_name
- *                     description: The shipping address's last name.
- *                   phone:
- *                     type: string
- *                     title: phone
- *                     description: The shipping address's phone.
- *                   company:
- *                     type: string
- *                     title: company
- *                     description: The shipping address's company.
- *                   address_1:
- *                     type: string
- *                     title: address_1
- *                     description: The shipping address's address 1.
- *                   address_2:
- *                     type: string
- *                     title: address_2
- *                     description: The shipping address's address 2.
- *                   city:
- *                     type: string
- *                     title: city
- *                     description: The shipping address's city.
- *                   country_code:
- *                     type: string
- *                     title: country_code
- *                     description: The shipping address's country code.
- *                   province:
- *                     type: string
- *                     title: province
- *                     description: The shipping address's province.
- *                   postal_code:
- *                     type: string
- *                     title: postal_code
- *                     description: The shipping address's postal code.
- *                   metadata:
- *                     type: object
- *                     description: The shipping address's metadata.
- *                     properties: {}
- *           sales_channel_id:
- *             type: string
- *             title: sales_channel_id
- *             description: The cart's sales channel id.
- *           metadata:
- *             type: object
- *             description: The cart's metadata.
- *             properties: {}
- *           promo_codes:
- *             type: array
- *             description: The cart's promo codes.
- *             items:
- *               type: string
- *               title: promo_codes
- *               description: The promo code's promo codes.
- * x-codeSamples:
- *   - lang: Shell
- *     label: cURL
- *     source: |-
- *       curl -X POST '{backend_url}/store/carts/{id}/payment-collections' \
- *       -H 'Content-Type: application/json' \
- *       --data-raw '{
- *         "region_id": "{value}",
- *         "email": "Greyson3@gmail.com",
- *         "sales_channel_id": "{value}",
- *         "metadata": {},
- *         "promo_codes": [
- *           "{value}"
- *         ]
- *       }'
- * tags:
- *   - Carts
- * responses:
- *   "400":
- *     $ref: "#/components/responses/400_error"
- *   "401":
- *     $ref: "#/components/responses/unauthorized"
- *   "404":
- *     $ref: "#/components/responses/not_found_error"
- *   "409":
- *     $ref: "#/components/responses/invalid_state_error"
- *   "422":
- *     $ref: "#/components/responses/invalid_request_error"
- *   "500":
- *     $ref: "#/components/responses/500_error"
- * 
-*/
-
@@ -21,12 +21,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -45,19 +51,48 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         type: object
+ *         description: SUMMARY
+ *         required:
+ *           - promo_codes
+ *         properties:
+ *           promo_codes:
+ *             type: array
+ *             description: The cart's promo codes.
+ *             items:
+ *               type: string
+ *               title: promo_codes
+ *               description: The promo code's promo codes.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
- *     source: curl -X POST '{backend_url}/store/carts/{id}/promotions'
+ *     source: |-
+ *       curl -X POST '{backend_url}/store/carts/{id}/promotions' \
+ *       -H 'Content-Type: application/json' \
+ *       --data-raw '{
+ *         "promo_codes": [
+ *           "{value}"
+ *         ]
+ *       }'
 * tags:
 *   - Carts
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -70,21 +105,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema:
- *         type: object
- *         required:
- *           - promo_codes
- *         properties:
- *           promo_codes:
- *             type: array
- *             description: The cart's promo codes.
- *             items:
- *               type: string
- *               title: promo_codes
- *               description: The promo code's promo codes.
 * 
 */

@@ -21,12 +21,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -45,12 +51,16 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
 * requestBody:
 *   content:
 *     application/json:
@@ -59,7 +69,6 @@
 *         description: SUMMARY
 *         required:
 *           - option_id
- *           - data
 *         properties:
 *           option_id:
 *             type: string
@@ -68,7 +77,6 @@
 *           data:
 *             type: object
 *             description: The cart's data.
- *             properties: {}
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -76,12 +84,13 @@
 *       curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \
 *       -H 'Content-Type: application/json' \
 *       --data-raw '{
- *         "option_id": "{value}",
- *         "data": {}
+ *         "option_id": "{value}"
 *       }'
 * tags:
 *   - Carts
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -21,12 +21,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -45,25 +51,21 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
 * requestBody:
 *   content:
 *     application/json:
 *       schema:
- *         type: object
- *         description: SUMMARY
- *         properties:
- *           fields:
- *             type: string
- *             title: fields
- *             description: The cart's fields.
- *         required:
- *           - fields
+ *         $ref: "#/components/schemas/StoreCalculateCartTaxes"
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -71,6 +73,8 @@
 * tags:
 *   - Carts
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -15,12 +15,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -39,19 +45,39 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/StoreCreateCustomer"
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
- *     source: curl -X POST '{backend_url}/store/customers'
+ *     source: |-
+ *       curl -X POST '{backend_url}/store/customers' \
+ *       -H 'Content-Type: application/json' \
+ *       --data-raw '{
+ *         "email": "Monserrate.Leannon88@yahoo.com",
+ *         "company_name": "{value}",
+ *         "first_name": "{value}",
+ *         "last_name": "{value}",
+ *         "phone": "{value}"
+ *       }'
 * tags:
 *   - Customers
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -64,39 +90,6 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * requestBody:
- *   content:
- *     application/json:
- *       schema:
- *         type: object
- *         required:
- *           - email
- *           - company_name
- *           - first_name
- *           - last_name
- *           - phone
- *         properties:
- *           email:
- *             type: string
- *             title: email
- *             description: The customer's email.
- *             format: email
- *           company_name:
- *             type: string
- *             title: company_name
- *             description: The customer's company name.
- *           first_name:
- *             type: string
- *             title: first_name
- *             description: The customer's first name.
- *           last_name:
- *             type: string
- *             title: last_name
- *             description: The customer's last name.
- *           phone:
- *             type: string
- *             title: phone
- *             description: The customer's phone.
 * 
 */

@@ -3,7 +3,7 @@
 * operationId: PostCustomersMe
 * summary: Create Customer
 * description: Create a customer.
- * x-authenticated: false
+ * x-authenticated: true
 * parameters:
 *   - name: expand
 *     in: query
@@ -15,12 +15,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -39,45 +45,30 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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:
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * requestBody:
 *   content:
 *     application/json:
 *       schema:
- *         type: object
- *         description: SUMMARY
- *         required:
- *           - company_name
- *           - first_name
- *           - last_name
- *           - phone
- *         properties:
- *           company_name:
- *             type: string
- *             title: company_name
- *             description: The customer's company name.
- *           first_name:
- *             type: string
- *             title: first_name
- *             description: The customer's first name.
- *           last_name:
- *             type: string
- *             title: last_name
- *             description: The customer's last name.
- *           phone:
- *             type: string
- *             title: phone
- *             description: The customer's phone.
+ *         $ref: "#/components/schemas/StoreUpdateCustomer"
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
 *     source: |-
 *       curl -X POST '{backend_url}/store/customers/me' \
+ *       -H 'Authorization: Bearer {access_token}' \
 *       -H 'Content-Type: application/json' \
 *       --data-raw '{
 *         "company_name": "{value}",
@@ -88,6 +79,8 @@
 * tags:
 *   - Customers
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -3,7 +3,7 @@
 * operationId: PostCustomersMeAddresses
 * summary: Create Customer
 * description: Create a customer.
- * x-authenticated: false
+ * x-authenticated: true
 * parameters:
 *   - name: expand
 *     in: query
@@ -15,12 +15,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -39,12 +45,19 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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:
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * requestBody:
 *   content:
 *     application/json:
@@ -64,13 +77,10 @@
 *           - province
 *           - postal_code
 *           - address_name
- *           - is_default_shipping
- *           - is_default_billing
 *         properties:
 *           metadata:
 *             type: object
 *             description: The customer's metadata.
- *             properties: {}
 *           first_name:
 *             type: string
 *             title: first_name
@@ -128,6 +138,7 @@
 *     label: cURL
 *     source: |-
 *       curl -X POST '{backend_url}/store/customers/me/addresses' \
+ *       -H 'Authorization: Bearer {access_token}' \
 *       -H 'Content-Type: application/json' \
 *       --data-raw '{
 *         "metadata": {},
@@ -141,13 +152,13 @@
 *         "country_code": "{value}",
 *         "province": "{value}",
 *         "postal_code": "{value}",
- *         "address_name": "{value}",
- *         "is_default_shipping": false,
- *         "is_default_billing": true
+ *         "address_name": "{value}"
 *       }'
 * tags:
 *   - Customers
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -3,7 +3,7 @@
 * operationId: PostCustomersMeAddressesAddress_id
 * summary: Add Addresses to Customer
 * description: Add a list of addresses to a customer.
- * x-authenticated: false
+ * x-authenticated: true
 * parameters:
 *   - name: address_id
 *     in: path
@@ -21,12 +21,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -45,12 +51,19 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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:
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * requestBody:
 *   content:
 *     application/json:
@@ -70,13 +83,10 @@
 *           - province
 *           - postal_code
 *           - address_name
- *           - is_default_shipping
- *           - is_default_billing
 *         properties:
 *           metadata:
 *             type: object
 *             description: The customer's metadata.
- *             properties: {}
 *           first_name:
 *             type: string
 *             title: first_name
@@ -134,6 +144,7 @@
 *     label: cURL
 *     source: |-
 *       curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \
+ *       -H 'Authorization: Bearer {access_token}' \
 *       -H 'Content-Type: application/json' \
 *       --data-raw '{
 *         "metadata": {},
@@ -147,13 +158,13 @@
 *         "country_code": "{value}",
 *         "province": "{value}",
 *         "postal_code": "{value}",
- *         "address_name": "{value}",
- *         "is_default_shipping": true,
- *         "is_default_billing": false
+ *         "address_name": "{value}"
 *       }'
 * tags:
 *   - Customers
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -0,0 +1,117 @@
+/**
+ * @oas [post] /store/payment-collections
+ * operationId: PostPaymentCollections
+ * summary: Create Payment Collection
+ * description: Create a payment collection.
+ * x-authenticated: false
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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
+ *         `-`.
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         type: object
+ *         description: SUMMARY
+ *         required:
+ *           - cart_id
+ *           - region_id
+ *           - currency_code
+ *           - amount
+ *         properties:
+ *           cart_id:
+ *             type: string
+ *             title: cart_id
+ *             description: The payment collection's cart id.
+ *           region_id:
+ *             type: string
+ *             title: region_id
+ *             description: The payment collection's region id.
+ *           currency_code:
+ *             type: string
+ *             title: currency_code
+ *             description: The payment collection's currency code.
+ *           amount:
+ *             type: number
+ *             title: amount
+ *             description: The payment collection's amount.
+ * x-codeSamples:
+ *   - lang: Shell
+ *     label: cURL
+ *     source: |-
+ *       curl -X POST '{backend_url}/store/payment-collections' \
+ *       -H 'Content-Type: application/json' \
+ *       --data-raw '{
+ *         "cart_id": "{value}",
+ *         "region_id": "{value}",
+ *         "currency_code": "{value}",
+ *         "amount": 8468325826822144
+ *       }'
+ * tags:
+ *   - Payment Collections
+ * responses:
+ *   "200":
+ *     description: OK
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ * 
+*/
+
@@ -21,12 +21,18 @@
 *       description: Comma-separated relations that should be expanded in the returned data.
 *   - name: fields
 *     in: query
- *     description: Comma-separated fields that should be included in the returned data.
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
 *     required: false
 *     schema:
 *       type: string
 *       title: fields
- *       description: Comma-separated fields that should be included in the returned data.
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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.
@@ -45,17 +51,35 @@
 *       description: Limit the number of items returned in the list.
 *   - name: order
 *     in: query
- *     description: Field to sort items in the list by.
+ *     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: Field to sort items in the list by.
+ *       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
+ *         `-`.
 * requestBody:
 *   content:
 *     application/json:
 *       schema:
- *         $ref: "#/components/schemas/StorePostPaymentCollectionsPaymentSessionReq"
+ *         type: object
+ *         description: SUMMARY
+ *         required:
+ *           - provider_id
+ *         properties:
+ *           provider_id:
+ *             type: string
+ *             title: provider_id
+ *             description: The payment collection's provider id.
+ *           context:
+ *             type: object
+ *             description: The payment collection's context.
+ *           data:
+ *             type: object
+ *             description: The payment collection's data.
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -71,6 +95,8 @@
 * tags:
 *   - Payment Collections
 * responses:
+ *   "200":
+ *     description: OK
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -0,0 +1,105 @@
+/**
+ * @oas [post] /store/return
+ * operationId: PostReturn
+ * summary: Create Return
+ * description: Create a return.
+ * x-authenticated: false
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: >-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * 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.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: >-
+ *         Comma-separated fields that should be included in the returned data.
+ *          * 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
+ *         `-`.
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/StorePostReturnsReqSchema"
+ * x-codeSamples:
+ *   - lang: Shell
+ *     label: cURL
+ *     source: |-
+ *       curl -X POST '{backend_url}/store/return' \
+ *       -H 'Content-Type: application/json' \
+ *       --data-raw '{
+ *         "order_id": "{value}",
+ *         "items": [
+ *           {
+ *             "id": "id_XbfptxUVo2io9EI",
+ *             "quantity": 7916429753974784,
+ *             "reason_id": "{value}",
+ *             "note": "{value}"
+ *           }
+ *         ],
+ *         "return_shipping": {
+ *           "option_id": "{value}",
+ *           "price": 1068364080349184
+ *         },
+ *         "note": "{value}",
+ *         "location_id": "{value}"
+ *       }'
+ * tags:
+ *   - Return
+ * responses:
+ *   "200":
+ *     description: OK
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ * 
+*/
+