diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index ca0fa2f9e1..1075400224 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -34,12 +34,6 @@ tags: externalDocs: description: How to manage currencies url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-currencies - - name: Customers - description: | - Customers can either be created when they register through the Store APIs, or created by the admin using the Admin APIs. - externalDocs: - description: How to manage customers - url: https://docs.medusajs.com/modules/customers/admin/manage-customers - name: Customer Groups description: | Customer Groups can be used to organize customers that share similar data or attributes into dedicated groups. @@ -47,6 +41,12 @@ tags: externalDocs: description: How to manage customer groups url: https://docs.medusajs.com/modules/customers/admin/manage-customer-groups + - name: Customers + description: | + Customers can either be created when they register through the Store APIs, or created by the admin using the Admin APIs. + externalDocs: + description: How to manage customers + url: https://docs.medusajs.com/modules/customers/admin/manage-customers - name: Discounts description: | Admins can create discounts with conditions and rules, providing them with advanced settings for variety of cases. @@ -86,6 +86,12 @@ tags: description: | Notifications are sent to customers to inform them of new updates. For example, a notification can be sent to the customer when their order is place or its state is updated. The notification's type, such as an email or SMS, is determined by the notification provider installed on the Medusa backend. + - name: Order Edits + description: | + An admin can edit an order to remove, add, or update an item's quantity. When an admin edits an order, they're stored as an `OrderEdit`. + externalDocs: + description: How to edit an order + url: https://docs.medusajs.com/modules/orders/admin/edit-order - name: Orders description: | Orders are purchases made by customers, typically through a storefront using the Store API. Draft orders created by the admin are also transformed to an Order once the payment is captured. @@ -93,30 +99,18 @@ tags: externalDocs: description: How to manage orders url: https://docs.medusajs.com/modules/orders/admin/manage-orders - - name: Order Edits - description: | - An admin can edit an order to remove, add, or update an item's quantity. When an admin edits an order, they're stored as an `OrderEdit`. - externalDocs: - description: How to edit an order - url: https://docs.medusajs.com/modules/orders/admin/edit-order - - name: Payments - description: | - A payment can be related to an order, swap, return, or more. It can be captured or refunded. - name: Payment Collections description: | A payment collection is useful for managing additional payments, such as for Order Edits, or installment payments. + - name: Payments + description: | + A payment can be related to an order, swap, return, or more. It can be captured or refunded. - name: Price Lists description: | A price list are special prices applied to products based on a set of conditions, such as customer group. externalDocs: description: How to manage price lists url: https://docs.medusajs.com/modules/price-lists/admin/manage-price-lists - - name: Products - description: | - Products are saleable items in a store. This also includes [saleable gift cards](https://docs.medusajs.com/modules/gift-cards/admin/manage-gift-cards#manage-gift-card-product) in a store. - externalDocs: - description: How to manage products - url: https://docs.medusajs.com/modules/products/admin/manage-products - name: Product Categories description: | Products can be categoriezed into categories. A product can be added into more than one category. @@ -141,6 +135,12 @@ tags: externalDocs: description: How to manage product variants url: https://docs.medusajs.com/modules/products/admin/manage-products#manage-product-variants + - name: Products + description: | + Products are saleable items in a store. This also includes [saleable gift cards](https://docs.medusajs.com/modules/gift-cards/admin/manage-gift-cards#manage-gift-card-product) in a store. + externalDocs: + description: How to manage products + url: https://docs.medusajs.com/modules/products/admin/manage-products - name: Publishable API Keys description: | Publishable API Keys can be used to scope Store API calls with an API key, determining what resources are retrieved when querying the API. @@ -150,13 +150,6 @@ tags: externalDocs: description: How to manage publishable API keys url: https://docs.medusajs.com/development/publishable-api-keys/admin/manage-publishable-api-keys - - name: Reservations - description: | - Reservations, provided by the [Inventory Module](https://docs.medusajs.com/modules/multiwarehouse/inventory-module), are quantities of an item that are reserved, typically when an order is placed but not yet fulfilled. - Reservations can be associated with any resources, but commonly with line items of an order. - externalDocs: - description: How to manage item allocations in orders - url: https://docs.medusajs.com/modules/multiwarehouse/admin/manage-item-allocations-in-orders - name: Regions description: | Regions are different countries or geographical regions that the commerce store serves customers in. @@ -164,6 +157,13 @@ tags: externalDocs: description: How to manage regions url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions + - name: Reservations + description: | + Reservations, provided by the [Inventory Module](https://docs.medusajs.com/modules/multiwarehouse/inventory-module), are quantities of an item that are reserved, typically when an order is placed but not yet fulfilled. + Reservations can be associated with any resources, but commonly with line items of an order. + externalDocs: + description: How to manage item allocations in orders + url: https://docs.medusajs.com/modules/multiwarehouse/admin/manage-item-allocations-in-orders - name: Return Reasons description: | Return reasons are key-value pairs that are used to specify why an order return is being created. @@ -1257,6 +1257,11 @@ paths: description: a term to search collections by their title or handle. schema: type: string + - in: query + name: order + description: A field to sort-order the retrieved collections by. + schema: + type: string - in: query name: discount_condition_id description: Filter collections by a discount condition ID associated with them. @@ -2261,6 +2266,11 @@ paths: description: Comma-separated relations that should be expanded in the returned customer groups. schema: type: string + - in: query + name: fields + description: Comma-separated fields that should be included in the returned customer groups. + schema: + type: string x-codegen: method: list queryParams: AdminGetCustomerGroupsParams @@ -3030,7 +3040,12 @@ paths: default: 0 - in: query name: expand - description: Comma-separated relations that should be expanded in the returned customer. + description: Comma-separated relations that should be expanded in the returned customers. + schema: + type: string + - in: query + name: fields + description: Comma-separated fields that should be included in the returned customers. schema: type: string - in: query @@ -3038,6 +3053,16 @@ paths: description: term to search customers' email, first_name, and last_name fields. schema: type: string + - in: query + name: has_account + description: Filter customers by whether they have an account. + schema: + type: boolean + - in: query + name: order + description: A field to sort-order the retrieved customers by. + schema: + type: string - in: query name: groups style: form @@ -3047,6 +3072,50 @@ paths: type: array items: type: string + - in: query + name: created_at + description: Filter by a creation date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Filter by an update date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date x-codegen: method: list queryParams: AdminGetCustomersParams @@ -3465,6 +3534,55 @@ paths: description: Comma-separated relations that should be expanded in each returned discount. schema: type: string + - in: query + name: order + description: A discount field to sort-order the retrieved discounts by. + schema: + type: string + - in: query + name: created_at + description: Filter by a creation date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Filter by an update date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date x-codegen: method: list queryParams: AdminGetDiscountsParams @@ -5101,6 +5219,77 @@ paths: description: a term to search draft orders' display IDs and emails in the draft order's cart schema: type: string + - in: query + name: order + description: Field to sort retrieved draft orders by. + schema: + type: string + - in: query + name: expand + description: A comma-separated list of fields to expand. + schema: + type: string + - in: query + name: fields + description: A comma-separated list of fields to include in the response. + schema: + type: string + - in: query + name: created_at + description: Filter by a creation date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Filter by an update date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: status + style: form + explode: false + description: Filter by status + schema: + type: array + items: + type: string + enum: + - open + - completed x-codegen: method: list queryParams: AdminGetDraftOrdersParams @@ -5946,6 +6135,11 @@ paths: description: a term to search gift cards' code or display ID schema: type: string + - in: query + name: order + description: A gift card field to sort-order the retrieved gift cards by. + schema: + type: string x-codegen: method: list queryParams: AdminGetGiftCardsParams @@ -6396,6 +6590,11 @@ paths: description: term to search inventory item's sku, title, and description. schema: type: string + - in: query + name: order + description: Field to sort-order inventory items by. + schema: + type: string - in: query name: location_id style: form @@ -9654,7 +9853,7 @@ paths: type: string - in: query name: order - description: A order field to sort-order the retrieved orders by. + description: Field to sort retrieved orders by. schema: type: string x-codegen: @@ -13958,9 +14157,17 @@ paths: type: string - in: query name: id - description: Filter by product ID + style: form + explode: false + description: Filter by product IDs. schema: - type: string + oneOf: + - type: string + description: ID of the product. + - type: array + items: + type: string + description: ID of a product. - in: query name: status description: Filter by product status @@ -14012,7 +14219,7 @@ paths: name: is_giftcard description: A boolean value to filter by whether the product is a gift card or not. schema: - type: string + type: boolean - in: query name: type description: Filter product type. @@ -16775,8 +16982,6 @@ paths: summary: List a Product's Variants description: | Retrieve a list of Product Variants associated with a Product. The variants can be paginated. - - By default, each variant will only have the `id` and `variant_id` fields. You can use the `expand` and `fields` request parameters to retrieve more fields or relations. x-authenticated: true parameters: - in: path @@ -16785,6 +16990,11 @@ paths: description: ID of the product. schema: type: string + - in: query + name: id + description: IDs to filter product variants by. + schema: + type: string - in: query name: fields description: Comma-separated fields that should be included in the returned product variants. @@ -16807,6 +17017,70 @@ paths: schema: type: integer default: 100 + - in: query + name: q + description: Search term to search product variants' title, sku, and products' title. + schema: + type: string + - in: query + name: 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 `-`. + schema: + type: string + - in: query + name: manage_inventory + description: Filter product variants by whether their inventory is managed or not. + schema: + type: boolean + - in: query + name: allow_backorder + description: Filter product variants by whether they are allowed to be backordered or not. + schema: + type: boolean + - in: query + name: created_at + description: Filter by a creation date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Filter by an update date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date x-codegen: method: listVariants queryParams: AdminGetProductsVariantsParams @@ -17228,6 +17502,80 @@ paths: description: Comma-separated fields that should be included in the returned publishable API keys. schema: type: string + - in: query + name: order + description: A field to sort-order the retrieved publishable API keys by. + schema: + type: string + - in: query + name: created_at + required: false + description: Filter by a creation date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + required: false + description: Filter by a update date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: revoked_at + required: false + description: Filter by a revocation date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date x-codegen: method: list queryParams: GetPublishableApiKeysParams @@ -23727,6 +24075,72 @@ paths: description: Filter by code. schema: type: string + - in: query + name: created_at + description: Filter by a creation date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Filter by an update date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: deleted_at + description: Filter by a deletion date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date - in: query name: rate style: form @@ -23749,6 +24163,16 @@ paths: gte: type: number description: filter by rates greater than or equal to this number + - in: query + name: q + description: Term used to search tax rates by name. + schema: + type: string + - in: query + name: order + description: A tax rate field to sort-order the retrieved tax rates by. + schema: + type: string - in: query name: offset description: The number of tax rates to skip when retrieving the tax rates. diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index 14bf37b3e9..f5988c19e7 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -50,13 +50,6 @@ tags: description: How to manage currencies url: >- https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-currencies - - name: Customers - description: > - Customers can either be created when they register through the Store APIs, - or created by the admin using the Admin APIs. - externalDocs: - description: How to manage customers - url: https://docs.medusajs.com/modules/customers/admin/manage-customers - name: Customer Groups description: > Customer Groups can be used to organize customers that share similar data @@ -67,6 +60,13 @@ tags: externalDocs: description: How to manage customer groups url: https://docs.medusajs.com/modules/customers/admin/manage-customer-groups + - name: Customers + description: > + Customers can either be created when they register through the Store APIs, + or created by the admin using the Admin APIs. + externalDocs: + description: How to manage customers + url: https://docs.medusajs.com/modules/customers/admin/manage-customers - name: Discounts description: > Admins can create discounts with conditions and rules, providing them with @@ -124,6 +124,13 @@ tags: The notification's type, such as an email or SMS, is determined by the notification provider installed on the Medusa backend. + - name: Order Edits + description: > + An admin can edit an order to remove, add, or update an item's quantity. + When an admin edits an order, they're stored as an `OrderEdit`. + externalDocs: + description: How to edit an order + url: https://docs.medusajs.com/modules/orders/admin/edit-order - name: Orders description: > Orders are purchases made by customers, typically through a storefront @@ -135,21 +142,14 @@ tags: externalDocs: description: How to manage orders url: https://docs.medusajs.com/modules/orders/admin/manage-orders - - name: Order Edits - description: > - An admin can edit an order to remove, add, or update an item's quantity. - When an admin edits an order, they're stored as an `OrderEdit`. - externalDocs: - description: How to edit an order - url: https://docs.medusajs.com/modules/orders/admin/edit-order - - name: Payments - description: > - A payment can be related to an order, swap, return, or more. It can be - captured or refunded. - name: Payment Collections description: > A payment collection is useful for managing additional payments, such as for Order Edits, or installment payments. + - name: Payments + description: > + A payment can be related to an order, swap, return, or more. It can be + captured or refunded. - name: Price Lists description: > A price list are special prices applied to products based on a set of @@ -157,14 +157,6 @@ tags: externalDocs: description: How to manage price lists url: https://docs.medusajs.com/modules/price-lists/admin/manage-price-lists - - name: Products - description: > - Products are saleable items in a store. This also includes [saleable gift - cards](https://docs.medusajs.com/modules/gift-cards/admin/manage-gift-cards#manage-gift-card-product) - in a store. - externalDocs: - description: How to manage products - url: https://docs.medusajs.com/modules/products/admin/manage-products - name: Product Categories description: > Products can be categoriezed into categories. A product can be added into @@ -203,6 +195,14 @@ tags: description: How to manage product variants url: >- https://docs.medusajs.com/modules/products/admin/manage-products#manage-product-variants + - name: Products + description: > + Products are saleable items in a store. This also includes [saleable gift + cards](https://docs.medusajs.com/modules/gift-cards/admin/manage-gift-cards#manage-gift-card-product) + in a store. + externalDocs: + description: How to manage products + url: https://docs.medusajs.com/modules/products/admin/manage-products - name: Publishable API Keys description: > Publishable API Keys can be used to scope Store API calls with an API key, @@ -221,6 +221,16 @@ tags: description: How to manage publishable API keys url: >- https://docs.medusajs.com/development/publishable-api-keys/admin/manage-publishable-api-keys + - name: Regions + description: > + Regions are different countries or geographical regions that the commerce + store serves customers in. + + Admins can manage these regions, their providers, and more. + externalDocs: + description: How to manage regions + url: >- + https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions - name: Reservations description: > Reservations, provided by the [Inventory @@ -234,16 +244,6 @@ tags: description: How to manage item allocations in orders url: >- https://docs.medusajs.com/modules/multiwarehouse/admin/manage-item-allocations-in-orders - - name: Regions - description: > - Regions are different countries or geographical regions that the commerce - store serves customers in. - - Admins can manage these regions, their providers, and more. - externalDocs: - description: How to manage regions - url: >- - https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions - name: Return Reasons description: > Return reasons are key-value pairs that are used to specify why an order diff --git a/www/apps/api-reference/specs/admin/paths/admin_collections.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections.yaml index 142bc873f4..20ab488693 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections.yaml @@ -34,6 +34,11 @@ get: description: a term to search collections by their title or handle. schema: type: string + - in: query + name: order + description: A field to sort-order the retrieved collections by. + schema: + type: string - in: query name: discount_condition_id description: Filter collections by a discount condition ID associated with them. diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml index d86c24ca3c..5568c1bfbf 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml @@ -125,6 +125,13 @@ get: customer groups. schema: type: string + - in: query + name: fields + description: >- + Comma-separated fields that should be included in the returned customer + groups. + schema: + type: string x-codegen: method: list queryParams: AdminGetCustomerGroupsParams diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml index f1f20e25cd..adf4c398c4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml @@ -22,7 +22,14 @@ get: name: expand description: >- Comma-separated relations that should be expanded in the returned - customer. + customers. + schema: + type: string + - in: query + name: fields + description: >- + Comma-separated fields that should be included in the returned + customers. schema: type: string - in: query @@ -30,6 +37,16 @@ get: description: term to search customers' email, first_name, and last_name fields. schema: type: string + - in: query + name: has_account + description: Filter customers by whether they have an account. + schema: + type: boolean + - in: query + name: order + description: A field to sort-order the retrieved customers by. + schema: + type: string - in: query name: groups style: form @@ -39,6 +56,50 @@ get: type: array items: type: string + - in: query + name: created_at + description: Filter by a creation date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Filter by an update date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date x-codegen: method: list queryParams: AdminGetCustomersParams diff --git a/www/apps/api-reference/specs/admin/paths/admin_discounts.yaml b/www/apps/api-reference/specs/admin/paths/admin_discounts.yaml index d8d07ca410..0f63545320 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_discounts.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_discounts.yaml @@ -59,6 +59,55 @@ get: discount. schema: type: string + - in: query + name: order + description: A discount field to sort-order the retrieved discounts by. + schema: + type: string + - in: query + name: created_at + description: Filter by a creation date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Filter by an update date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date x-codegen: method: list queryParams: AdminGetDiscountsParams diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml index 2c18e9c97c..4cf45c4d15 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml @@ -25,6 +25,77 @@ get: order's cart schema: type: string + - in: query + name: order + description: Field to sort retrieved draft orders by. + schema: + type: string + - in: query + name: expand + description: A comma-separated list of fields to expand. + schema: + type: string + - in: query + name: fields + description: A comma-separated list of fields to include in the response. + schema: + type: string + - in: query + name: created_at + description: Filter by a creation date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Filter by an update date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: status + style: form + explode: false + description: Filter by status + schema: + type: array + items: + type: string + enum: + - open + - completed x-codegen: method: list queryParams: AdminGetDraftOrdersParams diff --git a/www/apps/api-reference/specs/admin/paths/admin_gift-cards.yaml b/www/apps/api-reference/specs/admin/paths/admin_gift-cards.yaml index c281cba274..89c660585d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_gift-cards.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_gift-cards.yaml @@ -23,6 +23,11 @@ get: description: a term to search gift cards' code or display ID schema: type: string + - in: query + name: order + description: A gift card field to sort-order the retrieved gift cards by. + schema: + type: string x-codegen: method: list queryParams: AdminGetGiftCardsParams diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml index 61d14b4b88..23f05eb017 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml @@ -40,6 +40,11 @@ get: description: term to search inventory item's sku, title, and description. schema: type: string + - in: query + name: order + description: Field to sort-order inventory items by. + schema: + type: string - in: query name: location_id style: form diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml index 3b959dd8b0..8c3956d279 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml @@ -217,7 +217,7 @@ get: type: string - in: query name: order - description: A order field to sort-order the retrieved orders by. + description: Field to sort retrieved orders by. schema: type: string x-codegen: diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml index 1b957dbaab..e2acf32fb2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml @@ -21,9 +21,17 @@ get: type: string - in: query name: id - description: Filter by product ID + style: form + explode: false + description: Filter by product IDs. schema: - type: string + oneOf: + - type: string + description: ID of the product. + - type: array + items: + type: string + description: ID of a product. - in: query name: status description: Filter by product status @@ -79,7 +87,7 @@ get: name: is_giftcard description: A boolean value to filter by whether the product is a gift card or not. schema: - type: string + type: boolean - in: query name: type description: Filter product type. diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml index 8036e87aeb..eeb7ac3fde 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml @@ -4,11 +4,6 @@ get: description: > Retrieve a list of Product Variants associated with a Product. The variants can be paginated. - - - By default, each variant will only have the `id` and `variant_id` fields. - You can use the `expand` and `fields` request parameters to retrieve more - fields or relations. x-authenticated: true parameters: - in: path @@ -17,6 +12,11 @@ get: description: ID of the product. schema: type: string + - in: query + name: id + description: IDs to filter product variants by. + schema: + type: string - in: query name: fields description: >- @@ -45,6 +45,74 @@ get: schema: type: integer default: 100 + - in: query + name: q + description: Search term to search product variants' title, sku, and products' title. + schema: + type: string + - in: query + name: 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 `-`. + schema: + type: string + - in: query + name: manage_inventory + description: Filter product variants by whether their inventory is managed or not. + schema: + type: boolean + - in: query + name: allow_backorder + description: >- + Filter product variants by whether they are allowed to be backordered or + not. + schema: + type: boolean + - in: query + name: created_at + description: Filter by a creation date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Filter by an update date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date x-codegen: method: listVariants queryParams: AdminGetProductsVariantsParams diff --git a/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys.yaml b/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys.yaml index a104dd9801..69a0dea62a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys.yaml @@ -40,6 +40,80 @@ get: publishable API keys. schema: type: string + - in: query + name: order + description: A field to sort-order the retrieved publishable API keys by. + schema: + type: string + - in: query + name: created_at + required: false + description: Filter by a creation date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + required: false + description: Filter by a update date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: revoked_at + required: false + description: Filter by a revocation date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date x-codegen: method: list queryParams: GetPublishableApiKeysParams diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml index 0745b309a8..c2ff0e31b4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml @@ -27,6 +27,72 @@ get: description: Filter by code. schema: type: string + - in: query + name: created_at + description: Filter by a creation date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Filter by an update date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: deleted_at + description: Filter by a deletion date range. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date - in: query name: rate style: form @@ -49,6 +115,16 @@ get: gte: type: number description: filter by rates greater than or equal to this number + - in: query + name: q + description: Term used to search tax rates by name. + schema: + type: string + - in: query + name: order + description: A tax rate field to sort-order the retrieved tax rates by. + schema: + type: string - in: query name: offset description: The number of tax rates to skip when retrieving the tax rates.