diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateInventoryItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateInventoryItem.yaml index a974fc3ee4..e5c490d22e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateInventoryItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateInventoryItem.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminCreateInventoryItem properties: sku: type: string @@ -56,4 +57,3 @@ properties: metadata: type: object description: The inventory item's metadata. -x-schemaName: AdminCreateInventoryItem diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductCategory.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductCategory.yaml index 35a28c81d9..19c2aa6d6e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductCategory.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductCategory.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminCreateProductCategory required: - name properties: @@ -27,11 +28,10 @@ properties: type: string title: parent_category_id description: The product category's parent category id. - metadata: - type: object - description: The product category's metadata. rank: type: number title: rank description: The product category's rank. -x-schemaName: AdminCreateProductCategory + metadata: + type: object + description: The product category's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductTag.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductTag.yaml index 18462a72a4..3c412794ab 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductTag.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductTag.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminCreateProductTag required: - value properties: @@ -10,4 +11,3 @@ properties: metadata: type: object description: The product tag's metadata. -x-schemaName: AdminCreateProductTag diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateRefundReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateRefundReason.yaml index 1cac026bcd..9add02da66 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateRefundReason.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateRefundReason.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminCreateRefundReason required: - label properties: @@ -11,4 +12,3 @@ properties: type: string title: description description: The refund reason's description. -x-schemaName: AdminCreateRefundReason diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateRegion.yaml index a25a942ec7..c7b2be7076 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateRegion.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminCreateRegion required: - name - currency_code @@ -23,6 +24,10 @@ properties: type: boolean title: automatic_taxes description: The region's automatic taxes. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The region's is tax inclusive. payment_providers: type: array description: The region's payment providers. @@ -33,8 +38,3 @@ properties: metadata: type: object description: The region's metadata. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The region's is tax inclusive. -x-schemaName: AdminCreateRegion diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateReservation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateReservation.yaml index 928e366407..bf02a07a9c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateReservation.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateReservation.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminCreateReservation required: - location_id - inventory_item_id @@ -28,4 +29,3 @@ properties: metadata: type: object description: The reservation's metadata. -x-schemaName: AdminCreateReservation diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml index 34fbcd4738..5bf5ce727f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminCreateShippingOption required: - name - service_zone_id @@ -26,9 +27,10 @@ properties: description: The shipping option's data. price_type: type: string + description: The shipping option's price type. enum: - - calculated - flat + - calculated provider_id: type: string title: provider_id @@ -42,6 +44,7 @@ properties: oneOf: - type: object description: The price's prices. + x-schemaName: AdminCreateShippingOptionPriceWithCurrency required: - currency_code - amount @@ -56,6 +59,7 @@ properties: description: The price's amount. - type: object description: The price's prices. + x-schemaName: AdminCreateShippingOptionPriceWithRegion required: - region_id - amount @@ -73,4 +77,3 @@ properties: description: The shipping option's rules. items: $ref: ./AdminCreateShippingOptionRule.yaml -x-schemaName: AdminCreateShippingOption diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOptionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOptionRule.yaml index c974d26878..5fca721e07 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOptionRule.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOptionRule.yaml @@ -1,5 +1,6 @@ type: object description: The rule's rules. +x-schemaName: AdminCreateShippingOptionRule required: - operator - attribute @@ -7,14 +8,15 @@ required: properties: operator: type: string + description: The rule's operator. enum: - - in + - gt + - lt - eq - ne - - gt - - gte - - lt + - in - lte + - gte - nin attribute: type: string @@ -31,4 +33,3 @@ properties: type: string title: value description: The value's details. -x-schemaName: AdminCreateShippingOptionRule diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingProfile.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingProfile.yaml new file mode 100644 index 0000000000..221e02bf81 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingProfile.yaml @@ -0,0 +1,18 @@ +type: object +description: SUMMARY +required: + - name + - type +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. +x-schemaName: AdminCreateShippingProfile diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePaymentCollectionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePaymentCollectionResponse.yaml index 042dc95d6a..479fe851d6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePaymentCollectionResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePaymentCollectionResponse.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminDeletePaymentCollectionResponse required: - id - object @@ -12,10 +13,9 @@ properties: object: type: string title: object - description: The name of the deleted object. + description: SUMMARY default: payment-collection deleted: type: boolean title: deleted - description: Whether the payment collection was deleted. -x-schemaName: AdminDeletePaymentCollectionResponse + description: SUMMARY diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeDeleteResponse.yaml index 78d029950c..4fa416b52c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeDeleteResponse.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminExchangeDeleteResponse required: - id - object @@ -17,5 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the exchange was deleted. -x-schemaName: AdminExchangeDeleteResponse + description: Whether the Exchange was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSet.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSet.yaml index 3414f22b02..e9131c3f4a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSet.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSet.yaml @@ -1,5 +1,15 @@ type: object -description: The fulfillment set that the service zone belongs to. +description: The fulfillment set's parent. +x-schemaName: AdminFulfillmentSet +required: + - id + - name + - type + - location + - service_zones + - created_at + - updated_at + - deleted_at properties: id: type: string @@ -35,13 +45,3 @@ properties: format: date-time title: deleted_at description: The parent's deleted at. -required: - - id - - name - - type - - location - - service_zones - - created_at - - updated_at - - deleted_at -x-schemaName: AdminFulfillmentSet diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml index 5388547b61..6ea415b06d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml @@ -1,18 +1,18 @@ type: object -description: The product's variants. +description: SUMMARY x-schemaName: AdminProductVariantParams properties: q: type: string title: q - description: The variant's q. + description: The product's q. id: oneOf: - type: string title: id - description: The variant's ID. + description: The product's ID. - type: array - description: The variant's ID. + description: The product's ID. items: type: string title: id @@ -20,14 +20,14 @@ properties: manage_inventory: type: boolean title: manage_inventory - description: The variant's manage inventory. + description: The product's manage inventory. allow_backorder: type: boolean title: allow_backorder - description: The variant's allow backorder. + description: The product's allow backorder. created_at: type: object - description: The variant's created at. + description: The product's created at. properties: $and: type: array @@ -81,6 +81,150 @@ properties: description: Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of this + parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 the conditions in this parameter. items: @@ -154,7 +298,7 @@ properties: description: Filter by whether a value for this parameter exists (not `null`). updated_at: type: object - description: The variant's updated at. + description: The product's updated at. properties: $and: type: array @@ -208,6 +352,150 @@ properties: description: Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of this + parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 the conditions in this parameter. items: @@ -281,7 +569,7 @@ properties: description: Filter by whether a value for this parameter exists (not `null`). deleted_at: type: object - description: The variant's deleted at. + description: The product's deleted at. properties: $and: type: array @@ -335,6 +623,150 @@ properties: description: Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of this + parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 the conditions in this parameter. items: @@ -409,19 +841,19 @@ properties: limit: type: number title: limit - description: The variant's limit. + description: The product's limit. offset: type: number title: offset - description: The variant's offset. + description: The product's offset. order: type: string title: order - description: The variant's order. + description: The product's order. fields: type: string title: fields - description: The variant's fields. + description: The product's fields. $and: type: array description: >- diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonDeleteResponse.yaml index 78053ef89d..3743526610 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonDeleteResponse.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminReturnReasonDeleteResponse required: - id - object @@ -17,5 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the return reason was deleted. -x-schemaName: AdminReturnReasonDeleteResponse + description: Whether the Return Reason was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneDeleteResponse.yaml index 62609511c4..488b2b6081 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneDeleteResponse.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminServiceZoneDeleteResponse required: - id - object @@ -8,16 +9,14 @@ properties: id: type: string title: id - description: The service zone's ID. + description: The fulfillment set's ID. object: type: string title: object description: The name of the deleted object. - default: service_zone deleted: type: boolean title: deleted - description: Whether the service zone was deleted. + description: Whether the Fulfillment Set was deleted. parent: $ref: ./AdminFulfillmentSet.yaml -x-schemaName: AdminServiceZoneDeleteResponse diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCreatePaymentCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCreatePaymentCollection.yaml index f0f56b1048..c88dbe20d2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCreatePaymentCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCreatePaymentCollection.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: StoreCreatePaymentCollection required: - cart_id properties: @@ -7,4 +8,3 @@ properties: type: string title: cart_id description: The payment collection's cart id. -x-schemaName: StoreCreatePaymentCollection diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnItem.yaml index 839a17cf5c..021192cc25 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnItem.yaml @@ -1,5 +1,6 @@ type: object description: The item's items. +x-schemaName: StoreCreateReturnItem required: - id - quantity @@ -20,4 +21,3 @@ properties: type: string title: note description: The item's note. -x-schemaName: StoreCreateReturnItem diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnShipping.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnShipping.yaml index ad5ccf7fdc..ff842a7175 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnShipping.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnShipping.yaml @@ -1,5 +1,6 @@ type: object description: The return's return shipping. +x-schemaName: StoreCreateReturnShipping required: - option_id properties: @@ -11,4 +12,3 @@ properties: type: number title: price description: The return shipping's price. -x-schemaName: StoreCreateReturnShipping diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index aba8f1eb7e..d747454870 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -6689,12 +6689,12 @@ paths: 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 customer group's q. + description: Search term to filter the customer group's searchable properties. required: false schema: type: string title: q - description: The customer group's q. + description: Search term to filter the customer group's searchable properties. - name: id in: query required: false @@ -6702,13 +6702,13 @@ paths: oneOf: - type: string title: id - description: The customer group's ID. + description: Filter by a customer group's IDs. - type: array - description: The customer group's ID. + description: Filter by customer group IDs. items: type: string title: id - description: The id's ID. + description: A customer group's ID. - name: name in: query required: false @@ -6716,13 +6716,13 @@ paths: oneOf: - type: string title: name - description: The customer group's name. + description: Filter by a customer group's name. - type: array - description: The customer group's name. + description: Filter by customer group names. items: type: string title: name - description: The name's details. + description: A customer group's name. - name: customers in: query required: false @@ -6730,13 +6730,13 @@ paths: oneOf: - type: string title: customers - description: The customer group's customers. + description: Filter by the ID of a customer to retrieve its groups. - type: array - description: The customer group's customers. + description: Filter by customer IDs to retrieve their groups. items: type: string title: customers - description: The customer's customers. + description: A customer's ID. - $ref: '#/components/schemas/AdminCustomerInGroupFilters' - name: created_by in: query @@ -6745,20 +6745,20 @@ paths: oneOf: - type: string title: created_by - description: The customer group's created by. + description: Filter by an ID of a user to retrieve the customer groups they created. - type: array - description: The customer group's created by. + description: Filter by the IDs of users to retrieve the customer groups they created. items: type: string title: created_by - description: The created by's details. + description: The user's ID. - name: created_at in: query - description: The customer group's created at. + description: Filter the customer group by its creation date. required: false schema: type: object - description: The customer group's created at. + description: Filter the customer group by its creation date. properties: $and: type: array @@ -6778,11 +6778,11 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -6793,19 +6793,19 @@ paths: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -6827,42 +6827,42 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + 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 conditions in this parameter. + description: Filter by values not matching the values of this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -6901,31 +6901,31 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + 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 the conditions in this parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -6964,32 +6964,32 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + 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: The customer group's updated at. + description: Filter the customer groups by their update date. required: false schema: type: object - description: The customer group's updated at. + description: Filter the customer groups by their update date. properties: $and: type: array @@ -7009,11 +7009,11 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -7024,19 +7024,19 @@ paths: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -7058,42 +7058,42 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + 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 conditions in this parameter. + description: Filter by values not matching the values of this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -7132,31 +7132,31 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + 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 the conditions in this parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -7195,32 +7195,32 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The customer group's deleted at. + description: Filter the customer groups by their deletion date. required: false schema: type: object - description: The customer group's deleted at. + description: Filter the customer groups by their deletion date. properties: $and: type: array @@ -7240,11 +7240,11 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -7255,19 +7255,19 @@ paths: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -7289,42 +7289,42 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + 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 conditions in this parameter. + description: Filter by values not matching the values of this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -7363,31 +7363,31 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + 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 the conditions in this parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -7426,21 +7426,21 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -8014,30 +8014,22 @@ paths: oneOf: - type: string title: groups - description: The customer's groups. + description: Filter by a customer group's ID to retrieve customers that belong to it. + - $ref: '#/components/schemas/CustomerGroupInCustomerFilters' - type: array - description: The customer's groups. + description: Filter by customer group IDs to retrieve customers that belong to them. items: type: string title: groups - description: The group's groups. - - $ref: '#/components/schemas/CustomerGroupInCustomerFilters' - - name: has_account - in: query - description: The customer's has account. - required: false - schema: - type: boolean - title: has_account - description: The customer's has account. + description: The customer group's ID. - name: q in: query - description: The customer's q. + description: Search term to filter the customer's searchable properties by. required: false schema: type: string title: q - description: The customer's q. + description: Search term to filter the customer's searchable properties by. - name: id in: query required: false @@ -8045,15 +8037,15 @@ paths: oneOf: - type: string title: id - description: The customer's ID. + description: Filter by a customer's ID. - type: array - description: The customer's ID. + description: Filter by customer IDs. items: type: string title: id - description: The id's ID. + description: A customer's ID. - type: object - description: The customer's ID. + description: Filters to apply on the customer ID. properties: $and: type: array @@ -8073,20 +8065,20 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -8097,7 +8089,7 @@ paths: title: $ne description: Filter by values not equal to this parameter. - type: array - description: Filter by values not equal to this parameter. + description: Filter by values not in this array. items: type: string title: $ne @@ -8109,13 +8101,13 @@ paths: oneOf: - type: string title: $in - description: Filter by values in this array. + description: Filter by matching value. - type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: Filter matching values. $nin: type: array description: Filter by values not in this array. @@ -8123,18 +8115,18 @@ paths: oneOf: - type: string title: $nin - description: Filter by values not in this array. + description: Filter by values not matching this parameter. - type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -8156,7 +8148,7 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -8183,15 +8175,15 @@ paths: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + 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 conditions in this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. $gt: type: string title: $gt @@ -8250,18 +8242,18 @@ paths: title: $exists description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: array description: Filter by values not matching the conditions in this parameter. items: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -8283,7 +8275,7 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -8298,27 +8290,27 @@ paths: items: type: string title: $in - description: Filter by values in this array. + description: Filter by exact matches. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + 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 conditions in this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. $gt: type: string title: $gt @@ -8382,7 +8374,7 @@ paths: title: $gt description: Filter by values greater than this parameter. Useful for numbers and dates only. - type: array - description: Filter by values greater than this parameter. Useful for numbers and dates only. + description: Filter by values greater than items in this array. Useful for numbers and dates only. items: type: string title: $gt @@ -8393,7 +8385,7 @@ paths: title: $gte description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - type: array - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + description: Filter by values greater than or equal to items in this array. Useful for numbers and dates only. items: type: string title: $gte @@ -8404,7 +8396,7 @@ paths: title: $lt description: Filter by values less than this parameter. Useful for numbers and dates only. - type: array - description: Filter by values less than this parameter. Useful for numbers and dates only. + description: Filter by values less than items in this array. Useful for numbers and dates only. items: type: string title: $lt @@ -8415,7 +8407,7 @@ paths: title: $lte description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - type: array - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + description: Filter by values less than or equal to items in this array. Useful for numbers and dates only. items: type: string title: $lte @@ -8468,17 +8460,17 @@ paths: oneOf: - type: string title: email - description: The customer's email. + description: Filter by a customer email. format: email - type: array - description: The customer's email. + description: Filter by customer emails. items: type: string title: email - description: The email's details. + description: A customer's email. format: email - type: object - description: The customer's email. + description: Filter by conditions on the customer email. properties: $and: type: array @@ -8498,34 +8490,68 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. + oneOf: + - type: string + title: $ne + description: Filter by values not equal to this parameter. + - type: array + description: Filter by values not in this array. + items: + 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: Filter by values in this array. + oneOf: + - type: string + title: $in + description: Filter by matching value. + - type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter matching values. $nin: type: array description: Filter by values not in this array. items: - type: string - title: $nin - description: Filter by values not in this array. + oneOf: + - type: string + title: $nin + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -8547,7 +8573,7 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -8574,15 +8600,15 @@ paths: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + 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 conditions in this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. $gt: type: string title: $gt @@ -8641,27 +8667,176 @@ paths: title: $exists description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + 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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by exact matches. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. + oneOf: + - type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values greater than items in this array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values greater than or equal to items in this array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values less than items in this array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values less than or equal to items in this array. Useful for numbers and dates only. + items: + 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 @@ -8710,15 +8885,15 @@ paths: oneOf: - type: string title: company_name - description: The customer's company name. + description: Filter by a customer's company name. - type: array - description: The customer's company name. + description: Filter by customer company names. items: type: string title: company_name - description: The company name's details. + description: The customer's company name. - type: object - description: The customer's company name. + description: Filter by conditions on the customer's company name. properties: $and: type: array @@ -8738,34 +8913,68 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. + oneOf: + - type: string + title: $ne + description: Filter by values not equal to this parameter. + - type: array + description: Filter by values not in this array. + items: + 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: Filter by values in this array. + oneOf: + - type: string + title: $in + description: Filter by matching value. + - type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter matching values. $nin: type: array description: Filter by values not in this array. items: - type: string - title: $nin - description: Filter by values not in this array. + oneOf: + - type: string + title: $nin + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -8787,7 +8996,7 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -8814,15 +9023,15 @@ paths: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + 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 conditions in this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. $gt: type: string title: $gt @@ -8881,27 +9090,176 @@ paths: title: $exists description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + 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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by exact matches. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. + oneOf: + - type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values greater than items in this array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values greater than or equal to items in this array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values less than items in this array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values less than or equal to items in this array. Useful for numbers and dates only. + items: + 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 @@ -8950,15 +9308,15 @@ paths: oneOf: - type: string title: first_name - description: The customer's first name. + description: Filter by a customer's first name. - type: array - description: The customer's first name. + description: Filter by customer first names. items: type: string title: first_name - description: The first name's details. + description: A customer's first name. - type: object - description: The customer's first name. + description: Filter by conditions on the first name. properties: $and: type: array @@ -8978,34 +9336,68 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. + oneOf: + - type: string + title: $ne + description: Filter by values not equal to this parameter. + - type: array + description: Filter by values not in this array. + items: + 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: Filter by values in this array. + oneOf: + - type: string + title: $in + description: Filter by matching value. + - type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter matching values. $nin: type: array description: Filter by values not in this array. items: - type: string - title: $nin - description: Filter by values not in this array. + oneOf: + - type: string + title: $nin + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -9027,7 +9419,7 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -9054,15 +9446,15 @@ paths: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + 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 conditions in this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. $gt: type: string title: $gt @@ -9121,27 +9513,176 @@ paths: title: $exists description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + 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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by exact matches. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. + oneOf: + - type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values greater than items in this array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values greater than or equal to items in this array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values less than items in this array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values less than or equal to items in this array. Useful for numbers and dates only. + items: + 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 @@ -9190,15 +9731,15 @@ paths: oneOf: - type: string title: last_name - description: The customer's last name. + description: Filter by a customer's last name. - type: array - description: The customer's last name. + description: Filter by customer last names. items: type: string title: last_name - description: The last name's details. + description: A customer's last name. - type: object - description: The customer's last name. + description: Filter by conditions on a customer's last name. properties: $and: type: array @@ -9218,34 +9759,68 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. + oneOf: + - type: string + title: $ne + description: Filter by values not equal to this parameter. + - type: array + description: Filter by values not in this array. + items: + 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: Filter by values in this array. + oneOf: + - type: string + title: $in + description: Filter by matching value. + - type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter matching values. $nin: type: array description: Filter by values not in this array. items: - type: string - title: $nin - description: Filter by values not in this array. + oneOf: + - type: string + title: $nin + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -9267,7 +9842,7 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -9294,15 +9869,15 @@ paths: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + 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 conditions in this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. $gt: type: string title: $gt @@ -9361,27 +9936,176 @@ paths: title: $exists description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + 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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by exact matches. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. + oneOf: + - type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values greater than items in this array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values greater than or equal to items in this array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values less than items in this array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values less than or equal to items in this array. Useful for numbers and dates only. + items: + 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 @@ -9430,15 +10154,15 @@ paths: oneOf: - type: string title: created_by - description: The customer's created by. + description: Filter by a user ID to retrieve the customers they created. - type: array - description: The customer's created by. + description: Filter by user IDs to retrieve customers they created. items: type: string title: created_by - description: The created by's details. + description: A user's ID. - type: object - description: The customer's created by. + description: Filter by conditions on the user ID that created the customer. properties: $and: type: array @@ -9458,34 +10182,68 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. + oneOf: + - type: string + title: $ne + description: Filter by values not equal to this parameter. + - type: array + description: Filter by values not in this array. + items: + 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: Filter by values in this array. + oneOf: + - type: string + title: $in + description: Filter by matching value. + - type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter matching values. $nin: type: array description: Filter by values not in this array. items: - type: string - title: $nin - description: Filter by values not in this array. + oneOf: + - type: string + title: $nin + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -9507,7 +10265,7 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -9534,15 +10292,15 @@ paths: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + 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 conditions in this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. $gt: type: string title: $gt @@ -9601,27 +10359,176 @@ paths: title: $exists description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + 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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by exact matches. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. + oneOf: + - type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values greater than items in this array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values greater than or equal to items in this array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values less than items in this array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values less than or equal to items in this array. Useful for numbers and dates only. + items: + 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 @@ -9665,11 +10572,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: created_at in: query - description: The customer's created at. + description: Filter by the customer's creation date. required: false schema: type: object - description: The customer's created at. + description: Filter by the customer's creation date. properties: $and: type: array @@ -9689,11 +10596,11 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -9704,19 +10611,19 @@ paths: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -9738,42 +10645,42 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + 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 conditions in this parameter. + description: Filter by values not matching the values of this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -9812,31 +10719,31 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + 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 the conditions in this parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -9875,32 +10782,32 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + 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: The customer's updated at. + description: Filter by a customer's update date. required: false schema: type: object - description: The customer's updated at. + description: Filter by a customer's update date. properties: $and: type: array @@ -9920,11 +10827,11 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -9935,19 +10842,19 @@ paths: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -9969,42 +10876,42 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + 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 conditions in this parameter. + description: Filter by values not matching the values of this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -10043,31 +10950,31 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + 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 the conditions in this parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -10106,32 +11013,32 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The customer's deleted at. + description: Filter a customer by their deletion date. required: false schema: type: object - description: The customer's deleted at. + description: Filter a customer by their deletion date. properties: $and: type: array @@ -10151,11 +11058,11 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -10166,19 +11073,19 @@ paths: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -10200,42 +11107,42 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + 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 conditions in this parameter. + description: Filter by values not matching the values of this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -10274,31 +11181,31 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + 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 the conditions in this parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -10337,21 +11244,21 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -10376,6 +11283,14 @@ paths: items: type: object title: $or + - name: has_account + in: query + description: The customer's has account. + required: false + schema: + type: boolean + title: has_account + description: The customer's has account. security: - api_token: [] - cookie_auth: [] @@ -10396,7 +11311,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of customers. required: - limit - offset @@ -10405,17 +11320,17 @@ paths: limit: type: number title: limit - description: The customer's limit. + description: The maximum number of items returned in the list. offset: type: number title: offset - description: The customer's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The customer's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of customers. required: - customers properties: @@ -10855,7 +11770,7 @@ paths: get: operationId: GetCustomersIdAddresses 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 `query`. The addresses can also be paginated. x-authenticated: true parameters: - name: id @@ -10906,12 +11821,12 @@ paths: 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 customer's q. + description: Search term to apply on the address's searchable properties. required: false schema: type: string title: q - description: The customer's q. + description: Search term to apply on the address's searchable properties. - name: company in: query required: false @@ -10919,13 +11834,13 @@ paths: oneOf: - type: string title: company - description: The customer's company. + description: Filter by a company. - type: array - description: The customer's company. + description: Filter by companies. items: type: string title: company - description: The company's details. + description: A company's name. - name: city in: query required: false @@ -10933,13 +11848,13 @@ paths: oneOf: - type: string title: city - description: The customer's city. + description: Filter by a city. - type: array - description: The customer's city. + description: Filter by cities. items: type: string title: city - description: The city's details. + description: A city's name. - name: country_code in: query required: false @@ -10947,13 +11862,13 @@ paths: oneOf: - type: string title: country_code - description: The customer's country code. + description: Filter by a currency code. - type: array - description: The customer's country code. + description: Filter by currency codes. items: type: string title: country_code - description: The country code's details. + description: A currency code. - name: province in: query required: false @@ -10961,13 +11876,13 @@ paths: oneOf: - type: string title: province - description: The customer's province. + description: Filter by a province. - type: array - description: The customer's province. + description: Filter by provinces. items: type: string title: province - description: The province's details. + description: A province code. - name: postal_code in: query required: false @@ -10975,13 +11890,13 @@ paths: oneOf: - type: string title: postal_code - description: The customer's postal code. + description: Filter by a postal code. - type: array - description: The customer's postal code. + description: Filter by postal codes. items: type: string title: postal_code - description: The postal code's details. + description: A postal code. - name: $and in: query description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. @@ -11022,7 +11937,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of customer addresses. required: - limit - offset @@ -11031,23 +11946,23 @@ paths: limit: type: number title: limit - description: The customer's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The customer's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The customer's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of customer addresses required: - addresses properties: addresses: type: array - description: The customer's addresses. + description: The customer addresses. items: $ref: '#/components/schemas/AdminCustomerAddress' '400': @@ -11248,7 +12163,7 @@ paths: get: operationId: GetCustomersIdAddressesAddress_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 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 @@ -11689,27 +12604,865 @@ paths: oneOf: - type: string title: id - description: The draft order's ID. + description: Filter by a draft order's ID. - type: array - description: The draft order's ID. + description: Filter by draft order IDs. items: type: string title: id - description: The id's ID. - - name: name + description: A draft order's ID. + - type: object + description: Filter by conditions on the draft order's ID. + 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 exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. + $ne: + oneOf: + - type: string + title: $ne + description: Filter by values not equal to this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + oneOf: + - type: string + title: $in + description: Filter by matching value. + - type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter matching values. + $nin: + type: array + description: Filter by values not in this array. + items: + oneOf: + - type: string + title: $nin + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $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 in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - type: array + description: Filter by values not in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + 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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by exact matches. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + $gt: + oneOf: + - type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values greater than items in this array. Useful for numbers and dates only. + items: + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + $gte: + oneOf: + - type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values greater than or equal to items in this array. Useful for numbers and dates only. + items: + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + $lt: + oneOf: + - type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values less than items in this array. Useful for numbers and dates only. + items: + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + $lte: + oneOf: + - type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values less than or equal to items in this array. Useful for numbers and dates only. + items: + 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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: status in: query required: false schema: oneOf: - type: string - title: name - description: The draft order's name. + title: status + description: Filter by a draft order's status. - type: array - description: The draft order's name. + description: Filter by draft order statuses. items: type: string - title: name - description: The name's details. + title: status + description: The draft order status. + - type: object + description: Filter by conditions on the status. + 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 exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. + $ne: + oneOf: + - type: string + title: $ne + description: Filter by values not equal to this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + oneOf: + - type: string + title: $in + description: Filter by matching value. + - type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter matching values. + $nin: + type: array + description: Filter by values not in this array. + items: + oneOf: + - type: string + title: $nin + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $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 in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - type: array + description: Filter by values not in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + 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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by exact matches. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + $gt: + oneOf: + - type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values greater than items in this array. Useful for numbers and dates only. + items: + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + $gte: + oneOf: + - type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values greater than or equal to items in this array. Useful for numbers and dates only. + items: + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + $lt: + oneOf: + - type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values less than items in this array. Useful for numbers and dates only. + items: + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + $lte: + oneOf: + - type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + - type: array + description: Filter by values less than or equal to items in this array. Useful for numbers and dates only. + items: + 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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: $and + in: query + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + required: false + schema: + 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 + - name: $or + in: query + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + required: false + schema: + 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 - name: sales_channel_id in: query description: The draft order's sales channel id. @@ -11730,8 +13483,16 @@ paths: description: The draft order's fulfillment status. items: 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: The draft order's payment status. @@ -11741,8 +13502,18 @@ paths: description: The draft order's payment status. items: 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: The draft order's region id. @@ -12224,449 +13995,6 @@ paths: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - - name: status - in: query - required: false - schema: - oneOf: - - type: string - title: status - description: The draft order's status. - - type: array - description: The draft order's status. - items: - type: string - title: status - description: The status's details. - - type: object - description: The draft order's status. - 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 an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - oneOf: - - type: string - title: $ne - description: Filter by values not equal to this parameter. - - type: array - description: Filter by values not equal to this parameter. - items: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - oneOf: - - type: string - title: $in - description: Filter by values in this array. - - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - oneOf: - - type: string - title: $nin - description: Filter by values not in this array. - - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - $gt: - oneOf: - - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - - type: array - description: Filter by values greater than this parameter. Useful for numbers and dates only. - items: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - oneOf: - - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - - type: array - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - items: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - oneOf: - - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - - type: array - description: Filter by values less than this parameter. Useful for numbers and dates only. - items: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - oneOf: - - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - - type: array - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - items: - 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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - - name: $and - in: query - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - required: false - schema: - 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 - - name: $or - in: query - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - required: false - schema: - 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 security: - api_token: [] - cookie_auth: [] @@ -13117,7 +14445,7 @@ paths: get: 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. + 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 @@ -13206,11 +14534,11 @@ paths: 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: deleted_at in: query - description: The exchange's deleted at. + description: Filter by an exchange's deletion date. required: false schema: type: object - description: The exchange's deleted at. + description: Filter by an exchange's deletion date. properties: $and: type: array @@ -13230,11 +14558,11 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -13245,19 +14573,19 @@ paths: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -13279,42 +14607,42 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + 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 conditions in this parameter. + description: Filter by values not matching the values of this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -13353,31 +14681,31 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + 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 the conditions in this parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -13416,33 +14744,33 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - name: q in: query - description: The exchange's q. + description: Search term to apply on an exchange's searchable properties. required: false schema: type: string title: q - description: The exchange's q. + description: Search term to apply on an exchange's searchable properties. - name: id in: query required: false @@ -13450,13 +14778,13 @@ paths: oneOf: - type: string title: id - description: The exchange's ID. + description: Filter by an exchange ID. - type: array - description: The exchange's ID. + description: Filter by exchange IDs. items: type: string title: id - description: The id's ID. + description: An exchange ID. - name: order_id in: query required: false @@ -13464,13 +14792,13 @@ paths: oneOf: - type: string title: order_id - description: The exchange's order id. + description: Filter by an exchange's order ID. - type: array - description: The exchange's order id. + description: Filter by order IDs that the exchanges belong to. items: type: string title: order_id - description: The order id's details. + description: An order's ID. - name: status in: query required: false @@ -13478,20 +14806,20 @@ paths: oneOf: - type: string title: status - description: The exchange's status. + description: Filter by an exchange's status. - type: array - description: The exchange's status. + description: Filter by exchange statuses. items: type: string title: status - description: The status's details. + description: An exchange status. - name: created_at in: query - description: The exchange's created at. + description: Filter by the exchange's creation date. required: false schema: type: object - description: The exchange's created at. + description: Filter by the exchange's creation date. properties: $and: type: array @@ -13511,11 +14839,11 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -13526,19 +14854,19 @@ paths: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -13560,42 +14888,42 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + 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 conditions in this parameter. + description: Filter by values not matching the values of this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -13634,31 +14962,31 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + 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 the conditions in this parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -13697,32 +15025,32 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + 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: The exchange's updated at. + description: Filter by the exchange's update date. required: false schema: type: object - description: The exchange's updated at. + description: Filter by the exchange's update date. properties: $and: type: array @@ -13742,11 +15070,11 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -13757,19 +15085,19 @@ paths: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -13791,42 +15119,42 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + 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 conditions in this parameter. + description: Filter by values not matching the values of this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -13865,31 +15193,31 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + 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 the conditions in this parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -13928,21 +15256,21 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -14115,8 +15443,8 @@ paths: /admin/exchanges/{id}: get: operationId: GetExchangesId - summary: Get a Exchange - description: Retrieve a exchange by its ID. You can expand the exchange's relations or select the fields that should be returned. + 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. x-authenticated: true parameters: - name: id @@ -15393,29 +16721,29 @@ paths: oneOf: - type: string title: id - description: The fulfillment provider's ID. + description: Filter by a fulfillment provider's ID. - type: array - description: The fulfillment provider's ID. + description: Filter by fulfillment provider IDs. items: type: string title: id - description: The id's ID. + description: A fulfillment provider ID. - name: is_enabled in: query - description: The fulfillment provider's is enabled. + description: Filter by whether the fulfillment provider is enabled. required: false schema: type: boolean title: is_enabled - description: The fulfillment provider's is enabled. + description: Filter by whether the fulfillment provider is enabled. - name: q in: query - description: The fulfillment provider's q. + description: Search term to filter a fulfillment provider's searchable properties. required: false schema: type: string title: q - description: The fulfillment provider's q. + description: Search term to filter a fulfillment provider's searchable properties. - name: stock_location_id in: query required: false @@ -15423,13 +16751,13 @@ paths: oneOf: - type: string title: stock_location_id - description: The fulfillment provider's stock location id. + description: Filter by associated stock location's ID. - type: array - description: The fulfillment provider's stock location id. + description: Filter by associated stock location IDs. items: type: string title: stock_location_id - description: The stock location id's details. + description: A stock location's ID. security: - api_token: [] - cookie_auth: [] @@ -15717,8 +17045,9 @@ paths: /admin/fulfillment-sets/{id}/service-zones/{zone_id}: get: operationId: GetFulfillmentSetsIdServiceZonesZone_id - summary: List Service Zones - description: Retrieve a list of service zones in a fulfillment set. The service zones can be filtered by fields like FILTER FIELDS. The service zones can also be paginated. + 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. x-authenticated: true parameters: - name: id @@ -15729,7 +17058,7 @@ paths: type: string - name: zone_id in: path - description: The fulfillment set's zone id. + description: The service zone's ID. required: true schema: type: string @@ -16549,151 +17878,219 @@ paths: description: The inventory item's requires shipping. - name: weight in: query - description: The inventory item's weight. + description: Filter the inventory item's weight. required: false schema: - description: The inventory item's weight. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: Filter the inventory item's weight. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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: length in: query - description: The inventory item's length. + description: Filter the inventory item's length. required: false schema: - description: The inventory item's length. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: Filter the inventory item's length. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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: height in: query - description: The inventory item's height. + description: Filter by the inventory item's height. required: false schema: - description: The inventory item's height. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: Filter by the inventory item's height. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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: width in: query - description: The inventory item's width. + description: Filter by the inventory item's width. required: false schema: - description: The inventory item's width. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: Filter by the inventory item's width. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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: location_levels in: query - description: The inventory item's location levels. + description: Filter by the inventory item's associated location IDs. required: false schema: type: object - description: The inventory item's location levels. + description: Filter by the inventory item's associated location IDs. properties: location_id: oneOf: - type: string title: location_id - description: The location level's location id. + description: The associated location's ID. - type: array - description: The location level's location id. + description: The location IDs to retrieve inventory items associated with them. items: type: string title: location_id - description: The location id's details. + description: A location's ID. required: - location_id - name: $and @@ -16701,7 +18098,7 @@ paths: required: false schema: type: array - description: The inventory item's $and. + 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 @@ -16710,7 +18107,7 @@ paths: required: false schema: type: array - description: The inventory item's $or. + 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 @@ -17199,8 +18596,8 @@ paths: /admin/inventory-items/{id}/location-levels: get: operationId: GetInventoryItemsIdLocationLevels - summary: List Location Levels - description: Retrieve a list of location levels in a inventory item. The location levels can be filtered by fields like FILTER FIELDS. The location levels can also be paginated. + 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. x-authenticated: true parameters: - name: id @@ -17256,19 +18653,19 @@ paths: oneOf: - type: string title: location_id - description: The inventory item's location id. + description: Filter by an associated location's ID. - type: array - description: The inventory item's location id. + description: Filter by associated location IDs. items: type: string title: location_id - description: The location id's details. + description: An associated location ID. - name: $and in: query required: false schema: type: array - description: The inventory item's $and. + 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 @@ -17277,7 +18674,7 @@ paths: required: false schema: type: array - description: The inventory item's $or. + 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 @@ -17824,12 +19221,12 @@ paths: 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 invite's q. + description: Search term to apply on an invite's searchable properties. required: false schema: type: string title: q - description: The invite's q. + description: Search term to apply on an invite's searchable properties. - name: id in: query required: false @@ -17837,13 +19234,13 @@ paths: oneOf: - type: string title: id - description: The invite's ID. + description: Filter by an invite's ID. - type: array - description: The invite's ID. + description: Filter by invite IDs. items: type: string title: id - description: The id's ID. + description: An invite's ID. - name: email in: query required: false @@ -17851,22 +19248,22 @@ paths: oneOf: - type: string title: email - description: The invite's email. + description: Filter by an invite's email. format: email - type: array - description: The invite's email. + description: Filter by invite emails. items: type: string title: email - description: The email's details. + description: An email. format: email - name: created_at in: query - description: The invite's created at. + description: Filter by the invite's creation date. required: false schema: type: object - description: The invite's created at. + description: Filter by the invite's creation date. properties: $and: type: array @@ -17916,118 +19313,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -18093,11 +19378,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The invite's updated at. + description: Filter by the invite's update date. required: false schema: type: object - description: The invite's updated at. + description: Filter by the invite's update date. properties: $and: type: array @@ -18147,118 +19432,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -18324,11 +19497,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The invite's deleted at. + description: Filter by the invite's deletion date. required: false schema: type: object - description: The invite's deleted at. + description: Filter by the invite's deletion date. properties: $and: type: array @@ -18378,118 +19551,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -18558,7 +19619,7 @@ paths: required: false schema: type: array - description: The invite's $and. + 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 @@ -18567,7 +19628,7 @@ paths: required: false schema: type: array - description: The invite's $or. + 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 @@ -18585,7 +19646,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of invites. required: - limit - offset @@ -18594,23 +19655,23 @@ paths: limit: type: number title: limit - description: The invite's limit. + description: The maximum number of items retrieved. offset: type: number title: offset - description: The invite's offset. + description: The number of items skipped before the returned items. count: type: number title: count - description: The invite's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of invites. required: - invites properties: invites: type: array - description: The invite's invites. + description: The list of invites. items: $ref: '#/components/schemas/AdminInvite' '400': @@ -18842,8 +19903,8 @@ paths: /admin/invites/{id}: get: operationId: GetInvitesId - summary: Get a Invite - description: Retrieve a invite by its ID. You can expand the invite's relations or select the fields that should be returned. + summary: Get an Invite + description: Retrieve an invite by its ID. You can expand the invite's relations or select the fields that should be returned. x-authenticated: false parameters: - name: id @@ -19106,12 +20167,12 @@ paths: 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 notification's q. + description: Search term to apply on the notification's searchable properties. required: false schema: type: string title: q - description: The notification's q. + description: Search term to apply on the notification's searchable properties. - name: id in: query required: false @@ -19119,13 +20180,13 @@ paths: oneOf: - type: string title: id - description: The notification's ID. + description: Filter by a notification ID. - type: array - description: The notification's ID. + description: Filter by notification IDs. items: type: string title: id - description: The id's ID. + description: A notification ID. - name: channel in: query required: false @@ -19133,19 +20194,21 @@ paths: oneOf: - type: string title: channel - description: The notification's channel. + description: Filter by a notification channel. + example: email - type: array - description: The notification's channel. + description: Filter by notification channels. items: type: string title: channel - description: The channel's details. + description: A notification channel. + example: email - name: $and in: query required: false schema: type: array - description: The notification's $and. + 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 @@ -19154,7 +20217,7 @@ paths: required: false schema: type: array - description: The notification's $or. + 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 @@ -19922,27 +20985,47 @@ paths: oneOf: - type: string title: id - description: The order's ID. + description: Filter by an order ID. - type: array - description: The order's ID. + description: Filter by order IDs. items: type: string title: id - description: The id's ID. - - name: name + description: An order's ID. + - name: status in: query required: false schema: oneOf: - type: string - title: name - description: The order's name. + title: status + description: Filter by the order's status. - type: array - description: The order's name. + description: Filter by order statuses. items: type: string - title: name - description: The name's details. + title: status + description: An order's status. + - name: $and + in: query + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + required: false + schema: + 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 + - name: $or + in: query + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + required: false + schema: + 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 - name: sales_channel_id in: query description: The order's sales channel id. @@ -19963,8 +21046,16 @@ paths: description: The order's fulfillment status. items: 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: The order's payment status. @@ -19974,8 +21065,18 @@ paths: description: The order's payment status. items: 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: The order's region id. @@ -20457,449 +21558,6 @@ paths: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - - name: status - in: query - required: false - schema: - oneOf: - - type: string - title: status - description: The order's status. - - type: array - description: The order's status. - items: - type: string - title: status - description: The status's details. - - type: object - description: The order's status. - 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 an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - oneOf: - - type: string - title: $ne - description: Filter by values not equal to this parameter. - - type: array - description: Filter by values not equal to this parameter. - items: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - oneOf: - - type: string - title: $in - description: Filter by values in this array. - - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - oneOf: - - type: string - title: $nin - description: Filter by values not in this array. - - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - $gt: - oneOf: - - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - - type: array - description: Filter by values greater than this parameter. Useful for numbers and dates only. - items: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - oneOf: - - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - - type: array - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - items: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - oneOf: - - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - - type: array - description: Filter by values less than this parameter. Useful for numbers and dates only. - items: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - oneOf: - - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - - type: array - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - items: - 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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - - name: $and - in: query - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - required: false - schema: - 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 - - name: $or - in: query - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - required: false - schema: - 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 security: - api_token: [] - cookie_auth: [] @@ -20920,7 +21578,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of orders required: - limit - offset @@ -20929,23 +21587,23 @@ paths: limit: type: number title: limit - description: The order's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The order's offset. + description: The number of items skipped before the returned items. count: type: number title: count - description: The order's count. + description: The total count of items. - type: object - description: SUMMARY + description: The paginated list of orders. required: - orders properties: orders: type: array - description: The order's orders. + description: The list of orders. items: $ref: '#/components/schemas/AdminOrder' '400': @@ -20964,8 +21622,8 @@ paths: /admin/orders/{id}: get: 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. + summary: Get an Order + description: Retrieve an order by its ID. You can expand the order's relations or select the fields that should be returned. x-authenticated: true parameters: - name: id @@ -21319,8 +21977,12 @@ paths: /admin/orders/{id}/changes: get: operationId: GetOrdersIdChanges - summary: List Changes - description: Retrieve a list of changes in a order. The changes can be filtered by fields like FILTER FIELDS. The changes can also be paginated. + summary: List Changes on an Order + x-sidebar-summary: List Changes + 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: - name: id @@ -21940,8 +22602,8 @@ paths: /admin/orders/{id}/preview: get: operationId: GetOrdersIdPreview - summary: List Previews - description: Retrieve a list of previews in a order. The previews can be filtered by fields like FILTER FIELDS. The previews can also be paginated. + summary: Get Preview + description: Retrieve a preview of an order using its associated change, such as an edit. x-authenticated: true parameters: - name: id @@ -22278,12 +22940,12 @@ paths: 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 payment's q. + description: Search term to filter the payment's searchable properties. required: false schema: type: string title: q - description: The payment's q. + description: Search term to filter the payment's searchable properties. - name: id in: query required: false @@ -22291,13 +22953,13 @@ paths: oneOf: - type: string title: id - description: The payment's ID. + description: Filter by a payment ID. - type: array - description: The payment's ID. + description: Filter by payment IDs. items: type: string title: id - description: The id's ID. + description: A payment ID. - name: payment_session_id in: query required: false @@ -22305,20 +22967,20 @@ paths: oneOf: - type: string title: payment_session_id - description: The payment's payment session id. + description: Filter by a payment session ID to retrieve its associated payments. - type: array - description: The payment's payment session id. + description: Filter by payment session IDs to retrieve their associated payments. items: type: string title: payment_session_id - description: The payment session id's details. + description: A payment session's ID. - name: created_at in: query - description: The payment's created at. + description: Filter by the payment's creation date. required: false schema: type: object - description: The payment's created at. + description: Filter by the payment's creation date. properties: $and: type: array @@ -22368,118 +23030,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -22545,11 +23095,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The payment's updated at. + description: Filter by the payment's update date. required: false schema: type: object - description: The payment's updated at. + description: Filter by the payment's update date. properties: $and: type: array @@ -22599,118 +23149,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -22776,11 +23214,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The payment's deleted at. + description: Filter by the payment's deletion date. required: false schema: type: object - description: The payment's deleted at. + description: Filter by the payment's deletion date. properties: $and: type: array @@ -22830,118 +23268,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -23010,7 +23336,7 @@ paths: required: false schema: type: array - description: The payment's $and. + 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 @@ -23019,7 +23345,7 @@ paths: required: false schema: type: array - description: The payment's $or. + 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 @@ -23043,7 +23369,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of payments. required: - limit - offset @@ -23052,23 +23378,23 @@ paths: limit: type: number title: limit - description: The payment's limit. + description: The maximum number of returned items. offset: type: number title: offset - description: The payment's offset. + description: The number of items skipped before the returned items. count: type: number title: count - description: The payment's count. + description: The total number of payments. - type: object - description: SUMMARY + description: The paginated list of payments. required: - payments properties: payments: type: array - description: The payment's payments. + description: The list of payments. items: $ref: '#/components/schemas/AdminPayment' '400': @@ -23086,8 +23412,8 @@ paths: /admin/payments/payment-providers: get: operationId: GetPaymentsPaymentProviders - summary: List Payments - description: Retrieve a list of payments. The payments can be filtered by fields such as `id`. The payments can also be sorted or paginated. + summary: List Payment Providers + description: Retrieve a list of payment providers. The payment providers can be filtered by fields such as `id`. The payment providers can also be sorted or paginated. x-authenticated: true parameters: - name: expand @@ -23132,32 +23458,32 @@ paths: 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 title: id - description: The payment's ID. + description: Filter by a payment provider's ID. - type: array - description: The payment's ID. + description: Filter by payment provider IDs. items: type: string title: id - description: The id's ID. + description: A payment provider ID. - name: is_enabled in: query - description: The payment's is enabled. + description: Filter by whether the payment provider is enabled. required: false schema: type: boolean title: is_enabled - description: The payment's is enabled. + description: Filter by whether the payment provider is enabled. - name: $and in: query required: false schema: type: array - description: The payment's $and. + 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 @@ -23166,7 +23492,7 @@ paths: required: false schema: type: array - description: The payment's $or. + 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 @@ -23190,7 +23516,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The list of payment providers. required: - limit - offset @@ -23199,23 +23525,23 @@ paths: limit: type: number title: limit - description: The payment's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The payment's offset. + description: The number of items skipped before the returned items. count: type: number title: count - description: The payment's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of payment providers. required: - payment_providers properties: payment_providers: type: array - description: The payment's payment providers. + description: The list of payment providers. items: $ref: '#/components/schemas/AdminPaymentProvider' '400': @@ -23563,12 +23889,12 @@ paths: 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 price list's q. + description: Search term to filter the price list's searchable properties. required: false schema: type: string title: q - description: The price list's q. + description: Search term to filter the price list's searchable properties. - name: id in: query required: false @@ -23576,20 +23902,20 @@ paths: oneOf: - type: string title: id - description: The price list's ID. + description: Filter by a price list ID. - type: array - description: The price list's ID. + description: Filter by price list IDs. items: type: string title: id - description: The id's ID. + description: A price list ID. - name: starts_at in: query - description: The price list's starts at. + description: Filter by a price list's start date. required: false schema: type: object - description: The price list's starts at. + description: Filter by a price list's start date. properties: $and: type: array @@ -23639,118 +23965,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -23816,11 +24030,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: ends_at in: query - description: The price list's ends at. + description: Filter by the price list's end date. required: false schema: type: object - description: The price list's ends at. + description: Filter by the price list's end date. properties: $and: type: array @@ -23870,118 +24084,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -24047,28 +24149,28 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: status in: query - description: The price list's status. + description: Filter by the price list's status. required: false schema: type: array - description: The price list's status. + description: Filter by the price list's status. items: type: string - description: The status's details. + description: A price list's status. enum: - - draft - active + - draft - name: rules_count in: query - description: The price list's rules count. + description: Filter by the price list's rules count. required: false schema: type: array - description: The price list's rules count. + description: Filter by the price list's rules count. items: type: number title: rules_count - description: The rules count's details. + description: The price list's rule count. - name: $and in: query description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. @@ -24727,13 +24829,13 @@ paths: oneOf: - type: string title: id - description: The price preference's ID. + description: Filter by a price preference ID. - type: array - description: The price preference's ID. + description: Filter by price preference IDs. items: type: string title: id - description: The id's ID. + description: A price preference ID. - name: attribute in: query required: false @@ -24741,13 +24843,13 @@ paths: oneOf: - type: string title: attribute - description: The price preference's attribute. + description: Filter by a price preference's attribute. - type: array - description: The price preference's attribute. + description: Filter by price preference attributes. items: type: string title: attribute - description: The attribute's details. + description: A price preference's attribute. - name: value in: query required: false @@ -24755,21 +24857,21 @@ paths: oneOf: - type: string title: value - description: The price preference's value. + description: Filter by a price preference's value. - type: array - description: The price preference's value. + description: Filter by price preference values. items: type: string title: value - description: The value's details. + description: A price preference's value. - name: q in: query - description: The price preference's q. + description: Search term to apply on the price preference's searchable properties. required: false schema: type: string title: q - description: The price preference's q. + description: Search term to apply on the price preference's searchable properties. - name: $and in: query description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. @@ -25170,12 +25272,12 @@ paths: 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. + description: Search term to filter on the product category's searchable properties. required: false schema: type: string title: q - description: The product category's q. + description: Search term to filter on the product category's searchable properties. - name: id in: query required: false @@ -25183,13 +25285,13 @@ paths: oneOf: - type: string title: id - description: The product category's ID. + description: Filter by a product category's ID. - type: array - description: The product category's ID. + description: Filter by product category IDs. items: type: string title: id - description: The id's ID. + description: A product category ID. - name: description in: query required: false @@ -25197,13 +25299,13 @@ paths: oneOf: - type: string title: description - description: The product category's description. + description: Filter by the category's description. This performs a full-text search. To do keyword search, use the `q` parameter instead. - type: array - description: The product category's description. + description: Filter by category descriptions. This performs a full-text search. To do keyword search, use the `q` parameter instead. items: type: string title: description - description: The description's details. + description: The category's description. - name: handle in: query required: false @@ -25211,13 +25313,13 @@ paths: oneOf: - type: string title: handle - description: The product category's handle. + description: Filter by a category's handle. - type: array - description: The product category's handle. + description: Filter by category handles. items: type: string title: handle - description: The handle's details. + description: A category's handle. - name: parent_category_id in: query required: false @@ -25225,52 +25327,52 @@ paths: oneOf: - type: string title: parent_category_id - description: The product category's parent category id. + description: Filter by a parent category's ID to retrieve its child categories. - type: array - description: The product category's parent category id. + description: Filter by parent category IDs to retrieve their child categories. items: type: string title: parent_category_id - description: The parent category id's details. + description: A parent category's ID. - name: include_ancestors_tree in: query - description: The product category's include ancestors tree. + description: Whether to include the parent category of each category. If enabled, the parent category is set in the `parent_category` property of each category object. required: false schema: type: boolean title: include_ancestors_tree - description: The product category's include ancestors tree. + description: Whether to include the parent category of each category. If enabled, the parent category is set in the `parent_category` property of each category object. - name: include_descendants_tree in: query - description: The product category's include descendants tree. + description: Whether to include the child categories of each category. If enabled, the child categories are added to the `category_children` property of each category object. required: false schema: type: boolean title: include_descendants_tree - description: The product category's include descendants tree. + description: Whether to include the child categories of each category. If enabled, the child categories are added to the `category_children` property of each category object. - name: is_internal in: query - description: The product category's is internal. + description: Filter by whether the category is internal. required: false schema: type: boolean title: is_internal - description: The product category's is internal. + description: Filter by whether the category is internal. - name: is_active in: query - description: The product category's is active. + description: Filter by whether the category is active. required: false schema: type: boolean title: is_active - description: The product category's is active. + description: Filter by whether the category is active. - name: created_at in: query - description: The product category's created at. + description: Filter by the category's creation date. required: false schema: type: object - description: The product category's created at. + description: Filter by the category's creation date. properties: $and: type: array @@ -25320,118 +25422,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -25497,11 +25487,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The product category's updated at. + description: Filter by the category's update date. required: false schema: type: object - description: The product category's updated at. + description: Filter by the category's update date. properties: $and: type: array @@ -25551,118 +25541,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -25728,11 +25606,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The product category's deleted at. + description: Filter by the category's deletion date. required: false schema: type: object - description: The product category's deleted at. + description: Filter by the category's deletion date. properties: $and: type: array @@ -25782,118 +25660,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -25962,7 +25728,7 @@ paths: required: false schema: type: array - description: The product category's $and. + 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 @@ -25971,7 +25737,7 @@ paths: required: false schema: type: array - description: The product category's $or. + 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 @@ -26164,20 +25930,20 @@ paths: 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. + description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. required: false schema: type: boolean title: include_ancestors_tree - description: The product category's include ancestors tree. + description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. - name: include_descendants_tree in: query - description: The product category's include descendants tree. + description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property. required: false schema: type: boolean title: include_descendants_tree - description: The product category's include descendants tree. + description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property. security: - api_token: [] - cookie_auth: [] @@ -26538,12 +26304,12 @@ paths: 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 tag's q. + description: Search term to filter the product tag's searchable properties. required: false schema: type: string title: q - description: The product tag's q. + description: Search term to filter the product tag's searchable properties. - name: id in: query required: false @@ -26551,13 +26317,13 @@ paths: oneOf: - type: string title: id - description: The product tag's ID. + description: Filter by a product tag's ID. - type: array - description: The product tag's ID. + description: Filter by product tag IDs. items: type: string title: id - description: The id's ID. + description: A product tag's ID. - name: value in: query required: false @@ -26565,20 +26331,20 @@ paths: oneOf: - type: string title: value - description: The product tag's value. + description: Filter by a product tag's value. - type: array - description: The product tag's value. + description: Filter by product tag values. items: type: string title: value - description: The value's details. + description: A tag value. - name: created_at in: query - description: The product tag's created at. + description: Filter by the tag's creation date. required: false schema: type: object - description: The product tag's created at. + description: Filter by the tag's creation date. properties: $and: type: array @@ -26628,118 +26394,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -26805,11 +26459,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The product tag's updated at. + description: Filter by the tag's update date. required: false schema: type: object - description: The product tag's updated at. + description: Filter by the tag's update date. properties: $and: type: array @@ -26859,118 +26513,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -27036,11 +26578,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The product tag's deleted at. + description: Filter by the tag's deletion date. required: false schema: type: object - description: The product tag's deleted at. + description: Filter by the tag's deletion date. properties: $and: type: array @@ -27090,118 +26632,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -27270,7 +26700,7 @@ paths: required: false schema: type: array - description: The product tag's $and. + 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 @@ -27279,7 +26709,7 @@ paths: required: false schema: type: array - description: The product tag's $or. + 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 @@ -27683,12 +27113,12 @@ paths: 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 type's q. + description: Search term to filter the product type's searchable properties. required: false schema: type: string title: q - description: The product type's q. + description: Search term to filter the product type's searchable properties. - name: id in: query required: false @@ -27696,13 +27126,13 @@ paths: oneOf: - type: string title: id - description: The product type's ID. + description: Filter by a product type's ID. - type: array - description: The product type's ID. + description: Filter by product type IDs. items: type: string title: id - description: The id's ID. + description: A product type's ID. - name: value in: query required: false @@ -27710,20 +27140,20 @@ paths: oneOf: - type: string title: value - description: The product type's value. + description: Filter by a type's value. - type: array - description: The product type's value. + description: Filter by values. items: type: string title: value - description: The value's details. + description: A type's value. - name: created_at in: query - description: The product type's created at. + description: Filter by the type's creation date. required: false schema: type: object - description: The product type's created at. + description: Filter by the type's creation date. properties: $and: type: array @@ -27773,118 +27203,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -27950,11 +27268,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The product type's updated at. + description: Filter by the type's update date. required: false schema: type: object - description: The product type's updated at. + description: Filter by the type's update date. properties: $and: type: array @@ -28004,118 +27322,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -28181,11 +27387,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The product type's deleted at. + description: Filter by the type's deletion date. required: false schema: type: object - description: The product type's deleted at. + description: Filter by the type's deletion date. properties: $and: type: array @@ -28235,118 +27441,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -28415,7 +27509,7 @@ paths: required: false schema: type: array - description: The product type's $and. + 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 @@ -28424,7 +27518,7 @@ paths: required: false schema: type: array - description: The product type's $or. + 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 @@ -28828,12 +27922,12 @@ paths: 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 variant's q. + description: Search term to filter the product variant's searchable properties. required: false schema: type: string title: q - description: The product variant's q. + description: Search term to filter the product variant's searchable properties. - name: id in: query required: false @@ -28841,36 +27935,36 @@ paths: oneOf: - type: string title: id - description: The product variant's ID. + description: Filter by a variant's ID. - type: array - description: The product variant's ID. + description: Filter by variant IDs. items: type: string title: id - description: The id's ID. + description: A variant's ID. - name: manage_inventory in: query - description: The product variant's manage inventory. + description: Filter by whether a variant's `manage_inventory` is enabled. required: false schema: type: boolean title: manage_inventory - description: The product variant's manage inventory. + description: Filter by whether a variant's `manage_inventory` is enabled. - name: allow_backorder in: query - description: The product variant's allow backorder. + description: Filter by whether backorder is allowed for a variant. required: false schema: type: boolean title: allow_backorder - description: The product variant's allow backorder. + description: Filter by whether backorder is allowed for a variant. - name: created_at in: query - description: The product variant's created at. + description: Filter by the product variant's creation date. required: false schema: type: object - description: The product variant's created at. + description: Filter by the product variant's creation date. properties: $and: type: array @@ -28920,118 +28014,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -29097,11 +28079,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The product variant's updated at. + description: Filter by the product variant's update date. required: false schema: type: object - description: The product variant's updated at. + description: Filter by the product variant's update date. properties: $and: type: array @@ -29151,118 +28133,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -29328,11 +28198,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The product variant's deleted at. + description: Filter by the product variant's deletion date. required: false schema: type: object - description: The product variant's deleted at. + description: Filter by the product variant's deletion date. properties: $and: type: array @@ -29382,118 +28252,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -29691,21 +28449,21 @@ paths: oneOf: - type: string title: price_list_id - description: The product's price list id. + description: Filter by a price list's ID to retrieve its associated products. - type: array description: The product's price list id. items: type: string title: price_list_id - description: The price list id's details. + description: Filter by a price list IDs to retrieve their associated products. - name: q in: query - description: The product's q. + description: Search term to filter a product's searchable properties. required: false schema: type: string title: q - description: The product's q. + description: Search term to filter a product's searchable properties. - name: status in: query required: false @@ -29713,18 +28471,9 @@ paths: oneOf: - type: string title: status - description: The product's status. - - type: string - title: status - description: The product's status. - - type: string - title: status - description: The product's status. - - type: string - title: status - description: The product's status. + description: Filter by a product status. - type: array - description: The product's status. + description: Filter by product statuses. items: type: string enum: @@ -29739,13 +28488,13 @@ paths: oneOf: - type: string title: sales_channel_id - description: The product's sales channel id. + description: Filter by a sales channel's ID to retrieve its associated products. - type: array - description: The product's sales channel id. + description: Filter by sales channel IDs to retrieve their associated products. items: type: string title: sales_channel_id - description: The sales channel id's details. + description: A sales channel's ID. - name: title in: query required: false @@ -29753,13 +28502,13 @@ paths: oneOf: - type: string title: title - description: The product's title. + description: Filter by a title. - type: array - description: The product's title. + description: Filter by titles items: type: string title: title - description: The title's details. + description: A product title. - name: handle in: query required: false @@ -29767,13 +28516,13 @@ paths: oneOf: - type: string title: handle - description: The product's handle. + description: Filter by a handle. - type: array - description: The product's handle. + description: Filter by handles. items: type: string title: handle - description: The handle's details. + description: A product handle. - name: id in: query required: false @@ -29781,35 +28530,35 @@ paths: oneOf: - type: string title: id - description: The product's ID. + description: Filter by a product ID. - type: array - description: The product's ID. + description: Filter by product IDs. items: type: string title: id - description: The id's ID. + description: A product's ID. - name: is_giftcard in: query - description: The product's is giftcard. + description: Filter by whether a product is a gift card. required: false schema: type: boolean title: is_giftcard - description: The product's is giftcard. + description: Filter by whether a product is a gift card. - name: tags in: query - description: The product's tags. + description: Filter by associated tags to retrieve their products. required: false schema: - description: The product's tags. + description: Filter by associated tags to retrieve their products. properties: value: type: array - description: The tag's value. + description: Filter by tag values. items: type: string title: value - description: The value's details. + description: A tag's value. - name: type_id in: query required: false @@ -29817,13 +28566,13 @@ paths: oneOf: - type: string title: type_id - description: The product's type id. + description: Filter by a product type's ID to retrieve its associated products. - type: array - description: The product's type id. + description: Filter by product type IDs to retrieve their associated products. items: type: string title: type_id - description: The type id's details. + description: A product type's ID. - name: category_id in: query required: false @@ -29831,2281 +28580,390 @@ paths: oneOf: - type: string title: category_id - description: The product's category id. + description: Filter by a product category's ID to retrieve its associated products. - type: array - description: The product's category id. + description: Filter by product category IDs to retrieve their associated products. items: type: string title: category_id - description: The category id's details. - - type: object - description: The product's category id. - properties: - $and: - type: array - description: The category id's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $and's $eq. - - type: object - description: The $and's $eq. - x-schemaName: RegExp - - type: array - description: The $and's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $and's $ne. - - type: object - description: The $and's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $and's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $and's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $and's $not. - - type: object - description: The $and's $not. - x-schemaName: RegExp - - type: object - description: The $and's $not. - - type: array - description: The $and's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $and's $gt. - - type: object - description: The $and's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $and's $gte. - - type: object - description: The $and's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $and's $lt. - - type: object - description: The $and's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $and's $lte. - - type: object - description: The $and's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $and's $like. - $re: - type: string - title: $re - description: The $and's $re. - $ilike: - type: string - title: $ilike - description: The $and's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $and's $fulltext. - $overlap: - type: array - description: The $and's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $and's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $and's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $and's $exists. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. - $or: - type: array - description: The category id's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $or's $eq. - - type: object - description: The $or's $eq. - x-schemaName: RegExp - - type: array - description: The $or's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $or's $ne. - - type: object - description: The $or's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $or's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $or's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $or's $not. - - type: object - description: The $or's $not. - x-schemaName: RegExp - - type: object - description: The $or's $not. - - type: array - description: The $or's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $or's $gt. - - type: object - description: The $or's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $or's $gte. - - type: object - description: The $or's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $or's $lt. - - type: object - description: The $or's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $or's $lte. - - type: object - description: The $or's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $or's $like. - $re: - type: string - title: $re - description: The $or's $re. - $ilike: - type: string - title: $ilike - description: The $or's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $or's $fulltext. - $overlap: - type: array - description: The $or's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $or's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $or's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $or's $exists. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. - $eq: - oneOf: - - type: string - title: $eq - description: The category id's $eq. - - type: object - description: The category id's $eq. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. - - type: array - description: The category id's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. - $ne: - oneOf: - - type: string - title: $ne - description: The category id's $ne. - - type: object - description: The category id's $ne. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $ne's exec. - test: - type: object - description: The $ne's test. - source: - type: string - title: source - description: The $ne's source. - global: - type: boolean - title: global - description: The $ne's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $ne's ignorecase. - multiline: - type: boolean - title: multiline - description: The $ne's multiline. - lastIndex: - type: number - title: lastIndex - description: The $ne's lastindex. - compile: - type: object - description: The $ne's compile. - flags: - type: string - title: flags - description: The $ne's flags. - sticky: - type: boolean - title: sticky - description: The $ne's sticky. - unicode: - type: boolean - title: unicode - description: The $ne's unicode. - dotAll: - type: boolean - title: dotAll - description: The $ne's dotall. - __@match@1128: - type: object - description: The $ne's @match@1128. - __@replace@1130: - type: object - description: The $ne's @replace@1130. - __@search@1133: - type: object - description: The $ne's @search@1133. - __@split@1135: - type: object - description: The $ne's @split@1135. - __@matchAll@1137: - type: object - description: The $ne's @matchall@1137. - $in: - type: array - description: The category id's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $in's exec. - test: - type: object - description: The $in's test. - source: - type: string - title: source - description: The $in's source. - global: - type: boolean - title: global - description: The $in's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $in's ignorecase. - multiline: - type: boolean - title: multiline - description: The $in's multiline. - lastIndex: - type: number - title: lastIndex - description: The $in's lastindex. - compile: - type: object - description: The $in's compile. - flags: - type: string - title: flags - description: The $in's flags. - sticky: - type: boolean - title: sticky - description: The $in's sticky. - unicode: - type: boolean - title: unicode - description: The $in's unicode. - dotAll: - type: boolean - title: dotAll - description: The $in's dotall. - __@match@1128: - type: object - description: The $in's @match@1128. - __@replace@1130: - type: object - description: The $in's @replace@1130. - __@search@1133: - type: object - description: The $in's @search@1133. - __@split@1135: - type: object - description: The $in's @split@1135. - __@matchAll@1137: - type: object - description: The $in's @matchall@1137. - $nin: - type: array - description: The category id's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $nin's exec. - test: - type: object - description: The $nin's test. - source: - type: string - title: source - description: The $nin's source. - global: - type: boolean - title: global - description: The $nin's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $nin's ignorecase. - multiline: - type: boolean - title: multiline - description: The $nin's multiline. - lastIndex: - type: number - title: lastIndex - description: The $nin's lastindex. - compile: - type: object - description: The $nin's compile. - flags: - type: string - title: flags - description: The $nin's flags. - sticky: - type: boolean - title: sticky - description: The $nin's sticky. - unicode: - type: boolean - title: unicode - description: The $nin's unicode. - dotAll: - type: boolean - title: dotAll - description: The $nin's dotall. - __@match@1128: - type: object - description: The $nin's @match@1128. - __@replace@1130: - type: object - description: The $nin's @replace@1130. - __@search@1133: - type: object - description: The $nin's @search@1133. - __@split@1135: - type: object - description: The $nin's @split@1135. - __@matchAll@1137: - type: object - description: The $nin's @matchall@1137. - $not: - oneOf: - - type: string - title: $not - description: The category id's $not. - - type: object - description: The category id's $not. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. - - type: object - description: The category id's $not. - properties: - $and: - type: array - description: The $not's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $not's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $not's $eq. - - type: object - description: The $not's $eq. - x-schemaName: RegExp - - type: array - description: The $not's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $not's $ne. - - type: object - description: The $not's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $not's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $not's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - - type: object - description: The $not's details. - - type: array - description: The $not's details. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $not's $gt. - - type: object - description: The $not's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $not's $gte. - - type: object - description: The $not's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $not's $lt. - - type: object - description: The $not's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $not's $lte. - - type: object - description: The $not's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $not's $like. - $re: - type: string - title: $re - description: The $not's $re. - $ilike: - type: string - title: $ilike - description: The $not's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $not's $fulltext. - $overlap: - type: array - description: The $not's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $not's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $not's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $not's $exists. - - type: array - description: The category id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. - $gt: - oneOf: - - type: string - title: $gt - description: The category id's $gt. - - type: object - description: The category id's $gt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gt's exec. - test: - type: object - description: The $gt's test. - source: - type: string - title: source - description: The $gt's source. - global: - type: boolean - title: global - description: The $gt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gt's lastindex. - compile: - type: object - description: The $gt's compile. - flags: - type: string - title: flags - description: The $gt's flags. - sticky: - type: boolean - title: sticky - description: The $gt's sticky. - unicode: - type: boolean - title: unicode - description: The $gt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gt's dotall. - __@match@1128: - type: object - description: The $gt's @match@1128. - __@replace@1130: - type: object - description: The $gt's @replace@1130. - __@search@1133: - type: object - description: The $gt's @search@1133. - __@split@1135: - type: object - description: The $gt's @split@1135. - __@matchAll@1137: - type: object - description: The $gt's @matchall@1137. - $gte: - oneOf: - - type: string - title: $gte - description: The category id's $gte. - - type: object - description: The category id's $gte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gte's exec. - test: - type: object - description: The $gte's test. - source: - type: string - title: source - description: The $gte's source. - global: - type: boolean - title: global - description: The $gte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gte's lastindex. - compile: - type: object - description: The $gte's compile. - flags: - type: string - title: flags - description: The $gte's flags. - sticky: - type: boolean - title: sticky - description: The $gte's sticky. - unicode: - type: boolean - title: unicode - description: The $gte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gte's dotall. - __@match@1128: - type: object - description: The $gte's @match@1128. - __@replace@1130: - type: object - description: The $gte's @replace@1130. - __@search@1133: - type: object - description: The $gte's @search@1133. - __@split@1135: - type: object - description: The $gte's @split@1135. - __@matchAll@1137: - type: object - description: The $gte's @matchall@1137. - $lt: - oneOf: - - type: string - title: $lt - description: The category id's $lt. - - type: object - description: The category id's $lt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lt's exec. - test: - type: object - description: The $lt's test. - source: - type: string - title: source - description: The $lt's source. - global: - type: boolean - title: global - description: The $lt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lt's lastindex. - compile: - type: object - description: The $lt's compile. - flags: - type: string - title: flags - description: The $lt's flags. - sticky: - type: boolean - title: sticky - description: The $lt's sticky. - unicode: - type: boolean - title: unicode - description: The $lt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lt's dotall. - __@match@1128: - type: object - description: The $lt's @match@1128. - __@replace@1130: - type: object - description: The $lt's @replace@1130. - __@search@1133: - type: object - description: The $lt's @search@1133. - __@split@1135: - type: object - description: The $lt's @split@1135. - __@matchAll@1137: - type: object - description: The $lt's @matchall@1137. - $lte: - oneOf: - - type: string - title: $lte - description: The category id's $lte. - - type: object - description: The category id's $lte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lte's exec. - test: - type: object - description: The $lte's test. - source: - type: string - title: source - description: The $lte's source. - global: - type: boolean - title: global - description: The $lte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lte's lastindex. - compile: - type: object - description: The $lte's compile. - flags: - type: string - title: flags - description: The $lte's flags. - sticky: - type: boolean - title: sticky - description: The $lte's sticky. - unicode: - type: boolean - title: unicode - description: The $lte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lte's dotall. - __@match@1128: - type: object - description: The $lte's @match@1128. - __@replace@1130: - type: object - description: The $lte's @replace@1130. - __@search@1133: - type: object - description: The $lte's @search@1133. - __@split@1135: - type: object - description: The $lte's @split@1135. - __@matchAll@1137: - type: object - description: The $lte's @matchall@1137. - $like: - type: string - title: $like - description: The category id's $like. - $re: - type: string - title: $re - description: The category id's $re. - $ilike: - type: string - title: $ilike - description: The category id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The category id's $fulltext. - $overlap: - type: array - description: The category id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The category id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The category id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The category id's $exists. - - name: categories + description: A product category's ID. + - name: created_at in: query + description: Filter by a product's creation date. required: false schema: - oneOf: - - type: object - description: The product's categories. - required: - - id - properties: - id: - type: object - description: The category's ID. - properties: - $and: - type: array - description: The id's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The id's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The id's $eq. - - type: object - description: The id's $eq. - x-schemaName: RegExp - - type: array - description: The id's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The id's $ne. - - type: object - description: The id's $ne. - x-schemaName: RegExp - $in: - type: array - description: The id's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The id's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The id's $not. - - type: object - description: The id's $not. - x-schemaName: RegExp - - type: object - description: The id's $not. - - type: array - description: The id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The id's $gt. - - type: object - description: The id's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The id's $gte. - - type: object - description: The id's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The id's $lt. - - type: object - description: The id's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The id's $lte. - - type: object - description: The id's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The id's $like. - $re: - type: string - title: $re - description: The id's $re. - $ilike: - type: string - title: $ilike - description: The id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The id's $fulltext. - $overlap: - type: array - description: The id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The id's $exists. - - type: object - description: The product's categories. - required: - - id - properties: - id: - type: object - description: The category's ID. - properties: - $and: - type: array - description: The id's $and. - items: - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - $or: - type: array - description: The id's $or. - items: - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - $eq: - oneOf: - - type: array - description: The id's $eq. - items: - type: string - title: $eq - description: The $eq's details. - - type: array - description: The id's $eq. - items: - type: array - description: The $eq's details. - items: - type: string - title: $eq - description: The $eq's details. - $ne: - type: array - description: The id's $ne. - items: - type: string - title: $ne - description: The $ne's details. - $in: - type: array - description: The id's $in. - items: - type: array - description: The $in's details. - items: - type: string - title: $in - description: The $in's details. - $nin: - type: array - description: The id's $nin. - items: - type: array - description: The $nin's details. - items: - type: string - title: $nin - description: The $nin's details. - $not: - type: array - description: The id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - $gt: - type: array - description: The id's $gt. - items: - type: string - title: $gt - description: The $gt's details. - $gte: - type: array - description: The id's $gte. - items: - type: string - title: $gte - description: The $gte's details. - $lt: - type: array - description: The id's $lt. - items: - type: string - title: $lt - description: The $lt's details. - $lte: - type: array - description: The id's $lte. - items: - type: string - title: $lte - description: The $lte's details. - $like: - type: string - title: $like - description: The id's $like. - $re: - type: string - title: $re - description: The id's $re. - $ilike: - type: string - title: $ilike - description: The id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The id's $fulltext. - $overlap: - type: array - description: The id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The id's $exists. + type: object + description: Filter by a product'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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 a product's update date. + required: false + schema: + type: object + description: Filter by a product'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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: deleted_at + in: query + description: Filter by a product's deletion date. + required: false + schema: + type: object + description: Filter by a product's deletion 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: $and + in: query + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + required: false + schema: + 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 + - name: $or + in: query + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + required: false + schema: + 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 - name: collection_id in: query required: false @@ -32113,2608 +28971,13 @@ paths: oneOf: - type: string title: collection_id - description: The product's collection id. + description: Filter by a product collection ID. - type: array - description: The product's collection id. + description: Filter by product collection IDs. items: type: string title: collection_id - description: The collection id's details. - - type: object - description: The product's collection id. - properties: - $and: - type: array - description: The collection id's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $and's $eq. - - type: object - description: The $and's $eq. - x-schemaName: RegExp - - type: array - description: The $and's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $and's $ne. - - type: object - description: The $and's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $and's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $and's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $and's $not. - - type: object - description: The $and's $not. - x-schemaName: RegExp - - type: object - description: The $and's $not. - - type: array - description: The $and's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $and's $gt. - - type: object - description: The $and's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $and's $gte. - - type: object - description: The $and's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $and's $lt. - - type: object - description: The $and's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $and's $lte. - - type: object - description: The $and's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $and's $like. - $re: - type: string - title: $re - description: The $and's $re. - $ilike: - type: string - title: $ilike - description: The $and's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $and's $fulltext. - $overlap: - type: array - description: The $and's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $and's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $and's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $and's $exists. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. - $or: - type: array - description: The collection id's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $or's $eq. - - type: object - description: The $or's $eq. - x-schemaName: RegExp - - type: array - description: The $or's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $or's $ne. - - type: object - description: The $or's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $or's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $or's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $or's $not. - - type: object - description: The $or's $not. - x-schemaName: RegExp - - type: object - description: The $or's $not. - - type: array - description: The $or's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $or's $gt. - - type: object - description: The $or's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $or's $gte. - - type: object - description: The $or's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $or's $lt. - - type: object - description: The $or's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $or's $lte. - - type: object - description: The $or's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $or's $like. - $re: - type: string - title: $re - description: The $or's $re. - $ilike: - type: string - title: $ilike - description: The $or's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $or's $fulltext. - $overlap: - type: array - description: The $or's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $or's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $or's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $or's $exists. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. - $eq: - oneOf: - - type: string - title: $eq - description: The collection id's $eq. - - type: object - description: The collection id's $eq. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. - - type: array - description: The collection id's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. - $ne: - oneOf: - - type: string - title: $ne - description: The collection id's $ne. - - type: object - description: The collection id's $ne. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $ne's exec. - test: - type: object - description: The $ne's test. - source: - type: string - title: source - description: The $ne's source. - global: - type: boolean - title: global - description: The $ne's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $ne's ignorecase. - multiline: - type: boolean - title: multiline - description: The $ne's multiline. - lastIndex: - type: number - title: lastIndex - description: The $ne's lastindex. - compile: - type: object - description: The $ne's compile. - flags: - type: string - title: flags - description: The $ne's flags. - sticky: - type: boolean - title: sticky - description: The $ne's sticky. - unicode: - type: boolean - title: unicode - description: The $ne's unicode. - dotAll: - type: boolean - title: dotAll - description: The $ne's dotall. - __@match@1128: - type: object - description: The $ne's @match@1128. - __@replace@1130: - type: object - description: The $ne's @replace@1130. - __@search@1133: - type: object - description: The $ne's @search@1133. - __@split@1135: - type: object - description: The $ne's @split@1135. - __@matchAll@1137: - type: object - description: The $ne's @matchall@1137. - $in: - type: array - description: The collection id's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $in's exec. - test: - type: object - description: The $in's test. - source: - type: string - title: source - description: The $in's source. - global: - type: boolean - title: global - description: The $in's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $in's ignorecase. - multiline: - type: boolean - title: multiline - description: The $in's multiline. - lastIndex: - type: number - title: lastIndex - description: The $in's lastindex. - compile: - type: object - description: The $in's compile. - flags: - type: string - title: flags - description: The $in's flags. - sticky: - type: boolean - title: sticky - description: The $in's sticky. - unicode: - type: boolean - title: unicode - description: The $in's unicode. - dotAll: - type: boolean - title: dotAll - description: The $in's dotall. - __@match@1128: - type: object - description: The $in's @match@1128. - __@replace@1130: - type: object - description: The $in's @replace@1130. - __@search@1133: - type: object - description: The $in's @search@1133. - __@split@1135: - type: object - description: The $in's @split@1135. - __@matchAll@1137: - type: object - description: The $in's @matchall@1137. - $nin: - type: array - description: The collection id's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $nin's exec. - test: - type: object - description: The $nin's test. - source: - type: string - title: source - description: The $nin's source. - global: - type: boolean - title: global - description: The $nin's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $nin's ignorecase. - multiline: - type: boolean - title: multiline - description: The $nin's multiline. - lastIndex: - type: number - title: lastIndex - description: The $nin's lastindex. - compile: - type: object - description: The $nin's compile. - flags: - type: string - title: flags - description: The $nin's flags. - sticky: - type: boolean - title: sticky - description: The $nin's sticky. - unicode: - type: boolean - title: unicode - description: The $nin's unicode. - dotAll: - type: boolean - title: dotAll - description: The $nin's dotall. - __@match@1128: - type: object - description: The $nin's @match@1128. - __@replace@1130: - type: object - description: The $nin's @replace@1130. - __@search@1133: - type: object - description: The $nin's @search@1133. - __@split@1135: - type: object - description: The $nin's @split@1135. - __@matchAll@1137: - type: object - description: The $nin's @matchall@1137. - $not: - oneOf: - - type: string - title: $not - description: The collection id's $not. - - type: object - description: The collection id's $not. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. - - type: object - description: The collection id's $not. - properties: - $and: - type: array - description: The $not's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $not's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $not's $eq. - - type: object - description: The $not's $eq. - x-schemaName: RegExp - - type: array - description: The $not's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $not's $ne. - - type: object - description: The $not's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $not's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $not's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - - type: object - description: The $not's details. - - type: array - description: The $not's details. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $not's $gt. - - type: object - description: The $not's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $not's $gte. - - type: object - description: The $not's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $not's $lt. - - type: object - description: The $not's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $not's $lte. - - type: object - description: The $not's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $not's $like. - $re: - type: string - title: $re - description: The $not's $re. - $ilike: - type: string - title: $ilike - description: The $not's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $not's $fulltext. - $overlap: - type: array - description: The $not's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $not's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $not's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $not's $exists. - - type: array - description: The collection id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. - $gt: - oneOf: - - type: string - title: $gt - description: The collection id's $gt. - - type: object - description: The collection id's $gt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gt's exec. - test: - type: object - description: The $gt's test. - source: - type: string - title: source - description: The $gt's source. - global: - type: boolean - title: global - description: The $gt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gt's lastindex. - compile: - type: object - description: The $gt's compile. - flags: - type: string - title: flags - description: The $gt's flags. - sticky: - type: boolean - title: sticky - description: The $gt's sticky. - unicode: - type: boolean - title: unicode - description: The $gt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gt's dotall. - __@match@1128: - type: object - description: The $gt's @match@1128. - __@replace@1130: - type: object - description: The $gt's @replace@1130. - __@search@1133: - type: object - description: The $gt's @search@1133. - __@split@1135: - type: object - description: The $gt's @split@1135. - __@matchAll@1137: - type: object - description: The $gt's @matchall@1137. - $gte: - oneOf: - - type: string - title: $gte - description: The collection id's $gte. - - type: object - description: The collection id's $gte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gte's exec. - test: - type: object - description: The $gte's test. - source: - type: string - title: source - description: The $gte's source. - global: - type: boolean - title: global - description: The $gte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gte's lastindex. - compile: - type: object - description: The $gte's compile. - flags: - type: string - title: flags - description: The $gte's flags. - sticky: - type: boolean - title: sticky - description: The $gte's sticky. - unicode: - type: boolean - title: unicode - description: The $gte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gte's dotall. - __@match@1128: - type: object - description: The $gte's @match@1128. - __@replace@1130: - type: object - description: The $gte's @replace@1130. - __@search@1133: - type: object - description: The $gte's @search@1133. - __@split@1135: - type: object - description: The $gte's @split@1135. - __@matchAll@1137: - type: object - description: The $gte's @matchall@1137. - $lt: - oneOf: - - type: string - title: $lt - description: The collection id's $lt. - - type: object - description: The collection id's $lt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lt's exec. - test: - type: object - description: The $lt's test. - source: - type: string - title: source - description: The $lt's source. - global: - type: boolean - title: global - description: The $lt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lt's lastindex. - compile: - type: object - description: The $lt's compile. - flags: - type: string - title: flags - description: The $lt's flags. - sticky: - type: boolean - title: sticky - description: The $lt's sticky. - unicode: - type: boolean - title: unicode - description: The $lt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lt's dotall. - __@match@1128: - type: object - description: The $lt's @match@1128. - __@replace@1130: - type: object - description: The $lt's @replace@1130. - __@search@1133: - type: object - description: The $lt's @search@1133. - __@split@1135: - type: object - description: The $lt's @split@1135. - __@matchAll@1137: - type: object - description: The $lt's @matchall@1137. - $lte: - oneOf: - - type: string - title: $lte - description: The collection id's $lte. - - type: object - description: The collection id's $lte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lte's exec. - test: - type: object - description: The $lte's test. - source: - type: string - title: source - description: The $lte's source. - global: - type: boolean - title: global - description: The $lte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lte's lastindex. - compile: - type: object - description: The $lte's compile. - flags: - type: string - title: flags - description: The $lte's flags. - sticky: - type: boolean - title: sticky - description: The $lte's sticky. - unicode: - type: boolean - title: unicode - description: The $lte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lte's dotall. - __@match@1128: - type: object - description: The $lte's @match@1128. - __@replace@1130: - type: object - description: The $lte's @replace@1130. - __@search@1133: - type: object - description: The $lte's @search@1133. - __@split@1135: - type: object - description: The $lte's @split@1135. - __@matchAll@1137: - type: object - description: The $lte's @matchall@1137. - $like: - type: string - title: $like - description: The collection id's $like. - $re: - type: string - title: $re - description: The collection id's $re. - $ilike: - type: string - title: $ilike - description: The collection id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The collection id's $fulltext. - $overlap: - type: array - description: The collection id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The collection id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The collection id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The collection id's $exists. - - name: created_at - in: query - description: The product's created at. - required: false - schema: - type: object - description: The product's created at. - properties: - $and: - type: array - description: The created at's $and. - items: - type: object - $or: - type: array - description: The created at's $or. - items: - type: object - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - $in: - type: array - description: The created at's $in. - items: - type: string - title: $in - $nin: - type: array - description: The created at's $nin. - items: - type: string - title: $nin - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - properties: - $and: - type: array - description: The $not's $and. - items: - type: object - title: $and - $or: - type: array - description: The $not's $or. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - $gte: - type: string - title: $gte - $lt: - type: string - title: $lt - $lte: - type: string - title: $lte - $like: - type: string - title: $like - description: The created at's $like. - $re: - type: string - title: $re - description: The created at's $re. - $ilike: - type: string - title: $ilike - description: The created at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The created at's $fulltext. - $overlap: - type: array - description: The created at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The created at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The created at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The created at's $exists. - - name: updated_at - in: query - description: The product's updated at. - required: false - schema: - type: object - description: The product's updated at. - properties: - $and: - type: array - description: The updated at's $and. - items: - type: object - $or: - type: array - description: The updated at's $or. - items: - type: object - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - $in: - type: array - description: The updated at's $in. - items: - type: string - title: $in - $nin: - type: array - description: The updated at's $nin. - items: - type: string - title: $nin - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - properties: - $and: - type: array - description: The $not's $and. - items: - type: object - title: $and - $or: - type: array - description: The $not's $or. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - $gte: - type: string - title: $gte - $lt: - type: string - title: $lt - $lte: - type: string - title: $lte - $like: - type: string - title: $like - description: The updated at's $like. - $re: - type: string - title: $re - description: The updated at's $re. - $ilike: - type: string - title: $ilike - description: The updated at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The updated at's $fulltext. - $overlap: - type: array - description: The updated at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The updated at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The updated at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The updated at's $exists. - - name: deleted_at - in: query - description: The product's deleted at. - required: false - schema: - type: object - description: The product's deleted at. - properties: - $and: - type: array - description: The deleted at's $and. - items: - type: object - $or: - type: array - description: The deleted at's $or. - items: - type: object - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - $in: - type: array - description: The deleted at's $in. - items: - type: string - title: $in - $nin: - type: array - description: The deleted at's $nin. - items: - type: string - title: $nin - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - properties: - $and: - type: array - description: The $not's $and. - items: - type: object - title: $and - $or: - type: array - description: The $not's $or. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - $gte: - type: string - title: $gte - $lt: - type: string - title: $lt - $lte: - type: string - title: $lte - $like: - type: string - title: $like - description: The deleted at's $like. - $re: - type: string - title: $re - description: The deleted at's $re. - $ilike: - type: string - title: $ilike - description: The deleted at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The deleted at's $fulltext. - $overlap: - type: array - description: The deleted at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The deleted at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The deleted at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The deleted at's $exists. - - name: $and - in: query - description: The product's $and. - required: false - schema: - type: array - description: The product's $and. - items: - type: object - title: $and - - name: $or - in: query - description: The product's $or. - required: false - schema: - type: array - description: The product's $or. - items: - type: object - title: $or + description: A product collection's ID. security: - api_token: [] - cookie_auth: [] @@ -34735,7 +28998,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of products. required: - limit - offset @@ -34744,23 +29007,23 @@ paths: limit: type: number title: limit - description: The product's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of products. required: - products properties: products: type: array - description: The product's products. + description: The list of products. items: type: object '400': @@ -35353,8 +29616,9 @@ paths: /admin/products/{id}/options: get: operationId: GetProductsIdOptions - summary: List Options - description: Retrieve a list of options in a product. The options can be filtered by fields like FILTER FIELDS. The options can also be paginated. + summary: List a Product's Options + x-sidebar-summary: List Options + description: Retrieve a list of options of a product. The options can be filtered by fields like `id`. The options can also be paginated. x-authenticated: true parameters: - name: id @@ -35405,12 +29669,12 @@ paths: 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's q. + description: Search term to filter the product option's searchable fields. required: false schema: type: string title: q - description: The product's q. + description: Search term to filter the product option's searchable fields. - name: id in: query required: false @@ -35418,13 +29682,13 @@ paths: oneOf: - type: string title: id - description: The product's ID. + description: Filter by the product option's ID. - type: array - description: The product's ID. + description: Filter by product option IDs. items: type: string title: id - description: The id's ID. + description: A product option's ID. - name: title in: query required: false @@ -35432,44 +29696,30 @@ paths: oneOf: - type: string title: title - description: The product's title. + description: Filter by a title. - type: array - description: The product's title. + description: Filter by titles. items: type: string title: title - description: The title's details. - - name: product_id - in: query - required: false - schema: - oneOf: - - type: string - title: product_id - description: The product's product id. - - type: array - description: The product's product id. - items: - type: string - title: product_id - description: The product id's details. + description: An option's title. - name: $and in: query - description: The product's $and. + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. required: false schema: type: array - description: The product's $and. + 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 - name: $or in: query - description: The product's $or. + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. required: false schema: type: array - description: The product's $or. + 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 @@ -35493,7 +29743,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of product options. required: - limit - offset @@ -35502,23 +29752,23 @@ paths: limit: type: number title: limit - description: The product's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product's offset. + description: The number of items skipped before the returned items. count: type: number title: count - description: The product's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of product options. required: - product_options properties: product_options: type: array - description: The product's product options. + description: The list of product options. items: $ref: '#/components/schemas/AdminProductOption' '400': @@ -35640,8 +29890,9 @@ paths: /admin/products/{id}/options/{option_id}: get: operationId: GetProductsIdOptionsOption_id - summary: List Options - description: Retrieve a list of options in a product. The options can be filtered by fields like FILTER FIELDS. The options can also be paginated. + summary: Get a Product's Option + x-sidebar-summary: Get Option + description: Retrieve a product's option by its ID. x-authenticated: true parameters: - name: id @@ -35927,7 +30178,8 @@ paths: /admin/products/{id}/variants: get: operationId: GetProductsIdVariants - summary: List Variants + summary: List Variants of a Product + x-sidebar-summary: List Variants description: Retrieve a list of variants in a product. The variants can be filtered by fields like FILTER FIELDS. The variants can also be paginated. x-authenticated: true parameters: @@ -35977,6 +30229,421 @@ paths: 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: q + in: query + description: Search term to filter the variant's search attributes. + required: false + schema: + type: string + title: q + description: Search term to filter the variant's search attributes. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: Filter by a variant's ID. + - type: array + description: Filter by variant IDs. + items: + type: string + title: id + description: A variant ID. + - name: manage_inventory + in: query + description: Filter by whether a variant's `manage_inventory` property is enabled. + required: false + schema: + type: boolean + title: manage_inventory + description: Filter by whether a variant's `manage_inventory` property is enabled. + - name: allow_backorder + in: query + description: Filter by whether backorders are allowed for the variant. + required: false + schema: + type: boolean + title: allow_backorder + description: Filter by whether backorders are allowed for the variant. + - name: created_at + in: query + description: Filter by the product's creation date. + required: false + schema: + type: object + description: Filter by the product'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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 product's update date. + required: false + schema: + type: object + description: Filter by the product'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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: deleted_at + in: query + description: Filter by the product's deletion date. + required: false + schema: + type: object + description: Filter by the product's deletion 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: $and + in: query + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + required: false + schema: + 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 + - name: $or + in: query + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + required: false + schema: + 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 security: - api_token: [] - cookie_auth: [] @@ -35997,7 +30664,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of product variants. required: - limit - offset @@ -36006,23 +30673,23 @@ paths: limit: type: number title: limit - description: The product's limit. + description: The maximum number of returned items. offset: type: number title: offset - description: The product's offset. + description: The number of items skipped before the returned item. count: type: number title: count - description: The product's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of product variants. required: - variants properties: variants: type: array - description: The product's variants. + description: The list of product variants. items: $ref: '#/components/schemas/AdminProductVariant' '400': @@ -36348,8 +31015,9 @@ paths: /admin/products/{id}/variants/{variant_id}: get: operationId: GetProductsIdVariantsVariant_id - summary: List Variants - description: Retrieve a list of variants in a product. The variants can be filtered by fields like FILTER FIELDS. The variants can also be paginated. + summary: Get Variant of a Product + x-sidebar-summary: Get Variant + description: Retrieve a product's variant by its ID. x-authenticated: true parameters: - name: id @@ -36360,7 +31028,7 @@ paths: type: string - name: variant_id in: path - description: The product's variant id. + description: The variant's ID. required: true schema: type: string @@ -36982,12 +31650,12 @@ paths: 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 promotion's q. + description: Search term to filter the promotion's searchable attributes. required: false schema: type: string title: q - description: The promotion's q. + description: Search term to filter the promotion's searchable attributes. - name: code in: query required: false @@ -36995,13 +31663,13 @@ paths: oneOf: - type: string title: code - description: The promotion's code. + description: Filter by a promotion code. - type: array - description: The promotion's code. + description: Filter by promotion codes. items: type: string title: code - description: The code's details. + description: A promotion code. - name: campaign_id in: query required: false @@ -37009,39 +31677,39 @@ paths: oneOf: - type: string title: campaign_id - description: The promotion's campaign id. + description: Filter by a campaign's ID to retrieve its associated promotions. - type: array - description: The promotion's campaign id. + description: Filter by campaign IDs to retrieve their associated promotions. items: type: string title: campaign_id - description: The campaign id's details. + description: A campaign's ID. - name: application_method in: query - description: The promotion's application method. + description: Apply filters on the application methods to retrieve the promotions of the matching application methods. required: false schema: type: object - description: The promotion's application method. + description: Apply filters on the application methods to retrieve the promotions of the matching application methods. properties: currency_code: oneOf: - type: string title: currency_code - description: The application method's currency code. + description: Filter by a currency code. - type: array - description: The application method's currency code. + description: Filter by currency codes. items: type: string title: currency_code - description: The currency code's details. + description: A currency code. - name: created_at in: query - description: The promotion's created at. + description: Filter by a promotion's creation date. required: false schema: type: object - description: The promotion's created at. + description: Filter by a promotion's creation date. properties: $and: type: array @@ -37091,118 +31759,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -37268,11 +31824,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The promotion's updated at. + description: Filter by a promotion's update date. required: false schema: type: object - description: The promotion's updated at. + description: Filter by a promotion's update date. properties: $and: type: array @@ -37322,118 +31878,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -37499,11 +31943,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The promotion's deleted at. + description: Filter by a promotion's deletion date. required: false schema: type: object - description: The promotion's deleted at. + description: Filter by a promotion's deletion date. properties: $and: type: array @@ -37553,118 +31997,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -37733,7 +32065,7 @@ paths: required: false schema: type: array - description: The promotion's $and. + 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 @@ -37742,7 +32074,7 @@ paths: required: false schema: type: array - description: The promotion's $or. + 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 @@ -37766,7 +32098,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of promotions. required: - limit - offset @@ -37775,23 +32107,23 @@ paths: limit: type: number title: limit - description: The promotion's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The promotion's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The promotion's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of promotions. required: - promotions properties: promotions: type: array - description: The promotion's promotions. + description: The list of promotions. items: $ref: '#/components/schemas/AdminPromotion' '400': @@ -38186,32 +32518,46 @@ paths: /admin/promotions/rule-attribute-options/{rule_type}: get: operationId: GetPromotionsRuleAttributeOptionsRule_type - summary: List Rule Attribute Options - description: Retrieve a list of rule attribute options in a promotion. The rule attribute options can be filtered by fields like FILTER FIELDS. The rule attribute options can also be paginated. + summary: List Rule Attribute Options of a Rule Type + x-sidebar-summary: List Rule Attribute Options + description: | + Retrieve a list of attributes for the promotion and application method types specified in the query parameters. + Only the attributes of the rule type specified in the path parameter are retrieved: + - If `rule_type` is `rules`, the attributes of the promotion's type are retrieved. - If `rule_type` is `target-rules`, the target rules' attributes of the application method's type are retrieved. - If `rule_type` is `buy-rules`, the buy rules' attributes of the application method's type are retrieved. x-authenticated: true parameters: - name: rule_type in: path - description: The promotion's rule type. + description: The rule type. required: true schema: type: string + enum: + - rules + - target-rules + - buy-rules - name: promotion_type in: query - description: The promotion's promotion type. + description: The promotion type to retrieve rules for. required: false schema: type: string title: promotion_type - description: The promotion's promotion type. + description: The promotion type to retrieve rules for. + enum: + - standard + - buyget - name: application_method_type in: query - description: The promotion's application method type. + description: The application method type to retrieve rules for. required: false schema: type: string title: application_method_type - description: The promotion's application method type. + description: The application method type to retrieve rules for. + enum: + - fixed + - percentage security: - api_token: [] - cookie_auth: [] @@ -38231,13 +32577,13 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The list of attributes. required: - attributes properties: attributes: type: array - description: The promotion's attributes. + description: The list of attributes. items: $ref: '#/components/schemas/AdminRuleAttributeOption' '400': @@ -38255,19 +32601,26 @@ paths: /admin/promotions/rule-value-options/{rule_type}/{rule_attribute_id}: get: operationId: GetPromotionsRuleValueOptionsRule_typeRule_attribute_id - summary: 'List ' - description: Retrieve a list of in a promotion. The can be filtered by fields like FILTER FIELDS. The can also be paginated. + summary: List Rule Values Given a Rule Attribute + x-sidebar-summary: List Rule Values + 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. x-authenticated: true parameters: - name: rule_type in: path - description: The promotion's rule type. + description: The rule type. required: true schema: type: string + enum: + - rules + - target-rules + - buy-rules - name: rule_attribute_id in: path - description: The promotion's rule attribute id. + description: The rule attribute's ID. required: true schema: type: string @@ -38313,20 +32666,26 @@ paths: 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 promotion's promotion type. + description: The promotion type to retrieve rules for. required: false schema: type: string title: promotion_type - description: The promotion's promotion type. + description: The promotion type to retrieve rules for. + enum: + - standard + - buyget - name: application_method_type in: query - description: The promotion's application method type. + description: The application method type to retrieve rules for. required: false schema: type: string title: application_method_type - description: The promotion's application method type. + description: The application method type to retrieve rules for. + enum: + - fixed + - percentage security: - api_token: [] - cookie_auth: [] @@ -38346,13 +32705,13 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The list of rule values. required: - values properties: values: type: array - description: The promotion's values. + description: The list of rule values. items: $ref: '#/components/schemas/AdminRuleValueOption' '400': @@ -39548,8 +33907,11 @@ paths: /admin/promotions/{id}/{rule_type}: get: operationId: GetPromotionsIdRule_type - summary: 'List ' - description: Retrieve a list of in a promotion. The can be filtered by fields like FILTER FIELDS. The can also be paginated. + summary: List Rules of a Promotion + x-sidebar-summary: List Rules + 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. - If `rule_type` is `target-rules`, the target rules of the promotion's application method are retrieved. - If `rule_type` is `buy-rules`, the buy rules of the promotion's application method are retrieved. x-authenticated: true parameters: - name: id @@ -39560,10 +33922,14 @@ paths: type: string - name: rule_type in: path - description: The promotion's rule type. + description: The type of rules to retrieve. required: true schema: type: string + enum: + - rules + - target-rules + - buy-rules - name: expand in: query description: Comma-separated relations that should be expanded in the returned data. @@ -39623,13 +33989,13 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The list of promotion rules. required: - rules properties: rules: type: array - description: The promotion's rules. + description: The list of promotion rules. items: $ref: '#/components/schemas/AdminPromotionRule' '400': @@ -39698,21 +34064,21 @@ paths: oneOf: - type: string title: id - description: The refund reason's ID. + description: Filter by a refund reason's ID. - type: array - description: The refund reason's ID. + description: Filter by refund reason IDs. items: type: string title: id - description: The id's ID. + description: A refund reason ID. - name: q in: query - description: The refund reason's q. + description: Search term to filter the refund reason's searchable properties. required: false schema: type: string title: q - description: The refund reason's q. + description: Search term to filter the refund reason's searchable properties. - name: $and in: query description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. @@ -40182,12 +34548,12 @@ paths: 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 region's q. + description: Search term to filter the region's searchable properties. required: false schema: type: string title: q - description: The region's q. + description: Search term to filter the region's searchable properties. - name: id in: query required: false @@ -40195,13 +34561,13 @@ paths: oneOf: - type: string title: id - description: The region's ID. + description: Filter by a region's ID. - type: array - description: The region's ID. + description: Filter by region IDs. items: type: string title: id - description: The id's ID. + description: A region's ID. - name: code in: query required: false @@ -40209,13 +34575,13 @@ paths: oneOf: - type: string title: code - description: The region's code. + description: Filter by a currency code. - type: array - description: The region's code. + description: Filter by currency codes. items: type: string title: code - description: The code's details. + description: A currency code. - name: name in: query required: false @@ -40223,20 +34589,20 @@ paths: oneOf: - type: string title: name - description: The region's name. + description: Filter by a region's name. - type: array - description: The region's name. + description: Filter by region names. items: type: string title: name - description: The name's details. + description: A region's name. - name: created_at in: query - description: The region's created at. + description: Filter by a region's creation date. required: false schema: type: object - description: The region's created at. + description: Filter by a region's creation date. properties: $and: type: array @@ -40286,118 +34652,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -40463,11 +34717,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The region's updated at. + description: Filter by a region's update date. required: false schema: type: object - description: The region's updated at. + description: Filter by a region's update date. properties: $and: type: array @@ -40517,118 +34771,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -40694,11 +34836,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The region's deleted at. + description: Filter by a region's deletion date. required: false schema: type: object - description: The region's deleted at. + description: Filter by a region's deletion date. properties: $and: type: array @@ -40748,118 +34890,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -40928,7 +34958,7 @@ paths: required: false schema: type: array - description: The region's $and. + 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 @@ -40937,7 +34967,7 @@ paths: required: false schema: type: array - description: The region's $or. + 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 @@ -40961,7 +34991,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of regions. required: - limit - offset @@ -40970,23 +35000,23 @@ paths: limit: type: number title: limit - description: The region's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The region's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The region's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of regions. required: - regions properties: regions: type: array - description: The region's regions. + description: The list of regions. items: $ref: '#/components/schemas/AdminRegion' '400': @@ -41421,13 +35451,13 @@ paths: oneOf: - type: string title: location_id - description: The reservation's location id. + description: Filter by a location's ID to retrieve its associated reservations. - type: array - description: The reservation's location id. + description: Filter by location IDs to retrieve its associated reservations. items: type: string title: location_id - description: The location id's details. + description: A location ID. - name: inventory_item_id in: query required: false @@ -41435,13 +35465,13 @@ paths: oneOf: - type: string title: inventory_item_id - description: The reservation's inventory item id. + description: Filter by an inventory item's ID to retrieve its associated reservations. - type: array - description: The reservation's inventory item id. + description: Filter by inventory item IDs to retrieve its associated reservations. items: type: string title: inventory_item_id - description: The inventory item id's details. + description: An inventory item ID - name: line_item_id in: query required: false @@ -41449,13 +35479,13 @@ paths: oneOf: - type: string title: line_item_id - description: The reservation's line item id. + description: Filter by a line item's ID to retrieve its associated reservations. - type: array - description: The reservation's line item id. + description: Filter by line item IDs to retrieve its associated reservations. items: type: string title: line_item_id - description: The line item id's details. + description: A line item ID - name: created_by in: query required: false @@ -41463,13 +35493,13 @@ paths: oneOf: - type: string title: created_by - description: The reservation's created by. + description: Filter by the ID of a user to retrieve the reservations they created. - type: array - description: The reservation's created by. + description: Filter by user IDs to retrieve the reservations they created. items: type: string title: created_by - description: The created by's details. + description: A user's ID. - name: description in: query required: false @@ -41477,42 +35507,59 @@ paths: oneOf: - type: string title: description - description: The reservation's description. + description: Filter by a reservation's description. This filter applies a full-text match. To search by keywords, use the `q` query parameter instead. - type: object - description: The reservation's description. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: Apply filters on the reservation's description. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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: The reservation's created at. + description: Filter by a reservation's creation date. required: false schema: type: object - description: The reservation's created at. + description: Filter by a reservation's creation date. properties: $and: type: array @@ -41562,118 +35609,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -41739,11 +35674,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The reservation's updated at. + description: Filter by a reservation's update date. required: false schema: type: object - description: The reservation's updated at. + description: Filter by a reservation's update date. properties: $and: type: array @@ -41793,118 +35728,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -41970,11 +35793,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The reservation's deleted at. + description: Filter by a reservation's deletion date. required: false schema: type: object - description: The reservation's deleted at. + description: Filter by a reservation's deletion date. properties: $and: type: array @@ -42024,118 +35847,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -42219,7 +35930,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of reservations. required: - limit - offset @@ -42228,23 +35939,23 @@ paths: limit: type: number title: limit - description: The reservation's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The reservation's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The reservation's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of reservations. required: - reservations properties: reservations: type: array - description: The reservation's reservations. + description: The list of reservations`. items: $ref: '#/components/schemas/ReservationResponse' '400': @@ -42661,12 +36372,12 @@ paths: 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 return reason's q. + description: Search term to filter the return reason's searchable properties. required: false schema: type: string title: q - description: The return reason's q. + description: Search term to filter the return reason's searchable properties. - name: id in: query required: false @@ -42674,13 +36385,13 @@ paths: oneOf: - type: string title: id - description: The return reason's ID. + description: Filter by a return reason ID. - type: array - description: The return reason's ID. + description: Filter by return reason IDs. items: type: string title: id - description: The id's ID. + description: A return reason ID. - name: value in: query required: false @@ -42688,13 +36399,13 @@ paths: oneOf: - type: string title: value - description: The return reason's value. + description: Filter by a return reason's value. - type: array - description: The return reason's value. + description: Filter by return reason values. items: type: string title: value - description: The value's details. + description: A return reason value. - name: label in: query required: false @@ -42702,13 +36413,13 @@ paths: oneOf: - type: string title: label - description: The return reason's label. + description: Filter by a return reason's label. - type: array - description: The return reason's label. + description: Filter by return reason labels. items: type: string title: label - description: The label's details. + description: A return reason label. - name: description in: query required: false @@ -42716,13 +36427,13 @@ paths: oneOf: - type: string title: description - description: The return reason's description. + description: Filter by a description. This filter looks for an exact match of the return reason's description. To search by a term or keywords, use the `q` query parameter instead. - type: array - description: The return reason's description. + description: Filter by descriptions. This filter looks for an exact match of the return reason's description. To search by a term or keywords, use the `q` query parameter instead. items: type: string title: description - description: The description's details. + description: A return reason's description. - name: parent_return_reason_id in: query required: false @@ -42730,20 +36441,20 @@ paths: oneOf: - type: string title: parent_return_reason_id - description: The return reason's parent return reason id. + description: Filter by a return reason's ID to retrieve its child return reasons. - type: array - description: The return reason's parent return reason id. + description: Filter by return reason IDs to retrieve their child return reasons. items: type: string title: parent_return_reason_id - description: The parent return reason id's details. + description: The return reason's ID. - name: created_at in: query - description: The return reason's created at. + description: Filter by a return reason's creation date. required: false schema: type: object - description: The return reason's created at. + description: Filter by a return reason's creation date. properties: $and: type: array @@ -42793,118 +36504,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -42970,11 +36569,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The return reason's updated at. + description: Filter by a return reason's update date. required: false schema: type: object - description: The return reason's updated at. + description: Filter by a return reason's update date. properties: $and: type: array @@ -43024,118 +36623,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -43201,11 +36688,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The return reason's deleted at. + description: Filter by a return reason's deletion date. required: false schema: type: object - description: The return reason's deleted at. + description: Filter by a return reason's deletion date. properties: $and: type: array @@ -43255,118 +36742,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -43432,21 +36807,21 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: $and in: query - description: The return reason's $and. + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. required: false schema: type: array - description: The return reason's $and. + 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 - name: $or in: query - description: The return reason's $or. + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. required: false schema: type: array - description: The return reason's $or. + 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 @@ -43840,27 +37215,47 @@ paths: oneOf: - type: string title: id - description: The return's ID. + description: Filter by a return's ID. - type: array - description: The return's ID. + description: Filter by return IDs. items: type: string title: id - description: The id's ID. - - name: name + description: A return ID. + - name: status in: query required: false schema: oneOf: - type: string - title: name - description: The return's name. + title: status + description: Filter by a return status. - type: array - description: The return's name. + description: Filter by return statuses. items: type: string - title: name - description: The name's details. + title: status + description: A return status. + - name: $and + in: query + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + required: false + schema: + 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 + - name: $or + in: query + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + required: false + schema: + 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 - name: sales_channel_id in: query description: The return's sales channel id. @@ -43881,8 +37276,16 @@ paths: description: The return's fulfillment status. items: 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: The return's payment status. @@ -43892,8 +37295,18 @@ paths: description: The return's payment status. items: 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: The return's region id. @@ -44375,449 +37788,6 @@ paths: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - - name: status - in: query - required: false - schema: - oneOf: - - type: string - title: status - description: The return's status. - - type: array - description: The return's status. - items: - type: string - title: status - description: The status's details. - - type: object - description: The return's status. - 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 an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - oneOf: - - type: string - title: $ne - description: Filter by values not equal to this parameter. - - type: array - description: Filter by values not equal to this parameter. - items: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - oneOf: - - type: string - title: $in - description: Filter by values in this array. - - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - oneOf: - - type: string - title: $nin - description: Filter by values not in this array. - - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - $gt: - oneOf: - - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - - type: array - description: Filter by values greater than this parameter. Useful for numbers and dates only. - items: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - oneOf: - - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - - type: array - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - items: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - oneOf: - - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - - type: array - description: Filter by values less than this parameter. Useful for numbers and dates only. - items: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - oneOf: - - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - - type: array - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - items: - 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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - - name: $and - in: query - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - required: false - schema: - 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 - - name: $or - in: query - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - required: false - schema: - 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 security: - api_token: [] - cookie_auth: [] @@ -46788,12 +39758,12 @@ paths: 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 sales channel's q. + description: Search term to filter the sales channel's searchable properties. required: false schema: type: string title: q - description: The sales channel's q. + description: Search term to filter the sales channel's searchable properties. - name: id in: query required: false @@ -46801,13 +39771,13 @@ paths: oneOf: - type: string title: id - description: The sales channel's ID. + description: Filter by a sales channel ID. - type: array - description: The sales channel's ID. + description: Filter by sales channel IDs. items: type: string title: id - description: The id's ID. + description: A sales channel ID. - name: name in: query required: false @@ -46815,13 +39785,13 @@ paths: oneOf: - type: string title: name - description: The sales channel's name. + description: Filter by a sales channel name. - type: array - description: The sales channel's name. + description: Filter by sales channel names. items: type: string title: name - description: The name's details. + description: A sales channel name. - name: description in: query description: The sales channel's description. @@ -46829,22 +39799,22 @@ paths: schema: type: string title: description - description: The sales channel's description. + description: Filter by a description. This filter matches an entire description. To search by terms or keywords, use the `q` query parameter instead. - name: is_disabled in: query - description: The sales channel's is disabled. + description: Filter by whether the sales channel is disabled. required: false schema: type: boolean title: is_disabled - description: The sales channel's is disabled. + description: Filter by whether the sales channel is disabled. - name: created_at in: query - description: The sales channel's created at. + description: Filter by a sales channel's creation date. required: false schema: type: object - description: The sales channel's created at. + description: Filter by a sales channel's creation date. properties: $and: type: array @@ -46894,118 +39864,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -47071,11 +39929,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The sales channel's updated at. + description: Filter by a sales channel's update date. required: false schema: type: object - description: The sales channel's updated at. + description: Filter by a sales channel's update date. properties: $and: type: array @@ -47125,118 +39983,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -47302,11 +40048,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The sales channel's deleted at. + description: Filter by a sales channel's deletion date. required: false schema: type: object - description: The sales channel's deleted at. + description: Filter by a sales channel's deletion date. properties: $and: type: array @@ -47356,118 +40102,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -47538,13 +40172,13 @@ paths: oneOf: - type: string title: location_id - description: The sales channel's location id. + description: Filter by a location ID to retrieve its associated sales channels. - type: array - description: The sales channel's location id. + description: Filter by location IDs to retrieve their associated sales channels. items: type: string title: location_id - description: The location id's details. + description: A location ID. - name: publishable_key_id in: query required: false @@ -47552,19 +40186,19 @@ paths: oneOf: - type: string title: publishable_key_id - description: The sales channel's publishable key id. + description: Filter by a publishable API key's ID to retrieve its associated sales channels. - type: array - description: The sales channel's publishable key id. + description: Filter by publishable API key IDs to retrieve their associated sales channels. items: type: string title: publishable_key_id - description: The publishable key id's details. + description: A publishable API key ID. - name: $and in: query required: false schema: type: array - description: The sales channel's $and. + 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 @@ -47573,7 +40207,7 @@ paths: required: false schema: type: array - description: The sales channel's $or. + 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 @@ -47597,7 +40231,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of sales channels. required: - limit - offset @@ -47606,23 +40240,23 @@ paths: limit: type: number title: limit - description: The sales channel's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The sales channel's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The sales channel's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of sales channels. required: - sales_channels properties: sales_channels: type: array - description: The sales channel's sales channels. + description: The list of sales channels. items: $ref: '#/components/schemas/AdminSalesChannel' '400': @@ -48108,21 +40742,21 @@ paths: oneOf: - type: string title: id - description: The shipping option's ID. + description: Filter by a shipping option ID. - type: array - description: The shipping option's ID. + description: Filter by shipping option IDs. items: type: string title: id - description: The id's ID. + description: A shipping option's ID. - name: q in: query - description: The shipping option's q. + description: Search term to filter the shipping option's searchable properties. required: false schema: type: string title: q - description: The shipping option's q. + description: Search term to filter the shipping option's searchable properties. - name: service_zone_id in: query required: false @@ -48130,13 +40764,13 @@ paths: oneOf: - type: string title: service_zone_id - description: The shipping option's service zone id. + description: Filter by a service zone's ID to retrieve its associated shipping options. - type: array - description: The shipping option's service zone id. + description: Filter by service zone IDs to retrieve their associated shipping options. items: type: string title: service_zone_id - description: The service zone id's details. + description: A service zone ID. - name: shipping_profile_id in: query required: false @@ -48144,13 +40778,13 @@ paths: oneOf: - type: string title: shipping_profile_id - description: The shipping option's shipping profile id. + description: Filter by a shipping profile's ID to retrieve its associated shipping options. - type: array - description: The shipping option's shipping profile id. + description: Filter by shipping profile IDs to retrieve their associated shipping options. items: type: string title: shipping_profile_id - description: The shipping profile id's details. + description: A shipping profile ID. - name: provider_id in: query required: false @@ -48158,13 +40792,13 @@ paths: oneOf: - type: string title: provider_id - description: The shipping option's provider id. + description: Filter by a fulfillment provider's ID to retrieve its associated shipping options. - type: array - description: The shipping option's provider id. + description: Filter by fulfillment provider IDs to retrieve their associated shipping options. items: type: string title: provider_id - description: The provider id's details. + description: A fulfillment provider ID. - name: shipping_option_type_id in: query required: false @@ -48172,20 +40806,20 @@ paths: oneOf: - type: string title: shipping_option_type_id - description: The shipping option's shipping option type id. + description: Filter by a shipping option type's ID to retrieve its associated shipping options. - type: array - description: The shipping option's shipping option type id. + description: Filter by shipping option type IDs to retrieve its associated shipping options. items: type: string title: shipping_option_type_id - description: The shipping option type id's details. + description: A shipping option type ID. - name: created_at in: query - description: The shipping option's created at. + description: Filter by a shipping option's creation date. required: false schema: type: object - description: The shipping option's created at. + description: Filter by a shipping option's creation date. properties: $and: type: array @@ -48235,118 +40869,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -48412,11 +40934,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The shipping option's updated at. + description: Filter by a shipping option's update date. required: false schema: type: object - description: The shipping option's updated at. + description: Filter by a shipping option's update date. properties: $and: type: array @@ -48466,118 +40988,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -48643,11 +41053,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The shipping option's deleted at. + description: Filter by a shipping option's deletion date. required: false schema: type: object - description: The shipping option's deleted at. + description: Filter by a shipping option's deletion date. properties: $and: type: array @@ -48697,118 +41107,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -48879,13 +41177,13 @@ paths: oneOf: - type: string title: stock_location_id - description: The shipping option's stock location id. + description: Filter by a location ID to retrieve its associated shipping option. - type: array - description: The shipping option's stock location id. + description: Filter by location IDs to retrieve their associated shipping option. items: type: string title: stock_location_id - description: The stock location id's details. + description: A stock location's ID. - name: is_return in: query description: The shipping option's is return. @@ -48922,7 +41220,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of shipping options. required: - limit - offset @@ -48931,23 +41229,23 @@ paths: limit: type: number title: limit - description: The shipping option's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The shipping option's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The shipping option's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of shipping options. required: - shipping_options properties: shipping_options: type: array - description: The shipping option's shipping options. + description: The list of shipping options. items: type: object '400': @@ -49617,58 +41915,400 @@ paths: oneOf: - type: string title: id - description: The shipping profile's ID. + description: Filter by a shipping profile's ID. - type: array - description: The shipping profile's ID. + description: Filter by shipping profile IDs. items: type: string title: id - description: The id's ID. + description: A shipping profile ID. - name: q in: query - description: The shipping profile's q. + description: Search term to filter the shipping profile's searchable properties. required: false schema: type: string title: q - description: The shipping profile's q. + description: Search term to filter the shipping profile's searchable properties. - name: type in: query - description: The shipping profile's type. + description: Filter by a shipping profile's type. required: false schema: type: string title: type - description: The shipping profile's type. + description: Filter by a shipping profile's type. - name: name in: query - description: The shipping profile's name. + description: Filter by a shipping profile's name. required: false schema: type: string title: name - description: The shipping profile's name. + description: Filter by a shipping profile's name. - name: created_at in: query - description: The shipping profile's created at. + description: Filter by a shipping profile's creation date. required: false - schema: {} + schema: + type: object + description: Filter by a shipping profile'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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The shipping profile's updated at. + description: Filter by a shipping profile's update date. required: false - schema: {} + schema: + type: object + description: Filter by a shipping profile'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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The shipping profile's deleted at. + description: Filter by a shipping profile's deletion date. required: false - schema: {} + schema: + type: object + description: Filter by a shipping profile's deletion 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). - name: $and in: query required: false schema: type: array - description: The shipping profile's $and. + 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 @@ -49677,7 +42317,7 @@ paths: required: false schema: type: array - description: The shipping profile's $or. + 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 @@ -49701,7 +42341,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of shipping profiles. required: - limit - offset @@ -49710,23 +42350,23 @@ paths: limit: type: number title: limit - description: The shipping profile's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The shipping profile's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The shipping profile's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of shipping profiles. required: - shipping_profiles properties: shipping_profiles: type: array - description: The shipping profile's shipping profiles. + description: The list of shipping profiles. items: $ref: '#/components/schemas/AdminShippingProfile' '400': @@ -49795,24 +42435,7 @@ paths: 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 @@ -50132,12 +42755,12 @@ paths: 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 stock location's q. + description: Search term to filter the stock location's searchable properties. required: false schema: type: string title: q - description: The stock location's q. + description: Search term to filter the stock location's searchable properties. - name: id in: query required: false @@ -50145,13 +42768,13 @@ paths: oneOf: - type: string title: id - description: The stock location's ID. + description: Filter by a stock location ID. - type: array - description: The stock location's ID. + description: Filter by stock location IDs. items: type: string title: id - description: The id's ID. + description: A stock location ID. - name: name in: query required: false @@ -50159,13 +42782,13 @@ paths: oneOf: - type: string title: name - description: The stock location's name. + description: Filter by a stock location name. - type: array - description: The stock location's name. + description: Filter by stock location names. items: type: string title: name - description: The name's details. + description: A stock location name. - name: address_id in: query required: false @@ -50173,13 +42796,13 @@ paths: oneOf: - type: string title: address_id - description: The stock location's address id. + description: Filter by an address ID to retrieve its associated locations. - type: array - description: The stock location's address id. + description: Filter by address IDs to retrieve their associated locations. items: type: string title: address_id - description: The address id's details. + description: An address ID. - name: sales_channel_id in: query required: false @@ -50187,20 +42810,20 @@ paths: oneOf: - type: string title: sales_channel_id - description: The stock location's sales channel id. + description: Filter by a sales channel ID to retrieve its associated locations. - type: array - description: The stock location's sales channel id. + description: Filter by sales channel IDs to retrieve their associated locations. items: type: string title: sales_channel_id - description: The sales channel id's details. + description: A sales channel ID - name: created_at in: query - description: The stock location's created at. + description: Filter by a stock location's creation date. required: false schema: type: object - description: The stock location's created at. + description: Filter by a stock location's creation date. properties: $and: type: array @@ -50250,118 +42873,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -50427,11 +42938,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The stock location's updated at. + description: Filter by a stock location's update date. required: false schema: type: object - description: The stock location's updated at. + description: Filter by a stock location's update date. properties: $and: type: array @@ -50481,118 +42992,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -50658,11 +43057,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The stock location's deleted at. + description: Filter by a stock location's deletion date. required: false schema: type: object - description: The stock location's deleted at. + description: Filter by a stock location's deletion date. properties: $and: type: array @@ -50712,118 +43111,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -50892,7 +43179,7 @@ paths: required: false schema: type: array - description: The stock location's $and. + 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 @@ -50901,7 +43188,7 @@ paths: required: false schema: type: array - description: The stock location's $or. + 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 @@ -51616,12 +43903,12 @@ paths: 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 store's q. + description: Search term to filter the store's searchable properties. required: false schema: type: string title: q - description: The store's q. + description: Search term to filter the store's searchable properties. - name: id in: query required: false @@ -51629,13 +43916,13 @@ paths: oneOf: - type: string title: id - description: The store's ID. + description: Filter by a store ID. - type: array - description: The store's ID. + description: Filter by store IDs. items: type: string title: id - description: The id's ID. + description: A store ID. - name: name in: query required: false @@ -51643,19 +43930,19 @@ paths: oneOf: - type: string title: name - description: The store's name. + description: Filter by a store name. - type: array - description: The store's name. + description: Filter by store names. items: type: string title: name - description: The name's details. + description: A store name. - name: $and in: query required: false schema: type: array - description: The store's $and. + 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 @@ -51664,7 +43951,7 @@ paths: required: false schema: type: array - description: The store's $or. + 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 @@ -51929,12 +44216,12 @@ paths: 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 tax rate's q. + description: Search terms to filter the tax rate's searchable properties. required: false schema: type: string title: q - description: The tax rate's q. + description: Search terms to filter the tax rate's searchable properties. - name: tax_region_id in: query required: false @@ -51942,57 +44229,74 @@ paths: oneOf: - type: string title: tax_region_id - description: The tax rate's tax region id. + description: Filter by a tax region ID to retrieve its associated rates. - type: array - description: The tax rate's tax region id. + description: Filter by tax region IDs to retrieve their associated rates. items: type: string title: tax_region_id - description: The tax region id's details. + description: A tax region ID. - type: object - description: The tax rate's tax region id. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: Apply filters on the tax region ID to retrieve the rates associated with the matching tax regions. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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: is_default in: query required: false + description: Filter by whether the tax rate is a default in its tax region. schema: type: string enum: - 'true' - 'false' - title: is_default - name: created_at in: query - description: The tax rate's created at. + description: Filter by a tax rate's creation date. required: false schema: type: object - description: The tax rate's created at. + description: Filter by a tax rate's creation date. properties: $and: type: array @@ -52042,118 +44346,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -52219,11 +44411,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The tax rate's updated at. + description: Filter by a tax rate's update date. required: false schema: type: object - description: The tax rate's updated at. + description: Filter by a tax rate's update date. properties: $and: type: array @@ -52273,118 +44465,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -52450,11 +44530,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The tax rate's deleted at. + description: Filter by a tax rate's deletion date. required: false schema: type: object - description: The tax rate's deleted at. + description: Filter by a tax rate's deletion date. properties: $and: type: array @@ -52504,118 +44584,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -52684,7 +44652,7 @@ paths: required: false schema: type: array - description: The tax rate's $and. + 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 @@ -52693,42 +44661,42 @@ paths: required: false schema: type: array - description: The tax rate's $or. + 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 - name: service_zone_id in: query - description: The tax rate's service zone id. + description: Filter by a service zone's ID to retrieve its associated tax rates. required: false schema: type: string title: service_zone_id - description: The tax rate's service zone id. + description: Filter by a service zone's ID to retrieve its associated tax rates. - name: shipping_profile_id in: query - description: The tax rate's shipping profile id. + description: Filter by a shipping profile's ID to retrieve its associated tax rates. required: false schema: type: string title: shipping_profile_id - description: The tax rate's shipping profile id. + description: Filter by a shipping profile's ID to retrieve its associated tax rates. - name: provider_id in: query - description: The tax rate's provider id. + description: Filter by a fulfillment provider's ID to retrieve its associated tax rates. required: false schema: type: string title: provider_id - description: The tax rate's provider id. + description: Filter by a fulfillment provider's ID to retrieve its associated tax rates. - name: shipping_option_type_id in: query - description: The tax rate's shipping option type id. + description: Filter by a shipping option type's ID to retrieve its associated tax rates. required: false schema: type: string title: shipping_option_type_id - description: The tax rate's shipping option type id. + description: Filter by a shipping option type's ID to retrieve its associated tax rates. security: - api_token: [] - cookie_auth: [] @@ -52749,7 +44717,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of tax rates. required: - limit - offset @@ -52758,17 +44726,17 @@ paths: limit: type: number title: limit - description: The tax rate's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The tax rate's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The tax rate's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of tax rates. required: - tax_rates properties: @@ -53360,12 +45328,12 @@ paths: 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 tax region's q. + description: Search term to filter a tax region's searchable properties. required: false schema: type: string title: q - description: The tax region's q. + description: Search term to filter a tax region's searchable properties. - name: id in: query required: false @@ -53373,13 +45341,13 @@ paths: oneOf: - type: string title: id - description: The tax region's ID. + description: Filter by a tax region ID. - type: array - description: The tax region's ID. + description: Filter by tax region IDs. items: type: string title: id - description: The id's ID. + description: A tax region ID. - name: country_code in: query required: false @@ -53387,41 +45355,58 @@ paths: oneOf: - type: string title: country_code - description: The tax region's country code. + description: Filter by a country code. - type: array - description: The tax region's country code. + description: Filter by country codes. items: type: string title: country_code - description: The country code's details. + description: A country code. - type: object - description: The tax region's country code. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: Apply filters on the currency code. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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: province_code in: query required: false @@ -53429,41 +45414,58 @@ paths: oneOf: - type: string title: province_code - description: The tax region's province code. + description: Filter by a province code. - type: array - description: The tax region's province code. + description: Filter by province codes. items: type: string title: province_code - description: The province code's details. + description: A province code. - type: object - description: The tax region's province code. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: Apply filters on the province code. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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: parent_id in: query required: false @@ -53471,41 +45473,58 @@ paths: oneOf: - type: string title: parent_id - description: The tax region's parent id. + description: Filter by the ID of a parent tax region to retrieve its child tax regions. - type: array - description: The tax region's parent id. + description: Filter by the IDs of parent tax regions to retrieve their child tax regions. items: type: string title: parent_id - description: The parent id's details. + description: A tax region's ID. - type: object - description: The tax region's parent id. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: Apply filters on the parent tax region's ID to retrieve its child tax regions. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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_by in: query required: false @@ -53513,34 +45532,724 @@ paths: oneOf: - type: string title: created_by - description: The tax region's created by. + description: Filter by the ID of the user to retrieve the tax regions they created. - type: array - description: The tax region's created by. + description: Filter by user IDs to retrieve their tax regions they created. items: type: string title: created_by - description: The created by's details. + description: A user ID. - name: created_at in: query - description: The tax region's created at. + description: Filter by a tax region's creation date. required: false - schema: {} + schema: + oneOf: + - type: string + title: created_at + description: The tax region's created at. + - type: object + description: The tax region's created at. + 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The tax region's updated at. + description: Filter by a tax region's update date. required: false - schema: {} + schema: + oneOf: + - type: string + title: updated_at + description: The tax region's updated at. + - type: object + description: The tax region's updated at. + 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The tax region's deleted at. + description: Filter by a tax region's deletion date. required: false - schema: {} + schema: + oneOf: + - type: string + title: deleted_at + description: The tax region's deleted at. + - type: object + description: The tax region's deleted at. + 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). - name: $and in: query required: false schema: type: array - description: The tax region's $and. + 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 @@ -53549,7 +46258,7 @@ paths: required: false schema: type: array - description: The tax region's $or. + 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 @@ -53573,7 +46282,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of tax regions. required: - limit - offset @@ -53582,23 +46291,23 @@ paths: limit: type: number title: limit - description: The tax region's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The tax region's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The tax region's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of tax regions. required: - tax_regions properties: tax_regions: type: array - description: The tax region's tax regions. + description: The list of tax regions. items: type: object '400': @@ -53905,8 +46614,8 @@ paths: /admin/uploads/{id}: get: operationId: GetUploadsId - summary: Get a Upload - description: Retrieve a upload by its ID. You can expand the upload's relations or select the fields that should be returned. + summary: Get a File + description: Retrieve an uploaded file by its ID. You can expand the file's relations or select the fields that should be returned. x-authenticated: true parameters: - name: id @@ -54098,12 +46807,12 @@ paths: 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 user's q. + description: The search term to filter the user's searchable properties. required: false schema: type: string title: q - description: The user's q. + description: The search term to filter the user's searchable properties. - name: id in: query required: false @@ -54111,45 +46820,45 @@ paths: oneOf: - type: string title: id - description: The user's ID. + description: Filter by a user's ID. - type: array - description: The user's ID. + description: Filter by user IDs. items: type: string title: id - description: The id's ID. + description: A user's ID. - name: email in: query - description: The user's email. + description: Filter by an email. required: false schema: type: string title: email - description: The user's email. + description: Filter by an email. format: email - name: first_name in: query - description: The user's first name. + description: Filter by a first name. required: false schema: type: string title: first_name - description: The user's first name. + description: Filter by a first name. - name: last_name in: query - description: The user's last name. + description: Filter by a last name. required: false schema: type: string title: last_name - description: The user's last name. + description: Filter by a last name. - name: created_at in: query - description: The user's created at. + description: Filter by a user's creation date. required: false schema: type: object - description: The user's created at. + description: Filter by a user's creation date. properties: $and: type: array @@ -54199,118 +46908,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -54376,11 +46973,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The user's updated at. + description: Filter by a user's update date. required: false schema: type: object - description: The user's updated at. + description: Filter by a user's update date. properties: $and: type: array @@ -54430,118 +47027,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -54607,11 +47092,11 @@ paths: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The user's deleted at. + description: Filter by a user's deletion date. required: false schema: type: object - description: The user's deleted at. + description: Filter by a user's deletion date. properties: $and: type: array @@ -54661,118 +47146,6 @@ paths: description: Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $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: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this parameter. items: @@ -54864,8 +47237,8 @@ paths: /admin/users/me: get: operationId: GetUsersMe - summary: List Users - description: Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated. + summary: Get Logged-In User + description: Retrieve the logged-in user's details. x-authenticated: false parameters: - name: expand @@ -55193,13 +47566,13 @@ paths: oneOf: - type: string title: transaction_id - description: The workflows execution's transaction id. + description: Filter by a transaction ID. - type: array - description: The workflows execution's transaction id. + description: Filter by transaction IDs. items: type: string title: transaction_id - description: The transaction id's details. + description: A transaction ID. - name: workflow_id in: query required: false @@ -55207,13 +47580,13 @@ paths: oneOf: - type: string title: workflow_id - description: The workflows execution's workflow id. + description: Filter by a workflow ID. - type: array - description: The workflows execution's workflow id. + description: Filter by workflow IDs. items: type: string title: workflow_id - description: The workflow id's details. + description: A workflow ID. security: - api_token: [] - cookie_auth: [] @@ -55234,7 +47607,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of workflow executions. required: - limit - offset @@ -55243,17 +47616,17 @@ paths: limit: type: number title: limit - description: The workflows execution's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The workflows execution's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The workflows execution's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of workflow executions. required: - workflow_executions properties: @@ -55539,8 +47912,11 @@ paths: /admin/workflows-executions/{workflow_id}/subscribe: get: operationId: GetWorkflowsExecutionsWorkflow_idSubscribe - summary: List Subscribes - description: Retrieve a list of subscribes in a workflows execution. The subscribes can be filtered by fields like FILTER FIELDS. The subscribes can also be paginated. + summary: Subscribe to a Workflow's Execution + x-sidebar-summary: Subscribe to Workflow + 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: - name: workflow_id @@ -55562,6 +47938,16 @@ paths: tags: - Workflows Executions responses: + '200': + description: Stream of the step's status. + content: + text/event-stream: + schema: + type: string + description: The step's status update and data changes. + example: |- + event: success + data: {} '400': $ref: '#/components/responses/400_error' '401': @@ -55577,8 +47963,9 @@ paths: /admin/workflows-executions/{workflow_id}/{transaction_id}: get: operationId: GetWorkflowsExecutionsWorkflow_idTransaction_id - summary: 'List ' - description: Retrieve a list of in a workflows execution. The can be filtered by fields like FILTER FIELDS. The can also be paginated. + summary: Get Workflow Execution's Details + x-sidebar-summary: Get Exection + description: Get the details of the workflow's execution. x-authenticated: true parameters: - name: workflow_id @@ -55667,8 +48054,11 @@ paths: /admin/workflows-executions/{workflow_id}/{transaction_id}/{step_id}/subscribe: get: operationId: GetWorkflowsExecutionsWorkflow_idTransaction_idStep_idSubscribe - summary: List Subscribes - description: Retrieve a list of subscribes in a workflows execution. The subscribes can be filtered by fields like FILTER FIELDS. The subscribes can also be paginated. + summary: Subscribe to Step of a Workflow's Execution + x-sidebar-summary: Subscribe to Step + 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: - name: workflow_id @@ -55702,6 +48092,16 @@ paths: tags: - Workflows Executions responses: + '200': + description: Stream of the step's status. + content: + text/event-stream: + schema: + type: string + description: The step's status update and data changes. + example: |- + event: success + data: {} '400': $ref: '#/components/responses/400_error' '401': @@ -57021,6 +49421,7 @@ components: AdminCreateInventoryItem: type: object description: SUMMARY + x-schemaName: AdminCreateInventoryItem properties: sku: type: string @@ -57077,7 +49478,6 @@ components: metadata: type: object description: The inventory item's metadata. - x-schemaName: AdminCreateInventoryItem AdminCreatePriceList: type: object description: SUMMARY @@ -57323,6 +49723,7 @@ components: AdminCreateProductCategory: type: object description: SUMMARY + x-schemaName: AdminCreateProductCategory required: - name properties: @@ -57350,14 +49751,13 @@ components: type: string title: parent_category_id description: The product category's parent category id. - metadata: - type: object - description: The product category's metadata. rank: type: number title: rank description: The product category's rank. - x-schemaName: AdminCreateProductCategory + metadata: + type: object + description: The product category's metadata. AdminCreateProductOption: type: object description: SUMMARY @@ -57380,6 +49780,7 @@ components: AdminCreateProductTag: type: object description: SUMMARY + x-schemaName: AdminCreateProductTag required: - value properties: @@ -57390,7 +49791,6 @@ components: metadata: type: object description: The product tag's metadata. - x-schemaName: AdminCreateProductTag AdminCreateProductVariant: type: object description: The create's details. @@ -57543,6 +49943,7 @@ components: AdminCreateRefundReason: type: object description: SUMMARY + x-schemaName: AdminCreateRefundReason required: - label properties: @@ -57554,10 +49955,10 @@ components: type: string title: description description: The refund reason's description. - x-schemaName: AdminCreateRefundReason AdminCreateRegion: type: object description: SUMMARY + x-schemaName: AdminCreateRegion required: - name - currency_code @@ -57581,6 +49982,10 @@ components: type: boolean title: automatic_taxes description: The region's automatic taxes. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The region's is tax inclusive. payment_providers: type: array description: The region's payment providers. @@ -57591,14 +49996,10 @@ components: metadata: type: object description: The region's metadata. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The region's is tax inclusive. - x-schemaName: AdminCreateRegion AdminCreateReservation: type: object description: SUMMARY + x-schemaName: AdminCreateReservation required: - location_id - inventory_item_id @@ -57627,7 +50028,6 @@ components: metadata: type: object description: The reservation's metadata. - x-schemaName: AdminCreateReservation AdminCreateSalesChannel: type: object description: SUMMARY @@ -57683,6 +50083,7 @@ components: AdminCreateShippingOption: type: object description: SUMMARY + x-schemaName: AdminCreateShippingOption required: - name - service_zone_id @@ -57709,9 +50110,10 @@ components: description: The shipping option's data. price_type: type: string + description: The shipping option's price type. enum: - - calculated - flat + - calculated provider_id: type: string title: provider_id @@ -57725,6 +50127,7 @@ components: oneOf: - type: object description: The price's prices. + x-schemaName: AdminCreateShippingOptionPriceWithCurrency required: - currency_code - amount @@ -57739,6 +50142,7 @@ components: description: The price's amount. - type: object description: The price's prices. + x-schemaName: AdminCreateShippingOptionPriceWithRegion required: - region_id - amount @@ -57756,10 +50160,10 @@ components: description: The shipping option's rules. items: $ref: '#/components/schemas/AdminCreateShippingOptionRule' - x-schemaName: AdminCreateShippingOption AdminCreateShippingOptionRule: type: object description: The rule's rules. + x-schemaName: AdminCreateShippingOptionRule required: - operator - attribute @@ -57767,14 +50171,15 @@ components: properties: operator: type: string + description: The rule's operator. enum: - - in + - gt + - lt - eq - ne - - gt - - gte - - lt + - in - lte + - gte - nin attribute: type: string @@ -57791,7 +50196,25 @@ components: type: string title: value description: The value's details. - x-schemaName: AdminCreateShippingOptionRule + AdminCreateShippingProfile: + type: object + description: SUMMARY + required: + - name + - type + 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. + x-schemaName: AdminCreateShippingProfile AdminCreateStockLocation: type: object description: SUMMARY @@ -58774,6 +51197,7 @@ components: AdminDeletePaymentCollectionResponse: type: object description: SUMMARY + x-schemaName: AdminDeletePaymentCollectionResponse required: - id - object @@ -58786,13 +51210,12 @@ components: object: type: string title: object - description: The name of the deleted object. + description: SUMMARY default: payment-collection deleted: type: boolean title: deleted - description: Whether the payment collection was deleted. - x-schemaName: AdminDeletePaymentCollectionResponse + description: SUMMARY AdminDraftOrderResponse: type: object description: SUMMARY @@ -59059,6 +51482,7 @@ components: AdminExchangeDeleteResponse: type: object description: SUMMARY + x-schemaName: AdminExchangeDeleteResponse required: - id - object @@ -59076,8 +51500,7 @@ components: deleted: type: boolean title: deleted - description: Whether the exchange was deleted. - x-schemaName: AdminExchangeDeleteResponse + description: Whether the Exchange was deleted. AdminExchangeOrderResponse: type: object description: SUMMARY @@ -59523,7 +51946,17 @@ components: $ref: '#/components/schemas/AdminFulfillment' AdminFulfillmentSet: type: object - description: The fulfillment set that the service zone belongs to. + description: The fulfillment set's parent. + x-schemaName: AdminFulfillmentSet + required: + - id + - name + - type + - location + - service_zones + - created_at + - updated_at + - deleted_at properties: id: type: string @@ -59559,16 +51992,6 @@ components: format: date-time title: deleted_at description: The parent's deleted at. - required: - - id - - name - - type - - location - - service_zones - - created_at - - updated_at - - deleted_at - x-schemaName: AdminFulfillmentSet AdminFulfillmentSetDeleteResponse: type: object description: SUMMARY @@ -63305,20 +55728,20 @@ components: $ref: '#/components/schemas/AdminProductVariant' AdminProductVariantParams: type: object - description: The product's variants. + description: SUMMARY x-schemaName: AdminProductVariantParams properties: q: type: string title: q - description: The variant's q. + description: The product's q. id: oneOf: - type: string title: id - description: The variant's ID. + description: The product's ID. - type: array - description: The variant's ID. + description: The product's ID. items: type: string title: id @@ -63326,14 +55749,14 @@ components: manage_inventory: type: boolean title: manage_inventory - description: The variant's manage inventory. + description: The product's manage inventory. allow_backorder: type: boolean title: allow_backorder - description: The variant's allow backorder. + description: The product's allow backorder. created_at: type: object - description: The variant's created at. + description: The product's created at. properties: $and: type: array @@ -63383,6 +55806,118 @@ components: description: Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 the conditions in this parameter. items: @@ -63448,7 +55983,7 @@ components: description: Filter by whether a value for this parameter exists (not `null`). updated_at: type: object - description: The variant's updated at. + description: The product's updated at. properties: $and: type: array @@ -63498,6 +56033,118 @@ components: description: Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 the conditions in this parameter. items: @@ -63563,7 +56210,7 @@ components: description: Filter by whether a value for this parameter exists (not `null`). deleted_at: type: object - description: The variant's deleted at. + description: The product's deleted at. properties: $and: type: array @@ -63613,6 +56260,118 @@ components: description: Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 the conditions in this parameter. items: @@ -63679,19 +56438,19 @@ components: limit: type: number title: limit - description: The variant's limit. + description: The product's limit. offset: type: number title: offset - description: The variant's offset. + description: The product's offset. order: type: string title: order - description: The variant's order. + description: The product's order. fields: type: string title: fields - description: The variant's fields. + description: The product's fields. $and: type: array description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. @@ -64143,6 +56902,7 @@ components: AdminReturnReasonDeleteResponse: type: object description: SUMMARY + x-schemaName: AdminReturnReasonDeleteResponse required: - id - object @@ -64160,8 +56920,7 @@ components: deleted: type: boolean title: deleted - description: Whether the return reason was deleted. - x-schemaName: AdminReturnReasonDeleteResponse + description: Whether the Return Reason was deleted. AdminReturnReasonListResponse: type: object description: SUMMARY @@ -64415,6 +57174,7 @@ components: AdminServiceZoneDeleteResponse: type: object description: SUMMARY + x-schemaName: AdminServiceZoneDeleteResponse required: - id - object @@ -64423,19 +57183,17 @@ components: id: type: string title: id - description: The service zone's ID. + description: The fulfillment set's ID. object: type: string title: object description: The name of the deleted object. - default: service_zone deleted: type: boolean title: deleted - description: Whether the service zone was deleted. + description: Whether the Fulfillment Set was deleted. parent: $ref: '#/components/schemas/AdminFulfillmentSet' - x-schemaName: AdminServiceZoneDeleteResponse AdminServiceZoneResponse: type: object description: SUMMARY @@ -71935,6 +64693,7 @@ components: StoreCreatePaymentCollection: type: object description: SUMMARY + x-schemaName: StoreCreatePaymentCollection required: - cart_id properties: @@ -71942,7 +64701,6 @@ components: type: string title: cart_id description: The payment collection's cart id. - x-schemaName: StoreCreatePaymentCollection StoreCreateReturn: type: object description: SUMMARY @@ -71978,6 +64736,7 @@ components: StoreCreateReturnItem: type: object description: The item's items. + x-schemaName: StoreCreateReturnItem required: - id - quantity @@ -71998,10 +64757,10 @@ components: type: string title: note description: The item's note. - x-schemaName: StoreCreateReturnItem StoreCreateReturnShipping: type: object description: The return's return shipping. + x-schemaName: StoreCreateReturnShipping required: - option_id properties: @@ -72013,7 +64772,6 @@ components: type: number title: price description: The return shipping's price. - x-schemaName: StoreCreateReturnShipping StoreCurrency: type: object description: The currency's details. 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 3b154f4ded..ebb881dbc1 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 @@ -63,12 +63,12 @@ get: with `-`. - name: q in: query - description: The customer group's q. + description: Search term to filter the customer group's searchable properties. required: false schema: type: string title: q - description: The customer group's q. + description: Search term to filter the customer group's searchable properties. - name: id in: query required: false @@ -76,13 +76,13 @@ get: oneOf: - type: string title: id - description: The customer group's ID. + description: Filter by a customer group's IDs. - type: array - description: The customer group's ID. + description: Filter by customer group IDs. items: type: string title: id - description: The id's ID. + description: A customer group's ID. - name: name in: query required: false @@ -90,13 +90,13 @@ get: oneOf: - type: string title: name - description: The customer group's name. + description: Filter by a customer group's name. - type: array - description: The customer group's name. + description: Filter by customer group names. items: type: string title: name - description: The name's details. + description: A customer group's name. - name: customers in: query required: false @@ -104,13 +104,13 @@ get: oneOf: - type: string title: customers - description: The customer group's customers. + description: Filter by the ID of a customer to retrieve its groups. - type: array - description: The customer group's customers. + description: Filter by customer IDs to retrieve their groups. items: type: string title: customers - description: The customer's customers. + description: A customer's ID. - $ref: ../components/schemas/AdminCustomerInGroupFilters.yaml - name: created_by in: query @@ -119,20 +119,24 @@ get: oneOf: - type: string title: created_by - description: The customer group's created by. + description: >- + Filter by an ID of a user to retrieve the customer groups they + created. - type: array - description: The customer group's created by. + description: >- + Filter by the IDs of users to retrieve the customer groups they + created. items: type: string title: created_by - description: The created by's details. + description: The user's ID. - name: created_at in: query - description: The customer group's created at. + description: Filter the customer group by its creation date. required: false schema: type: object - description: The customer group's created at. + description: Filter the customer group by its creation date. properties: $and: type: array @@ -156,11 +160,11 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -171,21 +175,19 @@ get: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -213,50 +215,46 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + 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 conditions in this + Filter by values not matching the values of this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -307,9 +305,7 @@ get: items: type: string title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. + description: The value to match. $contains: type: array description: >- @@ -318,16 +314,14 @@ get: items: type: string title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -335,15 +329,11 @@ get: Filter by whether a value for this parameter exists (not `null`). - type: array - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -390,32 +380,32 @@ get: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + 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: The customer group's updated at. + description: Filter the customer groups by their update date. required: false schema: type: object - description: The customer group's updated at. + description: Filter the customer groups by their update date. properties: $and: type: array @@ -439,11 +429,11 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -454,21 +444,19 @@ get: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -496,50 +484,46 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + 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 conditions in this + Filter by values not matching the values of this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -590,9 +574,7 @@ get: items: type: string title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. + description: The value to match. $contains: type: array description: >- @@ -601,16 +583,14 @@ get: items: type: string title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -618,15 +598,11 @@ get: Filter by whether a value for this parameter exists (not `null`). - type: array - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -673,32 +649,32 @@ get: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The customer group's deleted at. + description: Filter the customer groups by their deletion date. required: false schema: type: object - description: The customer group's deleted at. + description: Filter the customer groups by their deletion date. properties: $and: type: array @@ -722,11 +698,11 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -737,21 +713,19 @@ get: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -779,50 +753,46 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + 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 conditions in this + Filter by values not matching the values of this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -873,9 +843,7 @@ get: items: type: string title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. + description: The value to match. $contains: type: array description: >- @@ -884,16 +852,14 @@ get: items: type: string title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -901,15 +867,11 @@ get: Filter by whether a value for this parameter exists (not `null`). - type: array - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -956,21 +918,21 @@ get: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists 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 711935361a..a8ca3dda3a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml @@ -68,30 +68,26 @@ get: oneOf: - type: string title: groups - description: The customer's groups. + description: >- + Filter by a customer group's ID to retrieve customers that belong + to it. + - $ref: ../components/schemas/CustomerGroupInCustomerFilters.yaml - type: array - description: The customer's groups. + description: >- + Filter by customer group IDs to retrieve customers that belong to + them. items: type: string title: groups - description: The group's groups. - - $ref: ../components/schemas/CustomerGroupInCustomerFilters.yaml - - name: has_account - in: query - description: The customer's has account. - required: false - schema: - type: boolean - title: has_account - description: The customer's has account. + description: The customer group's ID. - name: q in: query - description: The customer's q. + description: Search term to filter the customer's searchable properties by. required: false schema: type: string title: q - description: The customer's q. + description: Search term to filter the customer's searchable properties by. - name: id in: query required: false @@ -99,15 +95,15 @@ get: oneOf: - type: string title: id - description: The customer's ID. + description: Filter by a customer's ID. - type: array - description: The customer's ID. + description: Filter by customer IDs. items: type: string title: id - description: The id's ID. + description: A customer's ID. - type: object - description: The customer's ID. + description: Filters to apply on the customer ID. properties: $and: type: array @@ -131,20 +127,20 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: oneOf: - type: string title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -155,7 +151,7 @@ get: title: $ne description: Filter by values not equal to this parameter. - type: array - description: Filter by values not equal to this parameter. + description: Filter by values not in this array. items: type: string title: $ne @@ -167,13 +163,13 @@ get: oneOf: - type: string title: $in - description: Filter by values in this array. + description: Filter by matching value. - type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: Filter matching values. $nin: type: array description: Filter by values not in this array. @@ -181,20 +177,18 @@ get: oneOf: - type: string title: $nin - description: Filter by values not in this array. + description: Filter by values not matching this parameter. - type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -224,7 +218,7 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -251,23 +245,17 @@ get: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in - this parameter. + 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 conditions in - this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: >- - Filter by values not matching the conditions in - this parameter. + description: Filter by values not matching this parameter. $gt: type: string title: $gt @@ -350,15 +338,11 @@ get: Filter by whether a value for this parameter exists (not `null`). - type: array - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not in this array. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: array description: >- Filter by values not matching the conditions in this @@ -367,9 +351,7 @@ get: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -399,7 +381,7 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -414,35 +396,33 @@ get: items: type: string title: $in - description: Filter by values in this array. + description: Filter by exact matches. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not description: >- - Filter by values not matching the conditions - in this parameter. + 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 conditions - in this parameter. + description: Filter by values not in this array. items: type: string title: $not description: >- - Filter by values not matching the - conditions in this parameter. + Filter by values not matching this + parameter. $gt: type: string title: $gt @@ -533,8 +513,8 @@ get: numbers and dates only. - type: array description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. + Filter by values greater than items in this array. Useful + for numbers and dates only. items: type: string title: $gt @@ -550,8 +530,8 @@ get: Useful for numbers and dates only. - type: array description: >- - Filter by values greater than or equal to this parameter. - Useful for numbers and dates only. + Filter by values greater than or equal to items in this + array. Useful for numbers and dates only. items: type: string title: $gte @@ -567,7 +547,7 @@ get: numbers and dates only. - type: array description: >- - Filter by values less than this parameter. Useful for + Filter by values less than items in this array. Useful for numbers and dates only. items: type: string @@ -584,8 +564,8 @@ get: Useful for numbers and dates only. - type: array description: >- - Filter by values less than or equal to this parameter. - Useful for numbers and dates only. + Filter by values less than or equal to items in this + array. Useful for numbers and dates only. items: type: string title: $lte @@ -652,17 +632,17 @@ get: oneOf: - type: string title: email - description: The customer's email. + description: Filter by a customer email. format: email - type: array - description: The customer's email. + description: Filter by customer emails. items: type: string title: email - description: The email's details. + description: A customer's email. format: email - type: object - description: The customer's email. + description: Filter by conditions on the customer email. properties: $and: type: array @@ -686,36 +666,68 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. + oneOf: + - type: string + title: $ne + description: Filter by values not equal to this parameter. + - type: array + description: Filter by values not in this array. + items: + 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: Filter by values in this array. + oneOf: + - type: string + title: $in + description: Filter by matching value. + - type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter matching values. $nin: type: array description: Filter by values not in this array. items: - type: string - title: $nin - description: Filter by values not in this array. + oneOf: + - type: string + title: $nin + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -745,7 +757,7 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -772,23 +784,17 @@ get: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in - this parameter. + 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 conditions in - this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: >- - Filter by values not matching the conditions in - this parameter. + description: Filter by values not matching this parameter. $gt: type: string title: $gt @@ -870,40 +876,241 @@ get: description: >- Filter by whether a value for this parameter exists (not `null`). + - type: array + description: Filter by values not in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. - type: array description: >- Filter by values not matching the conditions in this parameter. items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + 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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by exact matches. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 in this array. + items: + type: string + title: $not + description: >- + Filter by values not matching this + parameter. + $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: >- + Filter arrays that have overlapping values + with this parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of + this parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values + of this parameter. + $contained: + type: array + description: >- + Filter arrays that contain all values of this + parameter. + items: + type: string + title: $contained + description: >- + Filter arrays that contain all values of this + parameter. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter + exists (not `null`). $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. + oneOf: + - type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + - type: array + description: >- + Filter by values greater than items in this array. Useful + for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. + - type: array + description: >- + Filter by values greater than or equal to items in this + array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. + - type: array + description: >- + Filter by values less than items in this array. Useful for + numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. + Useful for numbers and dates only. + - type: array + description: >- + Filter by values less than or equal to items in this + array. Useful for numbers and dates only. + items: + 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 @@ -964,15 +1171,15 @@ get: oneOf: - type: string title: company_name - description: The customer's company name. + description: Filter by a customer's company name. - type: array - description: The customer's company name. + description: Filter by customer company names. items: type: string title: company_name - description: The company name's details. + description: The customer's company name. - type: object - description: The customer's company name. + description: Filter by conditions on the customer's company name. properties: $and: type: array @@ -996,36 +1203,68 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. + oneOf: + - type: string + title: $ne + description: Filter by values not equal to this parameter. + - type: array + description: Filter by values not in this array. + items: + 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: Filter by values in this array. + oneOf: + - type: string + title: $in + description: Filter by matching value. + - type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter matching values. $nin: type: array description: Filter by values not in this array. items: - type: string - title: $nin - description: Filter by values not in this array. + oneOf: + - type: string + title: $nin + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -1055,7 +1294,7 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -1082,23 +1321,17 @@ get: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in - this parameter. + 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 conditions in - this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: >- - Filter by values not matching the conditions in - this parameter. + description: Filter by values not matching this parameter. $gt: type: string title: $gt @@ -1180,40 +1413,241 @@ get: description: >- Filter by whether a value for this parameter exists (not `null`). + - type: array + description: Filter by values not in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. - type: array description: >- Filter by values not matching the conditions in this parameter. items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + 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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by exact matches. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 in this array. + items: + type: string + title: $not + description: >- + Filter by values not matching this + parameter. + $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: >- + Filter arrays that have overlapping values + with this parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of + this parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values + of this parameter. + $contained: + type: array + description: >- + Filter arrays that contain all values of this + parameter. + items: + type: string + title: $contained + description: >- + Filter arrays that contain all values of this + parameter. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter + exists (not `null`). $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. + oneOf: + - type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + - type: array + description: >- + Filter by values greater than items in this array. Useful + for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. + - type: array + description: >- + Filter by values greater than or equal to items in this + array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. + - type: array + description: >- + Filter by values less than items in this array. Useful for + numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. + Useful for numbers and dates only. + - type: array + description: >- + Filter by values less than or equal to items in this + array. Useful for numbers and dates only. + items: + 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 @@ -1274,15 +1708,15 @@ get: oneOf: - type: string title: first_name - description: The customer's first name. + description: Filter by a customer's first name. - type: array - description: The customer's first name. + description: Filter by customer first names. items: type: string title: first_name - description: The first name's details. + description: A customer's first name. - type: object - description: The customer's first name. + description: Filter by conditions on the first name. properties: $and: type: array @@ -1306,36 +1740,68 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. + oneOf: + - type: string + title: $ne + description: Filter by values not equal to this parameter. + - type: array + description: Filter by values not in this array. + items: + 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: Filter by values in this array. + oneOf: + - type: string + title: $in + description: Filter by matching value. + - type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter matching values. $nin: type: array description: Filter by values not in this array. items: - type: string - title: $nin - description: Filter by values not in this array. + oneOf: + - type: string + title: $nin + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -1365,7 +1831,7 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -1392,23 +1858,17 @@ get: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in - this parameter. + 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 conditions in - this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: >- - Filter by values not matching the conditions in - this parameter. + description: Filter by values not matching this parameter. $gt: type: string title: $gt @@ -1490,40 +1950,241 @@ get: description: >- Filter by whether a value for this parameter exists (not `null`). + - type: array + description: Filter by values not in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. - type: array description: >- Filter by values not matching the conditions in this parameter. items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + 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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by exact matches. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 in this array. + items: + type: string + title: $not + description: >- + Filter by values not matching this + parameter. + $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: >- + Filter arrays that have overlapping values + with this parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of + this parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values + of this parameter. + $contained: + type: array + description: >- + Filter arrays that contain all values of this + parameter. + items: + type: string + title: $contained + description: >- + Filter arrays that contain all values of this + parameter. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter + exists (not `null`). $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. + oneOf: + - type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + - type: array + description: >- + Filter by values greater than items in this array. Useful + for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. + - type: array + description: >- + Filter by values greater than or equal to items in this + array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. + - type: array + description: >- + Filter by values less than items in this array. Useful for + numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. + Useful for numbers and dates only. + - type: array + description: >- + Filter by values less than or equal to items in this + array. Useful for numbers and dates only. + items: + 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 @@ -1584,15 +2245,15 @@ get: oneOf: - type: string title: last_name - description: The customer's last name. + description: Filter by a customer's last name. - type: array - description: The customer's last name. + description: Filter by customer last names. items: type: string title: last_name - description: The last name's details. + description: A customer's last name. - type: object - description: The customer's last name. + description: Filter by conditions on a customer's last name. properties: $and: type: array @@ -1616,36 +2277,68 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. + oneOf: + - type: string + title: $ne + description: Filter by values not equal to this parameter. + - type: array + description: Filter by values not in this array. + items: + 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: Filter by values in this array. + oneOf: + - type: string + title: $in + description: Filter by matching value. + - type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter matching values. $nin: type: array description: Filter by values not in this array. items: - type: string - title: $nin - description: Filter by values not in this array. + oneOf: + - type: string + title: $nin + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -1675,7 +2368,7 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -1702,23 +2395,17 @@ get: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in - this parameter. + 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 conditions in - this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: >- - Filter by values not matching the conditions in - this parameter. + description: Filter by values not matching this parameter. $gt: type: string title: $gt @@ -1800,40 +2487,241 @@ get: description: >- Filter by whether a value for this parameter exists (not `null`). + - type: array + description: Filter by values not in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. - type: array description: >- Filter by values not matching the conditions in this parameter. items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + 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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by exact matches. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 in this array. + items: + type: string + title: $not + description: >- + Filter by values not matching this + parameter. + $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: >- + Filter arrays that have overlapping values + with this parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of + this parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values + of this parameter. + $contained: + type: array + description: >- + Filter arrays that contain all values of this + parameter. + items: + type: string + title: $contained + description: >- + Filter arrays that contain all values of this + parameter. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter + exists (not `null`). $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. + oneOf: + - type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + - type: array + description: >- + Filter by values greater than items in this array. Useful + for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. + - type: array + description: >- + Filter by values greater than or equal to items in this + array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. + - type: array + description: >- + Filter by values less than items in this array. Useful for + numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. + Useful for numbers and dates only. + - type: array + description: >- + Filter by values less than or equal to items in this + array. Useful for numbers and dates only. + items: + 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 @@ -1894,15 +2782,15 @@ get: oneOf: - type: string title: created_by - description: The customer's created by. + description: Filter by a user ID to retrieve the customers they created. - type: array - description: The customer's created by. + description: Filter by user IDs to retrieve customers they created. items: type: string title: created_by - description: The created by's details. + description: A user's ID. - type: object - description: The customer's created by. + description: Filter by conditions on the user ID that created the customer. properties: $and: type: array @@ -1926,36 +2814,68 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. + oneOf: + - type: string + title: $ne + description: Filter by values not equal to this parameter. + - type: array + description: Filter by values not in this array. + items: + 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: Filter by values in this array. + oneOf: + - type: string + title: $in + description: Filter by matching value. + - type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter matching values. $nin: type: array description: Filter by values not in this array. items: - type: string - title: $nin - description: Filter by values not in this array. + oneOf: + - type: string + title: $nin + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -1985,7 +2905,7 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -2012,23 +2932,17 @@ get: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in - this parameter. + 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 conditions in - this parameter. + description: Filter by values not in this array. items: type: string title: $not - description: >- - Filter by values not matching the conditions in - this parameter. + description: Filter by values not matching this parameter. $gt: type: string title: $gt @@ -2110,40 +3024,241 @@ get: description: >- Filter by whether a value for this parameter exists (not `null`). + - type: array + description: Filter by values not in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. - type: array description: >- Filter by values not matching the conditions in this parameter. items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + 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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by exact matches. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 in this array. + items: + type: string + title: $not + description: >- + Filter by values not matching this + parameter. + $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: >- + Filter arrays that have overlapping values + with this parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of + this parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values + of this parameter. + $contained: + type: array + description: >- + Filter arrays that contain all values of this + parameter. + items: + type: string + title: $contained + description: >- + Filter arrays that contain all values of this + parameter. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter + exists (not `null`). $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. + oneOf: + - type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + - type: array + description: >- + Filter by values greater than items in this array. Useful + for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. + - type: array + description: >- + Filter by values greater than or equal to items in this + array. Useful for numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. + - type: array + description: >- + Filter by values less than items in this array. Useful for + numbers and dates only. + items: + 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. + oneOf: + - type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. + Useful for numbers and dates only. + - type: array + description: >- + Filter by values less than or equal to items in this + array. Useful for numbers and dates only. + items: + 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 @@ -2199,11 +3314,11 @@ get: `null`). - name: created_at in: query - description: The customer's created at. + description: Filter by the customer's creation date. required: false schema: type: object - description: The customer's created at. + description: Filter by the customer's creation date. properties: $and: type: array @@ -2227,11 +3342,11 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -2242,21 +3357,19 @@ get: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -2284,50 +3397,46 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + 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 conditions in this + Filter by values not matching the values of this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -2378,9 +3487,7 @@ get: items: type: string title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. + description: The value to match. $contains: type: array description: >- @@ -2389,16 +3496,14 @@ get: items: type: string title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -2406,15 +3511,11 @@ get: Filter by whether a value for this parameter exists (not `null`). - type: array - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -2461,32 +3562,32 @@ get: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + 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: The customer's updated at. + description: Filter by a customer's update date. required: false schema: type: object - description: The customer's updated at. + description: Filter by a customer's update date. properties: $and: type: array @@ -2510,11 +3611,11 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -2525,21 +3626,19 @@ get: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -2567,50 +3666,46 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + 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 conditions in this + Filter by values not matching the values of this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -2661,9 +3756,7 @@ get: items: type: string title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. + description: The value to match. $contains: type: array description: >- @@ -2672,16 +3765,14 @@ get: items: type: string title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -2689,15 +3780,11 @@ get: Filter by whether a value for this parameter exists (not `null`). - type: array - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -2744,32 +3831,32 @@ get: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The customer's deleted at. + description: Filter a customer by their deletion date. required: false schema: type: object - description: The customer's deleted at. + description: Filter a customer by their deletion date. properties: $and: type: array @@ -2793,11 +3880,11 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -2808,21 +3895,19 @@ get: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -2850,50 +3935,46 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + 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 conditions in this + Filter by values not matching the values of this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -2944,9 +4025,7 @@ get: items: type: string title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. + description: The value to match. $contains: type: array description: >- @@ -2955,16 +4034,14 @@ get: items: type: string title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -2972,15 +4049,11 @@ get: Filter by whether a value for this parameter exists (not `null`). - type: array - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -3027,21 +4100,21 @@ get: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -3074,6 +4147,14 @@ get: items: type: object title: $or + - name: has_account + in: query + description: The customer's has account. + required: false + schema: + type: boolean + title: has_account + description: The customer's has account. security: - api_token: [] - cookie_auth: [] @@ -3093,7 +4174,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of customers. required: - limit - offset @@ -3102,17 +4183,19 @@ get: limit: type: number title: limit - description: The customer's limit. + description: The maximum number of items returned in the list. offset: type: number title: offset - description: The customer's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The customer's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of customers. required: - customers properties: diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml index 2de4700c6c..b89c8f9b2b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml @@ -3,7 +3,7 @@ get: 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. + fields like `query`. The addresses can also be paginated. x-authenticated: true parameters: - name: id @@ -69,12 +69,12 @@ get: with `-`. - name: q in: query - description: The customer's q. + description: Search term to apply on the address's searchable properties. required: false schema: type: string title: q - description: The customer's q. + description: Search term to apply on the address's searchable properties. - name: company in: query required: false @@ -82,13 +82,13 @@ get: oneOf: - type: string title: company - description: The customer's company. + description: Filter by a company. - type: array - description: The customer's company. + description: Filter by companies. items: type: string title: company - description: The company's details. + description: A company's name. - name: city in: query required: false @@ -96,13 +96,13 @@ get: oneOf: - type: string title: city - description: The customer's city. + description: Filter by a city. - type: array - description: The customer's city. + description: Filter by cities. items: type: string title: city - description: The city's details. + description: A city's name. - name: country_code in: query required: false @@ -110,13 +110,13 @@ get: oneOf: - type: string title: country_code - description: The customer's country code. + description: Filter by a currency code. - type: array - description: The customer's country code. + description: Filter by currency codes. items: type: string title: country_code - description: The country code's details. + description: A currency code. - name: province in: query required: false @@ -124,13 +124,13 @@ get: oneOf: - type: string title: province - description: The customer's province. + description: Filter by a province. - type: array - description: The customer's province. + description: Filter by provinces. items: type: string title: province - description: The province's details. + description: A province code. - name: postal_code in: query required: false @@ -138,13 +138,13 @@ get: oneOf: - type: string title: postal_code - description: The customer's postal code. + description: Filter by a postal code. - type: array - description: The customer's postal code. + description: Filter by postal codes. items: type: string title: postal_code - description: The postal code's details. + description: A postal code. - name: $and in: query description: >- @@ -192,7 +192,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of customer addresses. required: - limit - offset @@ -201,23 +201,25 @@ get: limit: type: number title: limit - description: The customer's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The customer's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The customer's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of customer addresses required: - addresses properties: addresses: type: array - description: The customer's addresses. + description: The customer addresses. items: $ref: ../components/schemas/AdminCustomerAddress.yaml '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml index 9e2c05b134..b5328b1e48 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml @@ -2,8 +2,8 @@ get: operationId: GetCustomersIdAddressesAddress_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. + 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 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 124d24a623..3d5dbdc927 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 @@ -68,27 +68,1101 @@ get: oneOf: - type: string title: id - description: The draft order's ID. + description: Filter by a draft order's ID. - type: array - description: The draft order's ID. + description: Filter by draft order IDs. items: type: string title: id - description: The id's ID. - - name: name + description: A draft order's ID. + - type: object + description: Filter by conditions on the draft order's ID. + 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 exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. + $ne: + oneOf: + - type: string + title: $ne + description: Filter by values not equal to this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + oneOf: + - type: string + title: $in + description: Filter by matching value. + - type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter matching values. + $nin: + type: array + description: Filter by values not in this array. + items: + oneOf: + - type: string + title: $nin + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $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 in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. + $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: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of + this parameter. + $contained: + type: array + description: >- + Filter arrays that contain all values of this + parameter. + items: + type: string + title: $contained + description: >- + Filter arrays that contain all values of this + parameter. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter exists + (not `null`). + - type: array + description: Filter by values not in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + 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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by exact matches. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 in this array. + items: + type: string + title: $not + description: >- + Filter by values not matching this + parameter. + $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: >- + Filter arrays that have overlapping values + with this parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of + this parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values + of this parameter. + $contained: + type: array + description: >- + Filter arrays that contain all values of this + parameter. + items: + type: string + title: $contained + description: >- + Filter arrays that contain all values of this + parameter. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter + exists (not `null`). + $gt: + oneOf: + - type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + - type: array + description: >- + Filter by values greater than items in this array. Useful + for numbers and dates only. + items: + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + $gte: + oneOf: + - type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. + - type: array + description: >- + Filter by values greater than or equal to items in this + array. Useful for numbers and dates only. + items: + type: string + title: $gte + description: >- + Filter by values greater than or equal to this + parameter. Useful for numbers and dates only. + $lt: + oneOf: + - type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. + - type: array + description: >- + Filter by values less than items in this array. Useful for + numbers and dates only. + items: + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. + $lte: + oneOf: + - type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. + Useful for numbers and dates only. + - type: array + description: >- + Filter by values less than or equal to items in this + array. Useful for numbers and dates only. + items: + 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: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of this + parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter exists (not + `null`). + - name: status in: query required: false schema: oneOf: - type: string - title: name - description: The draft order's name. + title: status + description: Filter by a draft order's status. - type: array - description: The draft order's name. + description: Filter by draft order statuses. items: type: string - title: name - description: The name's details. + title: status + description: The draft order status. + - type: object + description: Filter by conditions on the status. + 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 exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by exact matches. + items: + type: string + title: $eq + description: Filter by an exact match. + $ne: + oneOf: + - type: string + title: $ne + description: Filter by values not equal to this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + oneOf: + - type: string + title: $in + description: Filter by matching value. + - type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter matching values. + $nin: + type: array + description: Filter by values not in this array. + items: + oneOf: + - type: string + title: $nin + description: Filter by values not matching this parameter. + - type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $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 in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. + $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: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of + this parameter. + $contained: + type: array + description: >- + Filter arrays that contain all values of this + parameter. + items: + type: string + title: $contained + description: >- + Filter arrays that contain all values of this + parameter. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter exists + (not `null`). + - type: array + description: Filter by values not in this array. + items: + type: string + title: $not + description: Filter by values not matching this parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + 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 exact matches. + items: + type: string + title: $eq + description: Filter by 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: Filter by exact matches. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not matching this parameter. + $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 in this array. + items: + type: string + title: $not + description: >- + Filter by values not matching this + parameter. + $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: >- + Filter arrays that have overlapping values + with this parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of + this parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values + of this parameter. + $contained: + type: array + description: >- + Filter arrays that contain all values of this + parameter. + items: + type: string + title: $contained + description: >- + Filter arrays that contain all values of this + parameter. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter + exists (not `null`). + $gt: + oneOf: + - type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + - type: array + description: >- + Filter by values greater than items in this array. Useful + for numbers and dates only. + items: + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + $gte: + oneOf: + - type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. + - type: array + description: >- + Filter by values greater than or equal to items in this + array. Useful for numbers and dates only. + items: + type: string + title: $gte + description: >- + Filter by values greater than or equal to this + parameter. Useful for numbers and dates only. + $lt: + oneOf: + - type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. + - type: array + description: >- + Filter by values less than items in this array. Useful for + numbers and dates only. + items: + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. + $lte: + oneOf: + - type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. + Useful for numbers and dates only. + - type: array + description: >- + Filter by values less than or equal to items in this + array. Useful for numbers and dates only. + items: + 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: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of this + parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter exists (not + `null`). + - name: $and + in: query + description: >- + Join query parameters with an AND condition. Each object's content is + the same type as the expected query parameters. + required: false + schema: + 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 + - name: $or + in: query + description: >- + Join query parameters with an OR condition. Each object's content is the + same type as the expected query parameters. + required: false + schema: + 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 - name: sales_channel_id in: query description: The draft order's sales channel id. @@ -109,8 +1183,16 @@ get: description: The draft order's fulfillment status. items: 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: The draft order's payment status. @@ -120,8 +1202,18 @@ get: description: The draft order's payment status. items: 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: The draft order's region id. @@ -707,587 +1799,6 @@ get: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - - name: status - in: query - required: false - schema: - oneOf: - - type: string - title: status - description: The draft order's status. - - type: array - description: The draft order's status. - items: - type: string - title: status - description: The status's details. - - type: object - description: The draft order's status. - 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 an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - oneOf: - - type: string - title: $ne - description: Filter by values not equal to this parameter. - - type: array - description: Filter by values not equal to this parameter. - items: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - oneOf: - - type: string - title: $in - description: Filter by values in this array. - - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - oneOf: - - type: string - title: $nin - description: Filter by values not in this array. - - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in - this parameter. - - type: object - description: >- - Filter by values not matching the conditions in - this parameter. - - type: array - description: >- - Filter by values not matching the conditions in - this parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in - this parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of - this parameter. - $contained: - type: array - description: >- - Filter arrays that contain all values of this - parameter. - items: - type: string - title: $contained - description: >- - Filter arrays that contain all values of this - parameter. - $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 the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions - in this parameter. - - type: object - description: >- - Filter by values not matching the conditions - in this parameter. - - type: array - description: >- - Filter by values not matching the conditions - in this parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the - conditions in this parameter. - $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: >- - Filter arrays that have overlapping values - with this parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of - this parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values - of this parameter. - $contained: - type: array - description: >- - Filter arrays that contain all values of this - parameter. - items: - type: string - title: $contained - description: >- - Filter arrays that contain all values of this - parameter. - $exists: - type: boolean - title: $exists - description: >- - Filter by whether a value for this parameter - exists (not `null`). - $gt: - oneOf: - - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. - - type: array - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. - items: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. - $gte: - oneOf: - - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. - Useful for numbers and dates only. - - type: array - description: >- - Filter by values greater than or equal to this parameter. - Useful for numbers and dates only. - items: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this - parameter. Useful for numbers and dates only. - $lt: - oneOf: - - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for - numbers and dates only. - - type: array - description: >- - Filter by values less than this parameter. Useful for - numbers and dates only. - items: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for - numbers and dates only. - $lte: - oneOf: - - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. - Useful for numbers and dates only. - - type: array - description: >- - Filter by values less than or equal to this parameter. - Useful for numbers and dates only. - items: - 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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: >- - Filter by whether a value for this parameter exists (not - `null`). - - name: $and - in: query - description: >- - Join query parameters with an AND condition. Each object's content is - the same type as the expected query parameters. - required: false - schema: - 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 - - name: $or - in: query - description: >- - Join query parameters with an OR condition. Each object's content is the - same type as the expected query parameters. - required: false - schema: - 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 security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml index dc56780d98..1e96c09036 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml @@ -3,7 +3,7 @@ get: 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. + or select the fields that should be returned using the query parameters. x-authenticated: true parameters: - name: id diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml index 0714737f95..98bd2db0af 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml @@ -63,11 +63,11 @@ get: with `-`. - name: deleted_at in: query - description: The exchange's deleted at. + description: Filter by an exchange's deletion date. required: false schema: type: object - description: The exchange's deleted at. + description: Filter by an exchange's deletion date. properties: $and: type: array @@ -91,11 +91,11 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -106,21 +106,19 @@ get: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -148,50 +146,46 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + 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 conditions in this + Filter by values not matching the values of this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -242,9 +236,7 @@ get: items: type: string title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. + description: The value to match. $contains: type: array description: >- @@ -253,16 +245,14 @@ get: items: type: string title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -270,15 +260,11 @@ get: Filter by whether a value for this parameter exists (not `null`). - type: array - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -325,33 +311,33 @@ get: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - name: q in: query - description: The exchange's q. + description: Search term to apply on an exchange's searchable properties. required: false schema: type: string title: q - description: The exchange's q. + description: Search term to apply on an exchange's searchable properties. - name: id in: query required: false @@ -359,13 +345,13 @@ get: oneOf: - type: string title: id - description: The exchange's ID. + description: Filter by an exchange ID. - type: array - description: The exchange's ID. + description: Filter by exchange IDs. items: type: string title: id - description: The id's ID. + description: An exchange ID. - name: order_id in: query required: false @@ -373,13 +359,13 @@ get: oneOf: - type: string title: order_id - description: The exchange's order id. + description: Filter by an exchange's order ID. - type: array - description: The exchange's order id. + description: Filter by order IDs that the exchanges belong to. items: type: string title: order_id - description: The order id's details. + description: An order's ID. - name: status in: query required: false @@ -387,20 +373,20 @@ get: oneOf: - type: string title: status - description: The exchange's status. + description: Filter by an exchange's status. - type: array - description: The exchange's status. + description: Filter by exchange statuses. items: type: string title: status - description: The status's details. + description: An exchange status. - name: created_at in: query - description: The exchange's created at. + description: Filter by the exchange's creation date. required: false schema: type: object - description: The exchange's created at. + description: Filter by the exchange's creation date. properties: $and: type: array @@ -424,11 +410,11 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -439,21 +425,19 @@ get: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -481,50 +465,46 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + 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 conditions in this + Filter by values not matching the values of this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -575,9 +555,7 @@ get: items: type: string title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. + description: The value to match. $contains: type: array description: >- @@ -586,16 +564,14 @@ get: items: type: string title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -603,15 +579,11 @@ get: Filter by whether a value for this parameter exists (not `null`). - type: array - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -658,32 +630,32 @@ get: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + 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: The exchange's updated at. + description: Filter by the exchange's update date. required: false schema: type: object - description: The exchange's updated at. + description: Filter by the exchange's update date. properties: $and: type: array @@ -707,11 +679,11 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -722,21 +694,19 @@ get: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -764,50 +734,46 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + 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 conditions in this + Filter by values not matching the values of this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -858,9 +824,7 @@ get: items: type: string title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. + description: The value to match. $contains: type: array description: >- @@ -869,16 +833,14 @@ get: items: type: string title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -886,15 +848,11 @@ get: Filter by whether a value for this parameter exists (not `null`). - type: array - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -941,21 +899,21 @@ get: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + 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: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml index 13a13e077d..bad903180a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml @@ -1,9 +1,9 @@ get: operationId: GetExchangesId - summary: Get a Exchange + summary: Get an Exchange description: >- - Retrieve a exchange by its ID. You can expand the exchange's relations or - select the fields that should be returned. + 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml index 966ac62862..52866320b9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml @@ -69,29 +69,29 @@ get: oneOf: - type: string title: id - description: The fulfillment provider's ID. + description: Filter by a fulfillment provider's ID. - type: array - description: The fulfillment provider's ID. + description: Filter by fulfillment provider IDs. items: type: string title: id - description: The id's ID. + description: A fulfillment provider ID. - name: is_enabled in: query - description: The fulfillment provider's is enabled. + description: Filter by whether the fulfillment provider is enabled. required: false schema: type: boolean title: is_enabled - description: The fulfillment provider's is enabled. + description: Filter by whether the fulfillment provider is enabled. - name: q in: query - description: The fulfillment provider's q. + description: Search term to filter a fulfillment provider's searchable properties. required: false schema: type: string title: q - description: The fulfillment provider's q. + description: Search term to filter a fulfillment provider's searchable properties. - name: stock_location_id in: query required: false @@ -99,13 +99,13 @@ get: oneOf: - type: string title: stock_location_id - description: The fulfillment provider's stock location id. + description: Filter by associated stock location's ID. - type: array - description: The fulfillment provider's stock location id. + description: Filter by associated stock location IDs. items: type: string title: stock_location_id - description: The stock location id's details. + description: A stock location's ID. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml index 3339cf05fd..971dd25627 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml @@ -1,10 +1,8 @@ get: operationId: GetFulfillmentSetsIdServiceZonesZone_id - summary: List Service Zones - description: >- - Retrieve a list of service zones in a fulfillment set. The service zones can - be filtered by fields like FILTER FIELDS. The service zones can also be - paginated. + 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. x-authenticated: true parameters: - name: id @@ -15,7 +13,7 @@ get: type: string - name: zone_id in: path - description: The fulfillment set's zone id. + description: The service zone's ID. required: true schema: type: string 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 1ef1574ae7..b60170b40f 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 @@ -163,151 +163,253 @@ get: description: The inventory item's requires shipping. - name: weight in: query - description: The inventory item's weight. + description: Filter the inventory item's weight. required: false schema: - description: The inventory item's weight. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: Filter the inventory item's weight. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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: length in: query - description: The inventory item's length. + description: Filter the inventory item's length. required: false schema: - description: The inventory item's length. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: Filter the inventory item's length. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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: height in: query - description: The inventory item's height. + description: Filter by the inventory item's height. required: false schema: - description: The inventory item's height. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: Filter by the inventory item's height. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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: width in: query - description: The inventory item's width. + description: Filter by the inventory item's width. required: false schema: - description: The inventory item's width. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: Filter by the inventory item's width. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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: location_levels in: query - description: The inventory item's location levels. + description: Filter by the inventory item's associated location IDs. required: false schema: type: object - description: The inventory item's location levels. + description: Filter by the inventory item's associated location IDs. properties: location_id: oneOf: - type: string title: location_id - description: The location level's location id. + description: The associated location's ID. - type: array - description: The location level's location id. + description: >- + The location IDs to retrieve inventory items associated with + them. items: type: string title: location_id - description: The location id's details. + description: A location's ID. required: - location_id - name: $and @@ -315,7 +417,9 @@ get: required: false schema: type: array - description: The inventory item's $and. + 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 @@ -324,7 +428,9 @@ get: required: false schema: type: array - description: The inventory item's $or. + 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml index 0043e9778b..5dc88150ac 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml @@ -1,10 +1,10 @@ get: operationId: GetInventoryItemsIdLocationLevels - summary: List Location Levels + summary: List Inventory Levels description: >- - Retrieve a list of location levels in a inventory item. The location levels - can be filtered by fields like FILTER FIELDS. The location levels can also - be paginated. + 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 @@ -75,19 +75,21 @@ get: oneOf: - type: string title: location_id - description: The inventory item's location id. + description: Filter by an associated location's ID. - type: array - description: The inventory item's location id. + description: Filter by associated location IDs. items: type: string title: location_id - description: The location id's details. + description: An associated location ID. - name: $and in: query required: false schema: type: array - description: The inventory item's $and. + 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 @@ -96,7 +98,9 @@ get: required: false schema: type: array - description: The inventory item's $or. + 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml index 35d661058b..2d78344d22 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml @@ -63,12 +63,12 @@ get: with `-`. - name: q in: query - description: The invite's q. + description: Search term to apply on an invite's searchable properties. required: false schema: type: string title: q - description: The invite's q. + description: Search term to apply on an invite's searchable properties. - name: id in: query required: false @@ -76,13 +76,13 @@ get: oneOf: - type: string title: id - description: The invite's ID. + description: Filter by an invite's ID. - type: array - description: The invite's ID. + description: Filter by invite IDs. items: type: string title: id - description: The id's ID. + description: An invite's ID. - name: email in: query required: false @@ -90,22 +90,22 @@ get: oneOf: - type: string title: email - description: The invite's email. + description: Filter by an invite's email. format: email - type: array - description: The invite's email. + description: Filter by invite emails. items: type: string title: email - description: The email's details. + description: An email. format: email - name: created_at in: query - description: The invite's created at. + description: Filter by the invite's creation date. required: false schema: type: object - description: The invite's created at. + description: Filter by the invite's creation date. properties: $and: type: array @@ -163,150 +163,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -384,11 +240,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The invite's updated at. + description: Filter by the invite's update date. required: false schema: type: object - description: The invite's updated at. + description: Filter by the invite's update date. properties: $and: type: array @@ -446,150 +302,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -667,11 +379,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The invite's deleted at. + description: Filter by the invite's deletion date. required: false schema: type: object - description: The invite's deleted at. + description: Filter by the invite's deletion date. properties: $and: type: array @@ -729,150 +441,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -953,7 +521,9 @@ get: required: false schema: type: array - description: The invite's $and. + 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 @@ -962,7 +532,9 @@ get: required: false schema: type: array - description: The invite's $or. + 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 @@ -981,7 +553,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of invites. required: - limit - offset @@ -990,23 +562,23 @@ get: limit: type: number title: limit - description: The invite's limit. + description: The maximum number of items retrieved. offset: type: number title: offset - description: The invite's offset. + description: The number of items skipped before the returned items. count: type: number title: count - description: The invite's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of invites. required: - invites properties: invites: type: array - description: The invite's invites. + description: The list of invites. items: $ref: ../components/schemas/AdminInvite.yaml '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml index 1f3833319e..d565d606da 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml @@ -1,9 +1,9 @@ get: operationId: GetInvitesId - summary: Get a Invite + summary: Get an Invite description: >- - Retrieve a invite by its ID. You can expand the invite's relations or select - the fields that should be returned. + Retrieve an invite by its ID. You can expand the invite's relations or + select the fields that should be returned. x-authenticated: false parameters: - name: id diff --git a/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml b/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml index f062b7cb00..8a56018b8f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml @@ -63,12 +63,12 @@ get: with `-`. - name: q in: query - description: The notification's q. + description: Search term to apply on the notification's searchable properties. required: false schema: type: string title: q - description: The notification's q. + description: Search term to apply on the notification's searchable properties. - name: id in: query required: false @@ -76,13 +76,13 @@ get: oneOf: - type: string title: id - description: The notification's ID. + description: Filter by a notification ID. - type: array - description: The notification's ID. + description: Filter by notification IDs. items: type: string title: id - description: The id's ID. + description: A notification ID. - name: channel in: query required: false @@ -90,19 +90,23 @@ get: oneOf: - type: string title: channel - description: The notification's channel. + description: Filter by a notification channel. + example: email - type: array - description: The notification's channel. + description: Filter by notification channels. items: type: string title: channel - description: The channel's details. + description: A notification channel. + example: email - name: $and in: query required: false schema: type: array - description: The notification's $and. + 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 @@ -111,7 +115,9 @@ get: required: false schema: type: array - description: The notification's $or. + 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 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 19e94d0efd..d1c7c09849 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml @@ -68,27 +68,55 @@ get: oneOf: - type: string title: id - description: The order's ID. + description: Filter by an order ID. - type: array - description: The order's ID. + description: Filter by order IDs. items: type: string title: id - description: The id's ID. - - name: name + description: An order's ID. + - name: status in: query required: false schema: oneOf: - type: string - title: name - description: The order's name. + title: status + description: Filter by the order's status. - type: array - description: The order's name. + description: Filter by order statuses. items: type: string - title: name - description: The name's details. + title: status + description: An order's status. + - name: $and + in: query + description: >- + Join query parameters with an AND condition. Each object's content is + the same type as the expected query parameters. + required: false + schema: + 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 + - name: $or + in: query + description: >- + Join query parameters with an OR condition. Each object's content is the + same type as the expected query parameters. + required: false + schema: + 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 - name: sales_channel_id in: query description: The order's sales channel id. @@ -109,8 +137,16 @@ get: description: The order's fulfillment status. items: 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: The order's payment status. @@ -120,8 +156,18 @@ get: description: The order's payment status. items: 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: The order's region id. @@ -707,587 +753,6 @@ get: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - - name: status - in: query - required: false - schema: - oneOf: - - type: string - title: status - description: The order's status. - - type: array - description: The order's status. - items: - type: string - title: status - description: The status's details. - - type: object - description: The order's status. - 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 an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - oneOf: - - type: string - title: $ne - description: Filter by values not equal to this parameter. - - type: array - description: Filter by values not equal to this parameter. - items: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - oneOf: - - type: string - title: $in - description: Filter by values in this array. - - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - oneOf: - - type: string - title: $nin - description: Filter by values not in this array. - - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in - this parameter. - - type: object - description: >- - Filter by values not matching the conditions in - this parameter. - - type: array - description: >- - Filter by values not matching the conditions in - this parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in - this parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of - this parameter. - $contained: - type: array - description: >- - Filter arrays that contain all values of this - parameter. - items: - type: string - title: $contained - description: >- - Filter arrays that contain all values of this - parameter. - $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 the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions - in this parameter. - - type: object - description: >- - Filter by values not matching the conditions - in this parameter. - - type: array - description: >- - Filter by values not matching the conditions - in this parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the - conditions in this parameter. - $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: >- - Filter arrays that have overlapping values - with this parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of - this parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values - of this parameter. - $contained: - type: array - description: >- - Filter arrays that contain all values of this - parameter. - items: - type: string - title: $contained - description: >- - Filter arrays that contain all values of this - parameter. - $exists: - type: boolean - title: $exists - description: >- - Filter by whether a value for this parameter - exists (not `null`). - $gt: - oneOf: - - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. - - type: array - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. - items: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. - $gte: - oneOf: - - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. - Useful for numbers and dates only. - - type: array - description: >- - Filter by values greater than or equal to this parameter. - Useful for numbers and dates only. - items: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this - parameter. Useful for numbers and dates only. - $lt: - oneOf: - - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for - numbers and dates only. - - type: array - description: >- - Filter by values less than this parameter. Useful for - numbers and dates only. - items: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for - numbers and dates only. - $lte: - oneOf: - - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. - Useful for numbers and dates only. - - type: array - description: >- - Filter by values less than or equal to this parameter. - Useful for numbers and dates only. - items: - 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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: >- - Filter by whether a value for this parameter exists (not - `null`). - - name: $and - in: query - description: >- - Join query parameters with an AND condition. Each object's content is - the same type as the expected query parameters. - required: false - schema: - 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 - - name: $or - in: query - description: >- - Join query parameters with an OR condition. Each object's content is the - same type as the expected query parameters. - required: false - schema: - 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 security: - api_token: [] - cookie_auth: [] @@ -1307,7 +772,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of orders required: - limit - offset @@ -1316,23 +781,23 @@ get: limit: type: number title: limit - description: The order's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The order's offset. + description: The number of items skipped before the returned items. count: type: number title: count - description: The order's count. + description: The total count of items. - type: object - description: SUMMARY + description: The paginated list of orders. required: - orders properties: orders: type: array - description: The order's orders. + description: The list of orders. items: $ref: ../components/schemas/AdminOrder.yaml '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml index d71bb42cc3..192e0024f0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml @@ -1,8 +1,8 @@ get: operationId: GetOrdersId - summary: Get a Order + summary: Get an Order description: >- - Retrieve a order by its ID. You can expand the order's relations or select + Retrieve an order by its ID. You can expand the order's relations or select the fields that should be returned. x-authenticated: true parameters: diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml index 7b5f1d3d53..3b07d685ef 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml @@ -1,9 +1,14 @@ get: operationId: GetOrdersIdChanges - summary: List Changes - description: >- - Retrieve a list of changes in a order. The changes can be filtered by fields - like FILTER FIELDS. The changes can also be paginated. + summary: List Changes on an Order + x-sidebar-summary: List Changes + 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: - name: id diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_preview.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_preview.yaml index b47d44ed92..e533c340ce 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_preview.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_preview.yaml @@ -1,9 +1,7 @@ get: operationId: GetOrdersIdPreview - summary: List Previews - description: >- - Retrieve a list of previews in a order. The previews can be filtered by - fields like FILTER FIELDS. The previews can also be paginated. + summary: Get Preview + description: Retrieve a preview of an order using its associated change, such as an edit. x-authenticated: true parameters: - name: id diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments.yaml index df26b84f73..93cb2a6991 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments.yaml @@ -63,12 +63,12 @@ get: with `-`. - name: q in: query - description: The payment's q. + description: Search term to filter the payment's searchable properties. required: false schema: type: string title: q - description: The payment's q. + description: Search term to filter the payment's searchable properties. - name: id in: query required: false @@ -76,13 +76,13 @@ get: oneOf: - type: string title: id - description: The payment's ID. + description: Filter by a payment ID. - type: array - description: The payment's ID. + description: Filter by payment IDs. items: type: string title: id - description: The id's ID. + description: A payment ID. - name: payment_session_id in: query required: false @@ -90,20 +90,24 @@ get: oneOf: - type: string title: payment_session_id - description: The payment's payment session id. + description: >- + Filter by a payment session ID to retrieve its associated + payments. - type: array - description: The payment's payment session id. + description: >- + Filter by payment session IDs to retrieve their associated + payments. items: type: string title: payment_session_id - description: The payment session id's details. + description: A payment session's ID. - name: created_at in: query - description: The payment's created at. + description: Filter by the payment's creation date. required: false schema: type: object - description: The payment's created at. + description: Filter by the payment's creation date. properties: $and: type: array @@ -161,150 +165,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -382,11 +242,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The payment's updated at. + description: Filter by the payment's update date. required: false schema: type: object - description: The payment's updated at. + description: Filter by the payment's update date. properties: $and: type: array @@ -444,150 +304,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -665,11 +381,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The payment's deleted at. + description: Filter by the payment's deletion date. required: false schema: type: object - description: The payment's deleted at. + description: Filter by the payment's deletion date. properties: $and: type: array @@ -727,150 +443,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -951,7 +523,9 @@ get: required: false schema: type: array - description: The payment's $and. + 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 @@ -960,7 +534,9 @@ get: required: false schema: type: array - description: The payment's $or. + 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 @@ -983,7 +559,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of payments. required: - limit - offset @@ -992,23 +568,23 @@ get: limit: type: number title: limit - description: The payment's limit. + description: The maximum number of returned items. offset: type: number title: offset - description: The payment's offset. + description: The number of items skipped before the returned items. count: type: number title: count - description: The payment's count. + description: The total number of payments. - type: object - description: SUMMARY + description: The paginated list of payments. required: - payments properties: payments: type: array - description: The payment's payments. + description: The list of payments. items: $ref: ../components/schemas/AdminPayment.yaml '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml index 0b0f255b78..aacc37c9c5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml @@ -1,9 +1,10 @@ get: operationId: GetPaymentsPaymentProviders - summary: List Payments + summary: List Payment Providers description: >- - Retrieve a list of payments. The payments can be filtered by fields such as - `id`. The payments can also be sorted or paginated. + 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: true parameters: - name: expand @@ -63,32 +64,34 @@ get: with `-`. - name: id in: query - required: false + required: true schema: oneOf: - type: string title: id - description: The payment's ID. + description: Filter by a payment provider's ID. - type: array - description: The payment's ID. + description: Filter by payment provider IDs. items: type: string title: id - description: The id's ID. + description: A payment provider ID. - name: is_enabled in: query - description: The payment's is enabled. + description: Filter by whether the payment provider is enabled. required: false schema: type: boolean title: is_enabled - description: The payment's is enabled. + description: Filter by whether the payment provider is enabled. - name: $and in: query required: false schema: type: array - description: The payment's $and. + 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 @@ -97,7 +100,9 @@ get: required: false schema: type: array - description: The payment's $or. + 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 @@ -120,7 +125,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The list of payment providers. required: - limit - offset @@ -129,23 +134,23 @@ get: limit: type: number title: limit - description: The payment's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The payment's offset. + description: The number of items skipped before the returned items. count: type: number title: count - description: The payment's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of payment providers. required: - payment_providers properties: payment_providers: type: array - description: The payment's payment providers. + description: The list of payment providers. items: $ref: ../components/schemas/AdminPaymentProvider.yaml '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml index 2da86bac87..078a7ed64f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml @@ -63,12 +63,12 @@ get: with `-`. - name: q in: query - description: The price list's q. + description: Search term to filter the price list's searchable properties. required: false schema: type: string title: q - description: The price list's q. + description: Search term to filter the price list's searchable properties. - name: id in: query required: false @@ -76,20 +76,20 @@ get: oneOf: - type: string title: id - description: The price list's ID. + description: Filter by a price list ID. - type: array - description: The price list's ID. + description: Filter by price list IDs. items: type: string title: id - description: The id's ID. + description: A price list ID. - name: starts_at in: query - description: The price list's starts at. + description: Filter by a price list's start date. required: false schema: type: object - description: The price list's starts at. + description: Filter by a price list's start date. properties: $and: type: array @@ -147,150 +147,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -368,11 +224,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: ends_at in: query - description: The price list's ends at. + description: Filter by the price list's end date. required: false schema: type: object - description: The price list's ends at. + description: Filter by the price list's end date. properties: $and: type: array @@ -430,150 +286,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -651,28 +363,28 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: status in: query - description: The price list's status. + description: Filter by the price list's status. required: false schema: type: array - description: The price list's status. + description: Filter by the price list's status. items: type: string - description: The status's details. + description: A price list's status. enum: - - draft - active + - draft - name: rules_count in: query - description: The price list's rules count. + description: Filter by the price list's rules count. required: false schema: type: array - description: The price list's rules count. + description: Filter by the price list's rules count. items: type: number title: rules_count - description: The rules count's details. + description: The price list's rule count. - name: $and in: query description: >- diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml index 39071efaa2..4b0a976e20 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml @@ -69,13 +69,13 @@ get: oneOf: - type: string title: id - description: The price preference's ID. + description: Filter by a price preference ID. - type: array - description: The price preference's ID. + description: Filter by price preference IDs. items: type: string title: id - description: The id's ID. + description: A price preference ID. - name: attribute in: query required: false @@ -83,13 +83,13 @@ get: oneOf: - type: string title: attribute - description: The price preference's attribute. + description: Filter by a price preference's attribute. - type: array - description: The price preference's attribute. + description: Filter by price preference attributes. items: type: string title: attribute - description: The attribute's details. + description: A price preference's attribute. - name: value in: query required: false @@ -97,21 +97,21 @@ get: oneOf: - type: string title: value - description: The price preference's value. + description: Filter by a price preference's value. - type: array - description: The price preference's value. + description: Filter by price preference values. items: type: string title: value - description: The value's details. + description: A price preference's value. - name: q in: query - description: The price preference's q. + description: Search term to apply on the price preference's searchable properties. required: false schema: type: string title: q - description: The price preference's q. + description: Search term to apply on the price preference's searchable properties. - name: $and in: query description: >- diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml index 68b0b20888..9522c0efa4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml @@ -64,12 +64,12 @@ get: with `-`. - name: q in: query - description: The product category's q. + description: Search term to filter on the product category's searchable properties. required: false schema: type: string title: q - description: The product category's q. + description: Search term to filter on the product category's searchable properties. - name: id in: query required: false @@ -77,13 +77,13 @@ get: oneOf: - type: string title: id - description: The product category's ID. + description: Filter by a product category's ID. - type: array - description: The product category's ID. + description: Filter by product category IDs. items: type: string title: id - description: The id's ID. + description: A product category ID. - name: description in: query required: false @@ -91,13 +91,17 @@ get: oneOf: - type: string title: description - description: The product category's description. + description: >- + Filter by the category's description. This performs a full-text + search. To do keyword search, use the `q` parameter instead. - type: array - description: The product category's description. + description: >- + Filter by category descriptions. This performs a full-text search. + To do keyword search, use the `q` parameter instead. items: type: string title: description - description: The description's details. + description: The category's description. - name: handle in: query required: false @@ -105,13 +109,13 @@ get: oneOf: - type: string title: handle - description: The product category's handle. + description: Filter by a category's handle. - type: array - description: The product category's handle. + description: Filter by category handles. items: type: string title: handle - description: The handle's details. + description: A category's handle. - name: parent_category_id in: query required: false @@ -119,52 +123,64 @@ get: oneOf: - type: string title: parent_category_id - description: The product category's parent category id. + description: Filter by a parent category's ID to retrieve its child categories. - type: array - description: The product category's parent category id. + description: Filter by parent category IDs to retrieve their child categories. items: type: string title: parent_category_id - description: The parent category id's details. + description: A parent category's ID. - name: include_ancestors_tree in: query - description: The product category's include ancestors tree. + description: >- + Whether to include the parent category of each category. If enabled, the + parent category is set in the `parent_category` property of each + category object. required: false schema: type: boolean title: include_ancestors_tree - description: The product category's include ancestors tree. + description: >- + Whether to include the parent category of each category. If enabled, + the parent category is set in the `parent_category` property of each + category object. - name: include_descendants_tree in: query - description: The product category's include descendants tree. + description: >- + Whether to include the child categories of each category. If enabled, + the child categories are added to the `category_children` property of + each category object. required: false schema: type: boolean title: include_descendants_tree - description: The product category's include descendants tree. + description: >- + Whether to include the child categories of each category. If enabled, + the child categories are added to the `category_children` property of + each category object. - name: is_internal in: query - description: The product category's is internal. + description: Filter by whether the category is internal. required: false schema: type: boolean title: is_internal - description: The product category's is internal. + description: Filter by whether the category is internal. - name: is_active in: query - description: The product category's is active. + description: Filter by whether the category is active. required: false schema: type: boolean title: is_active - description: The product category's is active. + description: Filter by whether the category is active. - name: created_at in: query - description: The product category's created at. + description: Filter by the category's creation date. required: false schema: type: object - description: The product category's created at. + description: Filter by the category's creation date. properties: $and: type: array @@ -222,150 +238,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -443,11 +315,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The product category's updated at. + description: Filter by the category's update date. required: false schema: type: object - description: The product category's updated at. + description: Filter by the category's update date. properties: $and: type: array @@ -505,150 +377,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -726,11 +454,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The product category's deleted at. + description: Filter by the category's deletion date. required: false schema: type: object - description: The product category's deleted at. + description: Filter by the category's deletion date. properties: $and: type: array @@ -788,150 +516,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -1012,7 +596,9 @@ get: required: false schema: type: array - description: The product category's $and. + 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 @@ -1021,7 +607,9 @@ get: required: false schema: type: array - description: The product category's $or. + 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml index 1ea884f1ef..6b103662b1 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml @@ -69,20 +69,28 @@ get: with `-`. - name: include_ancestors_tree in: query - description: The product category's include ancestors tree. + description: >- + Whether to retrieve the category's parent. When enabled, the parent + category is set in the `parent_category` property. required: false schema: type: boolean title: include_ancestors_tree - description: The product category's include ancestors tree. + description: >- + Whether to retrieve the category's parent. When enabled, the parent + category is set in the `parent_category` property. - name: include_descendants_tree in: query - description: The product category's include descendants tree. + description: >- + Whether to retrieve a list of child categories. When enabled, the parent + categories are added to the `category_children` property. required: false schema: type: boolean title: include_descendants_tree - description: The product category's include descendants tree. + description: >- + Whether to retrieve a list of child categories. When enabled, the + parent categories are added to the `category_children` property. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml index b103aa4885..ee6e431631 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml @@ -63,12 +63,12 @@ get: with `-`. - name: q in: query - description: The product tag's q. + description: Search term to filter the product tag's searchable properties. required: false schema: type: string title: q - description: The product tag's q. + description: Search term to filter the product tag's searchable properties. - name: id in: query required: false @@ -76,13 +76,13 @@ get: oneOf: - type: string title: id - description: The product tag's ID. + description: Filter by a product tag's ID. - type: array - description: The product tag's ID. + description: Filter by product tag IDs. items: type: string title: id - description: The id's ID. + description: A product tag's ID. - name: value in: query required: false @@ -90,20 +90,20 @@ get: oneOf: - type: string title: value - description: The product tag's value. + description: Filter by a product tag's value. - type: array - description: The product tag's value. + description: Filter by product tag values. items: type: string title: value - description: The value's details. + description: A tag value. - name: created_at in: query - description: The product tag's created at. + description: Filter by the tag's creation date. required: false schema: type: object - description: The product tag's created at. + description: Filter by the tag's creation date. properties: $and: type: array @@ -161,150 +161,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -382,11 +238,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The product tag's updated at. + description: Filter by the tag's update date. required: false schema: type: object - description: The product tag's updated at. + description: Filter by the tag's update date. properties: $and: type: array @@ -444,150 +300,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -665,11 +377,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The product tag's deleted at. + description: Filter by the tag's deletion date. required: false schema: type: object - description: The product tag's deleted at. + description: Filter by the tag's deletion date. properties: $and: type: array @@ -727,150 +439,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -951,7 +519,9 @@ get: required: false schema: type: array - description: The product tag's $and. + 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 @@ -960,7 +530,9 @@ get: required: false schema: type: array - description: The product tag's $or. + 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml index d2a2df313a..6eb5de96d6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml @@ -63,12 +63,12 @@ get: with `-`. - name: q in: query - description: The product type's q. + description: Search term to filter the product type's searchable properties. required: false schema: type: string title: q - description: The product type's q. + description: Search term to filter the product type's searchable properties. - name: id in: query required: false @@ -76,13 +76,13 @@ get: oneOf: - type: string title: id - description: The product type's ID. + description: Filter by a product type's ID. - type: array - description: The product type's ID. + description: Filter by product type IDs. items: type: string title: id - description: The id's ID. + description: A product type's ID. - name: value in: query required: false @@ -90,20 +90,20 @@ get: oneOf: - type: string title: value - description: The product type's value. + description: Filter by a type's value. - type: array - description: The product type's value. + description: Filter by values. items: type: string title: value - description: The value's details. + description: A type's value. - name: created_at in: query - description: The product type's created at. + description: Filter by the type's creation date. required: false schema: type: object - description: The product type's created at. + description: Filter by the type's creation date. properties: $and: type: array @@ -161,150 +161,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -382,11 +238,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The product type's updated at. + description: Filter by the type's update date. required: false schema: type: object - description: The product type's updated at. + description: Filter by the type's update date. properties: $and: type: array @@ -444,150 +300,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -665,11 +377,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The product type's deleted at. + description: Filter by the type's deletion date. required: false schema: type: object - description: The product type's deleted at. + description: Filter by the type's deletion date. properties: $and: type: array @@ -727,150 +439,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -951,7 +519,9 @@ get: required: false schema: type: array - description: The product type's $and. + 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 @@ -960,7 +530,9 @@ get: required: false schema: type: array - description: The product type's $or. + 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml index a80dad2752..6faaaf761d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml @@ -63,12 +63,12 @@ get: with `-`. - name: q in: query - description: The product variant's q. + description: Search term to filter the product variant's searchable properties. required: false schema: type: string title: q - description: The product variant's q. + description: Search term to filter the product variant's searchable properties. - name: id in: query required: false @@ -76,36 +76,36 @@ get: oneOf: - type: string title: id - description: The product variant's ID. + description: Filter by a variant's ID. - type: array - description: The product variant's ID. + description: Filter by variant IDs. items: type: string title: id - description: The id's ID. + description: A variant's ID. - name: manage_inventory in: query - description: The product variant's manage inventory. + description: Filter by whether a variant's `manage_inventory` is enabled. required: false schema: type: boolean title: manage_inventory - description: The product variant's manage inventory. + description: Filter by whether a variant's `manage_inventory` is enabled. - name: allow_backorder in: query - description: The product variant's allow backorder. + description: Filter by whether backorder is allowed for a variant. required: false schema: type: boolean title: allow_backorder - description: The product variant's allow backorder. + description: Filter by whether backorder is allowed for a variant. - name: created_at in: query - description: The product variant's created at. + description: Filter by the product variant's creation date. required: false schema: type: object - description: The product variant's created at. + description: Filter by the product variant's creation date. properties: $and: type: array @@ -163,150 +163,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -384,11 +240,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The product variant's updated at. + description: Filter by the product variant's update date. required: false schema: type: object - description: The product variant's updated at. + description: Filter by the product variant's update date. properties: $and: type: array @@ -446,150 +302,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -667,11 +379,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The product variant's deleted at. + description: Filter by the product variant's deletion date. required: false schema: type: object - description: The product variant's deleted at. + description: Filter by the product variant's deletion date. properties: $and: type: array @@ -729,150 +441,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this diff --git a/www/apps/api-reference/specs/admin/paths/admin_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_products.yaml index d9d7b11035..ada1149a1c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products.yaml @@ -68,21 +68,23 @@ get: oneOf: - type: string title: price_list_id - description: The product's price list id. + description: Filter by a price list's ID to retrieve its associated products. - type: array description: The product's price list id. items: type: string title: price_list_id - description: The price list id's details. + description: >- + Filter by a price list IDs to retrieve their associated + products. - name: q in: query - description: The product's q. + description: Search term to filter a product's searchable properties. required: false schema: type: string title: q - description: The product's q. + description: Search term to filter a product's searchable properties. - name: status in: query required: false @@ -90,18 +92,9 @@ get: oneOf: - type: string title: status - description: The product's status. - - type: string - title: status - description: The product's status. - - type: string - title: status - description: The product's status. - - type: string - title: status - description: The product's status. + description: Filter by a product status. - type: array - description: The product's status. + description: Filter by product statuses. items: type: string enum: @@ -116,13 +109,15 @@ get: oneOf: - type: string title: sales_channel_id - description: The product's sales channel id. + description: >- + Filter by a sales channel's ID to retrieve its associated + products. - type: array - description: The product's sales channel id. + description: Filter by sales channel IDs to retrieve their associated products. items: type: string title: sales_channel_id - description: The sales channel id's details. + description: A sales channel's ID. - name: title in: query required: false @@ -130,13 +125,13 @@ get: oneOf: - type: string title: title - description: The product's title. + description: Filter by a title. - type: array - description: The product's title. + description: Filter by titles items: type: string title: title - description: The title's details. + description: A product title. - name: handle in: query required: false @@ -144,13 +139,13 @@ get: oneOf: - type: string title: handle - description: The product's handle. + description: Filter by a handle. - type: array - description: The product's handle. + description: Filter by handles. items: type: string title: handle - description: The handle's details. + description: A product handle. - name: id in: query required: false @@ -158,35 +153,35 @@ get: oneOf: - type: string title: id - description: The product's ID. + description: Filter by a product ID. - type: array - description: The product's ID. + description: Filter by product IDs. items: type: string title: id - description: The id's ID. + description: A product's ID. - name: is_giftcard in: query - description: The product's is giftcard. + description: Filter by whether a product is a gift card. required: false schema: type: boolean title: is_giftcard - description: The product's is giftcard. + description: Filter by whether a product is a gift card. - name: tags in: query - description: The product's tags. + description: Filter by associated tags to retrieve their products. required: false schema: - description: The product's tags. + description: Filter by associated tags to retrieve their products. properties: value: type: array - description: The tag's value. + description: Filter by tag values. items: type: string title: value - description: The value's details. + description: A tag's value. - name: type_id in: query required: false @@ -194,13 +189,13 @@ get: oneOf: - type: string title: type_id - description: The product's type id. + description: Filter by a product type's ID to retrieve its associated products. - type: array - description: The product's type id. + description: Filter by product type IDs to retrieve their associated products. items: type: string title: type_id - description: The type id's details. + description: A product type's ID. - name: category_id in: query required: false @@ -208,2281 +203,462 @@ get: oneOf: - type: string title: category_id - description: The product's category id. + description: >- + Filter by a product category's ID to retrieve its associated + products. - type: array - description: The product's category id. + description: >- + Filter by product category IDs to retrieve their associated + products. items: type: string title: category_id - description: The category id's details. - - type: object - description: The product's category id. - properties: - $and: - type: array - description: The category id's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $and's $eq. - - type: object - description: The $and's $eq. - x-schemaName: RegExp - - type: array - description: The $and's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $and's $ne. - - type: object - description: The $and's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $and's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $and's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $and's $not. - - type: object - description: The $and's $not. - x-schemaName: RegExp - - type: object - description: The $and's $not. - - type: array - description: The $and's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $and's $gt. - - type: object - description: The $and's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $and's $gte. - - type: object - description: The $and's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $and's $lt. - - type: object - description: The $and's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $and's $lte. - - type: object - description: The $and's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $and's $like. - $re: - type: string - title: $re - description: The $and's $re. - $ilike: - type: string - title: $ilike - description: The $and's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $and's $fulltext. - $overlap: - type: array - description: The $and's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $and's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $and's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $and's $exists. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. - $or: - type: array - description: The category id's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $or's $eq. - - type: object - description: The $or's $eq. - x-schemaName: RegExp - - type: array - description: The $or's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $or's $ne. - - type: object - description: The $or's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $or's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $or's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $or's $not. - - type: object - description: The $or's $not. - x-schemaName: RegExp - - type: object - description: The $or's $not. - - type: array - description: The $or's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $or's $gt. - - type: object - description: The $or's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $or's $gte. - - type: object - description: The $or's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $or's $lt. - - type: object - description: The $or's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $or's $lte. - - type: object - description: The $or's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $or's $like. - $re: - type: string - title: $re - description: The $or's $re. - $ilike: - type: string - title: $ilike - description: The $or's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $or's $fulltext. - $overlap: - type: array - description: The $or's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $or's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $or's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $or's $exists. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. - $eq: - oneOf: - - type: string - title: $eq - description: The category id's $eq. - - type: object - description: The category id's $eq. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. - - type: array - description: The category id's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. - $ne: - oneOf: - - type: string - title: $ne - description: The category id's $ne. - - type: object - description: The category id's $ne. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $ne's exec. - test: - type: object - description: The $ne's test. - source: - type: string - title: source - description: The $ne's source. - global: - type: boolean - title: global - description: The $ne's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $ne's ignorecase. - multiline: - type: boolean - title: multiline - description: The $ne's multiline. - lastIndex: - type: number - title: lastIndex - description: The $ne's lastindex. - compile: - type: object - description: The $ne's compile. - flags: - type: string - title: flags - description: The $ne's flags. - sticky: - type: boolean - title: sticky - description: The $ne's sticky. - unicode: - type: boolean - title: unicode - description: The $ne's unicode. - dotAll: - type: boolean - title: dotAll - description: The $ne's dotall. - __@match@1128: - type: object - description: The $ne's @match@1128. - __@replace@1130: - type: object - description: The $ne's @replace@1130. - __@search@1133: - type: object - description: The $ne's @search@1133. - __@split@1135: - type: object - description: The $ne's @split@1135. - __@matchAll@1137: - type: object - description: The $ne's @matchall@1137. - $in: - type: array - description: The category id's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $in's exec. - test: - type: object - description: The $in's test. - source: - type: string - title: source - description: The $in's source. - global: - type: boolean - title: global - description: The $in's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $in's ignorecase. - multiline: - type: boolean - title: multiline - description: The $in's multiline. - lastIndex: - type: number - title: lastIndex - description: The $in's lastindex. - compile: - type: object - description: The $in's compile. - flags: - type: string - title: flags - description: The $in's flags. - sticky: - type: boolean - title: sticky - description: The $in's sticky. - unicode: - type: boolean - title: unicode - description: The $in's unicode. - dotAll: - type: boolean - title: dotAll - description: The $in's dotall. - __@match@1128: - type: object - description: The $in's @match@1128. - __@replace@1130: - type: object - description: The $in's @replace@1130. - __@search@1133: - type: object - description: The $in's @search@1133. - __@split@1135: - type: object - description: The $in's @split@1135. - __@matchAll@1137: - type: object - description: The $in's @matchall@1137. - $nin: - type: array - description: The category id's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $nin's exec. - test: - type: object - description: The $nin's test. - source: - type: string - title: source - description: The $nin's source. - global: - type: boolean - title: global - description: The $nin's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $nin's ignorecase. - multiline: - type: boolean - title: multiline - description: The $nin's multiline. - lastIndex: - type: number - title: lastIndex - description: The $nin's lastindex. - compile: - type: object - description: The $nin's compile. - flags: - type: string - title: flags - description: The $nin's flags. - sticky: - type: boolean - title: sticky - description: The $nin's sticky. - unicode: - type: boolean - title: unicode - description: The $nin's unicode. - dotAll: - type: boolean - title: dotAll - description: The $nin's dotall. - __@match@1128: - type: object - description: The $nin's @match@1128. - __@replace@1130: - type: object - description: The $nin's @replace@1130. - __@search@1133: - type: object - description: The $nin's @search@1133. - __@split@1135: - type: object - description: The $nin's @split@1135. - __@matchAll@1137: - type: object - description: The $nin's @matchall@1137. - $not: - oneOf: - - type: string - title: $not - description: The category id's $not. - - type: object - description: The category id's $not. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. - - type: object - description: The category id's $not. - properties: - $and: - type: array - description: The $not's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $not's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $not's $eq. - - type: object - description: The $not's $eq. - x-schemaName: RegExp - - type: array - description: The $not's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $not's $ne. - - type: object - description: The $not's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $not's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $not's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - - type: object - description: The $not's details. - - type: array - description: The $not's details. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $not's $gt. - - type: object - description: The $not's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $not's $gte. - - type: object - description: The $not's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $not's $lt. - - type: object - description: The $not's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $not's $lte. - - type: object - description: The $not's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $not's $like. - $re: - type: string - title: $re - description: The $not's $re. - $ilike: - type: string - title: $ilike - description: The $not's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $not's $fulltext. - $overlap: - type: array - description: The $not's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $not's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $not's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $not's $exists. - - type: array - description: The category id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. - $gt: - oneOf: - - type: string - title: $gt - description: The category id's $gt. - - type: object - description: The category id's $gt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gt's exec. - test: - type: object - description: The $gt's test. - source: - type: string - title: source - description: The $gt's source. - global: - type: boolean - title: global - description: The $gt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gt's lastindex. - compile: - type: object - description: The $gt's compile. - flags: - type: string - title: flags - description: The $gt's flags. - sticky: - type: boolean - title: sticky - description: The $gt's sticky. - unicode: - type: boolean - title: unicode - description: The $gt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gt's dotall. - __@match@1128: - type: object - description: The $gt's @match@1128. - __@replace@1130: - type: object - description: The $gt's @replace@1130. - __@search@1133: - type: object - description: The $gt's @search@1133. - __@split@1135: - type: object - description: The $gt's @split@1135. - __@matchAll@1137: - type: object - description: The $gt's @matchall@1137. - $gte: - oneOf: - - type: string - title: $gte - description: The category id's $gte. - - type: object - description: The category id's $gte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gte's exec. - test: - type: object - description: The $gte's test. - source: - type: string - title: source - description: The $gte's source. - global: - type: boolean - title: global - description: The $gte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gte's lastindex. - compile: - type: object - description: The $gte's compile. - flags: - type: string - title: flags - description: The $gte's flags. - sticky: - type: boolean - title: sticky - description: The $gte's sticky. - unicode: - type: boolean - title: unicode - description: The $gte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gte's dotall. - __@match@1128: - type: object - description: The $gte's @match@1128. - __@replace@1130: - type: object - description: The $gte's @replace@1130. - __@search@1133: - type: object - description: The $gte's @search@1133. - __@split@1135: - type: object - description: The $gte's @split@1135. - __@matchAll@1137: - type: object - description: The $gte's @matchall@1137. - $lt: - oneOf: - - type: string - title: $lt - description: The category id's $lt. - - type: object - description: The category id's $lt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lt's exec. - test: - type: object - description: The $lt's test. - source: - type: string - title: source - description: The $lt's source. - global: - type: boolean - title: global - description: The $lt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lt's lastindex. - compile: - type: object - description: The $lt's compile. - flags: - type: string - title: flags - description: The $lt's flags. - sticky: - type: boolean - title: sticky - description: The $lt's sticky. - unicode: - type: boolean - title: unicode - description: The $lt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lt's dotall. - __@match@1128: - type: object - description: The $lt's @match@1128. - __@replace@1130: - type: object - description: The $lt's @replace@1130. - __@search@1133: - type: object - description: The $lt's @search@1133. - __@split@1135: - type: object - description: The $lt's @split@1135. - __@matchAll@1137: - type: object - description: The $lt's @matchall@1137. - $lte: - oneOf: - - type: string - title: $lte - description: The category id's $lte. - - type: object - description: The category id's $lte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lte's exec. - test: - type: object - description: The $lte's test. - source: - type: string - title: source - description: The $lte's source. - global: - type: boolean - title: global - description: The $lte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lte's lastindex. - compile: - type: object - description: The $lte's compile. - flags: - type: string - title: flags - description: The $lte's flags. - sticky: - type: boolean - title: sticky - description: The $lte's sticky. - unicode: - type: boolean - title: unicode - description: The $lte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lte's dotall. - __@match@1128: - type: object - description: The $lte's @match@1128. - __@replace@1130: - type: object - description: The $lte's @replace@1130. - __@search@1133: - type: object - description: The $lte's @search@1133. - __@split@1135: - type: object - description: The $lte's @split@1135. - __@matchAll@1137: - type: object - description: The $lte's @matchall@1137. - $like: - type: string - title: $like - description: The category id's $like. - $re: - type: string - title: $re - description: The category id's $re. - $ilike: - type: string - title: $ilike - description: The category id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The category id's $fulltext. - $overlap: - type: array - description: The category id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The category id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The category id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The category id's $exists. - - name: categories + description: A product category's ID. + - name: created_at in: query + description: Filter by a product's creation date. required: false schema: - oneOf: - - type: object - description: The product's categories. - required: - - id - properties: - id: - type: object - description: The category's ID. - properties: - $and: - type: array - description: The id's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The id's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The id's $eq. - - type: object - description: The id's $eq. - x-schemaName: RegExp - - type: array - description: The id's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The id's $ne. - - type: object - description: The id's $ne. - x-schemaName: RegExp - $in: - type: array - description: The id's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The id's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The id's $not. - - type: object - description: The id's $not. - x-schemaName: RegExp - - type: object - description: The id's $not. - - type: array - description: The id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The id's $gt. - - type: object - description: The id's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The id's $gte. - - type: object - description: The id's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The id's $lt. - - type: object - description: The id's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The id's $lte. - - type: object - description: The id's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The id's $like. - $re: - type: string - title: $re - description: The id's $re. - $ilike: - type: string - title: $ilike - description: The id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The id's $fulltext. - $overlap: - type: array - description: The id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The id's $exists. - - type: object - description: The product's categories. - required: - - id - properties: - id: - type: object - description: The category's ID. - properties: - $and: - type: array - description: The id's $and. - items: - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - $or: - type: array - description: The id's $or. - items: - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - $eq: - oneOf: - - type: array - description: The id's $eq. - items: - type: string - title: $eq - description: The $eq's details. - - type: array - description: The id's $eq. - items: - type: array - description: The $eq's details. - items: - type: string - title: $eq - description: The $eq's details. - $ne: - type: array - description: The id's $ne. - items: - type: string - title: $ne - description: The $ne's details. - $in: - type: array - description: The id's $in. - items: - type: array - description: The $in's details. - items: - type: string - title: $in - description: The $in's details. - $nin: - type: array - description: The id's $nin. - items: - type: array - description: The $nin's details. - items: - type: string - title: $nin - description: The $nin's details. - $not: - type: array - description: The id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - $gt: - type: array - description: The id's $gt. - items: - type: string - title: $gt - description: The $gt's details. - $gte: - type: array - description: The id's $gte. - items: - type: string - title: $gte - description: The $gte's details. - $lt: - type: array - description: The id's $lt. - items: - type: string - title: $lt - description: The $lt's details. - $lte: - type: array - description: The id's $lte. - items: - type: string - title: $lte - description: The $lte's details. - $like: - type: string - title: $like - description: The id's $like. - $re: - type: string - title: $re - description: The id's $re. - $ilike: - type: string - title: $ilike - description: The id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The id's $fulltext. - $overlap: - type: array - description: The id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The id's $exists. + type: object + description: Filter by a product'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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 a product's update date. + required: false + schema: + type: object + description: Filter by a product'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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: deleted_at + in: query + description: Filter by a product's deletion date. + required: false + schema: + type: object + description: Filter by a product's deletion 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: $and + in: query + description: >- + Join query parameters with an AND condition. Each object's content is + the same type as the expected query parameters. + required: false + schema: + 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 + - name: $or + in: query + description: >- + Join query parameters with an OR condition. Each object's content is the + same type as the expected query parameters. + required: false + schema: + 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 - name: collection_id in: query required: false @@ -2490,2716 +666,13 @@ get: oneOf: - type: string title: collection_id - description: The product's collection id. + description: Filter by a product collection ID. - type: array - description: The product's collection id. + description: Filter by product collection IDs. items: type: string title: collection_id - description: The collection id's details. - - type: object - description: The product's collection id. - properties: - $and: - type: array - description: The collection id's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $and's $eq. - - type: object - description: The $and's $eq. - x-schemaName: RegExp - - type: array - description: The $and's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $and's $ne. - - type: object - description: The $and's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $and's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $and's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $and's $not. - - type: object - description: The $and's $not. - x-schemaName: RegExp - - type: object - description: The $and's $not. - - type: array - description: The $and's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $and's $gt. - - type: object - description: The $and's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $and's $gte. - - type: object - description: The $and's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $and's $lt. - - type: object - description: The $and's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $and's $lte. - - type: object - description: The $and's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $and's $like. - $re: - type: string - title: $re - description: The $and's $re. - $ilike: - type: string - title: $ilike - description: The $and's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $and's $fulltext. - $overlap: - type: array - description: The $and's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $and's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $and's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $and's $exists. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. - $or: - type: array - description: The collection id's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $or's $eq. - - type: object - description: The $or's $eq. - x-schemaName: RegExp - - type: array - description: The $or's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $or's $ne. - - type: object - description: The $or's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $or's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $or's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $or's $not. - - type: object - description: The $or's $not. - x-schemaName: RegExp - - type: object - description: The $or's $not. - - type: array - description: The $or's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $or's $gt. - - type: object - description: The $or's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $or's $gte. - - type: object - description: The $or's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $or's $lt. - - type: object - description: The $or's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $or's $lte. - - type: object - description: The $or's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $or's $like. - $re: - type: string - title: $re - description: The $or's $re. - $ilike: - type: string - title: $ilike - description: The $or's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $or's $fulltext. - $overlap: - type: array - description: The $or's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $or's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $or's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $or's $exists. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. - $eq: - oneOf: - - type: string - title: $eq - description: The collection id's $eq. - - type: object - description: The collection id's $eq. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. - - type: array - description: The collection id's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. - $ne: - oneOf: - - type: string - title: $ne - description: The collection id's $ne. - - type: object - description: The collection id's $ne. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $ne's exec. - test: - type: object - description: The $ne's test. - source: - type: string - title: source - description: The $ne's source. - global: - type: boolean - title: global - description: The $ne's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $ne's ignorecase. - multiline: - type: boolean - title: multiline - description: The $ne's multiline. - lastIndex: - type: number - title: lastIndex - description: The $ne's lastindex. - compile: - type: object - description: The $ne's compile. - flags: - type: string - title: flags - description: The $ne's flags. - sticky: - type: boolean - title: sticky - description: The $ne's sticky. - unicode: - type: boolean - title: unicode - description: The $ne's unicode. - dotAll: - type: boolean - title: dotAll - description: The $ne's dotall. - __@match@1128: - type: object - description: The $ne's @match@1128. - __@replace@1130: - type: object - description: The $ne's @replace@1130. - __@search@1133: - type: object - description: The $ne's @search@1133. - __@split@1135: - type: object - description: The $ne's @split@1135. - __@matchAll@1137: - type: object - description: The $ne's @matchall@1137. - $in: - type: array - description: The collection id's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $in's exec. - test: - type: object - description: The $in's test. - source: - type: string - title: source - description: The $in's source. - global: - type: boolean - title: global - description: The $in's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $in's ignorecase. - multiline: - type: boolean - title: multiline - description: The $in's multiline. - lastIndex: - type: number - title: lastIndex - description: The $in's lastindex. - compile: - type: object - description: The $in's compile. - flags: - type: string - title: flags - description: The $in's flags. - sticky: - type: boolean - title: sticky - description: The $in's sticky. - unicode: - type: boolean - title: unicode - description: The $in's unicode. - dotAll: - type: boolean - title: dotAll - description: The $in's dotall. - __@match@1128: - type: object - description: The $in's @match@1128. - __@replace@1130: - type: object - description: The $in's @replace@1130. - __@search@1133: - type: object - description: The $in's @search@1133. - __@split@1135: - type: object - description: The $in's @split@1135. - __@matchAll@1137: - type: object - description: The $in's @matchall@1137. - $nin: - type: array - description: The collection id's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $nin's exec. - test: - type: object - description: The $nin's test. - source: - type: string - title: source - description: The $nin's source. - global: - type: boolean - title: global - description: The $nin's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $nin's ignorecase. - multiline: - type: boolean - title: multiline - description: The $nin's multiline. - lastIndex: - type: number - title: lastIndex - description: The $nin's lastindex. - compile: - type: object - description: The $nin's compile. - flags: - type: string - title: flags - description: The $nin's flags. - sticky: - type: boolean - title: sticky - description: The $nin's sticky. - unicode: - type: boolean - title: unicode - description: The $nin's unicode. - dotAll: - type: boolean - title: dotAll - description: The $nin's dotall. - __@match@1128: - type: object - description: The $nin's @match@1128. - __@replace@1130: - type: object - description: The $nin's @replace@1130. - __@search@1133: - type: object - description: The $nin's @search@1133. - __@split@1135: - type: object - description: The $nin's @split@1135. - __@matchAll@1137: - type: object - description: The $nin's @matchall@1137. - $not: - oneOf: - - type: string - title: $not - description: The collection id's $not. - - type: object - description: The collection id's $not. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. - - type: object - description: The collection id's $not. - properties: - $and: - type: array - description: The $not's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $not's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $not's $eq. - - type: object - description: The $not's $eq. - x-schemaName: RegExp - - type: array - description: The $not's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $not's $ne. - - type: object - description: The $not's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $not's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $not's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - - type: object - description: The $not's details. - - type: array - description: The $not's details. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $not's $gt. - - type: object - description: The $not's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $not's $gte. - - type: object - description: The $not's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $not's $lt. - - type: object - description: The $not's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $not's $lte. - - type: object - description: The $not's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $not's $like. - $re: - type: string - title: $re - description: The $not's $re. - $ilike: - type: string - title: $ilike - description: The $not's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $not's $fulltext. - $overlap: - type: array - description: The $not's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $not's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $not's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $not's $exists. - - type: array - description: The collection id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. - $gt: - oneOf: - - type: string - title: $gt - description: The collection id's $gt. - - type: object - description: The collection id's $gt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gt's exec. - test: - type: object - description: The $gt's test. - source: - type: string - title: source - description: The $gt's source. - global: - type: boolean - title: global - description: The $gt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gt's lastindex. - compile: - type: object - description: The $gt's compile. - flags: - type: string - title: flags - description: The $gt's flags. - sticky: - type: boolean - title: sticky - description: The $gt's sticky. - unicode: - type: boolean - title: unicode - description: The $gt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gt's dotall. - __@match@1128: - type: object - description: The $gt's @match@1128. - __@replace@1130: - type: object - description: The $gt's @replace@1130. - __@search@1133: - type: object - description: The $gt's @search@1133. - __@split@1135: - type: object - description: The $gt's @split@1135. - __@matchAll@1137: - type: object - description: The $gt's @matchall@1137. - $gte: - oneOf: - - type: string - title: $gte - description: The collection id's $gte. - - type: object - description: The collection id's $gte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gte's exec. - test: - type: object - description: The $gte's test. - source: - type: string - title: source - description: The $gte's source. - global: - type: boolean - title: global - description: The $gte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gte's lastindex. - compile: - type: object - description: The $gte's compile. - flags: - type: string - title: flags - description: The $gte's flags. - sticky: - type: boolean - title: sticky - description: The $gte's sticky. - unicode: - type: boolean - title: unicode - description: The $gte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gte's dotall. - __@match@1128: - type: object - description: The $gte's @match@1128. - __@replace@1130: - type: object - description: The $gte's @replace@1130. - __@search@1133: - type: object - description: The $gte's @search@1133. - __@split@1135: - type: object - description: The $gte's @split@1135. - __@matchAll@1137: - type: object - description: The $gte's @matchall@1137. - $lt: - oneOf: - - type: string - title: $lt - description: The collection id's $lt. - - type: object - description: The collection id's $lt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lt's exec. - test: - type: object - description: The $lt's test. - source: - type: string - title: source - description: The $lt's source. - global: - type: boolean - title: global - description: The $lt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lt's lastindex. - compile: - type: object - description: The $lt's compile. - flags: - type: string - title: flags - description: The $lt's flags. - sticky: - type: boolean - title: sticky - description: The $lt's sticky. - unicode: - type: boolean - title: unicode - description: The $lt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lt's dotall. - __@match@1128: - type: object - description: The $lt's @match@1128. - __@replace@1130: - type: object - description: The $lt's @replace@1130. - __@search@1133: - type: object - description: The $lt's @search@1133. - __@split@1135: - type: object - description: The $lt's @split@1135. - __@matchAll@1137: - type: object - description: The $lt's @matchall@1137. - $lte: - oneOf: - - type: string - title: $lte - description: The collection id's $lte. - - type: object - description: The collection id's $lte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lte's exec. - test: - type: object - description: The $lte's test. - source: - type: string - title: source - description: The $lte's source. - global: - type: boolean - title: global - description: The $lte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lte's lastindex. - compile: - type: object - description: The $lte's compile. - flags: - type: string - title: flags - description: The $lte's flags. - sticky: - type: boolean - title: sticky - description: The $lte's sticky. - unicode: - type: boolean - title: unicode - description: The $lte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lte's dotall. - __@match@1128: - type: object - description: The $lte's @match@1128. - __@replace@1130: - type: object - description: The $lte's @replace@1130. - __@search@1133: - type: object - description: The $lte's @search@1133. - __@split@1135: - type: object - description: The $lte's @split@1135. - __@matchAll@1137: - type: object - description: The $lte's @matchall@1137. - $like: - type: string - title: $like - description: The collection id's $like. - $re: - type: string - title: $re - description: The collection id's $re. - $ilike: - type: string - title: $ilike - description: The collection id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The collection id's $fulltext. - $overlap: - type: array - description: The collection id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The collection id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The collection id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The collection id's $exists. - - name: created_at - in: query - description: The product's created at. - required: false - schema: - type: object - description: The product's created at. - properties: - $and: - type: array - description: The created at's $and. - items: - type: object - $or: - type: array - description: The created at's $or. - items: - type: object - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - $in: - type: array - description: The created at's $in. - items: - type: string - title: $in - $nin: - type: array - description: The created at's $nin. - items: - type: string - title: $nin - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - properties: - $and: - type: array - description: The $not's $and. - items: - type: object - title: $and - $or: - type: array - description: The $not's $or. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $gt: - type: string - title: $gt - $gte: - type: string - title: $gte - $lt: - type: string - title: $lt - $lte: - type: string - title: $lte - $like: - type: string - title: $like - description: The created at's $like. - $re: - type: string - title: $re - description: The created at's $re. - $ilike: - type: string - title: $ilike - description: The created at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The created at's $fulltext. - $overlap: - type: array - description: The created at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The created at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The created at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The created at's $exists. - - name: updated_at - in: query - description: The product's updated at. - required: false - schema: - type: object - description: The product's updated at. - properties: - $and: - type: array - description: The updated at's $and. - items: - type: object - $or: - type: array - description: The updated at's $or. - items: - type: object - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - $in: - type: array - description: The updated at's $in. - items: - type: string - title: $in - $nin: - type: array - description: The updated at's $nin. - items: - type: string - title: $nin - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - properties: - $and: - type: array - description: The $not's $and. - items: - type: object - title: $and - $or: - type: array - description: The $not's $or. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $gt: - type: string - title: $gt - $gte: - type: string - title: $gte - $lt: - type: string - title: $lt - $lte: - type: string - title: $lte - $like: - type: string - title: $like - description: The updated at's $like. - $re: - type: string - title: $re - description: The updated at's $re. - $ilike: - type: string - title: $ilike - description: The updated at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The updated at's $fulltext. - $overlap: - type: array - description: The updated at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The updated at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The updated at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The updated at's $exists. - - name: deleted_at - in: query - description: The product's deleted at. - required: false - schema: - type: object - description: The product's deleted at. - properties: - $and: - type: array - description: The deleted at's $and. - items: - type: object - $or: - type: array - description: The deleted at's $or. - items: - type: object - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - $in: - type: array - description: The deleted at's $in. - items: - type: string - title: $in - $nin: - type: array - description: The deleted at's $nin. - items: - type: string - title: $nin - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - properties: - $and: - type: array - description: The $not's $and. - items: - type: object - title: $and - $or: - type: array - description: The $not's $or. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $gt: - type: string - title: $gt - $gte: - type: string - title: $gte - $lt: - type: string - title: $lt - $lte: - type: string - title: $lte - $like: - type: string - title: $like - description: The deleted at's $like. - $re: - type: string - title: $re - description: The deleted at's $re. - $ilike: - type: string - title: $ilike - description: The deleted at's $ilike. - $fulltext: - type: string - title: $fulltext - description: The deleted at's $fulltext. - $overlap: - type: array - description: The deleted at's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The deleted at's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The deleted at's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The deleted at's $exists. - - name: $and - in: query - description: The product's $and. - required: false - schema: - type: array - description: The product's $and. - items: - type: object - title: $and - - name: $or - in: query - description: The product's $or. - required: false - schema: - type: array - description: The product's $or. - items: - type: object - title: $or + description: A product collection's ID. security: - api_token: [] - cookie_auth: [] @@ -5219,7 +692,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of products. required: - limit - offset @@ -5228,23 +701,25 @@ get: limit: type: number title: limit - description: The product's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The product's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of products. required: - products properties: products: type: array - description: The product's products. + description: The list of products. items: type: object '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml index 009f4f674d..53d66042d5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml @@ -1,9 +1,10 @@ get: operationId: GetProductsIdOptions - summary: List Options + summary: List a Product's Options + x-sidebar-summary: List Options description: >- - Retrieve a list of options in a product. The options can be filtered by - fields like FILTER FIELDS. The options can also be paginated. + Retrieve a list of options of a product. The options can be filtered by + fields like `id`. The options can also be paginated. x-authenticated: true parameters: - name: id @@ -69,12 +70,12 @@ get: with `-`. - name: q in: query - description: The product's q. + description: Search term to filter the product option's searchable fields. required: false schema: type: string title: q - description: The product's q. + description: Search term to filter the product option's searchable fields. - name: id in: query required: false @@ -82,13 +83,13 @@ get: oneOf: - type: string title: id - description: The product's ID. + description: Filter by the product option's ID. - type: array - description: The product's ID. + description: Filter by product option IDs. items: type: string title: id - description: The id's ID. + description: A product option's ID. - name: title in: query required: false @@ -96,44 +97,38 @@ get: oneOf: - type: string title: title - description: The product's title. + description: Filter by a title. - type: array - description: The product's title. + description: Filter by titles. items: type: string title: title - description: The title's details. - - name: product_id - in: query - required: false - schema: - oneOf: - - type: string - title: product_id - description: The product's product id. - - type: array - description: The product's product id. - items: - type: string - title: product_id - description: The product id's details. + description: An option's title. - name: $and in: query - description: The product's $and. + description: >- + Join query parameters with an AND condition. Each object's content is + the same type as the expected query parameters. required: false schema: type: array - description: The product's $and. + 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 - name: $or in: query - description: The product's $or. + description: >- + Join query parameters with an OR condition. Each object's content is the + same type as the expected query parameters. required: false schema: type: array - description: The product's $or. + 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 @@ -156,7 +151,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of product options. required: - limit - offset @@ -165,23 +160,23 @@ get: limit: type: number title: limit - description: The product's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product's offset. + description: The number of items skipped before the returned items. count: type: number title: count - description: The product's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of product options. required: - product_options properties: product_options: type: array - description: The product's product options. + description: The list of product options. items: $ref: ../components/schemas/AdminProductOption.yaml '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml index 6e406d38b5..499e1fcacb 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml @@ -1,9 +1,8 @@ get: operationId: GetProductsIdOptionsOption_id - summary: List Options - description: >- - Retrieve a list of options in a product. The options can be filtered by - fields like FILTER FIELDS. The options can also be paginated. + summary: Get a Product's Option + x-sidebar-summary: Get Option + description: Retrieve a product's option by its ID. x-authenticated: true parameters: - name: id 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 ca72ba095c..c8dcf85577 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 @@ -1,6 +1,7 @@ get: operationId: GetProductsIdVariants - summary: List Variants + summary: List Variants of a Product + x-sidebar-summary: List Variants description: >- Retrieve a list of variants in a product. The variants can be filtered by fields like FILTER FIELDS. The variants can also be paginated. @@ -67,6 +68,489 @@ get: 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: Search term to filter the variant's search attributes. + required: false + schema: + type: string + title: q + description: Search term to filter the variant's search attributes. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: Filter by a variant's ID. + - type: array + description: Filter by variant IDs. + items: + type: string + title: id + description: A variant ID. + - name: manage_inventory + in: query + description: Filter by whether a variant's `manage_inventory` property is enabled. + required: false + schema: + type: boolean + title: manage_inventory + description: Filter by whether a variant's `manage_inventory` property is enabled. + - name: allow_backorder + in: query + description: Filter by whether backorders are allowed for the variant. + required: false + schema: + type: boolean + title: allow_backorder + description: Filter by whether backorders are allowed for the variant. + - name: created_at + in: query + description: Filter by the product's creation date. + required: false + schema: + type: object + description: Filter by the product'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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 product's update date. + required: false + schema: + type: object + description: Filter by the product'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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: deleted_at + in: query + description: Filter by the product's deletion date. + required: false + schema: + type: object + description: Filter by the product's deletion 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + - name: $and + in: query + description: >- + Join query parameters with an AND condition. Each object's content is + the same type as the expected query parameters. + required: false + schema: + 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 + - name: $or + in: query + description: >- + Join query parameters with an OR condition. Each object's content is the + same type as the expected query parameters. + required: false + schema: + 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 security: - api_token: [] - cookie_auth: [] @@ -86,7 +570,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of product variants. required: - limit - offset @@ -95,23 +579,23 @@ get: limit: type: number title: limit - description: The product's limit. + description: The maximum number of returned items. offset: type: number title: offset - description: The product's offset. + description: The number of items skipped before the returned item. count: type: number title: count - description: The product's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of product variants. required: - variants properties: variants: type: array - description: The product's variants. + description: The list of product variants. items: $ref: ../components/schemas/AdminProductVariant.yaml '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml index 4fd627635d..c577e6cd86 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml @@ -1,9 +1,8 @@ get: operationId: GetProductsIdVariantsVariant_id - summary: List Variants - description: >- - Retrieve a list of variants in a product. The variants can be filtered by - fields like FILTER FIELDS. The variants can also be paginated. + summary: Get Variant of a Product + x-sidebar-summary: Get Variant + description: Retrieve a product's variant by its ID. x-authenticated: true parameters: - name: id @@ -14,7 +13,7 @@ get: type: string - name: variant_id in: path - description: The product's variant id. + description: The variant's ID. required: true schema: type: string diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml index 403314e58e..a95125393c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml @@ -63,12 +63,12 @@ get: with `-`. - name: q in: query - description: The promotion's q. + description: Search term to filter the promotion's searchable attributes. required: false schema: type: string title: q - description: The promotion's q. + description: Search term to filter the promotion's searchable attributes. - name: code in: query required: false @@ -76,13 +76,13 @@ get: oneOf: - type: string title: code - description: The promotion's code. + description: Filter by a promotion code. - type: array - description: The promotion's code. + description: Filter by promotion codes. items: type: string title: code - description: The code's details. + description: A promotion code. - name: campaign_id in: query required: false @@ -90,39 +90,43 @@ get: oneOf: - type: string title: campaign_id - description: The promotion's campaign id. + description: Filter by a campaign's ID to retrieve its associated promotions. - type: array - description: The promotion's campaign id. + description: Filter by campaign IDs to retrieve their associated promotions. items: type: string title: campaign_id - description: The campaign id's details. + description: A campaign's ID. - name: application_method in: query - description: The promotion's application method. + description: >- + Apply filters on the application methods to retrieve the promotions of + the matching application methods. required: false schema: type: object - description: The promotion's application method. + description: >- + Apply filters on the application methods to retrieve the promotions of + the matching application methods. properties: currency_code: oneOf: - type: string title: currency_code - description: The application method's currency code. + description: Filter by a currency code. - type: array - description: The application method's currency code. + description: Filter by currency codes. items: type: string title: currency_code - description: The currency code's details. + description: A currency code. - name: created_at in: query - description: The promotion's created at. + description: Filter by a promotion's creation date. required: false schema: type: object - description: The promotion's created at. + description: Filter by a promotion's creation date. properties: $and: type: array @@ -180,150 +184,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -401,11 +261,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The promotion's updated at. + description: Filter by a promotion's update date. required: false schema: type: object - description: The promotion's updated at. + description: Filter by a promotion's update date. properties: $and: type: array @@ -463,150 +323,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -684,11 +400,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The promotion's deleted at. + description: Filter by a promotion's deletion date. required: false schema: type: object - description: The promotion's deleted at. + description: Filter by a promotion's deletion date. properties: $and: type: array @@ -746,150 +462,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -970,7 +542,9 @@ get: required: false schema: type: array - description: The promotion's $and. + 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 @@ -979,7 +553,9 @@ get: required: false schema: type: array - description: The promotion's $or. + 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 @@ -1002,7 +578,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of promotions. required: - limit - offset @@ -1011,23 +587,25 @@ get: limit: type: number title: limit - description: The promotion's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The promotion's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The promotion's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of promotions. required: - promotions properties: promotions: type: array - description: The promotion's promotions. + description: The list of promotions. items: $ref: ../components/schemas/AdminPromotion.yaml '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml index d45d27ef03..f2ddf82ca5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml @@ -1,34 +1,53 @@ get: operationId: GetPromotionsRuleAttributeOptionsRule_type - summary: List Rule Attribute Options - description: >- - Retrieve a list of rule attribute options in a promotion. The rule attribute - options can be filtered by fields like FILTER FIELDS. The rule attribute - options can also be paginated. + summary: List Rule Attribute Options of a Rule Type + x-sidebar-summary: List Rule Attribute Options + description: > + Retrieve a list of attributes for the promotion and application method types + specified in the query parameters. + + Only the attributes of the rule type specified in the path parameter are + retrieved: + + - If `rule_type` is `rules`, the attributes of the promotion's type are + retrieved. - If `rule_type` is `target-rules`, the target rules' attributes + of the application method's type are retrieved. - If `rule_type` is + `buy-rules`, the buy rules' attributes of the application method's type are + retrieved. x-authenticated: true parameters: - name: rule_type in: path - description: The promotion's rule type. + description: The rule type. required: true schema: type: string + enum: + - rules + - target-rules + - buy-rules - name: promotion_type in: query - description: The promotion's promotion type. + description: The promotion type to retrieve rules for. required: false schema: type: string title: promotion_type - description: The promotion's promotion type. + description: The promotion type to retrieve rules for. + enum: + - standard + - buyget - name: application_method_type in: query - description: The promotion's application method type. + description: The application method type to retrieve rules for. required: false schema: type: string title: application_method_type - description: The promotion's application method type. + description: The application method type to retrieve rules for. + enum: + - fixed + - percentage security: - api_token: [] - cookie_auth: [] @@ -48,13 +67,13 @@ get: application/json: schema: type: object - description: SUMMARY + description: The list of attributes. required: - attributes properties: attributes: type: array - description: The promotion's attributes. + description: The list of attributes. items: $ref: ../components/schemas/AdminRuleAttributeOption.yaml '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml index 7138bb314a..a16bbc60b3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml @@ -1,20 +1,29 @@ get: operationId: GetPromotionsRuleValueOptionsRule_typeRule_attribute_id - summary: 'List ' - description: >- - Retrieve a list of in a promotion. The can be filtered by fields like - FILTER FIELDS. The can also be paginated. + summary: List Rule Values Given a Rule Attribute + x-sidebar-summary: List Rule Values + 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. x-authenticated: true parameters: - name: rule_type in: path - description: The promotion's rule type. + description: The rule type. required: true schema: type: string + enum: + - rules + - target-rules + - buy-rules - name: rule_attribute_id in: path - description: The promotion's rule attribute id. + description: The rule attribute's ID. required: true schema: type: string @@ -75,20 +84,26 @@ get: with `-`. - name: promotion_type in: query - description: The promotion's promotion type. + description: The promotion type to retrieve rules for. required: false schema: type: string title: promotion_type - description: The promotion's promotion type. + description: The promotion type to retrieve rules for. + enum: + - standard + - buyget - name: application_method_type in: query - description: The promotion's application method type. + description: The application method type to retrieve rules for. required: false schema: type: string title: application_method_type - description: The promotion's application method type. + description: The application method type to retrieve rules for. + enum: + - fixed + - percentage security: - api_token: [] - cookie_auth: [] @@ -108,13 +123,13 @@ get: application/json: schema: type: object - description: SUMMARY + description: The list of rule values. required: - values properties: values: type: array - description: The promotion's values. + description: The list of rule values. items: $ref: ../components/schemas/AdminRuleValueOption.yaml '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_{rule_type}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_{rule_type}.yaml index c7db32ed7d..613807fcee 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_{rule_type}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_{rule_type}.yaml @@ -1,9 +1,15 @@ get: operationId: GetPromotionsIdRule_type - summary: 'List ' - description: >- - Retrieve a list of in a promotion. The can be filtered by fields like - FILTER FIELDS. The can also be paginated. + summary: List Rules of a Promotion + x-sidebar-summary: List Rules + 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. - If + `rule_type` is `target-rules`, the target rules of the promotion's + application method are retrieved. - If `rule_type` is `buy-rules`, the buy + rules of the promotion's application method are retrieved. x-authenticated: true parameters: - name: id @@ -14,10 +20,14 @@ get: type: string - name: rule_type in: path - description: The promotion's rule type. + description: The type of rules to retrieve. required: true schema: type: string + enum: + - rules + - target-rules + - buy-rules - name: expand in: query description: Comma-separated relations that should be expanded in the returned data. @@ -91,13 +101,13 @@ get: application/json: schema: type: object - description: SUMMARY + description: The list of promotion rules. required: - rules properties: rules: type: array - description: The promotion's rules. + description: The list of promotion rules. items: $ref: ../components/schemas/AdminPromotionRule.yaml '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml index d00be7676a..4c4f513bd8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml @@ -68,21 +68,21 @@ get: oneOf: - type: string title: id - description: The refund reason's ID. + description: Filter by a refund reason's ID. - type: array - description: The refund reason's ID. + description: Filter by refund reason IDs. items: type: string title: id - description: The id's ID. + description: A refund reason ID. - name: q in: query - description: The refund reason's q. + description: Search term to filter the refund reason's searchable properties. required: false schema: type: string title: q - description: The refund reason's q. + description: Search term to filter the refund reason's searchable properties. - name: $and in: query description: >- diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml index 4757290536..8e21c26cd1 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml @@ -63,12 +63,12 @@ get: with `-`. - name: q in: query - description: The region's q. + description: Search term to filter the region's searchable properties. required: false schema: type: string title: q - description: The region's q. + description: Search term to filter the region's searchable properties. - name: id in: query required: false @@ -76,13 +76,13 @@ get: oneOf: - type: string title: id - description: The region's ID. + description: Filter by a region's ID. - type: array - description: The region's ID. + description: Filter by region IDs. items: type: string title: id - description: The id's ID. + description: A region's ID. - name: code in: query required: false @@ -90,13 +90,13 @@ get: oneOf: - type: string title: code - description: The region's code. + description: Filter by a currency code. - type: array - description: The region's code. + description: Filter by currency codes. items: type: string title: code - description: The code's details. + description: A currency code. - name: name in: query required: false @@ -104,20 +104,20 @@ get: oneOf: - type: string title: name - description: The region's name. + description: Filter by a region's name. - type: array - description: The region's name. + description: Filter by region names. items: type: string title: name - description: The name's details. + description: A region's name. - name: created_at in: query - description: The region's created at. + description: Filter by a region's creation date. required: false schema: type: object - description: The region's created at. + description: Filter by a region's creation date. properties: $and: type: array @@ -175,150 +175,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -396,11 +252,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The region's updated at. + description: Filter by a region's update date. required: false schema: type: object - description: The region's updated at. + description: Filter by a region's update date. properties: $and: type: array @@ -458,150 +314,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -679,11 +391,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The region's deleted at. + description: Filter by a region's deletion date. required: false schema: type: object - description: The region's deleted at. + description: Filter by a region's deletion date. properties: $and: type: array @@ -741,150 +453,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -965,7 +533,9 @@ get: required: false schema: type: array - description: The region's $and. + 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 @@ -974,7 +544,9 @@ get: required: false schema: type: array - description: The region's $or. + 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 @@ -997,7 +569,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of regions. required: - limit - offset @@ -1006,23 +578,25 @@ get: limit: type: number title: limit - description: The region's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The region's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The region's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of regions. required: - regions properties: regions: type: array - description: The region's regions. + description: The list of regions. items: $ref: ../components/schemas/AdminRegion.yaml '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml index c26cde604f..0edcb0be1b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml @@ -68,13 +68,13 @@ get: oneOf: - type: string title: location_id - description: The reservation's location id. + description: Filter by a location's ID to retrieve its associated reservations. - type: array - description: The reservation's location id. + description: Filter by location IDs to retrieve its associated reservations. items: type: string title: location_id - description: The location id's details. + description: A location ID. - name: inventory_item_id in: query required: false @@ -82,13 +82,17 @@ get: oneOf: - type: string title: inventory_item_id - description: The reservation's inventory item id. + description: >- + Filter by an inventory item's ID to retrieve its associated + reservations. - type: array - description: The reservation's inventory item id. + description: >- + Filter by inventory item IDs to retrieve its associated + reservations. items: type: string title: inventory_item_id - description: The inventory item id's details. + description: An inventory item ID - name: line_item_id in: query required: false @@ -96,13 +100,15 @@ get: oneOf: - type: string title: line_item_id - description: The reservation's line item id. + description: >- + Filter by a line item's ID to retrieve its associated + reservations. - type: array - description: The reservation's line item id. + description: Filter by line item IDs to retrieve its associated reservations. items: type: string title: line_item_id - description: The line item id's details. + description: A line item ID - name: created_by in: query required: false @@ -110,13 +116,15 @@ get: oneOf: - type: string title: created_by - description: The reservation's created by. + description: >- + Filter by the ID of a user to retrieve the reservations they + created. - type: array - description: The reservation's created by. + description: Filter by user IDs to retrieve the reservations they created. items: type: string title: created_by - description: The created by's details. + description: A user's ID. - name: description in: query required: false @@ -124,42 +132,74 @@ get: oneOf: - type: string title: description - description: The reservation's description. + description: >- + Filter by a reservation's description. This filter applies a + full-text match. To search by keywords, use the `q` query + parameter instead. - type: object - description: The reservation's description. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: Apply filters on the reservation's description. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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: The reservation's created at. + description: Filter by a reservation's creation date. required: false schema: type: object - description: The reservation's created at. + description: Filter by a reservation's creation date. properties: $and: type: array @@ -217,150 +257,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -438,11 +334,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The reservation's updated at. + description: Filter by a reservation's update date. required: false schema: type: object - description: The reservation's updated at. + description: Filter by a reservation's update date. properties: $and: type: array @@ -500,150 +396,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -721,11 +473,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The reservation's deleted at. + description: Filter by a reservation's deletion date. required: false schema: type: object - description: The reservation's deleted at. + description: Filter by a reservation's deletion date. properties: $and: type: array @@ -783,150 +535,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -1021,7 +629,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of reservations. required: - limit - offset @@ -1030,23 +638,25 @@ get: limit: type: number title: limit - description: The reservation's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The reservation's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The reservation's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of reservations. required: - reservations properties: reservations: type: array - description: The reservation's reservations. + description: The list of reservations`. items: $ref: ../components/schemas/ReservationResponse.yaml '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml b/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml index fbe79e7960..a618a6b137 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml @@ -63,12 +63,12 @@ get: with `-`. - name: q in: query - description: The return reason's q. + description: Search term to filter the return reason's searchable properties. required: false schema: type: string title: q - description: The return reason's q. + description: Search term to filter the return reason's searchable properties. - name: id in: query required: false @@ -76,13 +76,13 @@ get: oneOf: - type: string title: id - description: The return reason's ID. + description: Filter by a return reason ID. - type: array - description: The return reason's ID. + description: Filter by return reason IDs. items: type: string title: id - description: The id's ID. + description: A return reason ID. - name: value in: query required: false @@ -90,13 +90,13 @@ get: oneOf: - type: string title: value - description: The return reason's value. + description: Filter by a return reason's value. - type: array - description: The return reason's value. + description: Filter by return reason values. items: type: string title: value - description: The value's details. + description: A return reason value. - name: label in: query required: false @@ -104,13 +104,13 @@ get: oneOf: - type: string title: label - description: The return reason's label. + description: Filter by a return reason's label. - type: array - description: The return reason's label. + description: Filter by return reason labels. items: type: string title: label - description: The label's details. + description: A return reason label. - name: description in: query required: false @@ -118,13 +118,19 @@ get: oneOf: - type: string title: description - description: The return reason's description. + description: >- + Filter by a description. This filter looks for an exact match of + the return reason's description. To search by a term or keywords, + use the `q` query parameter instead. - type: array - description: The return reason's description. + description: >- + Filter by descriptions. This filter looks for an exact match of + the return reason's description. To search by a term or keywords, + use the `q` query parameter instead. items: type: string title: description - description: The description's details. + description: A return reason's description. - name: parent_return_reason_id in: query required: false @@ -132,20 +138,24 @@ get: oneOf: - type: string title: parent_return_reason_id - description: The return reason's parent return reason id. + description: >- + Filter by a return reason's ID to retrieve its child return + reasons. - type: array - description: The return reason's parent return reason id. + description: >- + Filter by return reason IDs to retrieve their child return + reasons. items: type: string title: parent_return_reason_id - description: The parent return reason id's details. + description: The return reason's ID. - name: created_at in: query - description: The return reason's created at. + description: Filter by a return reason's creation date. required: false schema: type: object - description: The return reason's created at. + description: Filter by a return reason's creation date. properties: $and: type: array @@ -203,150 +213,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -424,11 +290,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The return reason's updated at. + description: Filter by a return reason's update date. required: false schema: type: object - description: The return reason's updated at. + description: Filter by a return reason's update date. properties: $and: type: array @@ -486,150 +352,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -707,11 +429,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The return reason's deleted at. + description: Filter by a return reason's deletion date. required: false schema: type: object - description: The return reason's deleted at. + description: Filter by a return reason's deletion date. properties: $and: type: array @@ -769,150 +491,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -990,21 +568,29 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: $and in: query - description: The return reason's $and. + description: >- + Join query parameters with an AND condition. Each object's content is + the same type as the expected query parameters. required: false schema: type: array - description: The return reason's $and. + 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 - name: $or in: query - description: The return reason's $or. + description: >- + Join query parameters with an OR condition. Each object's content is the + same type as the expected query parameters. required: false schema: type: array - description: The return reason's $or. + 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml index a0771e28a8..5d14ccd833 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml @@ -68,27 +68,55 @@ get: oneOf: - type: string title: id - description: The return's ID. + description: Filter by a return's ID. - type: array - description: The return's ID. + description: Filter by return IDs. items: type: string title: id - description: The id's ID. - - name: name + description: A return ID. + - name: status in: query required: false schema: oneOf: - type: string - title: name - description: The return's name. + title: status + description: Filter by a return status. - type: array - description: The return's name. + description: Filter by return statuses. items: type: string - title: name - description: The name's details. + title: status + description: A return status. + - name: $and + in: query + description: >- + Join query parameters with an AND condition. Each object's content is + the same type as the expected query parameters. + required: false + schema: + 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 + - name: $or + in: query + description: >- + Join query parameters with an OR condition. Each object's content is the + same type as the expected query parameters. + required: false + schema: + 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 - name: sales_channel_id in: query description: The return's sales channel id. @@ -109,8 +137,16 @@ get: description: The return's fulfillment status. items: 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: The return's payment status. @@ -120,8 +156,18 @@ get: description: The return's payment status. items: 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: The return's region id. @@ -707,587 +753,6 @@ get: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - - name: status - in: query - required: false - schema: - oneOf: - - type: string - title: status - description: The return's status. - - type: array - description: The return's status. - items: - type: string - title: status - description: The status's details. - - type: object - description: The return's status. - 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 an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - oneOf: - - type: string - title: $ne - description: Filter by values not equal to this parameter. - - type: array - description: Filter by values not equal to this parameter. - items: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - oneOf: - - type: string - title: $in - description: Filter by values in this array. - - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - oneOf: - - type: string - title: $nin - description: Filter by values not in this array. - - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in - this parameter. - - type: object - description: >- - Filter by values not matching the conditions in - this parameter. - - type: array - description: >- - Filter by values not matching the conditions in - this parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in - this parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of - this parameter. - $contained: - type: array - description: >- - Filter arrays that contain all values of this - parameter. - items: - type: string - title: $contained - description: >- - Filter arrays that contain all values of this - parameter. - $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 the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions - in this parameter. - - type: object - description: >- - Filter by values not matching the conditions - in this parameter. - - type: array - description: >- - Filter by values not matching the conditions - in this parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the - conditions in this parameter. - $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: >- - Filter arrays that have overlapping values - with this parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of - this parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values - of this parameter. - $contained: - type: array - description: >- - Filter arrays that contain all values of this - parameter. - items: - type: string - title: $contained - description: >- - Filter arrays that contain all values of this - parameter. - $exists: - type: boolean - title: $exists - description: >- - Filter by whether a value for this parameter - exists (not `null`). - $gt: - oneOf: - - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. - - type: array - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. - items: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. - $gte: - oneOf: - - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. - Useful for numbers and dates only. - - type: array - description: >- - Filter by values greater than or equal to this parameter. - Useful for numbers and dates only. - items: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this - parameter. Useful for numbers and dates only. - $lt: - oneOf: - - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for - numbers and dates only. - - type: array - description: >- - Filter by values less than this parameter. Useful for - numbers and dates only. - items: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for - numbers and dates only. - $lte: - oneOf: - - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. - Useful for numbers and dates only. - - type: array - description: >- - Filter by values less than or equal to this parameter. - Useful for numbers and dates only. - items: - 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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: >- - Filter by whether a value for this parameter exists (not - `null`). - - name: $and - in: query - description: >- - Join query parameters with an AND condition. Each object's content is - the same type as the expected query parameters. - required: false - schema: - 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 - - name: $or - in: query - description: >- - Join query parameters with an OR condition. Each object's content is the - same type as the expected query parameters. - required: false - schema: - 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 security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml index af1cdff583..9ef05b87d0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml @@ -63,12 +63,12 @@ get: with `-`. - name: q in: query - description: The sales channel's q. + description: Search term to filter the sales channel's searchable properties. required: false schema: type: string title: q - description: The sales channel's q. + description: Search term to filter the sales channel's searchable properties. - name: id in: query required: false @@ -76,13 +76,13 @@ get: oneOf: - type: string title: id - description: The sales channel's ID. + description: Filter by a sales channel ID. - type: array - description: The sales channel's ID. + description: Filter by sales channel IDs. items: type: string title: id - description: The id's ID. + description: A sales channel ID. - name: name in: query required: false @@ -90,13 +90,13 @@ get: oneOf: - type: string title: name - description: The sales channel's name. + description: Filter by a sales channel name. - type: array - description: The sales channel's name. + description: Filter by sales channel names. items: type: string title: name - description: The name's details. + description: A sales channel name. - name: description in: query description: The sales channel's description. @@ -104,22 +104,24 @@ get: schema: type: string title: description - description: The sales channel's description. + description: >- + Filter by a description. This filter matches an entire description. To + search by terms or keywords, use the `q` query parameter instead. - name: is_disabled in: query - description: The sales channel's is disabled. + description: Filter by whether the sales channel is disabled. required: false schema: type: boolean title: is_disabled - description: The sales channel's is disabled. + description: Filter by whether the sales channel is disabled. - name: created_at in: query - description: The sales channel's created at. + description: Filter by a sales channel's creation date. required: false schema: type: object - description: The sales channel's created at. + description: Filter by a sales channel's creation date. properties: $and: type: array @@ -177,150 +179,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -398,11 +256,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The sales channel's updated at. + description: Filter by a sales channel's update date. required: false schema: type: object - description: The sales channel's updated at. + description: Filter by a sales channel's update date. properties: $and: type: array @@ -460,150 +318,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -681,11 +395,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The sales channel's deleted at. + description: Filter by a sales channel's deletion date. required: false schema: type: object - description: The sales channel's deleted at. + description: Filter by a sales channel's deletion date. properties: $and: type: array @@ -743,150 +457,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -969,13 +539,15 @@ get: oneOf: - type: string title: location_id - description: The sales channel's location id. + description: Filter by a location ID to retrieve its associated sales channels. - type: array - description: The sales channel's location id. + description: >- + Filter by location IDs to retrieve their associated sales + channels. items: type: string title: location_id - description: The location id's details. + description: A location ID. - name: publishable_key_id in: query required: false @@ -983,19 +555,25 @@ get: oneOf: - type: string title: publishable_key_id - description: The sales channel's publishable key id. + description: >- + Filter by a publishable API key's ID to retrieve its associated + sales channels. - type: array - description: The sales channel's publishable key id. + description: >- + Filter by publishable API key IDs to retrieve their associated + sales channels. items: type: string title: publishable_key_id - description: The publishable key id's details. + description: A publishable API key ID. - name: $and in: query required: false schema: type: array - description: The sales channel's $and. + 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 @@ -1004,7 +582,9 @@ get: required: false schema: type: array - description: The sales channel's $or. + 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 @@ -1027,7 +607,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of sales channels. required: - limit - offset @@ -1036,23 +616,25 @@ get: limit: type: number title: limit - description: The sales channel's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The sales channel's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The sales channel's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of sales channels. required: - sales_channels properties: sales_channels: type: array - description: The sales channel's sales channels. + description: The list of sales channels. items: $ref: ../components/schemas/AdminSalesChannel.yaml '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml index ddd9a68d4d..a9f3e79a28 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml @@ -68,21 +68,21 @@ get: oneOf: - type: string title: id - description: The shipping option's ID. + description: Filter by a shipping option ID. - type: array - description: The shipping option's ID. + description: Filter by shipping option IDs. items: type: string title: id - description: The id's ID. + description: A shipping option's ID. - name: q in: query - description: The shipping option's q. + description: Search term to filter the shipping option's searchable properties. required: false schema: type: string title: q - description: The shipping option's q. + description: Search term to filter the shipping option's searchable properties. - name: service_zone_id in: query required: false @@ -90,13 +90,17 @@ get: oneOf: - type: string title: service_zone_id - description: The shipping option's service zone id. + description: >- + Filter by a service zone's ID to retrieve its associated shipping + options. - type: array - description: The shipping option's service zone id. + description: >- + Filter by service zone IDs to retrieve their associated shipping + options. items: type: string title: service_zone_id - description: The service zone id's details. + description: A service zone ID. - name: shipping_profile_id in: query required: false @@ -104,13 +108,17 @@ get: oneOf: - type: string title: shipping_profile_id - description: The shipping option's shipping profile id. + description: >- + Filter by a shipping profile's ID to retrieve its associated + shipping options. - type: array - description: The shipping option's shipping profile id. + description: >- + Filter by shipping profile IDs to retrieve their associated + shipping options. items: type: string title: shipping_profile_id - description: The shipping profile id's details. + description: A shipping profile ID. - name: provider_id in: query required: false @@ -118,13 +126,17 @@ get: oneOf: - type: string title: provider_id - description: The shipping option's provider id. + description: >- + Filter by a fulfillment provider's ID to retrieve its associated + shipping options. - type: array - description: The shipping option's provider id. + description: >- + Filter by fulfillment provider IDs to retrieve their associated + shipping options. items: type: string title: provider_id - description: The provider id's details. + description: A fulfillment provider ID. - name: shipping_option_type_id in: query required: false @@ -132,20 +144,24 @@ get: oneOf: - type: string title: shipping_option_type_id - description: The shipping option's shipping option type id. + description: >- + Filter by a shipping option type's ID to retrieve its associated + shipping options. - type: array - description: The shipping option's shipping option type id. + description: >- + Filter by shipping option type IDs to retrieve its associated + shipping options. items: type: string title: shipping_option_type_id - description: The shipping option type id's details. + description: A shipping option type ID. - name: created_at in: query - description: The shipping option's created at. + description: Filter by a shipping option's creation date. required: false schema: type: object - description: The shipping option's created at. + description: Filter by a shipping option's creation date. properties: $and: type: array @@ -203,150 +219,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -424,11 +296,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The shipping option's updated at. + description: Filter by a shipping option's update date. required: false schema: type: object - description: The shipping option's updated at. + description: Filter by a shipping option's update date. properties: $and: type: array @@ -486,150 +358,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -707,11 +435,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The shipping option's deleted at. + description: Filter by a shipping option's deletion date. required: false schema: type: object - description: The shipping option's deleted at. + description: Filter by a shipping option's deletion date. properties: $and: type: array @@ -769,150 +497,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -995,13 +579,17 @@ get: oneOf: - type: string title: stock_location_id - description: The shipping option's stock location id. + description: >- + Filter by a location ID to retrieve its associated shipping + option. - type: array - description: The shipping option's stock location id. + description: >- + Filter by location IDs to retrieve their associated shipping + option. items: type: string title: stock_location_id - description: The stock location id's details. + description: A stock location's ID. - name: is_return in: query description: The shipping option's is return. @@ -1037,7 +625,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of shipping options. required: - limit - offset @@ -1046,23 +634,25 @@ get: limit: type: number title: limit - description: The shipping option's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The shipping option's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The shipping option's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of shipping options. required: - shipping_options properties: shipping_options: type: array - description: The shipping option's shipping options. + description: The list of shipping options. items: type: object '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml index 25455f6e98..659cbeaa1b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml @@ -69,58 +69,462 @@ get: oneOf: - type: string title: id - description: The shipping profile's ID. + description: Filter by a shipping profile's ID. - type: array - description: The shipping profile's ID. + description: Filter by shipping profile IDs. items: type: string title: id - description: The id's ID. + description: A shipping profile ID. - name: q in: query - description: The shipping profile's q. + description: Search term to filter the shipping profile's searchable properties. required: false schema: type: string title: q - description: The shipping profile's q. + description: Search term to filter the shipping profile's searchable properties. - name: type in: query - description: The shipping profile's type. + description: Filter by a shipping profile's type. required: false schema: type: string title: type - description: The shipping profile's type. + description: Filter by a shipping profile's type. - name: name in: query - description: The shipping profile's name. + description: Filter by a shipping profile's name. required: false schema: type: string title: name - description: The shipping profile's name. + description: Filter by a shipping profile's name. - name: created_at in: query - description: The shipping profile's created at. + description: Filter by a shipping profile's creation date. required: false - schema: {} + schema: + type: object + description: Filter by a shipping profile'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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The shipping profile's updated at. + description: Filter by a shipping profile's update date. required: false - schema: {} + schema: + type: object + description: Filter by a shipping profile'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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The shipping profile's deleted at. + description: Filter by a shipping profile's deletion date. required: false - schema: {} + schema: + type: object + description: Filter by a shipping profile's deletion 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). - name: $and in: query required: false schema: type: array - description: The shipping profile's $and. + 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 @@ -129,7 +533,9 @@ get: required: false schema: type: array - description: The shipping profile's $or. + 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 @@ -152,7 +558,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of shipping profiles. required: - limit - offset @@ -161,23 +567,25 @@ get: limit: type: number title: limit - description: The shipping profile's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The shipping profile's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The shipping profile's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of shipping profiles. required: - shipping_profiles properties: shipping_profiles: type: array - description: The shipping profile's shipping profiles. + description: The list of shipping profiles. items: $ref: ../components/schemas/AdminShippingProfile.yaml '400': @@ -261,24 +669,7 @@ post: 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.yaml x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml index dae26ff185..b997c8b759 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml @@ -63,12 +63,12 @@ get: with `-`. - name: q in: query - description: The stock location's q. + description: Search term to filter the stock location's searchable properties. required: false schema: type: string title: q - description: The stock location's q. + description: Search term to filter the stock location's searchable properties. - name: id in: query required: false @@ -76,13 +76,13 @@ get: oneOf: - type: string title: id - description: The stock location's ID. + description: Filter by a stock location ID. - type: array - description: The stock location's ID. + description: Filter by stock location IDs. items: type: string title: id - description: The id's ID. + description: A stock location ID. - name: name in: query required: false @@ -90,13 +90,13 @@ get: oneOf: - type: string title: name - description: The stock location's name. + description: Filter by a stock location name. - type: array - description: The stock location's name. + description: Filter by stock location names. items: type: string title: name - description: The name's details. + description: A stock location name. - name: address_id in: query required: false @@ -104,13 +104,13 @@ get: oneOf: - type: string title: address_id - description: The stock location's address id. + description: Filter by an address ID to retrieve its associated locations. - type: array - description: The stock location's address id. + description: Filter by address IDs to retrieve their associated locations. items: type: string title: address_id - description: The address id's details. + description: An address ID. - name: sales_channel_id in: query required: false @@ -118,20 +118,22 @@ get: oneOf: - type: string title: sales_channel_id - description: The stock location's sales channel id. + description: Filter by a sales channel ID to retrieve its associated locations. - type: array - description: The stock location's sales channel id. + description: >- + Filter by sales channel IDs to retrieve their associated + locations. items: type: string title: sales_channel_id - description: The sales channel id's details. + description: A sales channel ID - name: created_at in: query - description: The stock location's created at. + description: Filter by a stock location's creation date. required: false schema: type: object - description: The stock location's created at. + description: Filter by a stock location's creation date. properties: $and: type: array @@ -189,150 +191,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -410,11 +268,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The stock location's updated at. + description: Filter by a stock location's update date. required: false schema: type: object - description: The stock location's updated at. + description: Filter by a stock location's update date. properties: $and: type: array @@ -472,150 +330,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -693,11 +407,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The stock location's deleted at. + description: Filter by a stock location's deletion date. required: false schema: type: object - description: The stock location's deleted at. + description: Filter by a stock location's deletion date. properties: $and: type: array @@ -755,150 +469,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -979,7 +549,9 @@ get: required: false schema: type: array - description: The stock location's $and. + 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 @@ -988,7 +560,9 @@ get: required: false schema: type: array - description: The stock location's $or. + 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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_stores.yaml b/www/apps/api-reference/specs/admin/paths/admin_stores.yaml index 2c16e68667..aadc3e0eac 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stores.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stores.yaml @@ -63,12 +63,12 @@ get: with `-`. - name: q in: query - description: The store's q. + description: Search term to filter the store's searchable properties. required: false schema: type: string title: q - description: The store's q. + description: Search term to filter the store's searchable properties. - name: id in: query required: false @@ -76,13 +76,13 @@ get: oneOf: - type: string title: id - description: The store's ID. + description: Filter by a store ID. - type: array - description: The store's ID. + description: Filter by store IDs. items: type: string title: id - description: The id's ID. + description: A store ID. - name: name in: query required: false @@ -90,19 +90,21 @@ get: oneOf: - type: string title: name - description: The store's name. + description: Filter by a store name. - type: array - description: The store's name. + description: Filter by store names. items: type: string title: name - description: The name's details. + description: A store name. - name: $and in: query required: false schema: type: array - description: The store's $and. + 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 @@ -111,7 +113,9 @@ get: required: false schema: type: array - description: The store's $or. + 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 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 fe5d3c209d..1b57b45b87 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 @@ -63,12 +63,12 @@ get: with `-`. - name: q in: query - description: The tax rate's q. + description: Search terms to filter the tax rate's searchable properties. required: false schema: type: string title: q - description: The tax rate's q. + description: Search terms to filter the tax rate's searchable properties. - name: tax_region_id in: query required: false @@ -76,57 +76,88 @@ get: oneOf: - type: string title: tax_region_id - description: The tax rate's tax region id. + description: Filter by a tax region ID to retrieve its associated rates. - type: array - description: The tax rate's tax region id. + description: Filter by tax region IDs to retrieve their associated rates. items: type: string title: tax_region_id - description: The tax region id's details. + description: A tax region ID. - type: object - description: The tax rate's tax region id. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: >- + Apply filters on the tax region ID to retrieve the rates + associated with the matching tax regions. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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: is_default in: query required: false + description: Filter by whether the tax rate is a default in its tax region. schema: type: string enum: - 'true' - 'false' - title: is_default - name: created_at in: query - description: The tax rate's created at. + description: Filter by a tax rate's creation date. required: false schema: type: object - description: The tax rate's created at. + description: Filter by a tax rate's creation date. properties: $and: type: array @@ -184,150 +215,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -405,11 +292,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The tax rate's updated at. + description: Filter by a tax rate's update date. required: false schema: type: object - description: The tax rate's updated at. + description: Filter by a tax rate's update date. properties: $and: type: array @@ -467,150 +354,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -688,11 +431,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The tax rate's deleted at. + description: Filter by a tax rate's deletion date. required: false schema: type: object - description: The tax rate's deleted at. + description: Filter by a tax rate's deletion date. properties: $and: type: array @@ -750,150 +493,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -974,7 +573,9 @@ get: required: false schema: type: array - description: The tax rate's $and. + 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 @@ -983,42 +584,54 @@ get: required: false schema: type: array - description: The tax rate's $or. + 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 - name: service_zone_id in: query - description: The tax rate's service zone id. + description: Filter by a service zone's ID to retrieve its associated tax rates. required: false schema: type: string title: service_zone_id - description: The tax rate's service zone id. + description: Filter by a service zone's ID to retrieve its associated tax rates. - name: shipping_profile_id in: query - description: The tax rate's shipping profile id. + description: Filter by a shipping profile's ID to retrieve its associated tax rates. required: false schema: type: string title: shipping_profile_id - description: The tax rate's shipping profile id. + description: >- + Filter by a shipping profile's ID to retrieve its associated tax + rates. - name: provider_id in: query - description: The tax rate's provider id. + description: >- + Filter by a fulfillment provider's ID to retrieve its associated tax + rates. required: false schema: type: string title: provider_id - description: The tax rate's provider id. + description: >- + Filter by a fulfillment provider's ID to retrieve its associated tax + rates. - name: shipping_option_type_id in: query - description: The tax rate's shipping option type id. + description: >- + Filter by a shipping option type's ID to retrieve its associated tax + rates. required: false schema: type: string title: shipping_option_type_id - description: The tax rate's shipping option type id. + description: >- + Filter by a shipping option type's ID to retrieve its associated tax + rates. security: - api_token: [] - cookie_auth: [] @@ -1038,7 +651,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of tax rates. required: - limit - offset @@ -1047,17 +660,19 @@ get: limit: type: number title: limit - description: The tax rate's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The tax rate's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The tax rate's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of tax rates. required: - tax_rates properties: diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml index 2420c98b25..dc3bc61ff0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml @@ -63,12 +63,12 @@ get: with `-`. - name: q in: query - description: The tax region's q. + description: Search term to filter a tax region's searchable properties. required: false schema: type: string title: q - description: The tax region's q. + description: Search term to filter a tax region's searchable properties. - name: id in: query required: false @@ -76,13 +76,13 @@ get: oneOf: - type: string title: id - description: The tax region's ID. + description: Filter by a tax region ID. - type: array - description: The tax region's ID. + description: Filter by tax region IDs. items: type: string title: id - description: The id's ID. + description: A tax region ID. - name: country_code in: query required: false @@ -90,41 +90,70 @@ get: oneOf: - type: string title: country_code - description: The tax region's country code. + description: Filter by a country code. - type: array - description: The tax region's country code. + description: Filter by country codes. items: type: string title: country_code - description: The country code's details. + description: A country code. - type: object - description: The tax region's country code. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: Apply filters on the currency code. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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: province_code in: query required: false @@ -132,41 +161,70 @@ get: oneOf: - type: string title: province_code - description: The tax region's province code. + description: Filter by a province code. - type: array - description: The tax region's province code. + description: Filter by province codes. items: type: string title: province_code - description: The province code's details. + description: A province code. - type: object - description: The tax region's province code. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: Apply filters on the province code. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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: parent_id in: query required: false @@ -174,41 +232,76 @@ get: oneOf: - type: string title: parent_id - description: The tax region's parent id. + description: >- + Filter by the ID of a parent tax region to retrieve its child tax + regions. - type: array - description: The tax region's parent id. + description: >- + Filter by the IDs of parent tax regions to retrieve their child + tax regions. items: type: string title: parent_id - description: The parent id's details. + description: A tax region's ID. - type: object - description: The tax region's parent id. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte + description: >- + Apply filters on the parent tax region's ID to retrieve its child + tax regions. properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} + $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_by in: query required: false @@ -216,34 +309,938 @@ get: oneOf: - type: string title: created_by - description: The tax region's created by. + description: >- + Filter by the ID of the user to retrieve the tax regions they + created. - type: array - description: The tax region's created by. + description: Filter by user IDs to retrieve their tax regions they created. items: type: string title: created_by - description: The created by's details. + description: A user ID. - name: created_at in: query - description: The tax region's created at. + description: Filter by a tax region's creation date. required: false - schema: {} + schema: + oneOf: + - type: string + title: created_at + description: The tax region's created at. + - type: object + description: The tax region's created at. + 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in + this parameter. + - type: object + description: >- + Filter by values not matching the conditions in + this parameter. + - type: array + description: >- + Filter by values not matching the conditions in + this parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in + this parameter. + $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: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of + this parameter. + $contained: + type: array + description: >- + Filter arrays that contain all values of this + parameter. + items: + type: string + title: $contained + description: >- + Filter arrays that contain all values of this + parameter. + $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 the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of this + parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter exists (not + `null`). - name: updated_at in: query - description: The tax region's updated at. + description: Filter by a tax region's update date. required: false - schema: {} + schema: + oneOf: + - type: string + title: updated_at + description: The tax region's updated at. + - type: object + description: The tax region's updated at. + 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in + this parameter. + - type: object + description: >- + Filter by values not matching the conditions in + this parameter. + - type: array + description: >- + Filter by values not matching the conditions in + this parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in + this parameter. + $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: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of + this parameter. + $contained: + type: array + description: >- + Filter arrays that contain all values of this + parameter. + items: + type: string + title: $contained + description: >- + Filter arrays that contain all values of this + parameter. + $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 the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of this + parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter exists (not + `null`). - name: deleted_at in: query - description: The tax region's deleted at. + description: Filter by a tax region's deletion date. required: false - schema: {} + schema: + oneOf: + - type: string + title: deleted_at + description: The tax region's deleted at. + - type: object + description: The tax region's deleted at. + 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in + this parameter. + - type: object + description: >- + Filter by values not matching the conditions in + this parameter. + - type: array + description: >- + Filter by values not matching the conditions in + this parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in + this parameter. + $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: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of + this parameter. + $contained: + type: array + description: >- + Filter arrays that contain all values of this + parameter. + items: + type: string + title: $contained + description: >- + Filter arrays that contain all values of this + parameter. + $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 the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of this + parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter exists (not + `null`). - name: $and in: query required: false schema: type: array - description: The tax region's $and. + 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 @@ -252,7 +1249,9 @@ get: required: false schema: type: array - description: The tax region's $or. + 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 @@ -275,7 +1274,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of tax regions. required: - limit - offset @@ -284,23 +1283,25 @@ get: limit: type: number title: limit - description: The tax region's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The tax region's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The tax region's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of tax regions. required: - tax_regions properties: tax_regions: type: array - description: The tax region's tax regions. + description: The list of tax regions. items: type: object '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml index 5c051787d8..dde1664ffc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml @@ -1,9 +1,9 @@ get: operationId: GetUploadsId - summary: Get a Upload + summary: Get a File description: >- - Retrieve a upload by its ID. You can expand the upload's relations or select - the fields that should be returned. + Retrieve an uploaded file by its ID. You can expand the file's relations or + select the fields that should be returned. x-authenticated: true parameters: - name: id diff --git a/www/apps/api-reference/specs/admin/paths/admin_users.yaml b/www/apps/api-reference/specs/admin/paths/admin_users.yaml index 65b8918ad5..eb21679829 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users.yaml @@ -63,12 +63,12 @@ get: with `-`. - name: q in: query - description: The user's q. + description: The search term to filter the user's searchable properties. required: false schema: type: string title: q - description: The user's q. + description: The search term to filter the user's searchable properties. - name: id in: query required: false @@ -76,45 +76,45 @@ get: oneOf: - type: string title: id - description: The user's ID. + description: Filter by a user's ID. - type: array - description: The user's ID. + description: Filter by user IDs. items: type: string title: id - description: The id's ID. + description: A user's ID. - name: email in: query - description: The user's email. + description: Filter by an email. required: false schema: type: string title: email - description: The user's email. + description: Filter by an email. format: email - name: first_name in: query - description: The user's first name. + description: Filter by a first name. required: false schema: type: string title: first_name - description: The user's first name. + description: Filter by a first name. - name: last_name in: query - description: The user's last name. + description: Filter by a last name. required: false schema: type: string title: last_name - description: The user's last name. + description: Filter by a last name. - name: created_at in: query - description: The user's created at. + description: Filter by a user's creation date. required: false schema: type: object - description: The user's created at. + description: Filter by a user's creation date. properties: $and: type: array @@ -172,150 +172,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -393,11 +249,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The user's updated at. + description: Filter by a user's update date. required: false schema: type: object - description: The user's updated at. + description: Filter by a user's update date. properties: $and: type: array @@ -455,150 +311,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this @@ -676,11 +388,11 @@ get: description: Filter by whether a value for this parameter exists (not `null`). - name: deleted_at in: query - description: The user's deleted at. + description: Filter by a user's deletion date. required: false schema: type: object - description: The user's deleted at. + description: Filter by a user's deletion date. properties: $and: type: array @@ -738,150 +450,6 @@ get: 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 an exact match. - items: - type: string - title: $eq - description: Filter by 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: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $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: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $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 the conditions in this diff --git a/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml b/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml index 9793a3e63b..3afc2c6905 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml @@ -1,9 +1,7 @@ get: operationId: GetUsersMe - summary: List Users - description: >- - Retrieve a list of users. The users can be filtered by fields such as `id`. - The users can also be sorted or paginated. + summary: Get Logged-In User + description: Retrieve the logged-in user's details. x-authenticated: false parameters: - name: expand diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml index 502f17c599..7b383f8028 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml @@ -69,13 +69,13 @@ get: oneOf: - type: string title: transaction_id - description: The workflows execution's transaction id. + description: Filter by a transaction ID. - type: array - description: The workflows execution's transaction id. + description: Filter by transaction IDs. items: type: string title: transaction_id - description: The transaction id's details. + description: A transaction ID. - name: workflow_id in: query required: false @@ -83,13 +83,13 @@ get: oneOf: - type: string title: workflow_id - description: The workflows execution's workflow id. + description: Filter by a workflow ID. - type: array - description: The workflows execution's workflow id. + description: Filter by workflow IDs. items: type: string title: workflow_id - description: The workflow id's details. + description: A workflow ID. security: - api_token: [] - cookie_auth: [] @@ -109,7 +109,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of workflow executions. required: - limit - offset @@ -118,17 +118,19 @@ get: limit: type: number title: limit - description: The workflows execution's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The workflows execution's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The workflows execution's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of workflow executions. required: - workflow_executions properties: diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_subscribe.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_subscribe.yaml index 62d5318841..ebedacb189 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_subscribe.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_subscribe.yaml @@ -1,10 +1,14 @@ get: operationId: GetWorkflowsExecutionsWorkflow_idSubscribe - summary: List Subscribes - description: >- - Retrieve a list of subscribes in a workflows execution. The subscribes can - be filtered by fields like FILTER FIELDS. The subscribes can also be - paginated. + summary: Subscribe to a Workflow's Execution + x-sidebar-summary: Subscribe to Workflow + 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: - name: workflow_id @@ -26,6 +30,16 @@ get: tags: - Workflows Executions responses: + '200': + description: Stream of the step's status. + content: + text/event-stream: + schema: + type: string + description: The step's status update and data changes. + example: |- + event: success + data: {} '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}.yaml index a68c4a9789..5f6d620e7d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}.yaml @@ -1,9 +1,8 @@ get: operationId: GetWorkflowsExecutionsWorkflow_idTransaction_id - summary: 'List ' - description: >- - Retrieve a list of in a workflows execution. The can be filtered by fields - like FILTER FIELDS. The can also be paginated. + summary: Get Workflow Execution's Details + x-sidebar-summary: Get Exection + description: Get the details of the workflow's execution. x-authenticated: true parameters: - name: workflow_id diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}_{step_id}_subscribe.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}_{step_id}_subscribe.yaml index 6693f4007f..496908c22b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}_{step_id}_subscribe.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}_{step_id}_subscribe.yaml @@ -1,10 +1,14 @@ get: operationId: GetWorkflowsExecutionsWorkflow_idTransaction_idStep_idSubscribe - summary: List Subscribes - description: >- - Retrieve a list of subscribes in a workflows execution. The subscribes can - be filtered by fields like FILTER FIELDS. The subscribes can also be - paginated. + summary: Subscribe to Step of a Workflow's Execution + x-sidebar-summary: Subscribe to Step + 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: - name: workflow_id @@ -38,6 +42,16 @@ get: tags: - Workflows Executions responses: + '200': + description: Stream of the step's status. + content: + text/event-stream: + schema: + type: string + description: The step's status update and data changes. + example: |- + event: success + data: {} '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateInventoryItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateInventoryItem.yaml index a974fc3ee4..e5c490d22e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateInventoryItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateInventoryItem.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminCreateInventoryItem properties: sku: type: string @@ -56,4 +57,3 @@ properties: metadata: type: object description: The inventory item's metadata. -x-schemaName: AdminCreateInventoryItem diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductCategory.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductCategory.yaml index 35a28c81d9..19c2aa6d6e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductCategory.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductCategory.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminCreateProductCategory required: - name properties: @@ -27,11 +28,10 @@ properties: type: string title: parent_category_id description: The product category's parent category id. - metadata: - type: object - description: The product category's metadata. rank: type: number title: rank description: The product category's rank. -x-schemaName: AdminCreateProductCategory + metadata: + type: object + description: The product category's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductTag.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductTag.yaml index 18462a72a4..3c412794ab 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductTag.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductTag.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminCreateProductTag required: - value properties: @@ -10,4 +11,3 @@ properties: metadata: type: object description: The product tag's metadata. -x-schemaName: AdminCreateProductTag diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateRefundReason.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateRefundReason.yaml index 1cac026bcd..9add02da66 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateRefundReason.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateRefundReason.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminCreateRefundReason required: - label properties: @@ -11,4 +12,3 @@ properties: type: string title: description description: The refund reason's description. -x-schemaName: AdminCreateRefundReason diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateRegion.yaml index a25a942ec7..c7b2be7076 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateRegion.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminCreateRegion required: - name - currency_code @@ -23,6 +24,10 @@ properties: type: boolean title: automatic_taxes description: The region's automatic taxes. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The region's is tax inclusive. payment_providers: type: array description: The region's payment providers. @@ -33,8 +38,3 @@ properties: metadata: type: object description: The region's metadata. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The region's is tax inclusive. -x-schemaName: AdminCreateRegion diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateReservation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateReservation.yaml index 928e366407..bf02a07a9c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateReservation.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateReservation.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminCreateReservation required: - location_id - inventory_item_id @@ -28,4 +29,3 @@ properties: metadata: type: object description: The reservation's metadata. -x-schemaName: AdminCreateReservation diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml index 7d87bda7e1..f03625cdbf 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminCreateShippingOption required: - name - service_zone_id @@ -26,9 +27,10 @@ properties: description: The shipping option's data. price_type: type: string + description: The shipping option's price type. enum: - - calculated - flat + - calculated provider_id: type: string title: provider_id @@ -42,6 +44,7 @@ properties: oneOf: - type: object description: The price's prices. + x-schemaName: AdminCreateShippingOptionPriceWithCurrency required: - currency_code - amount @@ -56,6 +59,7 @@ properties: description: The price's amount. - type: object description: The price's prices. + x-schemaName: AdminCreateShippingOptionPriceWithRegion required: - region_id - amount @@ -73,4 +77,3 @@ properties: description: The shipping option's rules. items: $ref: ./AdminCreateShippingOptionRule.yaml -x-schemaName: AdminCreateShippingOption diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOptionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOptionRule.yaml index c974d26878..5fca721e07 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOptionRule.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOptionRule.yaml @@ -1,5 +1,6 @@ type: object description: The rule's rules. +x-schemaName: AdminCreateShippingOptionRule required: - operator - attribute @@ -7,14 +8,15 @@ required: properties: operator: type: string + description: The rule's operator. enum: - - in + - gt + - lt - eq - ne - - gt - - gte - - lt + - in - lte + - gte - nin attribute: type: string @@ -31,4 +33,3 @@ properties: type: string title: value description: The value's details. -x-schemaName: AdminCreateShippingOptionRule diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingProfile.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingProfile.yaml new file mode 100644 index 0000000000..221e02bf81 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingProfile.yaml @@ -0,0 +1,18 @@ +type: object +description: SUMMARY +required: + - name + - type +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. +x-schemaName: AdminCreateShippingProfile diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminDeletePaymentCollectionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminDeletePaymentCollectionResponse.yaml index 042dc95d6a..479fe851d6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminDeletePaymentCollectionResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminDeletePaymentCollectionResponse.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminDeletePaymentCollectionResponse required: - id - object @@ -12,10 +13,9 @@ properties: object: type: string title: object - description: The name of the deleted object. + description: SUMMARY default: payment-collection deleted: type: boolean title: deleted - description: Whether the payment collection was deleted. -x-schemaName: AdminDeletePaymentCollectionResponse + description: SUMMARY diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeDeleteResponse.yaml index 78d029950c..4fa416b52c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeDeleteResponse.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminExchangeDeleteResponse required: - id - object @@ -17,5 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the exchange was deleted. -x-schemaName: AdminExchangeDeleteResponse + description: Whether the Exchange was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSet.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSet.yaml index 3414f22b02..e9131c3f4a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSet.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSet.yaml @@ -1,5 +1,15 @@ type: object -description: The fulfillment set that the service zone belongs to. +description: The fulfillment set's parent. +x-schemaName: AdminFulfillmentSet +required: + - id + - name + - type + - location + - service_zones + - created_at + - updated_at + - deleted_at properties: id: type: string @@ -35,13 +45,3 @@ properties: format: date-time title: deleted_at description: The parent's deleted at. -required: - - id - - name - - type - - location - - service_zones - - created_at - - updated_at - - deleted_at -x-schemaName: AdminFulfillmentSet diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml index 5388547b61..6ea415b06d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml @@ -1,18 +1,18 @@ type: object -description: The product's variants. +description: SUMMARY x-schemaName: AdminProductVariantParams properties: q: type: string title: q - description: The variant's q. + description: The product's q. id: oneOf: - type: string title: id - description: The variant's ID. + description: The product's ID. - type: array - description: The variant's ID. + description: The product's ID. items: type: string title: id @@ -20,14 +20,14 @@ properties: manage_inventory: type: boolean title: manage_inventory - description: The variant's manage inventory. + description: The product's manage inventory. allow_backorder: type: boolean title: allow_backorder - description: The variant's allow backorder. + description: The product's allow backorder. created_at: type: object - description: The variant's created at. + description: The product's created at. properties: $and: type: array @@ -81,6 +81,150 @@ properties: description: Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of this + parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 the conditions in this parameter. items: @@ -154,7 +298,7 @@ properties: description: Filter by whether a value for this parameter exists (not `null`). updated_at: type: object - description: The variant's updated at. + description: The product's updated at. properties: $and: type: array @@ -208,6 +352,150 @@ properties: description: Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of this + parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 the conditions in this parameter. items: @@ -281,7 +569,7 @@ properties: description: Filter by whether a value for this parameter exists (not `null`). deleted_at: type: object - description: The variant's deleted at. + description: The product's deleted at. properties: $and: type: array @@ -335,6 +623,150 @@ properties: description: Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $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: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of this + parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 the conditions in this parameter. items: @@ -409,19 +841,19 @@ properties: limit: type: number title: limit - description: The variant's limit. + description: The product's limit. offset: type: number title: offset - description: The variant's offset. + description: The product's offset. order: type: string title: order - description: The variant's order. + description: The product's order. fields: type: string title: fields - description: The variant's fields. + description: The product's fields. $and: type: array description: >- diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonDeleteResponse.yaml index 78053ef89d..3743526610 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonDeleteResponse.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminReturnReasonDeleteResponse required: - id - object @@ -17,5 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the return reason was deleted. -x-schemaName: AdminReturnReasonDeleteResponse + description: Whether the Return Reason was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneDeleteResponse.yaml index 62609511c4..488b2b6081 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneDeleteResponse.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminServiceZoneDeleteResponse required: - id - object @@ -8,16 +9,14 @@ properties: id: type: string title: id - description: The service zone's ID. + description: The fulfillment set's ID. object: type: string title: object description: The name of the deleted object. - default: service_zone deleted: type: boolean title: deleted - description: Whether the service zone was deleted. + description: Whether the Fulfillment Set was deleted. parent: $ref: ./AdminFulfillmentSet.yaml -x-schemaName: AdminServiceZoneDeleteResponse diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCreatePaymentCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCreatePaymentCollection.yaml index f0f56b1048..c88dbe20d2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCreatePaymentCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCreatePaymentCollection.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: StoreCreatePaymentCollection required: - cart_id properties: @@ -7,4 +8,3 @@ properties: type: string title: cart_id description: The payment collection's cart id. -x-schemaName: StoreCreatePaymentCollection diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnItem.yaml index 839a17cf5c..021192cc25 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnItem.yaml @@ -1,5 +1,6 @@ type: object description: The item's items. +x-schemaName: StoreCreateReturnItem required: - id - quantity @@ -20,4 +21,3 @@ properties: type: string title: note description: The item's note. -x-schemaName: StoreCreateReturnItem diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnShipping.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnShipping.yaml index ad5ccf7fdc..ff842a7175 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnShipping.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnShipping.yaml @@ -1,5 +1,6 @@ type: object description: The return's return shipping. +x-schemaName: StoreCreateReturnShipping required: - option_id properties: @@ -11,4 +12,3 @@ properties: type: number title: price description: The return shipping's price. -x-schemaName: StoreCreateReturnShipping diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 7261625e58..9df62f3a88 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -9110,6 +9110,7 @@ components: AdminCreateInventoryItem: type: object description: SUMMARY + x-schemaName: AdminCreateInventoryItem properties: sku: type: string @@ -9166,7 +9167,6 @@ components: metadata: type: object description: The inventory item's metadata. - x-schemaName: AdminCreateInventoryItem AdminCreatePriceList: type: object description: SUMMARY @@ -9412,6 +9412,7 @@ components: AdminCreateProductCategory: type: object description: SUMMARY + x-schemaName: AdminCreateProductCategory required: - name properties: @@ -9439,14 +9440,13 @@ components: type: string title: parent_category_id description: The product category's parent category id. - metadata: - type: object - description: The product category's metadata. rank: type: number title: rank description: The product category's rank. - x-schemaName: AdminCreateProductCategory + metadata: + type: object + description: The product category's metadata. AdminCreateProductOption: type: object description: SUMMARY @@ -9469,6 +9469,7 @@ components: AdminCreateProductTag: type: object description: SUMMARY + x-schemaName: AdminCreateProductTag required: - value properties: @@ -9479,7 +9480,6 @@ components: metadata: type: object description: The product tag's metadata. - x-schemaName: AdminCreateProductTag AdminCreateProductVariant: type: object description: The create's details. @@ -9632,6 +9632,7 @@ components: AdminCreateRefundReason: type: object description: SUMMARY + x-schemaName: AdminCreateRefundReason required: - label properties: @@ -9643,10 +9644,10 @@ components: type: string title: description description: The refund reason's description. - x-schemaName: AdminCreateRefundReason AdminCreateRegion: type: object description: SUMMARY + x-schemaName: AdminCreateRegion required: - name - currency_code @@ -9670,6 +9671,10 @@ components: type: boolean title: automatic_taxes description: The region's automatic taxes. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The region's is tax inclusive. payment_providers: type: array description: The region's payment providers. @@ -9680,14 +9685,10 @@ components: metadata: type: object description: The region's metadata. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The region's is tax inclusive. - x-schemaName: AdminCreateRegion AdminCreateReservation: type: object description: SUMMARY + x-schemaName: AdminCreateReservation required: - location_id - inventory_item_id @@ -9716,7 +9717,6 @@ components: metadata: type: object description: The reservation's metadata. - x-schemaName: AdminCreateReservation AdminCreateSalesChannel: type: object description: SUMMARY @@ -9772,6 +9772,7 @@ components: AdminCreateShippingOption: type: object description: SUMMARY + x-schemaName: AdminCreateShippingOption required: - name - service_zone_id @@ -9798,9 +9799,10 @@ components: description: The shipping option's data. price_type: type: string + description: The shipping option's price type. enum: - - calculated - flat + - calculated provider_id: type: string title: provider_id @@ -9814,6 +9816,7 @@ components: oneOf: - type: object description: The price's prices. + x-schemaName: AdminCreateShippingOptionPriceWithCurrency required: - currency_code - amount @@ -9828,6 +9831,7 @@ components: description: The price's amount. - type: object description: The price's prices. + x-schemaName: AdminCreateShippingOptionPriceWithRegion required: - region_id - amount @@ -9845,10 +9849,10 @@ components: description: The shipping option's rules. items: $ref: '#/components/schemas/AdminCreateShippingOptionRule' - x-schemaName: AdminCreateShippingOption AdminCreateShippingOptionRule: type: object description: The rule's rules. + x-schemaName: AdminCreateShippingOptionRule required: - operator - attribute @@ -9856,14 +9860,15 @@ components: properties: operator: type: string + description: The rule's operator. enum: - - in + - gt + - lt - eq - ne - - gt - - gte - - lt + - in - lte + - gte - nin attribute: type: string @@ -9880,7 +9885,25 @@ components: type: string title: value description: The value's details. - x-schemaName: AdminCreateShippingOptionRule + AdminCreateShippingProfile: + type: object + description: SUMMARY + required: + - name + - type + 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. + x-schemaName: AdminCreateShippingProfile AdminCreateStockLocation: type: object description: SUMMARY @@ -10863,6 +10886,7 @@ components: AdminDeletePaymentCollectionResponse: type: object description: SUMMARY + x-schemaName: AdminDeletePaymentCollectionResponse required: - id - object @@ -10875,13 +10899,12 @@ components: object: type: string title: object - description: The name of the deleted object. + description: SUMMARY default: payment-collection deleted: type: boolean title: deleted - description: Whether the payment collection was deleted. - x-schemaName: AdminDeletePaymentCollectionResponse + description: SUMMARY AdminDraftOrderResponse: type: object description: SUMMARY @@ -11148,6 +11171,7 @@ components: AdminExchangeDeleteResponse: type: object description: SUMMARY + x-schemaName: AdminExchangeDeleteResponse required: - id - object @@ -11165,8 +11189,7 @@ components: deleted: type: boolean title: deleted - description: Whether the exchange was deleted. - x-schemaName: AdminExchangeDeleteResponse + description: Whether the Exchange was deleted. AdminExchangeOrderResponse: type: object description: SUMMARY @@ -11612,7 +11635,17 @@ components: $ref: '#/components/schemas/AdminFulfillment' AdminFulfillmentSet: type: object - description: The fulfillment set that the service zone belongs to. + description: The fulfillment set's parent. + x-schemaName: AdminFulfillmentSet + required: + - id + - name + - type + - location + - service_zones + - created_at + - updated_at + - deleted_at properties: id: type: string @@ -11648,16 +11681,6 @@ components: format: date-time title: deleted_at description: The parent's deleted at. - required: - - id - - name - - type - - location - - service_zones - - created_at - - updated_at - - deleted_at - x-schemaName: AdminFulfillmentSet AdminFulfillmentSetDeleteResponse: type: object description: SUMMARY @@ -15394,20 +15417,20 @@ components: $ref: '#/components/schemas/AdminProductVariant' AdminProductVariantParams: type: object - description: The product's variants. + description: SUMMARY x-schemaName: AdminProductVariantParams properties: q: type: string title: q - description: The variant's q. + description: The product's q. id: oneOf: - type: string title: id - description: The variant's ID. + description: The product's ID. - type: array - description: The variant's ID. + description: The product's ID. items: type: string title: id @@ -15415,14 +15438,14 @@ components: manage_inventory: type: boolean title: manage_inventory - description: The variant's manage inventory. + description: The product's manage inventory. allow_backorder: type: boolean title: allow_backorder - description: The variant's allow backorder. + description: The product's allow backorder. created_at: type: object - description: The variant's created at. + description: The product's created at. properties: $and: type: array @@ -15472,6 +15495,118 @@ components: description: Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 the conditions in this parameter. items: @@ -15537,7 +15672,7 @@ components: description: Filter by whether a value for this parameter exists (not `null`). updated_at: type: object - description: The variant's updated at. + description: The product's updated at. properties: $and: type: array @@ -15587,6 +15722,118 @@ components: description: Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 the conditions in this parameter. items: @@ -15652,7 +15899,7 @@ components: description: Filter by whether a value for this parameter exists (not `null`). deleted_at: type: object - description: The variant's deleted at. + description: The product's deleted at. properties: $and: type: array @@ -15702,6 +15949,118 @@ components: description: Filter by values not matching the conditions in 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 an exact match. + items: + type: string + title: $eq + description: Filter by 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: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $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: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $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 the conditions in this parameter. items: @@ -15768,19 +16127,19 @@ components: limit: type: number title: limit - description: The variant's limit. + description: The product's limit. offset: type: number title: offset - description: The variant's offset. + description: The product's offset. order: type: string title: order - description: The variant's order. + description: The product's order. fields: type: string title: fields - description: The variant's fields. + description: The product's fields. $and: type: array description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. @@ -16232,6 +16591,7 @@ components: AdminReturnReasonDeleteResponse: type: object description: SUMMARY + x-schemaName: AdminReturnReasonDeleteResponse required: - id - object @@ -16249,8 +16609,7 @@ components: deleted: type: boolean title: deleted - description: Whether the return reason was deleted. - x-schemaName: AdminReturnReasonDeleteResponse + description: Whether the Return Reason was deleted. AdminReturnReasonListResponse: type: object description: SUMMARY @@ -16504,6 +16863,7 @@ components: AdminServiceZoneDeleteResponse: type: object description: SUMMARY + x-schemaName: AdminServiceZoneDeleteResponse required: - id - object @@ -16512,19 +16872,17 @@ components: id: type: string title: id - description: The service zone's ID. + description: The fulfillment set's ID. object: type: string title: object description: The name of the deleted object. - default: service_zone deleted: type: boolean title: deleted - description: Whether the service zone was deleted. + description: Whether the Fulfillment Set was deleted. parent: $ref: '#/components/schemas/AdminFulfillmentSet' - x-schemaName: AdminServiceZoneDeleteResponse AdminServiceZoneResponse: type: object description: SUMMARY @@ -24024,6 +24382,7 @@ components: StoreCreatePaymentCollection: type: object description: SUMMARY + x-schemaName: StoreCreatePaymentCollection required: - cart_id properties: @@ -24031,7 +24390,6 @@ components: type: string title: cart_id description: The payment collection's cart id. - x-schemaName: StoreCreatePaymentCollection StoreCreateReturn: type: object description: SUMMARY @@ -24067,6 +24425,7 @@ components: StoreCreateReturnItem: type: object description: The item's items. + x-schemaName: StoreCreateReturnItem required: - id - quantity @@ -24087,10 +24446,10 @@ components: type: string title: note description: The item's note. - x-schemaName: StoreCreateReturnItem StoreCreateReturnShipping: type: object description: The return's return shipping. + x-schemaName: StoreCreateReturnShipping required: - option_id properties: @@ -24102,7 +24461,6 @@ components: type: number title: price description: The return shipping's price. - x-schemaName: StoreCreateReturnShipping StoreCurrency: type: object description: The currency's details. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts index f824c539d9..436d01f1f8 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts index b9736bbacf..665d688af6 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts index e2f509c095..f0d613cf54 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts @@ -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. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts index 851871939e..4fccfbd76a 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts index 1d2ad0f56c..48040ac177 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts index c862081d3d..3296014ad6 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts index 0f2eea359e..07d2b14da1 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts index 02fd8e9be4..a32a04204f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts @@ -362,6 +362,8 @@ * type: string * title: location_id * description: A location's ID. + * required: + * - location_id * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts index fa42da610a..ac7359e257 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts b/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts index c48a8f1489..d4db0a7cc6 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts @@ -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: diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts b/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts index d67f6b3cf9..9bf94c8a2d 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts index 391b512c34..2277fed1a1 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts index a8356000d4..1c97e34ff3 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts @@ -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: diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts b/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts index c629aabe5e..da562f2339 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts @@ -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: diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts index aee7c5a663..95f69ed983 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts index a2b16b38a3..bb3542b162 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts @@ -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: diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts index ab39646b60..990af1331b 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts @@ -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: diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts index 3e2ad297ed..d498ee44e1 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts @@ -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: diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts index 6cb9e0699e..e237cd9fcd 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts @@ -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: diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts index efa138e1f0..89d842bd23 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts index 8f38ce3080..184e4c8e22 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts b/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts index 16288001d0..dfa13adf6c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts @@ -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. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts b/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts index 61fad04cdd..7dfbde38b2 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts index 767c9b45d5..9875e4291e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts @@ -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: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts index 072aea5393..164a92eadc 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts @@ -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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts index 846818a3e6..5b525e426a 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts @@ -123,7 +123,6 @@ * enum: * - "true" * - "false" - * title: is_default * - name: created_at * in: query * description: Filter by a tax rate's creation date. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts index 88c03746d7..5eacdb63a6 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts @@ -253,9 +253,9 @@ * oneOf: * - type: string * title: created_by - * description: Filter by the ID of the user to retrieve the tax regions they created. + * description: Filter by the ID of the user to retrieve the tax regions they created. * - type: array - * description: Filter by user IDs to retrieve their tax regions they created. + * description: Filter by user IDs to retrieve their tax regions they created. * items: * type: string * title: created_by @@ -265,358 +265,706 @@ * description: Filter by a tax region's creation date. * required: false * schema: - * type: object - * description: Filter by a tax region'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 an exact match. + * oneOf: + * - type: string + * title: created_at + * description: Filter by a tax region's creation date. + * - type: object + * description: Apply filters on the tax region'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 an exact match. + * items: + * type: string + * title: $eq + * description: Filter by 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: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. + * title: $in + * description: Filter by values in this array. + * $nin: + * type: array + * description: Filter by values not in this array. * items: * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). + * title: $nin + * description: Filter by values not in this array. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching the conditions in 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 an exact match. + * items: + * type: string + * title: $eq + * description: Filter by 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: Filter by values in this array. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: Filter by values not in this array. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the conditions in this parameter. + * items: + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * $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: Filter arrays that have overlapping values with this parameter. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: Filter arrays that contain some of the values of this parameter. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: Filter arrays that contain all values of this parameter. + * $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 the conditions in this parameter. + * items: + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * $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: Filter arrays that have overlapping values with this parameter. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: Filter arrays that contain some of the values of this parameter. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: Filter arrays that contain all values of this parameter. + * $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 a tax region's update date. * required: false * schema: - * type: object - * description: Filter by a tax region'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 an exact match. + * oneOf: + * - type: string + * title: updated_at + * description: Filter by a tax region's update date. + * - type: object + * description: Apply filters on the tax region'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 an exact match. + * items: + * type: string + * title: $eq + * description: Filter by 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: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. + * title: $in + * description: Filter by values in this array. + * $nin: + * type: array + * description: Filter by values not in this array. * items: * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). + * title: $nin + * description: Filter by values not in this array. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching the conditions in 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 an exact match. + * items: + * type: string + * title: $eq + * description: Filter by 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: Filter by values in this array. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: Filter by values not in this array. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the conditions in this parameter. + * items: + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * $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: Filter arrays that have overlapping values with this parameter. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: Filter arrays that contain some of the values of this parameter. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: Filter arrays that contain all values of this parameter. + * $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 the conditions in this parameter. + * items: + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * $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: Filter arrays that have overlapping values with this parameter. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: Filter arrays that contain some of the values of this parameter. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: Filter arrays that contain all values of this parameter. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). * - name: deleted_at * in: query * description: Filter by a tax region's deletion date. * required: false * schema: - * type: object - * description: Filter by a tax region's deletion 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 an exact match. + * oneOf: + * - type: string + * title: deleted_at + * description: Filter by a tax region's deletion date. + * - type: object + * description: Apply filters on the tax region's deletion 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 an exact match. + * items: + * type: string + * title: $eq + * description: Filter by 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: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. + * title: $in + * description: Filter by values in this array. + * $nin: + * type: array + * description: Filter by values not in this array. * items: * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). + * title: $nin + * description: Filter by values not in this array. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching the conditions in 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 an exact match. + * items: + * type: string + * title: $eq + * description: Filter by 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: Filter by values in this array. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: Filter by values not in this array. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the conditions in this parameter. + * items: + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * $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: Filter arrays that have overlapping values with this parameter. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: Filter arrays that contain some of the values of this parameter. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: Filter arrays that contain all values of this parameter. + * $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 the conditions in this parameter. + * items: + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * $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: Filter arrays that have overlapping values with this parameter. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: Filter arrays that contain some of the values of this parameter. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: Filter arrays that contain all values of this parameter. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts index 8882f086cc..bef4f1a00c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts @@ -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": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts index e6fad6fe9d..ed11a06bac 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts @@ -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": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts index e43cdc2311..d1025e6dbb 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts @@ -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 diff --git a/www/utils/generated/oas-output/schemas/AdminCreateInventoryItem.ts b/www/utils/generated/oas-output/schemas/AdminCreateInventoryItem.ts index f96c602801..56d506cf2c 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateInventoryItem.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateInventoryItem.ts @@ -2,6 +2,7 @@ * @schema AdminCreateInventoryItem * type: object * description: SUMMARY + * x-schemaName: AdminCreateInventoryItem * properties: * sku: * type: string @@ -58,7 +59,6 @@ * metadata: * type: object * description: The inventory item's metadata. - * x-schemaName: AdminCreateInventoryItem * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateProductCategory.ts b/www/utils/generated/oas-output/schemas/AdminCreateProductCategory.ts index 2008979b54..ad7fd50538 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateProductCategory.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateProductCategory.ts @@ -2,6 +2,7 @@ * @schema AdminCreateProductCategory * type: object * description: SUMMARY + * x-schemaName: AdminCreateProductCategory * required: * - name * properties: @@ -29,14 +30,13 @@ * type: string * title: parent_category_id * description: The product category's parent category id. - * metadata: - * type: object - * description: The product category's metadata. * rank: * type: number * title: rank * description: The product category's rank. - * x-schemaName: AdminCreateProductCategory + * metadata: + * type: object + * description: The product category's metadata. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateProductTag.ts b/www/utils/generated/oas-output/schemas/AdminCreateProductTag.ts index b6db4905c4..162fdc0d2f 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateProductTag.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateProductTag.ts @@ -2,6 +2,7 @@ * @schema AdminCreateProductTag * type: object * description: SUMMARY + * x-schemaName: AdminCreateProductTag * required: * - value * properties: @@ -12,7 +13,6 @@ * metadata: * type: object * description: The product tag's metadata. - * x-schemaName: AdminCreateProductTag * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateRefundReason.ts b/www/utils/generated/oas-output/schemas/AdminCreateRefundReason.ts index 60c814919a..74a26a69d8 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateRefundReason.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateRefundReason.ts @@ -2,6 +2,7 @@ * @schema AdminCreateRefundReason * type: object * description: SUMMARY + * x-schemaName: AdminCreateRefundReason * required: * - label * properties: @@ -13,7 +14,6 @@ * type: string * title: description * description: The refund reason's description. - * x-schemaName: AdminCreateRefundReason * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateRegion.ts b/www/utils/generated/oas-output/schemas/AdminCreateRegion.ts index 1b23e04c65..5f94b90176 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateRegion.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateRegion.ts @@ -2,6 +2,7 @@ * @schema AdminCreateRegion * type: object * description: SUMMARY + * x-schemaName: AdminCreateRegion * required: * - name * - currency_code @@ -25,6 +26,10 @@ * type: boolean * title: automatic_taxes * description: The region's automatic taxes. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The region's is tax inclusive. * payment_providers: * type: array * description: The region's payment providers. @@ -35,11 +40,6 @@ * metadata: * type: object * description: The region's metadata. - * is_tax_inclusive: - * type: boolean - * title: is_tax_inclusive - * description: The region's is tax inclusive. - * x-schemaName: AdminCreateRegion * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateReservation.ts b/www/utils/generated/oas-output/schemas/AdminCreateReservation.ts index 40c688f9ce..b2aba5d6ab 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateReservation.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateReservation.ts @@ -2,6 +2,7 @@ * @schema AdminCreateReservation * type: object * description: SUMMARY + * x-schemaName: AdminCreateReservation * required: * - location_id * - inventory_item_id @@ -30,7 +31,6 @@ * metadata: * type: object * description: The reservation's metadata. - * x-schemaName: AdminCreateReservation * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts b/www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts index 2f910e7f67..0f95411fa1 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts @@ -2,6 +2,7 @@ * @schema AdminCreateShippingOption * type: object * description: SUMMARY + * x-schemaName: AdminCreateShippingOption * required: * - name * - service_zone_id @@ -28,9 +29,10 @@ * description: The shipping option's data. * price_type: * type: string + * description: The shipping option's price type. * enum: - * - calculated * - flat + * - calculated * provider_id: * type: string * title: provider_id @@ -44,6 +46,7 @@ * oneOf: * - type: object * description: The price's prices. + * x-schemaName: AdminCreateShippingOptionPriceWithCurrency * required: * - currency_code * - amount @@ -58,6 +61,7 @@ * description: The price's amount. * - type: object * description: The price's prices. + * x-schemaName: AdminCreateShippingOptionPriceWithRegion * required: * - region_id * - amount @@ -75,7 +79,6 @@ * description: The shipping option's rules. * items: * $ref: "#/components/schemas/AdminCreateShippingOptionRule" - * x-schemaName: AdminCreateShippingOption * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateShippingOptionRule.ts b/www/utils/generated/oas-output/schemas/AdminCreateShippingOptionRule.ts index 25e7712f65..e1fad25b4a 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateShippingOptionRule.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateShippingOptionRule.ts @@ -2,6 +2,7 @@ * @schema AdminCreateShippingOptionRule * type: object * description: The rule's rules. + * x-schemaName: AdminCreateShippingOptionRule * required: * - operator * - attribute @@ -9,14 +10,15 @@ * properties: * operator: * type: string + * description: The rule's operator. * enum: - * - in + * - gt + * - lt * - eq * - ne - * - gt - * - gte - * - lt + * - in * - lte + * - gte * - nin * attribute: * type: string @@ -33,7 +35,6 @@ * type: string * title: value * description: The value's details. - * x-schemaName: AdminCreateShippingOptionRule * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateShippingProfile.ts b/www/utils/generated/oas-output/schemas/AdminCreateShippingProfile.ts new file mode 100644 index 0000000000..9f10c2856d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateShippingProfile.ts @@ -0,0 +1,23 @@ +/** + * @schema AdminCreateShippingProfile + * type: object + * description: SUMMARY + * required: + * - name + * - type + * 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. + * x-schemaName: AdminCreateShippingProfile + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCustomerAddressFilters.ts b/www/utils/generated/oas-output/schemas/AdminCustomerAddressFilters.ts deleted file mode 100644 index 06d9b1e10f..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminCustomerAddressFilters.ts +++ /dev/null @@ -1,80 +0,0 @@ -/** - * @schema AdminCustomerAddressFilters - * type: object - * description: SUMMARY - * x-schemaName: AdminCustomerAddressFilters - * properties: - * q: - * type: string - * title: q - * description: The customer's q. - * company: - * oneOf: - * - type: string - * title: company - * description: The customer's company. - * - type: array - * description: The customer's company. - * items: - * type: string - * title: company - * description: The company's details. - * city: - * oneOf: - * - type: string - * title: city - * description: The customer's city. - * - type: array - * description: The customer's city. - * items: - * type: string - * title: city - * description: The city's details. - * country_code: - * oneOf: - * - type: string - * title: country_code - * description: The customer's country code. - * - type: array - * description: The customer's country code. - * items: - * type: string - * title: country_code - * description: The country code's details. - * province: - * oneOf: - * - type: string - * title: province - * description: The customer's province. - * - type: array - * description: The customer's province. - * items: - * type: string - * title: province - * description: The province's details. - * postal_code: - * oneOf: - * - type: string - * title: postal_code - * description: The customer's postal code. - * - type: array - * description: The customer's postal code. - * items: - * type: string - * title: postal_code - * description: The postal code's details. - * $and: - * type: array - * description: The customer's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The customer's $or. - * items: - * type: object - * title: $or - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminCustomerFilters.ts b/www/utils/generated/oas-output/schemas/AdminCustomerFilters.ts deleted file mode 100644 index 5a3ee5a645..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminCustomerFilters.ts +++ /dev/null @@ -1,2327 +0,0 @@ -/** - * @schema AdminCustomerFilters - * type: object - * description: SUMMARY - * x-schemaName: AdminCustomerFilters - * required: - * - groups - * properties: - * groups: - * oneOf: - * - type: string - * title: groups - * description: The customer's groups. - * - $ref: "#/components/schemas/CustomerGroupInCustomerFilters" - * - type: array - * description: The customer's groups. - * items: - * type: string - * title: groups - * description: The group's groups. - * q: - * type: string - * title: q - * description: The customer's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The customer's ID. - * - type: array - * description: The customer's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * - type: object - * description: The customer's ID. - * properties: - * $and: - * type: array - * description: The id's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The id's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by an exact match. - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: Filter by values not equal to this parameter. - * - type: array - * description: Filter by values not equal to this parameter. - * items: - * type: string - * title: $ne - * description: Filter by values not equal to this parameter. - * $in: - * type: array - * description: Filter by values in this array. - * items: - * oneOf: - * - type: string - * title: $in - * description: Filter by values in this array. - * - type: array - * description: Filter by values in this array. - * items: - * type: string - * title: $in - * description: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * oneOf: - * - type: string - * title: $nin - * description: Filter by values not in this array. - * - type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: Filter by values greater than this parameter. Useful for numbers and dates only. - * - type: array - * description: Filter by values greater than this parameter. Useful for numbers and dates only. - * items: - * type: string - * title: $gt - * description: Filter by values greater than this parameter. Useful for numbers and dates only. - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - * - type: array - * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - * items: - * type: string - * title: $gte - * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: Filter by values less than this parameter. Useful for numbers and dates only. - * - type: array - * description: Filter by values less than this parameter. Useful for numbers and dates only. - * items: - * type: string - * title: $lt - * description: Filter by values less than this parameter. Useful for numbers and dates only. - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - * - type: array - * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - * items: - * 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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * email: - * oneOf: - * - type: string - * title: email - * description: The customer's email. - * format: email - * - type: array - * description: The customer's email. - * items: - * type: string - * title: email - * description: The email's details. - * format: email - * - type: object - * description: The customer's email. - * properties: - * $and: - * type: array - * description: The email's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The email's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * company_name: - * oneOf: - * - type: string - * title: company_name - * description: The customer's company name. - * - type: array - * description: The customer's company name. - * items: - * type: string - * title: company_name - * description: The company name's details. - * - type: object - * description: The customer's company name. - * properties: - * $and: - * type: array - * description: The company name's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The company name's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * first_name: - * oneOf: - * - type: string - * title: first_name - * description: The customer's first name. - * - type: array - * description: The customer's first name. - * items: - * type: string - * title: first_name - * description: The first name's details. - * - type: object - * description: The customer's first name. - * properties: - * $and: - * type: array - * description: The first name's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The first name's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * last_name: - * oneOf: - * - type: string - * title: last_name - * description: The customer's last name. - * - type: array - * description: The customer's last name. - * items: - * type: string - * title: last_name - * description: The last name's details. - * - type: object - * description: The customer's last name. - * properties: - * $and: - * type: array - * description: The last name's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The last name's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * created_by: - * oneOf: - * - type: string - * title: created_by - * description: The customer's created by. - * - type: array - * description: The customer's created by. - * items: - * type: string - * title: created_by - * description: The created by's details. - * - type: object - * description: The customer's created by. - * properties: - * $and: - * type: array - * description: The created by's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The created by's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * created_at: - * type: object - * description: The customer's created at. - * properties: - * $and: - * type: array - * description: The created at's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The created at's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * updated_at: - * type: object - * description: The customer's updated at. - * properties: - * $and: - * type: array - * description: The updated at's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The updated at's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * deleted_at: - * type: object - * description: The customer's deleted at. - * properties: - * $and: - * type: array - * description: The deleted at's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The deleted at's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * $and: - * type: array - * description: The customer's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The customer's $or. - * items: - * type: object - * title: $or - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminCustomerInGroupFilters.ts b/www/utils/generated/oas-output/schemas/AdminCustomerInGroupFilters.ts index daa15be9d9..bea4e2b647 100644 --- a/www/utils/generated/oas-output/schemas/AdminCustomerInGroupFilters.ts +++ b/www/utils/generated/oas-output/schemas/AdminCustomerInGroupFilters.ts @@ -33,13 +33,13 @@ * properties: * $and: * type: array - * description: The email's $and. + * 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: The email's $or. + * 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 @@ -214,13 +214,13 @@ * properties: * $and: * type: array - * description: The created at's $and. + * 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: The created at's $or. + * 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 @@ -329,13 +329,13 @@ * properties: * $and: * type: array - * description: The updated at's $and. + * 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: The updated at's $or. + * 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 @@ -444,13 +444,13 @@ * properties: * $and: * type: array - * description: The deleted at's $and. + * 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: The deleted at's $or. + * 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 diff --git a/www/utils/generated/oas-output/schemas/AdminDeletePaymentCollectionResponse.ts b/www/utils/generated/oas-output/schemas/AdminDeletePaymentCollectionResponse.ts index 783f717e13..e28293d167 100644 --- a/www/utils/generated/oas-output/schemas/AdminDeletePaymentCollectionResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminDeletePaymentCollectionResponse.ts @@ -2,6 +2,7 @@ * @schema AdminDeletePaymentCollectionResponse * type: object * description: SUMMARY + * x-schemaName: AdminDeletePaymentCollectionResponse * required: * - id * - object @@ -14,13 +15,12 @@ * object: * type: string * title: object - * description: The name of the deleted object. + * description: SUMMARY * default: payment-collection * deleted: * type: boolean * title: deleted - * description: Whether the payment collection was deleted. - * x-schemaName: AdminDeletePaymentCollectionResponse + * description: SUMMARY * */ diff --git a/www/utils/generated/oas-output/schemas/AdminExchangeDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminExchangeDeleteResponse.ts index 58055997dc..575d2bbab6 100644 --- a/www/utils/generated/oas-output/schemas/AdminExchangeDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminExchangeDeleteResponse.ts @@ -2,6 +2,7 @@ * @schema AdminExchangeDeleteResponse * type: object * description: SUMMARY + * x-schemaName: AdminExchangeDeleteResponse * required: * - id * - object @@ -19,8 +20,7 @@ * deleted: * type: boolean * title: deleted - * description: Whether the exchange was deleted. - * x-schemaName: AdminExchangeDeleteResponse + * description: Whether the Exchange was deleted. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminExchangeListParams.ts b/www/utils/generated/oas-output/schemas/AdminExchangeListParams.ts deleted file mode 100644 index 51ecc1e6e2..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminExchangeListParams.ts +++ /dev/null @@ -1,755 +0,0 @@ -/** - * @schema AdminExchangeListParams - * type: object - * description: SUMMARY - * x-schemaName: AdminExchangeListParams - * properties: - * deleted_at: - * type: object - * description: The exchange's deleted at. - * properties: - * $and: - * type: array - * description: The deleted at's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The deleted at's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * q: - * type: string - * title: q - * description: The exchange's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The exchange's ID. - * - type: array - * description: The exchange's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * order_id: - * oneOf: - * - type: string - * title: order_id - * description: The exchange's order id. - * - type: array - * description: The exchange's order id. - * items: - * type: string - * title: order_id - * description: The order id's details. - * status: - * oneOf: - * - type: string - * title: status - * description: The exchange's status. - * - type: array - * description: The exchange's status. - * items: - * type: string - * title: status - * description: The status's details. - * created_at: - * type: object - * description: The exchange's created at. - * properties: - * $and: - * type: array - * description: The created at's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The created at's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * updated_at: - * type: object - * description: The exchange's updated at. - * properties: - * $and: - * type: array - * description: The updated at's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The updated at's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * limit: - * type: number - * title: limit - * description: The exchange's limit. - * offset: - * type: number - * title: offset - * description: The exchange's offset. - * order: - * type: string - * title: order - * description: The exchange's order. - * fields: - * type: string - * title: fields - * description: The exchange's fields. - * $and: - * type: array - * description: The exchange's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The exchange's $or. - * items: - * type: object - * title: $or - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentSet.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentSet.ts index 78a02e7e59..4bda16271e 100644 --- a/www/utils/generated/oas-output/schemas/AdminFulfillmentSet.ts +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentSet.ts @@ -1,7 +1,17 @@ /** * @schema AdminFulfillmentSet * type: object - * description: The fulfillment set that the service zone belongs to. + * description: The fulfillment set's parent. + * x-schemaName: AdminFulfillmentSet + * required: + * - id + * - name + * - type + * - location + * - service_zones + * - created_at + * - updated_at + * - deleted_at * properties: * id: * type: string @@ -37,16 +47,6 @@ * format: date-time * title: deleted_at * description: The parent's deleted at. - * required: - * - id - * - name - * - type - * - location - * - service_zones - * - created_at - * - updated_at - * - deleted_at - * x-schemaName: AdminFulfillmentSet * */ diff --git a/www/utils/generated/oas-output/schemas/AdminGetCustomerGroupsParams.ts b/www/utils/generated/oas-output/schemas/AdminGetCustomerGroupsParams.ts deleted file mode 100644 index 0d4baf1981..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminGetCustomerGroupsParams.ts +++ /dev/null @@ -1,759 +0,0 @@ -/** - * @schema AdminGetCustomerGroupsParams - * type: object - * description: SUMMARY - * x-schemaName: AdminGetCustomerGroupsParams - * properties: - * limit: - * type: number - * title: limit - * description: The customer group's limit. - * offset: - * type: number - * title: offset - * description: The customer group's offset. - * q: - * type: string - * title: q - * description: The customer group's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The customer group's ID. - * - type: array - * description: The customer group's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * name: - * oneOf: - * - type: string - * title: name - * description: The customer group's name. - * - type: array - * description: The customer group's name. - * items: - * type: string - * title: name - * description: The name's details. - * customers: - * oneOf: - * - type: string - * title: customers - * description: The customer group's customers. - * - type: array - * description: The customer group's customers. - * items: - * type: string - * title: customers - * description: The customer's customers. - * - $ref: "#/components/schemas/AdminCustomerInGroupFilters" - * created_by: - * oneOf: - * - type: string - * title: created_by - * description: The customer group's created by. - * - type: array - * description: The customer group's created by. - * items: - * type: string - * title: created_by - * description: The created by's details. - * created_at: - * type: object - * description: The customer group's created at. - * properties: - * $and: - * type: array - * description: The created at's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The created at's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * updated_at: - * type: object - * description: The customer group's updated at. - * properties: - * $and: - * type: array - * description: The updated at's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The updated at's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * deleted_at: - * type: object - * description: The customer group's deleted at. - * properties: - * $and: - * type: array - * description: The deleted at's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The deleted at's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * $and: - * type: array - * description: The customer group's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The customer group's $or. - * items: - * type: object - * title: $or - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminGetPromotionRuleParams.ts b/www/utils/generated/oas-output/schemas/AdminGetPromotionRuleParams.ts deleted file mode 100644 index 2254769b61..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminGetPromotionRuleParams.ts +++ /dev/null @@ -1,17 +0,0 @@ -/** - * @schema AdminGetPromotionRuleParams - * type: object - * description: SUMMARY - * x-schemaName: AdminGetPromotionRuleParams - * properties: - * promotion_type: - * type: string - * title: promotion_type - * description: The promotion's promotion type. - * application_method_type: - * type: string - * title: application_method_type - * description: The promotion's application method type. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminOrderFilters.ts b/www/utils/generated/oas-output/schemas/AdminOrderFilters.ts deleted file mode 100644 index 0efc3a2632..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminOrderFilters.ts +++ /dev/null @@ -1,59 +0,0 @@ -/** - * @schema AdminOrderFilters - * type: object - * description: SUMMARY - * x-schemaName: AdminOrderFilters - * properties: - * id: - * oneOf: - * - type: string - * title: id - * description: The return's ID. - * - type: array - * description: The return's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * name: - * oneOf: - * - type: string - * title: name - * description: The return's name. - * - type: array - * description: The return's name. - * items: - * type: string - * title: name - * description: The name's details. - * limit: - * type: number - * title: limit - * description: The return's limit. - * offset: - * type: number - * title: offset - * description: The return's offset. - * order: - * type: string - * title: order - * description: The return's order. - * fields: - * type: string - * title: fields - * description: The return's fields. - * $and: - * type: array - * description: The return's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The return's $or. - * items: - * type: object - * title: $or - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminPriceListListParams.ts b/www/utils/generated/oas-output/schemas/AdminPriceListListParams.ts deleted file mode 100644 index ef8e8c31df..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminPriceListListParams.ts +++ /dev/null @@ -1,522 +0,0 @@ -/** - * @schema AdminPriceListListParams - * type: object - * description: SUMMARY - * x-schemaName: AdminPriceListListParams - * properties: - * q: - * type: string - * title: q - * description: The price list's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The price list's ID. - * - type: array - * description: The price list's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * starts_at: - * type: object - * description: The price list's starts at. - * properties: - * $and: - * type: array - * description: The starts at's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The starts at's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * ends_at: - * type: object - * description: The price list's ends at. - * properties: - * $and: - * type: array - * description: The ends at's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The ends at's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * status: - * type: array - * description: The price list's status. - * items: - * type: string - * description: The status's details. - * enum: - * - active - * - draft - * rules_count: - * type: array - * description: The price list's rules count. - * items: - * type: number - * title: rules_count - * description: The rules count's details. - * limit: - * type: number - * title: limit - * description: The price list's limit. - * offset: - * type: number - * title: offset - * description: The price list's offset. - * order: - * type: string - * title: order - * description: The price list's order. - * fields: - * type: string - * title: fields - * description: The price list's fields. - * $and: - * type: array - * description: The price list's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The price list's $or. - * items: - * type: object - * title: $or - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminPricePreferenceListParams.ts b/www/utils/generated/oas-output/schemas/AdminPricePreferenceListParams.ts deleted file mode 100644 index e3d3485b63..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminPricePreferenceListParams.ts +++ /dev/null @@ -1,74 +0,0 @@ -/** - * @schema AdminPricePreferenceListParams - * type: object - * description: SUMMARY - * x-schemaName: AdminPricePreferenceListParams - * properties: - * id: - * oneOf: - * - type: string - * title: id - * description: The price preference's ID. - * - type: array - * description: The price preference's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * attribute: - * oneOf: - * - type: string - * title: attribute - * description: The price preference's attribute. - * - type: array - * description: The price preference's attribute. - * items: - * type: string - * title: attribute - * description: The attribute's details. - * value: - * oneOf: - * - type: string - * title: value - * description: The price preference's value. - * - type: array - * description: The price preference's value. - * items: - * type: string - * title: value - * description: The value's details. - * q: - * type: string - * title: q - * description: The price preference's q. - * limit: - * type: number - * title: limit - * description: The price preference's limit. - * offset: - * type: number - * title: offset - * description: The price preference's offset. - * order: - * type: string - * title: order - * description: The price preference's order. - * fields: - * type: string - * title: fields - * description: The price preference's fields. - * $and: - * type: array - * description: The price preference's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The price preference's $or. - * items: - * type: object - * title: $or - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts b/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts index 3775971bbb..aa52bc804c 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts @@ -1,20 +1,20 @@ /** * @schema AdminProductVariantParams * type: object - * description: The product's variants. + * description: SUMMARY * x-schemaName: AdminProductVariantParams * properties: * q: * type: string * title: q - * description: The variant's q. + * description: The product's q. * id: * oneOf: * - type: string * title: id - * description: The variant's ID. + * description: The product's ID. * - type: array - * description: The variant's ID. + * description: The product's ID. * items: * type: string * title: id @@ -22,14 +22,14 @@ * manage_inventory: * type: boolean * title: manage_inventory - * description: The variant's manage inventory. + * description: The product's manage inventory. * allow_backorder: * type: boolean * title: allow_backorder - * description: The variant's allow backorder. + * description: The product's allow backorder. * created_at: * type: object - * description: The variant's created at. + * description: The product's created at. * properties: * $and: * type: array @@ -79,6 +79,118 @@ * description: Filter by values not matching the conditions in 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 an exact match. + * items: + * type: string + * title: $eq + * description: Filter by 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: Filter by values in this array. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: Filter by values not in this array. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the conditions in this parameter. + * items: + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * $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: Filter arrays that have overlapping values with this parameter. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: Filter arrays that contain some of the values of this parameter. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: Filter arrays that contain all values of this parameter. + * $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 the conditions in this parameter. * items: @@ -144,7 +256,7 @@ * description: Filter by whether a value for this parameter exists (not `null`). * updated_at: * type: object - * description: The variant's updated at. + * description: The product's updated at. * properties: * $and: * type: array @@ -194,6 +306,118 @@ * description: Filter by values not matching the conditions in 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 an exact match. + * items: + * type: string + * title: $eq + * description: Filter by 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: Filter by values in this array. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: Filter by values not in this array. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the conditions in this parameter. + * items: + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * $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: Filter arrays that have overlapping values with this parameter. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: Filter arrays that contain some of the values of this parameter. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: Filter arrays that contain all values of this parameter. + * $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 the conditions in this parameter. * items: @@ -259,7 +483,7 @@ * description: Filter by whether a value for this parameter exists (not `null`). * deleted_at: * type: object - * description: The variant's deleted at. + * description: The product's deleted at. * properties: * $and: * type: array @@ -309,6 +533,118 @@ * description: Filter by values not matching the conditions in 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 an exact match. + * items: + * type: string + * title: $eq + * description: Filter by 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: Filter by values in this array. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: Filter by values not in this array. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the conditions in this parameter. + * items: + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * $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: Filter arrays that have overlapping values with this parameter. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: Filter arrays that contain some of the values of this parameter. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: Filter arrays that contain all values of this parameter. + * $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 the conditions in this parameter. * items: @@ -375,19 +711,19 @@ * limit: * type: number * title: limit - * description: The variant's limit. + * description: The product's limit. * offset: * type: number * title: offset - * description: The variant's offset. + * description: The product's offset. * order: * type: string * title: order - * description: The variant's order. + * description: The product's order. * fields: * type: string * title: fields - * description: The variant's fields. + * description: The product's fields. * $and: * type: array * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. diff --git a/www/utils/generated/oas-output/schemas/AdminReturnReasonDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminReturnReasonDeleteResponse.ts index a4a2a4c1fc..e42da24362 100644 --- a/www/utils/generated/oas-output/schemas/AdminReturnReasonDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminReturnReasonDeleteResponse.ts @@ -2,6 +2,7 @@ * @schema AdminReturnReasonDeleteResponse * type: object * description: SUMMARY + * x-schemaName: AdminReturnReasonDeleteResponse * required: * - id * - object @@ -19,8 +20,7 @@ * deleted: * type: boolean * title: deleted - * description: Whether the return reason was deleted. - * x-schemaName: AdminReturnReasonDeleteResponse + * description: Whether the Return Reason was deleted. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminServiceZoneDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminServiceZoneDeleteResponse.ts index 3d47af985d..a3a1498f02 100644 --- a/www/utils/generated/oas-output/schemas/AdminServiceZoneDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminServiceZoneDeleteResponse.ts @@ -2,6 +2,7 @@ * @schema AdminServiceZoneDeleteResponse * type: object * description: SUMMARY + * x-schemaName: AdminServiceZoneDeleteResponse * required: * - id * - object @@ -10,19 +11,17 @@ * id: * type: string * title: id - * description: The service zone's ID. + * description: The fulfillment set's ID. * object: * type: string * title: object * description: The name of the deleted object. - * default: service_zone * deleted: * type: boolean * title: deleted - * description: Whether the service zone was deleted. + * description: Whether the Fulfillment Set was deleted. * parent: * $ref: "#/components/schemas/AdminFulfillmentSet" - * x-schemaName: AdminServiceZoneDeleteResponse * */ diff --git a/www/utils/generated/oas-output/schemas/AdminTaxRateListParams.ts b/www/utils/generated/oas-output/schemas/AdminTaxRateListParams.ts deleted file mode 100644 index 8f10e26d15..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminTaxRateListParams.ts +++ /dev/null @@ -1,1162 +0,0 @@ -/** - * @schema AdminTaxRateListParams - * type: object - * description: SUMMARY - * x-schemaName: AdminTaxRateListParams - * properties: - * q: - * type: string - * title: q - * description: The tax rate's q. - * tax_region_id: - * oneOf: - * - type: string - * title: tax_region_id - * description: The tax rate's tax region id. - * - type: array - * description: The tax rate's tax region id. - * items: - * type: string - * title: tax_region_id - * description: The tax region id's details. - * - type: object - * description: The tax rate's tax region id. - * properties: - * $and: - * type: array - * description: The tax region id's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The tax region id's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by an exact match. - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: Filter by values not equal to this parameter. - * - type: array - * description: Filter by values not equal to this parameter. - * items: - * type: string - * title: $ne - * description: Filter by values not equal to this parameter. - * $in: - * type: array - * description: Filter by values in this array. - * items: - * oneOf: - * - type: string - * title: $in - * description: Filter by values in this array. - * - type: array - * description: Filter by values in this array. - * items: - * type: string - * title: $in - * description: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * oneOf: - * - type: string - * title: $nin - * description: Filter by values not in this array. - * - type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: Filter by values greater than this parameter. Useful for numbers and dates only. - * - type: array - * description: Filter by values greater than this parameter. Useful for numbers and dates only. - * items: - * type: string - * title: $gt - * description: Filter by values greater than this parameter. Useful for numbers and dates only. - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - * - type: array - * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - * items: - * type: string - * title: $gte - * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: Filter by values less than this parameter. Useful for numbers and dates only. - * - type: array - * description: Filter by values less than this parameter. Useful for numbers and dates only. - * items: - * type: string - * title: $lt - * description: Filter by values less than this parameter. Useful for numbers and dates only. - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - * - type: array - * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - * items: - * 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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * is_default: - * type: string - * title: is_default - * description: The tax rate's is default. - * service_zone_id: - * type: string - * title: service_zone_id - * description: The tax rate's service zone id. - * shipping_profile_id: - * type: string - * title: shipping_profile_id - * description: The tax rate's shipping profile id. - * provider_id: - * type: string - * title: provider_id - * description: The tax rate's provider id. - * shipping_option_type_id: - * type: string - * title: shipping_option_type_id - * description: The tax rate's shipping option type id. - * created_at: - * type: object - * description: The tax rate's created at. - * properties: - * $and: - * type: array - * description: The created at's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The created at's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * updated_at: - * type: object - * description: The tax rate's updated at. - * properties: - * $and: - * type: array - * description: The updated at's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The updated at's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * deleted_at: - * type: object - * description: The tax rate's deleted at. - * properties: - * $and: - * type: array - * description: The deleted at's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The deleted at's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * limit: - * type: number - * title: limit - * description: The tax rate's limit. - * offset: - * type: number - * title: offset - * description: The tax rate's offset. - * order: - * type: string - * title: order - * description: The tax rate's order. - * fields: - * type: string - * title: fields - * description: The tax rate's fields. - * $and: - * type: array - * description: The tax rate's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The tax rate's $or. - * items: - * type: object - * title: $or - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminUserListParams.ts b/www/utils/generated/oas-output/schemas/AdminUserListParams.ts deleted file mode 100644 index 0be2b013cc..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminUserListParams.ts +++ /dev/null @@ -1,734 +0,0 @@ -/** - * @schema AdminUserListParams - * type: object - * description: SUMMARY - * x-schemaName: AdminUserListParams - * properties: - * q: - * type: string - * title: q - * description: The user's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The user's ID. - * - type: array - * description: The user's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * email: - * type: string - * title: email - * description: The user's email. - * format: email - * first_name: - * type: string - * title: first_name - * description: The user's first name. - * last_name: - * type: string - * title: last_name - * description: The user's last name. - * created_at: - * type: object - * description: The user's created at. - * properties: - * $and: - * type: array - * description: The created at's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The created at's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * updated_at: - * type: object - * description: The user's updated at. - * properties: - * $and: - * type: array - * description: The updated at's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The updated at's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * deleted_at: - * type: object - * description: The user's deleted at. - * properties: - * $and: - * type: array - * description: The deleted at's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The deleted at's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: The $not's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The $not's $or. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by 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: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $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 the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $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: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * limit: - * type: number - * title: limit - * description: The user's limit. - * offset: - * type: number - * title: offset - * description: The user's offset. - * order: - * type: string - * title: order - * description: The user's order. - * fields: - * type: string - * title: fields - * description: The user's fields. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/CustomerGroupInCustomerFilters.ts b/www/utils/generated/oas-output/schemas/CustomerGroupInCustomerFilters.ts index e030ea6ac6..4ba9b2b6ec 100644 --- a/www/utils/generated/oas-output/schemas/CustomerGroupInCustomerFilters.ts +++ b/www/utils/generated/oas-output/schemas/CustomerGroupInCustomerFilters.ts @@ -38,13 +38,13 @@ * properties: * $and: * type: array - * description: The created at's $and. + * 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: The created at's $or. + * 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 @@ -153,13 +153,13 @@ * properties: * $and: * type: array - * description: The updated at's $and. + * 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: The updated at's $or. + * 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 @@ -268,13 +268,13 @@ * properties: * $and: * type: array - * description: The deleted at's $and. + * 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: The deleted at's $or. + * 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 diff --git a/www/utils/generated/oas-output/schemas/OrderLineItem.ts b/www/utils/generated/oas-output/schemas/OrderLineItem.ts deleted file mode 100644 index a9306bcab1..0000000000 --- a/www/utils/generated/oas-output/schemas/OrderLineItem.ts +++ /dev/null @@ -1,364 +0,0 @@ -/** - * @schema OrderLineItem - * type: object - * description: The item's items. - * x-schemaName: OrderLineItem - * required: - * - id - * - title - * - requires_shipping - * - is_discountable - * - is_tax_inclusive - * - unit_price - * - raw_unit_price - * - quantity - * - raw_quantity - * - detail - * - created_at - * - updated_at - * - original_total - * - original_subtotal - * - original_tax_total - * - item_total - * - item_subtotal - * - item_tax_total - * - total - * - subtotal - * - tax_total - * - discount_total - * - discount_tax_total - * - refundable_total - * - refundable_total_per_unit - * - raw_original_total - * - raw_original_subtotal - * - raw_original_tax_total - * - raw_item_total - * - raw_item_subtotal - * - raw_item_tax_total - * - raw_total - * - raw_subtotal - * - raw_tax_total - * - raw_discount_total - * - raw_discount_tax_total - * - raw_refundable_total - * - raw_refundable_total_per_unit - * properties: - * id: - * type: string - * title: id - * description: The item's ID. - * title: - * type: string - * title: title - * description: The item's title. - * subtitle: - * type: string - * title: subtitle - * description: The item's subtitle. - * thumbnail: - * type: string - * title: thumbnail - * description: The item's thumbnail. - * variant_id: - * type: string - * title: variant_id - * description: The item's variant id. - * product_id: - * type: string - * title: product_id - * description: The item's product id. - * product_title: - * type: string - * title: product_title - * description: The item's product title. - * product_description: - * type: string - * title: product_description - * description: The item's product description. - * product_subtitle: - * type: string - * title: product_subtitle - * description: The item's product subtitle. - * product_type: - * type: string - * title: product_type - * description: The item's product type. - * product_collection: - * type: string - * title: product_collection - * description: The item's product collection. - * product_handle: - * type: string - * title: product_handle - * description: The item's product handle. - * variant_sku: - * type: string - * title: variant_sku - * description: The item's variant sku. - * variant_barcode: - * type: string - * title: variant_barcode - * description: The item's variant barcode. - * variant_title: - * type: string - * title: variant_title - * description: The item's variant title. - * variant_option_values: - * type: object - * description: The item's variant option values. - * requires_shipping: - * type: boolean - * title: requires_shipping - * description: The item's requires shipping. - * is_discountable: - * type: boolean - * title: is_discountable - * description: The item's is discountable. - * is_tax_inclusive: - * type: boolean - * title: is_tax_inclusive - * description: The item's is tax inclusive. - * compare_at_unit_price: - * type: number - * title: compare_at_unit_price - * description: The item's compare at unit price. - * raw_compare_at_unit_price: - * type: object - * description: The item's raw compare at unit price. - * unit_price: - * type: number - * title: unit_price - * description: The item's unit price. - * raw_unit_price: - * type: object - * description: The item's raw unit price. - * quantity: - * type: number - * title: quantity - * description: The item's quantity. - * raw_quantity: - * type: object - * description: The item's raw quantity. - * tax_lines: - * type: array - * description: The item's tax lines. - * items: - * $ref: "#/components/schemas/OrderLineItemTaxLine" - * adjustments: - * type: array - * description: The item's adjustments. - * items: - * $ref: "#/components/schemas/OrderLineItemAdjustment" - * detail: - * $ref: "#/components/schemas/OrderItem" - * created_at: - * type: string - * format: date-time - * title: created_at - * description: The item's created at. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The item's updated at. - * metadata: - * type: object - * description: The item's metadata. - * original_total: - * oneOf: - * - type: string - * title: original_total - * description: The item's original total. - * - type: number - * title: original_total - * description: The item's original total. - * - type: string - * title: original_total - * description: The item's original total. - * - $ref: "#/components/schemas/IBigNumber" - * original_subtotal: - * oneOf: - * - type: string - * title: original_subtotal - * description: The item's original subtotal. - * - type: number - * title: original_subtotal - * description: The item's original subtotal. - * - type: string - * title: original_subtotal - * description: The item's original subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * original_tax_total: - * oneOf: - * - type: string - * title: original_tax_total - * description: The item's original tax total. - * - type: number - * title: original_tax_total - * description: The item's original tax total. - * - type: string - * title: original_tax_total - * description: The item's original tax total. - * - $ref: "#/components/schemas/IBigNumber" - * item_total: - * oneOf: - * - type: string - * title: item_total - * description: The item's item total. - * - type: number - * title: item_total - * description: The item's item total. - * - type: string - * title: item_total - * description: The item's item total. - * - $ref: "#/components/schemas/IBigNumber" - * item_subtotal: - * oneOf: - * - type: string - * title: item_subtotal - * description: The item's item subtotal. - * - type: number - * title: item_subtotal - * description: The item's item subtotal. - * - type: string - * title: item_subtotal - * description: The item's item subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * item_tax_total: - * oneOf: - * - type: string - * title: item_tax_total - * description: The item's item tax total. - * - type: number - * title: item_tax_total - * description: The item's item tax total. - * - type: string - * title: item_tax_total - * description: The item's item tax total. - * - $ref: "#/components/schemas/IBigNumber" - * total: - * oneOf: - * - type: string - * title: total - * description: The item's total. - * - type: number - * title: total - * description: The item's total. - * - type: string - * title: total - * description: The item's total. - * - $ref: "#/components/schemas/IBigNumber" - * subtotal: - * oneOf: - * - type: string - * title: subtotal - * description: The item's subtotal. - * - type: number - * title: subtotal - * description: The item's subtotal. - * - type: string - * title: subtotal - * description: The item's subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * tax_total: - * oneOf: - * - type: string - * title: tax_total - * description: The item's tax total. - * - type: number - * title: tax_total - * description: The item's tax total. - * - type: string - * title: tax_total - * description: The item's tax total. - * - $ref: "#/components/schemas/IBigNumber" - * discount_total: - * oneOf: - * - type: string - * title: discount_total - * description: The item's discount total. - * - type: number - * title: discount_total - * description: The item's discount total. - * - type: string - * title: discount_total - * description: The item's discount total. - * - $ref: "#/components/schemas/IBigNumber" - * discount_tax_total: - * oneOf: - * - type: string - * title: discount_tax_total - * description: The item's discount tax total. - * - type: number - * title: discount_tax_total - * description: The item's discount tax total. - * - type: string - * title: discount_tax_total - * description: The item's discount tax total. - * - $ref: "#/components/schemas/IBigNumber" - * refundable_total: - * oneOf: - * - type: string - * title: refundable_total - * description: The item's refundable total. - * - type: number - * title: refundable_total - * description: The item's refundable total. - * - type: string - * title: refundable_total - * description: The item's refundable total. - * - $ref: "#/components/schemas/IBigNumber" - * refundable_total_per_unit: - * oneOf: - * - type: string - * title: refundable_total_per_unit - * description: The item's refundable total per unit. - * - type: number - * title: refundable_total_per_unit - * description: The item's refundable total per unit. - * - type: string - * title: refundable_total_per_unit - * description: The item's refundable total per unit. - * - $ref: "#/components/schemas/IBigNumber" - * raw_original_total: - * type: object - * description: The item's raw original total. - * raw_original_subtotal: - * type: object - * description: The item's raw original subtotal. - * raw_original_tax_total: - * type: object - * description: The item's raw original tax total. - * raw_item_total: - * type: object - * description: The item's raw item total. - * raw_item_subtotal: - * type: object - * description: The item's raw item subtotal. - * raw_item_tax_total: - * type: object - * description: The item's raw item tax total. - * raw_total: - * type: object - * description: The item's raw total. - * raw_subtotal: - * type: object - * description: The item's raw subtotal. - * raw_tax_total: - * type: object - * description: The item's raw tax total. - * raw_discount_total: - * type: object - * description: The item's raw discount total. - * raw_discount_tax_total: - * type: object - * description: The item's raw discount tax total. - * raw_refundable_total: - * type: object - * description: The item's raw refundable total. - * raw_refundable_total_per_unit: - * type: object - * description: The item's raw refundable total per unit. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/OrderShippingMethod.ts b/www/utils/generated/oas-output/schemas/OrderShippingMethod.ts deleted file mode 100644 index fbde5bc8a1..0000000000 --- a/www/utils/generated/oas-output/schemas/OrderShippingMethod.ts +++ /dev/null @@ -1,219 +0,0 @@ -/** - * @schema OrderShippingMethod - * type: object - * description: The shipping method's shipping methods. - * x-schemaName: OrderShippingMethod - * required: - * - id - * - order_id - * - name - * - amount - * - raw_amount - * - is_tax_inclusive - * - created_at - * - updated_at - * - original_total - * - original_subtotal - * - original_tax_total - * - total - * - subtotal - * - tax_total - * - discount_total - * - discount_tax_total - * - raw_original_total - * - raw_original_subtotal - * - raw_original_tax_total - * - raw_total - * - raw_subtotal - * - raw_tax_total - * - raw_discount_total - * - raw_discount_tax_total - * properties: - * id: - * type: string - * title: id - * description: The shipping method's ID. - * order_id: - * type: string - * title: order_id - * description: The shipping method's order id. - * name: - * type: string - * title: name - * description: The shipping method's name. - * description: - * type: string - * title: description - * description: The shipping method's description. - * amount: - * oneOf: - * - type: string - * title: amount - * description: The shipping method's amount. - * - type: number - * title: amount - * description: The shipping method's amount. - * - type: string - * title: amount - * description: The shipping method's amount. - * - $ref: "#/components/schemas/IBigNumber" - * raw_amount: - * type: object - * description: The shipping method's raw amount. - * is_tax_inclusive: - * type: boolean - * title: is_tax_inclusive - * description: The shipping method's is tax inclusive. - * shipping_option_id: - * type: string - * title: shipping_option_id - * description: The shipping method's shipping option id. - * data: - * type: object - * description: The shipping method's data. - * metadata: - * type: object - * description: The shipping method's metadata. - * tax_lines: - * type: array - * description: The shipping method's tax lines. - * items: - * $ref: "#/components/schemas/OrderShippingMethodTaxLine" - * adjustments: - * type: array - * description: The shipping method's adjustments. - * items: - * $ref: "#/components/schemas/OrderShippingMethodAdjustment" - * created_at: - * type: string - * format: date-time - * title: created_at - * description: The shipping method's created at. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The shipping method's updated at. - * original_total: - * oneOf: - * - type: string - * title: original_total - * description: The shipping method's original total. - * - type: number - * title: original_total - * description: The shipping method's original total. - * - type: string - * title: original_total - * description: The shipping method's original total. - * - $ref: "#/components/schemas/IBigNumber" - * original_subtotal: - * oneOf: - * - type: string - * title: original_subtotal - * description: The shipping method's original subtotal. - * - type: number - * title: original_subtotal - * description: The shipping method's original subtotal. - * - type: string - * title: original_subtotal - * description: The shipping method's original subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * original_tax_total: - * oneOf: - * - type: string - * title: original_tax_total - * description: The shipping method's original tax total. - * - type: number - * title: original_tax_total - * description: The shipping method's original tax total. - * - type: string - * title: original_tax_total - * description: The shipping method's original tax total. - * - $ref: "#/components/schemas/IBigNumber" - * total: - * oneOf: - * - type: string - * title: total - * description: The shipping method's total. - * - type: number - * title: total - * description: The shipping method's total. - * - type: string - * title: total - * description: The shipping method's total. - * - $ref: "#/components/schemas/IBigNumber" - * subtotal: - * oneOf: - * - type: string - * title: subtotal - * description: The shipping method's subtotal. - * - type: number - * title: subtotal - * description: The shipping method's subtotal. - * - type: string - * title: subtotal - * description: The shipping method's subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * tax_total: - * oneOf: - * - type: string - * title: tax_total - * description: The shipping method's tax total. - * - type: number - * title: tax_total - * description: The shipping method's tax total. - * - type: string - * title: tax_total - * description: The shipping method's tax total. - * - $ref: "#/components/schemas/IBigNumber" - * discount_total: - * oneOf: - * - type: string - * title: discount_total - * description: The shipping method's discount total. - * - type: number - * title: discount_total - * description: The shipping method's discount total. - * - type: string - * title: discount_total - * description: The shipping method's discount total. - * - $ref: "#/components/schemas/IBigNumber" - * discount_tax_total: - * oneOf: - * - type: string - * title: discount_tax_total - * description: The shipping method's discount tax total. - * - type: number - * title: discount_tax_total - * description: The shipping method's discount tax total. - * - type: string - * title: discount_tax_total - * description: The shipping method's discount tax total. - * - $ref: "#/components/schemas/IBigNumber" - * raw_original_total: - * type: object - * description: The shipping method's raw original total. - * raw_original_subtotal: - * type: object - * description: The shipping method's raw original subtotal. - * raw_original_tax_total: - * type: object - * description: The shipping method's raw original tax total. - * raw_total: - * type: object - * description: The shipping method's raw total. - * raw_subtotal: - * type: object - * description: The shipping method's raw subtotal. - * raw_tax_total: - * type: object - * description: The shipping method's raw tax total. - * raw_discount_total: - * type: object - * description: The shipping method's raw discount total. - * raw_discount_tax_total: - * type: object - * description: The shipping method's raw discount tax total. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/RefundReasonFilters.ts b/www/utils/generated/oas-output/schemas/RefundReasonFilters.ts deleted file mode 100644 index 8dc2719d25..0000000000 --- a/www/utils/generated/oas-output/schemas/RefundReasonFilters.ts +++ /dev/null @@ -1,52 +0,0 @@ -/** - * @schema RefundReasonFilters - * type: object - * description: SUMMARY - * x-schemaName: RefundReasonFilters - * properties: - * id: - * oneOf: - * - type: string - * title: id - * description: The refund reason's ID. - * - type: array - * description: The refund reason's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * q: - * type: string - * title: q - * description: The refund reason's q. - * limit: - * type: number - * title: limit - * description: The refund reason's limit. - * offset: - * type: number - * title: offset - * description: The refund reason's offset. - * order: - * type: string - * title: order - * description: The refund reason's order. - * fields: - * type: string - * title: fields - * description: The refund reason's fields. - * $and: - * type: array - * description: The refund reason's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The refund reason's $or. - * items: - * type: object - * title: $or - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/StoreCreatePaymentCollection.ts b/www/utils/generated/oas-output/schemas/StoreCreatePaymentCollection.ts index ab5f682b86..c399e04903 100644 --- a/www/utils/generated/oas-output/schemas/StoreCreatePaymentCollection.ts +++ b/www/utils/generated/oas-output/schemas/StoreCreatePaymentCollection.ts @@ -2,6 +2,7 @@ * @schema StoreCreatePaymentCollection * type: object * description: SUMMARY + * x-schemaName: StoreCreatePaymentCollection * required: * - cart_id * properties: @@ -9,7 +10,6 @@ * type: string * title: cart_id * description: The payment collection's cart id. - * x-schemaName: StoreCreatePaymentCollection * */ diff --git a/www/utils/generated/oas-output/schemas/StoreCreateReturnItem.ts b/www/utils/generated/oas-output/schemas/StoreCreateReturnItem.ts index ee4419204d..204cd1e1b2 100644 --- a/www/utils/generated/oas-output/schemas/StoreCreateReturnItem.ts +++ b/www/utils/generated/oas-output/schemas/StoreCreateReturnItem.ts @@ -2,6 +2,7 @@ * @schema StoreCreateReturnItem * type: object * description: The item's items. + * x-schemaName: StoreCreateReturnItem * required: * - id * - quantity @@ -22,7 +23,6 @@ * type: string * title: note * description: The item's note. - * x-schemaName: StoreCreateReturnItem * */ diff --git a/www/utils/generated/oas-output/schemas/StoreCreateReturnShipping.ts b/www/utils/generated/oas-output/schemas/StoreCreateReturnShipping.ts index bddc09fe3f..0146269daa 100644 --- a/www/utils/generated/oas-output/schemas/StoreCreateReturnShipping.ts +++ b/www/utils/generated/oas-output/schemas/StoreCreateReturnShipping.ts @@ -2,6 +2,7 @@ * @schema StoreCreateReturnShipping * type: object * description: The return's return shipping. + * x-schemaName: StoreCreateReturnShipping * required: * - option_id * properties: @@ -13,7 +14,6 @@ * type: number * title: price * description: The return shipping's price. - * x-schemaName: StoreCreateReturnShipping * */