asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Updated API Reference (v2) (#8954)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-09-03 07:18:42 +00:00
committed by GitHub
co-authored by Shahed Nasser
parent 6652db45ef
commit edc19e748b
157 changed files with 16009 additions and 35955 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/utils/generated/oas-output/operations/admin/get_admin_customers.ts
+9 -1
View File
@@ -49,7 +49,7 @@
* 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: groups
* in: query
* required: true
* required: false
* schema:
* oneOf:
* - type: string
@@ -3323,6 +3323,14 @@
* items:
* type: object
* title: $or
* - name: has_account
* in: query
* description: Filter by whether the customer is registered.
* required: false
* schema:
* type: boolean
* title: has_account
* description: Filter by whether the customer is registered.
* security:
* - api_token: []
* - cookie_auth: []
www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts
+1 -2
View File
@@ -2,8 +2,7 @@
* @oas [get] /admin/customers/{id}/addresses/{address_id}
* operationId: GetCustomersIdAddressesAddress_id
* summary: List Addresses
* description: Retrieve a list of a customer's addresses. The addresses can be
* filtered by fields like `company`. The addresses can also be paginated.
* description: Retrieve a list of a customer's addresses. The addresses can be filtered by fields like `company`. The addresses can also be paginated.
* x-authenticated: true
* parameters:
* - name: id
www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts
+20
View File
@@ -935,6 +935,15 @@
* type: string
* title: fulfillment_status
* description: The fulfillment status's details.
* enum:
* - canceled
* - not_fulfilled
* - partially_fulfilled
* - fulfilled
* - partially_shipped
* - shipped
* - partially_delivered
* - delivered
* - name: payment_status
* in: query
* description: Filter by the payment status of the draft order.
@@ -946,6 +955,17 @@
* type: string
* title: payment_status
* description: The payment status's details.
* enum:
* - canceled
* - not_paid
* - awaiting
* - authorized
* - partially_authorized
* - captured
* - partially_captured
* - partially_refunded
* - refunded
* - requires_action
* - name: region_id
* in: query
* description: Filter by region IDs to retrieve their associated draft orders.
www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts
+1 -2
View File
@@ -2,8 +2,7 @@
* @oas [get] /admin/draft-orders/{id}
* operationId: GetDraftOrdersId
* summary: Get a Draft Order
* description: Retrieve a draft order by its ID. You can expand the draft order's
* relations or select the fields that should be returned using the query parameters.
* description: Retrieve a draft order by its ID. You can expand the draft order's relations or select the fields that should be returned using the query parameters.
* x-authenticated: true
* parameters:
* - name: id
www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts
+1 -2
View File
@@ -2,8 +2,7 @@
* @oas [get] /admin/exchanges/{id}
* operationId: GetExchangesId
* summary: Get an Exchange
* description: Retrieve an exchange by its ID. You can expand the exchange's
* relations or select the fields that should be returned using query parameters.
* description: Retrieve an exchange by its ID. You can expand the exchange's relations or select the fields that should be returned using query parameters.
* x-authenticated: true
* parameters:
* - name: id
www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts
+1 -1
View File
@@ -64,7 +64,7 @@
* - name: is_enabled
* in: query
* description: Filter by whether the fulfillment provider is enabled.
* required: true
* required: false
* schema:
* type: boolean
* title: is_enabled
www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts
+1 -2
View File
@@ -3,8 +3,7 @@
* operationId: GetFulfillmentSetsIdServiceZonesZone_id
* summary: Get a Service Zone in a Fulfillment Set
* x-sidebar-summary: Get a Service Zone
* description: Retrieve a service zone that belongs to a fulfillment set.
* be paginated.
* description: Retrieve a service zone that belongs to a fulfillment set. be paginated.
* x-authenticated: true
* parameters:
* - name: id
www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts
+2
View File
@@ -362,6 +362,8 @@
* type: string
* title: location_id
* description: A location's ID.
* required:
* - location_id
* - name: $and
* in: query
* required: false
www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts
+1 -3
View File
@@ -2,9 +2,7 @@
* @oas [get] /admin/inventory-items/{id}/location-levels
* operationId: GetInventoryItemsIdLocationLevels
* summary: List Inventory Levels
* description: Retrieve a list of inventory levels associated with an inventory item. The
* inventory levels can be filtered by fields like `location_id`. The inventory
* levels can also be paginated.
* description: Retrieve a list of inventory levels associated with an inventory item. The inventory levels can be filtered by fields like `location_id`. The inventory levels can also be paginated.
* x-authenticated: true
* parameters:
* - name: id
www/utils/generated/oas-output/operations/admin/get_admin_invites.ts
+3 -3
View File
@@ -89,7 +89,7 @@
* in: query
* description: Filter by the invite's creation date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the invite's creation date.
* properties:
@@ -208,7 +208,7 @@
* in: query
* description: Filter by the invite's update date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the invite's update date.
* properties:
@@ -327,7 +327,7 @@
* in: query
* description: Filter by the invite's deletion date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the invite's deletion date.
* properties:
www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts
+2 -2
View File
@@ -77,14 +77,14 @@
* - type: string
* title: channel
* description: Filter by a notification channel.
* example: "email"
* example: email
* - type: array
* description: Filter by notification channels.
* items:
* type: string
* title: channel
* description: A notification channel.
* example: "email"
* example: email
* - name: $and
* in: query
* required: false
www/utils/generated/oas-output/operations/admin/get_admin_orders.ts
+532
View File
@@ -95,6 +95,538 @@
* items:
* type: object
* title: $or
* - name: sales_channel_id
* in: query
* description: Filter by sales channel IDs to retrieve the orders associated with them.
* required: false
* schema:
* type: array
* description: Filter by sales channel IDs to retrieve the orders associated with them.
* items:
* type: string
* title: sales_channel_id
* description: A sales channel's ID.
* - name: fulfillment_status
* in: query
* description: Filter by the order's fulfillment status.
* required: false
* schema:
* type: array
* description: Filter by the order's fulfillment status.
* items:
* type: string
* description: A fulfillment status.
* enum:
* - canceled
* - not_fulfilled
* - partially_fulfilled
* - fulfilled
* - partially_shipped
* - shipped
* - partially_delivered
* - delivered
* - name: payment_status
* in: query
* description: Filter by the order's payment status.
* required: false
* schema:
* type: array
* description: Filter by the order's payment status.
* items:
* type: string
* description: A payment status
* enum:
* - canceled
* - not_paid
* - awaiting
* - authorized
* - partially_authorized
* - captured
* - partially_captured
* - partially_refunded
* - refunded
* - requires_action
* - name: region_id
* in: query
* description: Filter by region IDs to retrieve their associated orders.
* required: false
* schema:
* type: array
* description: Filter by region IDs to retrieve their associated orders.
* items:
* type: string
* title: region_id
* description: A region ID.
* - name: q
* in: query
* description: Search term to filter the order's searchable properties.
* required: false
* schema:
* type: string
* title: q
* description: Search term to filter the order's searchable properties.
* - name: created_at
* in: query
* description: Filter by the order's creation date.
* required: false
* schema:
* type: object
* description: Filter by the order's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: updated_at
* in: query
* description: Filter by the order's update date.
* required: false
* schema:
* type: object
* description: Filter by the order's update date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* security:
* - api_token: []
* - cookie_auth: []
www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts
+2 -3
View File
@@ -3,10 +3,9 @@
* operationId: GetOrdersIdChanges
* summary: List Changes on an Order
* x-sidebar-summary: List Changes
* description: >
* description: |
* Retrieve a list of changes made on an order, including returns, exchanges, etc...
*
*
*
* The changes can be filtered by fields like FILTER FIELDS. The changes can also be paginated.
* x-authenticated: true
* parameters:
www/utils/generated/oas-output/operations/admin/get_admin_payments.ts
+3 -3
View File
@@ -87,7 +87,7 @@
* in: query
* description: Filter by the payment's creation date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the payment's creation date.
* properties:
@@ -206,7 +206,7 @@
* in: query
* description: Filter by the payment's update date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the payment's update date.
* properties:
@@ -325,7 +325,7 @@
* in: query
* description: Filter by the payment's deletion date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the payment's deletion date.
* properties:
www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts
+1 -1
View File
@@ -49,7 +49,7 @@
* 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
* required: true
* schema:
* oneOf:
* - type: string
www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts
+3 -3
View File
@@ -147,7 +147,7 @@
* in: query
* description: Filter by the category's creation date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the category's creation date.
* properties:
@@ -266,7 +266,7 @@
* in: query
* description: Filter by the category's update date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the category's update date.
* properties:
@@ -385,7 +385,7 @@
* in: query
* description: Filter by the category's deletion date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the category's deletion date.
* properties:
www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts
+3 -3
View File
@@ -87,7 +87,7 @@
* in: query
* description: Filter by the tag's creation date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the tag's creation date.
* properties:
@@ -206,7 +206,7 @@
* in: query
* description: Filter by the tag's update date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the tag's update date.
* properties:
@@ -325,7 +325,7 @@
* in: query
* description: Filter by the tag's deletion date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the tag's deletion date.
* properties:
www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts
+3 -3
View File
@@ -87,7 +87,7 @@
* in: query
* description: Filter by the type's creation date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the type's creation date.
* properties:
@@ -206,7 +206,7 @@
* in: query
* description: Filter by the type's update date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the type's update date.
* properties:
@@ -325,7 +325,7 @@
* in: query
* description: Filter by the type's deletion date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the type's deletion date.
* properties:
www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts
+3 -3
View File
@@ -96,7 +96,7 @@
* in: query
* description: Filter by the product's creation date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the product's creation date.
* properties:
@@ -215,7 +215,7 @@
* in: query
* description: Filter by the product's update date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the product's update date.
* properties:
@@ -334,7 +334,7 @@
* in: query
* description: Filter by the product's deletion date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the product's deletion date.
* properties:
www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts
+1 -23
View File
@@ -3,7 +3,7 @@
* operationId: GetPromotionsIdRule_type
* summary: List Rules of a Promotion
* x-sidebar-summary: List Rules
* description: >
* description: >
* Retrieve a list of rules in a promotion. The type of rules retrieved depend on the value of the `rule_type` path parameter:
*
* - If `rule_type` is `rules`, the promotion's rules are retrivied.
@@ -69,28 +69,6 @@
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: promotion_type
* in: query
* description: The type of promotion to retrieve its rules. This is only used if the promotion doesn't have a type.
* required: false
* schema:
* type: string
* title: promotion_type
* description: The type of promotion to retrieve its rules. This is only used if the promotion doesn't have a type.
* enum:
* - standard
* - buyget
* - name: application_method_type
* in: query
* description: The type of application method to retrieve its rules. This is only used if the promotion doesn't have an application method, or its method doesn't have a type.
* required: false
* schema:
* type: string
* title: application_method_type
* description: The type of application method to retrieve its rules. This is only used if the promotion doesn't have an application method, or its method doesn't have a type.
* enum:
* - fixed
* - percentage
* security:
* - api_token: []
* - cookie_auth: []
www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts
+2 -4
View File
@@ -3,11 +3,9 @@
* operationId: GetPromotionsRuleValueOptionsRule_typeRule_attribute_id
* summary: List Rule Values Given a Rule Attribute
* x-sidebar-summary: List Rule Values
* description: >
* description: |
* Retrieve all potential values for promotion rules and target and buy rules based on the specified rule attribute and type.
*
* For example, if you provide the ID of the `currency_code` rule attribute, and set `rule_type` to `rules`, a list of currencies
* are retrieved in label-value pairs.
* For example, if you provide the ID of the `currency_code` rule attribute, and set `rule_type` to `rules`, a list of currencies are retrieved in label-value pairs.
* x-authenticated: true
* parameters:
* - name: rule_type
www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts
-49
View File
@@ -156,55 +156,6 @@
* $lte:
* type: string
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* - name: quantity
* in: query
* description: Filter by a reserved quantity.
* required: false
* schema:
* description: The reservation's quantity.
* properties:
* $eq:
* type: string
* description: Filter by an exact match.
* $ne:
* type: string
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array's items.
* items:
* type: string
* $nin:
* type: array
* description: Filter by values not in this array's items.
* items:
* type: string
* $like:
* type: string
* description: Apply a `like` filter. Useful for strings only.
* $ilike:
* type: string
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $re:
* type: string
* description: Apply a regex filter. Useful for strings only.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* $gt:
* type: string
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* - name: created_at
* in: query
* description: Filter by a reservation's creation date.
www/utils/generated/oas-output/operations/admin/get_admin_returns.ts
+532
View File
@@ -95,6 +95,538 @@
* items:
* type: object
* title: $or
* - name: sales_channel_id
* in: query
* description: Filter by sales channel IDs to retrieve their associated returns.
* required: false
* schema:
* type: array
* description: Filter by sales channel IDs to retrieve their associated returns.
* items:
* type: string
* title: sales_channel_id
* description: A sales channel's ID.
* - name: fulfillment_status
* in: query
* description: Filter by fulfillment statuses.
* required: false
* schema:
* type: array
* description: Filter by fulfillment statuses.
* items:
* type: string
* description: A fulfillment status.
* enum:
* - canceled
* - not_fulfilled
* - partially_fulfilled
* - fulfilled
* - partially_shipped
* - shipped
* - partially_delivered
* - delivered
* - name: payment_status
* in: query
* description: Filter by payment statuses.
* required: false
* schema:
* type: array
* description: Filter by payment statuses.
* items:
* type: string
* description: A payment status.
* enum:
* - canceled
* - not_paid
* - awaiting
* - authorized
* - partially_authorized
* - captured
* - partially_captured
* - partially_refunded
* - refunded
* - requires_action
* - name: region_id
* in: query
* description: Filter by region IDs to retrieve their associated returns.
* required: false
* schema:
* type: array
* description: Filter by region IDs to retrieve their associated returns.
* items:
* type: string
* title: region_id
* description: The region id's details.
* - name: q
* in: query
* description: Search term to filter the return's searchable properties.
* required: false
* schema:
* type: string
* title: q
* description: Search term to filter the return's searchable properties.
* - name: created_at
* in: query
* description: Filter by the return's creation date.
* required: false
* schema:
* type: object
* description: Filter by the return's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: updated_at
* in: query
* description: Filter by the return's update date.
* required: false
* schema:
* type: object
* description: Filter by the return's update date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: An exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* security:
* - api_token: []
* - cookie_auth: []
www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts
+16
View File
@@ -496,6 +496,22 @@
* type: string
* title: stock_location_id
* description: A stock location's ID.
* - name: is_return
* in: query
* description: Filter by whether the shipping option is used for returns.
* required: false
* schema:
* type: boolean
* title: is_return
* description: Filter by whether the shipping option is used for returns.
* - name: admin_only
* in: query
* description: Filter by whether the shipping option is used by admin users only.
* required: false
* schema:
* type: boolean
* title: admin_only
* description: Filter by whether the shipping option is used by admin users only.
* security:
* - api_token: []
* - cookie_auth: []
www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts
+1 -1
View File
@@ -64,7 +64,7 @@
* title: id
* description: Filter by a stock location ID.
* - type: array
* description: Filter by stock location IDs.
* description: Filter by stock location IDs.
* items:
* type: string
* title: id
www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts
-1
View File
@@ -123,7 +123,6 @@
* enum:
* - "true"
* - "false"
* title: is_default
* - name: created_at
* in: query
* description: Filter by a tax rate's creation date.
www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts
+680 -332
View File
File diff suppressed because it is too large Load Diff
www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts
+4 -3
View File
@@ -3,9 +3,8 @@
* operationId: GetWorkflowsExecutionsWorkflow_idTransaction_idStep_idSubscribe
* summary: Subscribe to Step of a Workflow's Execution
* x-sidebar-summary: Subscribe to Step
* description: >
* description: |
* Subscribe to a step in a workflow's execution to receive real-time information about its status and data.
*
* This route returns an event stream that you can consume using the [EventSource API](https://developer.mozilla.org/en-US/docs/Web/API/EventSource).
* x-authenticated: true
* parameters:
@@ -47,7 +46,9 @@
* schema:
* type: string
* description: The step's status update and data changes.
* example: "event: success\n data: {}"
* example: |-
* event: success
* data: {}
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts
+4 -3
View File
@@ -3,9 +3,8 @@
* operationId: GetWorkflowsExecutionsWorkflow_idSubscribe
* summary: Subscribe to a Workflow's Execution
* x-sidebar-summary: Subscribe to Workflow
* description: >
* description: |
* Subscribe to a workflow's execution to receive real-time information about its steps, status, and data.
*
* This route returns an event stream that you can consume using the [EventSource API](https://developer.mozilla.org/en-US/docs/Web/API/EventSource).
* x-authenticated: true
* parameters:
@@ -35,7 +34,9 @@
* schema:
* type: string
* description: The step's status update and data changes.
* example: "event: success\n data: {}"
* example: |-
* event: success
* data: {}
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts
+1 -18
View File
@@ -55,24 +55,7 @@
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - name
* - type
* - metadata
* properties:
* name:
* type: string
* title: name
* description: The shipping profile's name.
* type:
* type: string
* title: type
* description: The shipping profile's type.
* metadata:
* type: object
* description: The shipping profile's metadata.
* $ref: "#/components/schemas/AdminCreateShippingProfile"
* x-codeSamples:
* - lang: Shell
* label: cURL