chore(docs): Generated API Reference (v2) (#8890)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
1 parent
891037081d
commit
524be62312
749 files changed
+9092
-52161
No files matched your search
+8
-16
@@ -2,8 +2,7 @@
|
||||
* @oas [delete] /store/carts/{id}/line-items/{line_id}
|
||||
* operationId: DeleteCartsIdLineItemsLine_id
|
||||
* summary: Remove Line Items from Cart
|
||||
* description: Remove a list of line items from a cart. This doesn't delete the
|
||||
* Line Item, only the association between the Line Item and the cart.
|
||||
* description: Remove a list of line items from a cart. This doesn't delete the Line Item, only the association between the Line Item and the cart.
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: id
|
||||
@@ -28,18 +27,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -58,16 +53,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
@@ -114,6 +105,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: deleteLineItemsWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
+8
-16
@@ -2,8 +2,7 @@
|
||||
* @oas [delete] /store/carts/{id}/promotions
|
||||
* operationId: DeleteCartsIdPromotions
|
||||
* summary: Remove Promotions from Cart
|
||||
* description: Remove a list of promotions from a cart. This doesn't delete the
|
||||
* Promotion, only the association between the Promotion and the cart.
|
||||
* description: Remove a list of promotions from a cart. This doesn't delete the Promotion, only the association between the Promotion and the cart.
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: id
|
||||
@@ -22,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
@@ -93,6 +84,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: updateCartPromotionsWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
+8
-16
@@ -2,8 +2,7 @@
|
||||
* @oas [delete] /store/customers/me/addresses/{address_id}
|
||||
* operationId: DeleteCustomersMeAddressesAddress_id
|
||||
* 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.
|
||||
* 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: true
|
||||
* parameters:
|
||||
* - name: address_id
|
||||
@@ -22,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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: []
|
||||
@@ -113,6 +104,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: deleteCustomerAddressesWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
* @oas [get] /store/carts/{id}
|
||||
* operationId: GetCartsId
|
||||
* summary: Get a Cart
|
||||
* description: Retrieve a cart by its ID. You can expand the cart's relations or
|
||||
* select the fields that should be returned.
|
||||
* description: Retrieve a cart by its ID. You can expand the cart's relations or select the fields that should be returned.
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: id
|
||||
@@ -22,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
* @oas [get] /store/collections
|
||||
* operationId: GetCollections
|
||||
* summary: List Collections
|
||||
* description: Retrieve a list of collections. The collections can be filtered by
|
||||
* fields such as `id`. The collections can also be sorted or paginated.
|
||||
* description: Retrieve a list of collections. The collections can be filtered by fields such as `id`. The collections can also be sorted or paginated.
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: expand
|
||||
@@ -16,18 +15,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +41,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
* @oas [get] /store/collections/{id}
|
||||
* operationId: GetCollectionsId
|
||||
* summary: Get a Collection
|
||||
* description: Retrieve a collection by its ID. You can expand the collection's
|
||||
* relations or select the fields that should be returned.
|
||||
* description: Retrieve a collection by its ID. You can expand the collection's relations or select the fields that should be returned.
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: id
|
||||
@@ -22,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
* @oas [get] /store/currencies
|
||||
* operationId: GetCurrencies
|
||||
* summary: List Currencies
|
||||
* description: Retrieve a list of currencies. The currencies can be filtered by
|
||||
* fields such as `id`. The currencies can also be sorted or paginated.
|
||||
* description: Retrieve a list of currencies. The currencies can be filtered by fields such as `id`. The currencies can also be sorted or paginated.
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: expand
|
||||
@@ -16,18 +15,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +41,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
* @oas [get] /store/currencies/{code}
|
||||
* operationId: GetCurrenciesCode
|
||||
* summary: Get a Currency
|
||||
* description: Retrieve a currency by its ID. You can expand the currency's
|
||||
* relations or select the fields that should be returned.
|
||||
* description: Retrieve a currency by its ID. You can expand the currency's relations or select the fields that should be returned.
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: code
|
||||
@@ -22,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
* @oas [get] /store/customers/me
|
||||
* operationId: GetCustomersMe
|
||||
* 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.
|
||||
* 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: true
|
||||
* parameters:
|
||||
* - name: expand
|
||||
@@ -16,18 +15,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +41,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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: []
|
||||
|
||||
+7
-16
@@ -2,8 +2,7 @@
|
||||
* @oas [get] /store/customers/me/addresses
|
||||
* operationId: GetCustomersMeAddresses
|
||||
* 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.
|
||||
* 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: true
|
||||
* parameters:
|
||||
* - name: expand
|
||||
@@ -16,18 +15,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +41,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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.
|
||||
|
||||
+7
-16
@@ -2,8 +2,7 @@
|
||||
* @oas [get] /store/customers/me/addresses/{address_id}
|
||||
* operationId: GetCustomersMeAddressesAddress_id
|
||||
* 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.
|
||||
* 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: true
|
||||
* parameters:
|
||||
* - name: address_id
|
||||
@@ -22,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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: []
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
* @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.
|
||||
* 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
|
||||
@@ -16,18 +15,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +41,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
* @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.
|
||||
* 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
|
||||
@@ -22,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
|
||||
@@ -2,9 +2,7 @@
|
||||
* @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.
|
||||
* 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
|
||||
@@ -17,18 +15,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -47,16 +41,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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.
|
||||
|
||||
@@ -2,9 +2,7 @@
|
||||
* @oas [get] /store/product-categories
|
||||
* operationId: GetProductCategories
|
||||
* summary: List Product Categories
|
||||
* description: Retrieve a list of product categories. The product categories can
|
||||
* be filtered by fields such as `id`. The product categories can also be sorted
|
||||
* or paginated.
|
||||
* description: Retrieve a list of product categories. The product categories can be filtered by fields such as `id`. The product categories can also be sorted or paginated.
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: expand
|
||||
@@ -17,18 +15,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -47,16 +41,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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.
|
||||
@@ -124,7 +114,7 @@
|
||||
* - name: include_ancestors_tree
|
||||
* in: query
|
||||
* description: The product category's include ancestors tree.
|
||||
* required: true
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: include_ancestors_tree
|
||||
@@ -132,7 +122,7 @@
|
||||
* - name: include_descendants_tree
|
||||
* in: query
|
||||
* description: The product category's include descendants tree.
|
||||
* required: true
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: include_descendants_tree
|
||||
@@ -141,104 +131,17 @@
|
||||
* in: query
|
||||
* description: The product category's created at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* 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: {}
|
||||
* title: created_at
|
||||
* schema: {}
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: The product category's updated at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* 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: {}
|
||||
* title: updated_at
|
||||
* schema: {}
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: The product category's deleted at.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* 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: {}
|
||||
* title: deleted_at
|
||||
* schema: {}
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
|
||||
+9
-18
@@ -2,8 +2,7 @@
|
||||
* @oas [get] /store/product-categories/{id}
|
||||
* operationId: GetProductCategoriesId
|
||||
* summary: Get a Product Category
|
||||
* description: Retrieve a product category by its ID. You can expand the product
|
||||
* category's relations or select the fields that should be returned.
|
||||
* description: Retrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned.
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: id
|
||||
@@ -22,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,20 +47,16 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: include_ancestors_tree
|
||||
@@ -73,7 +64,7 @@
|
||||
* - name: include_descendants_tree
|
||||
* in: query
|
||||
* description: The product category's include descendants tree.
|
||||
* required: true
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: include_descendants_tree
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
@@ -2,8 +2,7 @@
|
||||
* @oas [get] /store/products/{id}
|
||||
* operationId: GetProductsId
|
||||
* summary: Get a Product
|
||||
* description: Retrieve a product by its ID. You can expand the product's
|
||||
* relations or select the fields that should be returned.
|
||||
* description: Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned.
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: id
|
||||
@@ -22,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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 product's region id.
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
* @oas [get] /store/regions
|
||||
* operationId: GetRegions
|
||||
* summary: List Regions
|
||||
* description: Retrieve a list of regions. The regions can be filtered by fields
|
||||
* such as `id`. The regions can also be sorted or paginated.
|
||||
* description: Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated.
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: expand
|
||||
@@ -16,18 +15,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +41,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
* @oas [get] /store/regions/{id}
|
||||
* operationId: GetRegionsId
|
||||
* summary: Get a Region
|
||||
* description: Retrieve a region by its ID. You can expand the region's relations
|
||||
* or select the fields that should be returned.
|
||||
* description: Retrieve a region by its ID. You can expand the region's relations or select the fields that should be returned.
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
* - name: id
|
||||
@@ -22,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
|
||||
@@ -2,9 +2,7 @@
|
||||
* @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.
|
||||
* 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
|
||||
@@ -17,18 +15,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -47,16 +41,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
* @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.
|
||||
* 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
|
||||
@@ -22,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
|
||||
@@ -2,9 +2,7 @@
|
||||
* @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.
|
||||
* 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: expand
|
||||
@@ -17,18 +15,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -47,16 +41,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
|
||||
@@ -15,18 +15,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +41,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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:
|
||||
@@ -66,9 +58,7 @@
|
||||
* properties:
|
||||
* additional_data:
|
||||
* type: object
|
||||
* description: Pass additional custom data to the API route. This data is passed
|
||||
* to the underlying workflow under the `additional_data`
|
||||
* parameter.
|
||||
* description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter.
|
||||
* description: SUMMARY
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
|
||||
@@ -21,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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:
|
||||
@@ -72,9 +64,7 @@
|
||||
* properties:
|
||||
* additional_data:
|
||||
* type: object
|
||||
* description: Pass additional custom data to the API route. This data is passed
|
||||
* to the underlying workflow under the `additional_data`
|
||||
* parameter.
|
||||
* description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter.
|
||||
* description: SUMMARY
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
@@ -107,6 +97,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: updateCartWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -21,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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:
|
||||
|
||||
+7
-14
@@ -21,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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:
|
||||
@@ -98,6 +90,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: addToCartWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
+7
-14
@@ -27,18 +27,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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.
|
||||
@@ -57,16 +53,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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:
|
||||
@@ -103,6 +95,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: updateLineItemInCartWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
+7
-14
@@ -21,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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:
|
||||
@@ -109,6 +101,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: updateCartPromotionsWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
+7
-14
@@ -21,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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:
|
||||
@@ -107,6 +99,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: addShippingMethodToWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -21,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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:
|
||||
@@ -91,6 +83,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: updateTaxLinesWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -15,18 +15,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +41,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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:
|
||||
@@ -94,6 +86,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: createCustomerAccountWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -15,18 +15,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +41,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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: []
|
||||
@@ -97,6 +89,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: updateCustomersWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
+7
-14
@@ -15,18 +15,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +41,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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: []
|
||||
@@ -175,6 +167,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: createCustomerAddressesWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
+7
-14
@@ -21,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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: []
|
||||
@@ -181,6 +173,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: updateCustomerAddressesWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -15,18 +15,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +41,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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:
|
||||
@@ -101,6 +93,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: createPaymentCollectionForCartWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
+9
-19
@@ -21,18 +21,14 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* 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,16 +47,12 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* 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
|
||||
* `-`.
|
||||
* 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:
|
||||
@@ -83,12 +75,9 @@
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: >-
|
||||
* curl -X POST
|
||||
* '{backend_url}/store/payment-collections/{id}/payment-sessions' \
|
||||
*
|
||||
* source: |-
|
||||
* curl -X POST '{backend_url}/store/payment-collections/{id}/payment-sessions' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
*
|
||||
* --data-raw '{
|
||||
* "provider_id": "{value}"
|
||||
* }'
|
||||
@@ -113,6 +102,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: createPaymentSessionsWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -4,57 +4,7 @@
|
||||
* 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
|
||||
* `-`.
|
||||
* parameters: []
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
@@ -104,6 +54,7 @@
|
||||
* $ref: "#/components/responses/invalid_request_error"
|
||||
* "500":
|
||||
* $ref: "#/components/responses/500_error"
|
||||
* x-workflow: createAndCompleteReturnOrderWorkflow
|
||||
*
|
||||
*/
|
||||
|
||||
Reference in new issue
Block a user