From d6dcda5b8f07667893bdd393a1e0792c0bc34c98 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 2 Sep 2024 07:45:24 +0000 Subject: [PATCH] chore(docs): Updated API Reference (v2) (#8929) Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action --- .../admin/components/schemas/AdminClaim.yaml | 2 +- .../schemas/AdminClaimDeleteResponse.yaml | 3 - .../AdminCollectionDeleteResponse.yaml | 3 - .../schemas/AdminCreateApplicationMethod.yaml | 61 + .../schemas/AdminCreateCampaign.yaml | 48 + .../schemas/AdminCreateInventoryItem.yaml | 59 + .../schemas/AdminCreateProductCategory.yaml | 37 + .../schemas/AdminCreateProductTag.yaml | 13 + .../schemas/AdminCreatePromotionRule.yaml | 38 + .../schemas/AdminCreateRefundReason.yaml | 14 + .../components/schemas/AdminCreateRegion.yaml | 40 + .../schemas/AdminCreateReservation.yaml | 31 + .../schemas/AdminCreateSalesChannel.yaml | 2 - .../schemas/AdminCreateShippingOption.yaml | 76 + .../AdminCreateShippingOptionRule.yaml | 34 + .../schemas/AdminCreateStockLocation.yaml | 49 +- .../schemas/AdminCreateTaxRate.yaml | 32 +- .../schemas/AdminCreateTaxRegion.yaml | 4 - .../components/schemas/AdminCustomer.yaml | 2 +- .../schemas/AdminCustomerGroup.yaml | 34 - .../schemas/AdminCustomerInGroupFilters.yaml | 609 + .../AdminDeletePaymentCollectionResponse.yaml | 21 + .../components/schemas/AdminExchange.yaml | 2 +- .../schemas/AdminExchangeDeleteResponse.yaml | 21 + .../schemas/AdminFulfillmentSet.yaml | 74 +- .../AdminFulfillmentSetDeleteResponse.yaml | 3 - .../schemas/AdminGetUploadParams.yaml | 8 - .../schemas/AdminInventoryItem.yaml | 5 + .../schemas/AdminInventoryLevel.yaml | 76 + .../admin/components/schemas/AdminOrder.yaml | 14 +- .../components/schemas/AdminOrderAddress.yaml | 72 + .../components/schemas/AdminOrderPreview.yaml | 10 +- .../schemas/AdminPriceListDeleteResponse.yaml | 3 - .../AdminPricePreferenceDeleteResponse.yaml | 3 - .../components/schemas/AdminProduct.yaml | 10 +- .../AdminProductCategoryDeleteResponse.yaml | 3 - .../schemas/AdminProductDeleteResponse.yaml | 3 - .../AdminProductOptionDeleteResponse.yaml | 1 - .../AdminProductTagDeleteResponse.yaml | 3 - .../AdminProductTypeDeleteResponse.yaml | 3 - .../AdminProductVariantDeleteResponse.yaml | 1 - .../schemas/AdminProductVariantParams.yaml | 420 +- .../schemas/AdminRegionCountry.yaml | 3 + .../components/schemas/AdminReservation.yaml | 2 +- .../AdminReturnReasonDeleteResponse.yaml | 21 + .../components/schemas/AdminSalesChannel.yaml | 2 +- .../AdminSalesChannelDeleteResponse.yaml | 3 - .../AdminServiceZoneDeleteResponse.yaml | 23 + .../AdminShippingOptionDeleteResponse.yaml | 3 - .../AdminShippingProfileDeleteResponse.yaml | 3 - .../schemas/AdminStockLocation.yaml | 2 +- .../AdminStockLocationDeleteResponse.yaml | 3 - .../components/schemas/AdminTaxRate.yaml | 28 +- .../schemas/AdminTaxRateDeleteResponse.yaml | 3 - .../components/schemas/AdminTaxRegion.yaml | 2 +- .../schemas/AdminTaxRegionDeleteResponse.yaml | 3 - .../AdminUpsertStockLocationAddress.yaml | 39 + .../schemas/AdminUserDeleteResponse.yaml | 3 - .../components/schemas/BaseCartAddress.yaml | 2 +- .../components/schemas/BaseCustomer.yaml | 3 - .../schemas/BaseCustomerAddress.yaml | 93 - .../components/schemas/BaseOrderAddress.yaml | 2 +- .../admin/components/schemas/BaseRegion.yaml | 2 +- .../CustomerGroupInCustomerFilters.yaml | 413 + .../admin/components/schemas/FileList.yaml | 18 + .../admin/components/schemas/StoreCart.yaml | 156 +- .../schemas/StoreCreateCustomer.yaml | 7 +- .../schemas/StoreCreatePaymentCollection.yaml | 10 + .../components/schemas/StoreCreateReturn.yaml | 31 + .../schemas/StoreCreateReturnItem.yaml | 23 + .../schemas/StoreCreateReturnShipping.yaml | 14 + .../components/schemas/StoreCustomer.yaml | 30 +- .../admin/components/schemas/StoreOrder.yaml | 2 +- .../schemas/StorePostReturnsReqSchema.yaml | 68 - .../components/schemas/StoreProduct.yaml | 10 +- .../schemas/StoreProductVariantParams.yaml | 76 + .../specs/admin/openapi.full.yaml | 24362 +++++++++++++++- .../api-reference/specs/admin/openapi.yaml | 2 +- .../specs/admin/paths/admin_api-keys.yaml | 1181 +- .../admin/paths/admin_api-keys_{id}.yaml | 11 +- .../specs/admin/paths/admin_campaigns.yaml | 12 +- .../admin/paths/admin_campaigns_{id}.yaml | 5 +- .../specs/admin/paths/admin_claims.yaml | 927 + .../specs/admin/paths/admin_claims_{id}.yaml | 2 +- .../specs/admin/paths/admin_collections.yaml | 885 + .../admin/paths/admin_collections_{id}.yaml | 2 +- .../specs/admin/paths/admin_currencies.yaml | 50 + .../admin/paths/admin_currencies_{code}.yaml | 4 +- .../admin/paths/admin_customer-groups.yaml | 942 + .../paths/admin_customer-groups_{id}.yaml | 3 - .../specs/admin/paths/admin_customers.yaml | 3013 ++ .../admin/paths/admin_customers_{id}.yaml | 3 - .../paths/admin_customers_{id}_addresses.yaml | 106 + ...customers_{id}_addresses_{address_id}.yaml | 46 +- .../specs/admin/paths/admin_draft-orders.yaml | 1227 + .../specs/admin/paths/admin_exchanges.yaml | 927 + .../paths/admin_exchanges_{id}_request.yaml | 24 +- ...ent-sets_{id}_service-zones_{zone_id}.yaml | 24 +- .../admin/paths/admin_inventory-items.yaml | 96 +- .../paths/admin_inventory-items_{id}.yaml | 3 - ...ms_{id}_location-levels_{location_id}.yaml | 47 +- .../specs/admin/paths/admin_invites.yaml | 843 +- .../specs/admin/paths/admin_invites_{id}.yaml | 3 - .../admin/paths/admin_order-edits_{id}.yaml | 3 - .../specs/admin/paths/admin_orders.yaml | 1227 + .../paths/admin_orders_{id}_changes.yaml | 18 +- .../paths/admin_payment-collections_{id}.yaml | 24 +- .../specs/admin/paths/admin_payments.yaml | 840 +- .../specs/admin/paths/admin_price-lists.yaml | 640 + .../admin/paths/admin_price-preferences.yaml | 78 + .../admin/paths/admin_product-categories.yaml | 893 +- .../specs/admin/paths/admin_product-tags.yaml | 854 +- .../admin/paths/admin_product-types.yaml | 854 +- .../admin/paths/admin_product-variants.yaml | 915 + .../specs/admin/paths/admin_promotions.yaml | 840 +- .../admin/paths/admin_promotions_{id}.yaml | 3 - .../admin/paths/admin_refund-reasons.yaml | 65 +- .../paths/admin_refund-reasons_{id}.yaml | 3 - .../specs/admin/paths/admin_regions.yaml | 881 +- .../specs/admin/paths/admin_regions_{id}.yaml | 3 - .../specs/admin/paths/admin_reservations.yaml | 906 +- .../admin/paths/admin_reservations_{id}.yaml | 3 - .../admin/paths/admin_return-reasons.yaml | 840 +- .../paths/admin_return-reasons_{id}.yaml | 24 +- .../specs/admin/paths/admin_returns.yaml | 1227 + .../paths/admin_returns_{id}_receive.yaml | 3 - .../paths/admin_returns_{id}_request.yaml | 3 - ...urns_{id}_shipping-method_{action_id}.yaml | 17 +- .../admin/paths/admin_sales-channels.yaml | 840 +- .../admin/paths/admin_shipping-options.yaml | 980 +- .../admin/paths/admin_stock-locations.yaml | 840 +- .../specs/admin/paths/admin_tax-rates.yaml | 873 +- .../admin_tax-rates_{id}_rules_{rule_id}.yaml | 55 +- .../specs/admin/paths/admin_uploads.yaml | 29 +- .../specs/admin/paths/admin_uploads_{id}.yaml | 16 +- .../specs/admin/paths/admin_users.yaml | 896 + .../store/components/schemas/AdminClaim.yaml | 2 +- .../schemas/AdminClaimDeleteResponse.yaml | 3 - .../AdminCollectionDeleteResponse.yaml | 3 - .../schemas/AdminCreateApplicationMethod.yaml | 61 + .../schemas/AdminCreateCampaign.yaml | 48 + .../schemas/AdminCreateInventoryItem.yaml | 59 + .../schemas/AdminCreateProductCategory.yaml | 37 + .../schemas/AdminCreateProductTag.yaml | 13 + .../schemas/AdminCreatePromotionRule.yaml | 38 + .../schemas/AdminCreateRefundReason.yaml | 14 + .../components/schemas/AdminCreateRegion.yaml | 40 + .../schemas/AdminCreateReservation.yaml | 31 + .../schemas/AdminCreateSalesChannel.yaml | 2 - .../schemas/AdminCreateShippingOption.yaml | 76 + .../AdminCreateShippingOptionRule.yaml | 34 + .../schemas/AdminCreateStockLocation.yaml | 49 +- .../schemas/AdminCreateTaxRate.yaml | 32 +- .../schemas/AdminCreateTaxRegion.yaml | 4 - .../components/schemas/AdminCustomer.yaml | 2 +- .../schemas/AdminCustomerGroup.yaml | 34 - .../schemas/AdminCustomerInGroupFilters.yaml | 609 + .../AdminDeletePaymentCollectionResponse.yaml | 21 + .../components/schemas/AdminExchange.yaml | 2 +- .../schemas/AdminExchangeDeleteResponse.yaml | 21 + .../schemas/AdminFulfillmentSet.yaml | 74 +- .../AdminFulfillmentSetDeleteResponse.yaml | 3 - .../schemas/AdminGetUploadParams.yaml | 8 - .../schemas/AdminInventoryItem.yaml | 5 + .../schemas/AdminInventoryLevel.yaml | 76 + .../store/components/schemas/AdminOrder.yaml | 14 +- .../components/schemas/AdminOrderAddress.yaml | 72 + .../components/schemas/AdminOrderPreview.yaml | 10 +- .../schemas/AdminPriceListDeleteResponse.yaml | 3 - .../AdminPricePreferenceDeleteResponse.yaml | 3 - .../components/schemas/AdminProduct.yaml | 10 +- .../AdminProductCategoryDeleteResponse.yaml | 3 - .../schemas/AdminProductDeleteResponse.yaml | 3 - .../AdminProductOptionDeleteResponse.yaml | 1 - .../AdminProductTagDeleteResponse.yaml | 3 - .../AdminProductTypeDeleteResponse.yaml | 3 - .../AdminProductVariantDeleteResponse.yaml | 1 - .../schemas/AdminProductVariantParams.yaml | 420 +- .../schemas/AdminRegionCountry.yaml | 3 + .../components/schemas/AdminReservation.yaml | 2 +- .../AdminReturnReasonDeleteResponse.yaml | 21 + .../components/schemas/AdminSalesChannel.yaml | 2 +- .../AdminSalesChannelDeleteResponse.yaml | 3 - .../AdminServiceZoneDeleteResponse.yaml | 23 + .../AdminShippingOptionDeleteResponse.yaml | 3 - .../AdminShippingProfileDeleteResponse.yaml | 3 - .../schemas/AdminStockLocation.yaml | 2 +- .../AdminStockLocationDeleteResponse.yaml | 3 - .../components/schemas/AdminTaxRate.yaml | 28 +- .../schemas/AdminTaxRateDeleteResponse.yaml | 3 - .../components/schemas/AdminTaxRegion.yaml | 2 +- .../schemas/AdminTaxRegionDeleteResponse.yaml | 3 - .../AdminUpsertStockLocationAddress.yaml | 39 + .../schemas/AdminUserDeleteResponse.yaml | 3 - .../components/schemas/BaseCartAddress.yaml | 2 +- .../components/schemas/BaseCustomer.yaml | 3 - .../schemas/BaseCustomerAddress.yaml | 93 - .../components/schemas/BaseOrderAddress.yaml | 2 +- .../store/components/schemas/BaseRegion.yaml | 2 +- .../CustomerGroupInCustomerFilters.yaml | 413 + .../store/components/schemas/FileList.yaml | 18 + .../store/components/schemas/StoreCart.yaml | 156 +- .../schemas/StoreCreateCustomer.yaml | 7 +- .../schemas/StoreCreatePaymentCollection.yaml | 10 + .../components/schemas/StoreCreateReturn.yaml | 31 + .../schemas/StoreCreateReturnItem.yaml | 23 + .../schemas/StoreCreateReturnShipping.yaml | 14 + .../components/schemas/StoreCustomer.yaml | 30 +- .../store/components/schemas/StoreOrder.yaml | 2 +- .../schemas/StorePostReturnsReqSchema.yaml | 68 - .../components/schemas/StoreProduct.yaml | 10 +- .../schemas/StoreProductVariantParams.yaml | 76 + .../specs/store/openapi.full.yaml | 5630 +++- .../api-reference/specs/store/openapi.yaml | 2 +- ...store_carts_{id}_line-items_{line_id}.yaml | 46 +- .../specs/store/paths/store_collections.yaml | 913 + .../specs/store/paths/store_currencies.yaml | 50 + ...e_customers_me_addresses_{address_id}.yaml | 46 +- .../paths/store_payment-collections.yaml | 10 +- .../store/paths/store_payment-providers.yaml | 15 +- .../store/paths/store_product-categories.yaml | 870 +- .../specs/store/paths/store_products.yaml | 91 +- .../specs/store/paths/store_regions.yaml | 1183 + .../specs/store/paths/store_return.yaml | 2 +- .../store/paths/store_shipping-options.yaml | 36 + .../admin/delete_admin_api-keys_[id].ts | 3 - .../admin/delete_admin_campaigns_[id].ts | 3 - .../delete_admin_customer-groups_[id].ts | 3 - .../admin/delete_admin_customers_[id].ts | 3 - ...n_customers_[id]_addresses_[address_id].ts | 46 +- .../delete_admin_exchanges_[id]_request.ts | 24 +- ...lment-sets_[id]_service-zones_[zone_id].ts | 24 +- .../delete_admin_inventory-items_[id].ts | 3 - ...tems_[id]_location-levels_[location_id].ts | 47 +- .../admin/delete_admin_invites_[id].ts | 3 - .../admin/delete_admin_order-edits_[id].ts | 3 - .../delete_admin_payment-collections_[id].ts | 24 +- .../admin/delete_admin_promotions_[id].ts | 3 - .../admin/delete_admin_refund-reasons_[id].ts | 3 - .../admin/delete_admin_regions_[id].ts | 3 - .../admin/delete_admin_reservations_[id].ts | 3 - .../admin/delete_admin_return-reasons_[id].ts | 24 +- .../delete_admin_returns_[id]_receive.ts | 3 - .../delete_admin_returns_[id]_request.ts | 3 - ...eturns_[id]_shipping-method_[action_id].ts | 6 +- ...te_admin_tax-rates_[id]_rules_[rule_id].ts | 47 +- .../admin/delete_admin_uploads_[id].ts | 3 - .../operations/admin/get_admin_api-keys.ts | 3 +- .../admin/get_admin_api-keys_[id].ts | 3 +- .../operations/admin/get_admin_campaigns.ts | 48 - .../admin/get_admin_campaigns_[id].ts | 3 +- .../operations/admin/get_admin_claims.ts | 763 + .../operations/admin/get_admin_claims_[id].ts | 3 +- .../admin/get_admin_collections_[id].ts | 3 +- .../admin/get_admin_currencies_[code].ts | 3 +- .../admin/get_admin_orders_[id]_changes.ts | 8 +- .../admin/get_admin_product-categories.ts | 14 + .../admin/post_admin_inventory-items.ts | 94 +- .../operations/admin/post_admin_invites.ts | 3 + .../admin/post_admin_product-categories.ts | 39 +- .../admin/post_admin_product-tags.ts | 14 +- .../admin/post_admin_product-types.ts | 14 +- .../admin/post_admin_refund-reasons.ts | 15 +- .../operations/admin/post_admin_regions.ts | 41 +- .../admin/post_admin_reservations.ts | 34 +- .../admin/post_admin_shipping-options.ts | 126 +- .../operations/admin/post_admin_uploads.ts | 29 +- ...h_[actor_type]_[auth_provider]_register.ts | 6 +- ...e_store_carts_[id]_line-items_[line_id].ts | 46 +- ...ore_customers_me_addresses_[address_id].ts | 46 +- .../operations/store/get_store_collections.ts | 749 + .../operations/store/get_store_currencies.ts | 42 + .../store/get_store_payment-providers.ts | 15 +- .../store/get_store_product-categories.ts | 714 +- .../operations/store/get_store_products.ts | 91 +- .../operations/store/get_store_regions.ts | 941 + .../store/get_store_shipping-options.ts | 28 + .../store/post_store_payment-collections.ts | 10 +- .../operations/store/post_store_return.ts | 2 +- .../oas-output/schemas/AdminClaim.ts | 2 +- .../schemas/AdminClaimDeleteResponse.ts | 3 - .../schemas/AdminCollectionDeleteResponse.ts | 3 - .../schemas/AdminCreateApplicationMethod.ts | 66 + .../oas-output/schemas/AdminCreateCampaign.ts | 53 + .../schemas/AdminCreateInventoryItem.ts | 64 + .../schemas/AdminCreateProductCategory.ts | 42 + .../schemas/AdminCreateProductTag.ts | 18 + .../schemas/AdminCreatePromotionRule.ts | 43 + .../oas-output/schemas/AdminCreateRegion.ts | 45 + .../schemas/AdminCreateReservation.ts | 36 + .../schemas/AdminCreateSalesChannel.ts | 2 - .../schemas/AdminCreateShippingOption.ts | 81 + .../schemas/AdminCreateShippingOptionRule.ts | 39 + .../schemas/AdminCreateStockLocation.ts | 49 +- .../oas-output/schemas/AdminCreateTaxRate.ts | 32 +- .../schemas/AdminCreateTaxRegion.ts | 4 - .../oas-output/schemas/AdminCurrency.ts | 68 +- .../schemas/AdminCurrencyListParams.ts | 52 - .../oas-output/schemas/AdminCurrencyParams.ts | 13 - .../oas-output/schemas/AdminCustomer.ts | 2 +- .../oas-output/schemas/AdminCustomerGroup.ts | 34 - .../AdminDeletePaymentCollectionResponse.ts | 26 + .../oas-output/schemas/AdminExchange.ts | 2 +- .../schemas/AdminExchangeDeleteResponse.ts | 26 + .../oas-output/schemas/AdminFulfillmentSet.ts | 74 +- .../AdminFulfillmentSetDeleteResponse.ts | 3 - .../schemas/AdminGetUploadParams.ts | 13 - .../oas-output/schemas/AdminInventoryItem.ts | 5 + .../oas-output/schemas/AdminInventoryLevel.ts | 81 + .../oas-output/schemas/AdminOrder.ts | 14 +- .../oas-output/schemas/AdminOrderAddress.ts | 77 + .../oas-output/schemas/AdminOrderPreview.ts | 10 +- .../schemas/AdminPriceListDeleteResponse.ts | 3 - .../AdminPricePreferenceDeleteResponse.ts | 3 - .../oas-output/schemas/AdminProduct.ts | 10 +- .../AdminProductCategoryDeleteResponse.ts | 3 - .../schemas/AdminProductDeleteResponse.ts | 3 - .../AdminProductOptionDeleteResponse.ts | 1 - .../schemas/AdminProductTagDeleteResponse.ts | 3 - .../schemas/AdminProductTypeDeleteResponse.ts | 3 - .../AdminProductVariantDeleteResponse.ts | 1 - .../schemas/AdminProductVariantParams.ts | 380 +- .../oas-output/schemas/AdminRegionCountry.ts | 8 + .../oas-output/schemas/AdminReservation.ts | 2 +- .../AdminReturnReasonDeleteResponse.ts | 26 + .../oas-output/schemas/AdminSalesChannel.ts | 2 +- .../AdminSalesChannelDeleteResponse.ts | 3 - .../schemas/AdminServiceZoneDeleteResponse.ts | 28 + .../AdminShippingOptionDeleteResponse.ts | 3 - .../AdminShippingProfileDeleteResponse.ts | 3 - .../oas-output/schemas/AdminStockLocation.ts | 2 +- .../AdminStockLocationDeleteResponse.ts | 3 - .../oas-output/schemas/AdminTaxRate.ts | 28 +- .../schemas/AdminTaxRateDeleteResponse.ts | 3 - .../oas-output/schemas/AdminTaxRegion.ts | 2 +- .../schemas/AdminTaxRegionDeleteResponse.ts | 3 - .../AdminUpsertStockLocationAddress.ts | 44 + .../schemas/AdminUserDeleteResponse.ts | 3 - .../oas-output/schemas/BaseCartAddress.ts | 2 +- .../oas-output/schemas/BaseCustomer.ts | 8 - .../oas-output/schemas/BaseCustomerAddress.ts | 93 - .../oas-output/schemas/BaseOrderAddress.ts | 2 +- .../oas-output/schemas/BaseRegion.ts | 2 +- .../generated/oas-output/schemas/FileList.ts | 23 + .../generated/oas-output/schemas/StoreCart.ts | 156 +- .../oas-output/schemas/StoreCreateCustomer.ts | 7 +- .../schemas/StoreCreatePaymentCollection.ts | 15 + .../oas-output/schemas/StoreCreateReturn.ts | 36 + .../schemas/StoreCreateReturnItem.ts | 28 + .../schemas/StoreCreateReturnShipping.ts | 19 + .../oas-output/schemas/StoreCustomer.ts | 30 +- .../oas-output/schemas/StoreOrder.ts | 2 +- .../schemas/StorePostReturnsReqSchema.ts | 73 - .../oas-output/schemas/StoreProduct.ts | 10 +- .../schemas/StoreProductVariantParams.ts | 77 + 355 files changed, 66808 insertions(+), 5101 deletions(-) create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCreateApplicationMethod.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCreateCampaign.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCreateInventoryItem.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductCategory.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductTag.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCreatePromotionRule.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCreateRefundReason.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCreateRegion.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCreateReservation.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOptionRule.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCustomerInGroupFilters.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminDeletePaymentCollectionResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminExchangeDeleteResponse.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminGetUploadParams.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminInventoryLevel.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminOrderAddress.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminRegionCountry.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminUpsertStockLocationAddress.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseCustomer.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/CustomerGroupInCustomerFilters.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/FileList.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCreatePaymentCollection.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturn.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnItem.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnShipping.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/StorePostReturnsReqSchema.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreProductVariantParams.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCreateApplicationMethod.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCreateCampaign.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCreateInventoryItem.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCreateProductCategory.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCreateProductTag.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCreatePromotionRule.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCreateRefundReason.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCreateRegion.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCreateReservation.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOptionRule.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCustomerInGroupFilters.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminDeletePaymentCollectionResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminExchangeDeleteResponse.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminGetUploadParams.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminInventoryLevel.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminOrderAddress.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminRegionCountry.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminUpsertStockLocationAddress.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseCustomer.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/CustomerGroupInCustomerFilters.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/FileList.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCreatePaymentCollection.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCreateReturn.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnItem.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnShipping.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/StorePostReturnsReqSchema.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreProductVariantParams.yaml create mode 100644 www/utils/generated/oas-output/schemas/AdminCreateApplicationMethod.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCreateCampaign.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCreateInventoryItem.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCreateProductCategory.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCreateProductTag.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCreatePromotionRule.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCreateRegion.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCreateReservation.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCreateShippingOptionRule.ts delete mode 100644 www/utils/generated/oas-output/schemas/AdminCurrencyListParams.ts delete mode 100644 www/utils/generated/oas-output/schemas/AdminCurrencyParams.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminDeletePaymentCollectionResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminExchangeDeleteResponse.ts delete mode 100644 www/utils/generated/oas-output/schemas/AdminGetUploadParams.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminInventoryLevel.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminOrderAddress.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminRegionCountry.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminReturnReasonDeleteResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminServiceZoneDeleteResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminUpsertStockLocationAddress.ts delete mode 100644 www/utils/generated/oas-output/schemas/BaseCustomer.ts create mode 100644 www/utils/generated/oas-output/schemas/FileList.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreCreatePaymentCollection.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreCreateReturn.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreCreateReturnItem.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreCreateReturnShipping.ts delete mode 100644 www/utils/generated/oas-output/schemas/StorePostReturnsReqSchema.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreProductVariantParams.ts diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml index c92a30e4e8..4bd73651ee 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml @@ -94,7 +94,7 @@ properties: description: The claim's email. format: email display_id: - type: string + type: number title: display_id description: The claim's display id. shipping_address: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimDeleteResponse.yaml index 7262c162bf..762248df11 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Claim was deleted. - parent: - type: object - description: The claim's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionDeleteResponse.yaml index 8fb21f0636..c49daa3bbe 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Collection was deleted. - parent: - type: object - description: The collection's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateApplicationMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateApplicationMethod.yaml new file mode 100644 index 0000000000..7bc1869e1f --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateApplicationMethod.yaml @@ -0,0 +1,61 @@ +type: object +description: The promotion's application method. +x-schemaName: AdminCreateApplicationMethod +required: + - value + - type + - target_type +properties: + description: + type: string + title: description + description: The application method's description. + value: + type: number + title: value + description: The application method's value. + currency_code: + type: string + title: currency_code + description: The application method's currency code. + max_quantity: + type: number + title: max_quantity + description: The application method's max quantity. + type: + type: string + description: The application method's type. + enum: + - fixed + - percentage + target_type: + type: string + description: The application method's target type. + enum: + - items + - shipping_methods + - order + allocation: + type: string + description: The application method's allocation. + enum: + - each + - across + target_rules: + type: array + description: The application method's target rules. + items: + $ref: ./AdminCreatePromotionRule.yaml + buy_rules: + type: array + description: The application method's buy rules. + items: + $ref: ./AdminCreatePromotionRule.yaml + apply_to_quantity: + type: number + title: apply_to_quantity + description: The application method's apply to quantity. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The application method's buy rules min quantity. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCampaign.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCampaign.yaml new file mode 100644 index 0000000000..f5219bcaee --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCampaign.yaml @@ -0,0 +1,48 @@ +type: object +description: The promotion's campaign. +x-schemaName: AdminCreateCampaign +properties: + name: + type: string + title: name + description: The campaign's name. + description: + type: string + title: description + description: The campaign's description. + currency: + type: string + title: currency + description: The campaign's currency. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + budget: + type: object + description: The campaign's budget. + properties: + type: + type: string + description: The budget's type. + enum: + - spend + - usage + currency_code: + type: string + title: currency_code + description: The budget's currency code. + limit: + type: number + title: limit + description: The budget's limit. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateInventoryItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateInventoryItem.yaml new file mode 100644 index 0000000000..a974fc3ee4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateInventoryItem.yaml @@ -0,0 +1,59 @@ +type: object +description: SUMMARY +properties: + sku: + type: string + title: sku + description: The inventory item's sku. + hs_code: + type: string + title: hs_code + description: The inventory item's hs code. + weight: + type: number + title: weight + description: The inventory item's weight. + length: + type: number + title: length + description: The inventory item's length. + height: + type: number + title: height + description: The inventory item's height. + width: + type: number + title: width + description: The inventory item's width. + origin_country: + type: string + title: origin_country + description: The inventory item's origin country. + mid_code: + type: string + title: mid_code + description: The inventory item's mid code. + material: + type: string + title: material + description: The inventory item's material. + title: + type: string + title: title + description: The inventory item's title. + description: + type: string + title: description + description: The inventory item's description. + requires_shipping: + type: boolean + title: requires_shipping + description: The inventory item's requires shipping. + thumbnail: + type: string + title: thumbnail + description: The inventory item's thumbnail. + 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 new file mode 100644 index 0000000000..35a28c81d9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductCategory.yaml @@ -0,0 +1,37 @@ +type: object +description: SUMMARY +required: + - name +properties: + name: + type: string + title: name + description: The product category's name. + description: + type: string + title: description + description: The product category's description. + handle: + type: string + title: handle + description: The product category's handle. + is_internal: + type: boolean + title: is_internal + description: The product category's is internal. + is_active: + type: boolean + title: is_active + description: The product category's is active. + parent_category_id: + 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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductTag.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductTag.yaml new file mode 100644 index 0000000000..18462a72a4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductTag.yaml @@ -0,0 +1,13 @@ +type: object +description: SUMMARY +required: + - value +properties: + value: + type: string + title: value + description: The product tag's value. + metadata: + type: object + description: The product tag's metadata. +x-schemaName: AdminCreateProductTag diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePromotionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePromotionRule.yaml new file mode 100644 index 0000000000..71606d0bd6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePromotionRule.yaml @@ -0,0 +1,38 @@ +type: object +description: The rule's rules. +x-schemaName: AdminCreatePromotionRule +required: + - operator + - attribute + - values +properties: + operator: + type: string + description: The rule's operator. + enum: + - gt + - lt + - eq + - ne + - in + - lte + - gte + description: + type: string + title: description + description: The rule's description. + attribute: + type: string + title: attribute + description: The rule's attribute. + values: + oneOf: + - type: string + title: values + description: The rule's values. + - type: array + description: The rule's values. + items: + type: string + title: values + description: The value's values. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateRefundReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateRefundReason.yaml new file mode 100644 index 0000000000..1cac026bcd --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateRefundReason.yaml @@ -0,0 +1,14 @@ +type: object +description: SUMMARY +required: + - label +properties: + label: + type: string + title: label + description: The refund reason's label. + description: + 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 new file mode 100644 index 0000000000..a25a942ec7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateRegion.yaml @@ -0,0 +1,40 @@ +type: object +description: SUMMARY +required: + - name + - currency_code +properties: + name: + type: string + title: name + description: The region's name. + currency_code: + type: string + title: currency_code + description: The region's currency code. + countries: + type: array + description: The region's countries. + items: + type: string + title: countries + description: The country's countries. + automatic_taxes: + type: boolean + title: automatic_taxes + description: The region's automatic taxes. + payment_providers: + type: array + description: The region's payment providers. + items: + type: string + title: payment_providers + description: The payment provider's payment providers. + 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 new file mode 100644 index 0000000000..928e366407 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateReservation.yaml @@ -0,0 +1,31 @@ +type: object +description: SUMMARY +required: + - location_id + - inventory_item_id + - quantity +properties: + line_item_id: + type: string + title: line_item_id + description: The reservation's line item id. + location_id: + type: string + title: location_id + description: The reservation's location id. + inventory_item_id: + type: string + title: inventory_item_id + description: The reservation's inventory item id. + quantity: + type: number + title: quantity + description: The reservation's quantity. + description: + type: string + title: description + description: The reservation's description. + metadata: + type: object + description: The reservation's metadata. +x-schemaName: AdminCreateReservation diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateSalesChannel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateSalesChannel.yaml index 95757db18b..21e8775112 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateSalesChannel.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateSalesChannel.yaml @@ -3,8 +3,6 @@ description: SUMMARY x-schemaName: AdminCreateSalesChannel required: - name - - description - - metadata properties: name: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml new file mode 100644 index 0000000000..34fbcd4738 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml @@ -0,0 +1,76 @@ +type: object +description: SUMMARY +required: + - name + - service_zone_id + - shipping_profile_id + - price_type + - provider_id + - type + - prices +properties: + name: + type: string + title: name + description: The shipping option's name. + service_zone_id: + type: string + title: service_zone_id + description: The shipping option's service zone id. + shipping_profile_id: + type: string + title: shipping_profile_id + description: The shipping option's shipping profile id. + data: + type: object + description: The shipping option's data. + price_type: + type: string + enum: + - calculated + - flat + provider_id: + type: string + title: provider_id + description: The shipping option's provider id. + type: + type: object + prices: + type: array + description: The shipping option's prices. + items: + oneOf: + - type: object + description: The price's prices. + required: + - currency_code + - amount + properties: + currency_code: + type: string + title: currency_code + description: The price's currency code. + amount: + type: number + title: amount + description: The price's amount. + - type: object + description: The price's prices. + required: + - region_id + - amount + properties: + region_id: + type: string + title: region_id + description: The price's region id. + amount: + type: number + title: amount + description: The price's amount. + rules: + type: array + 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 new file mode 100644 index 0000000000..c974d26878 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOptionRule.yaml @@ -0,0 +1,34 @@ +type: object +description: The rule's rules. +required: + - operator + - attribute + - value +properties: + operator: + type: string + enum: + - in + - eq + - ne + - gt + - gte + - lt + - lte + - nin + attribute: + type: string + title: attribute + description: The rule's attribute. + value: + oneOf: + - type: string + title: value + description: The rule's value. + - type: array + description: The rule's value. + items: + type: string + title: value + description: The value's details. +x-schemaName: AdminCreateShippingOptionRule diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStockLocation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStockLocation.yaml index 8e3ef68737..3766f7c914 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStockLocation.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStockLocation.yaml @@ -3,62 +3,17 @@ description: SUMMARY x-schemaName: AdminCreateStockLocation required: - name - - address_id - - metadata properties: name: type: string title: name description: The stock location's name. - address: - type: object - description: The stock location's address. - required: - - address_1 - - address_2 - - company - - city - - country_code - - phone - - postal_code - - province - properties: - address_1: - type: string - title: address_1 - description: The address's address 1. - address_2: - type: string - title: address_2 - description: The address's address 2. - company: - type: string - title: company - description: The address's company. - city: - type: string - title: city - description: The address's city. - country_code: - type: string - title: country_code - description: The address's country code. - phone: - type: string - title: phone - description: The address's phone. - postal_code: - type: string - title: postal_code - description: The address's postal code. - province: - type: string - title: province - description: The address's province. address_id: type: string title: address_id description: The stock location's address id. + address: + $ref: ./AdminUpsertStockLocationAddress.yaml metadata: type: object description: The stock location's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRate.yaml index 0ae78fdda5..32492385be 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRate.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRate.yaml @@ -4,8 +4,15 @@ x-schemaName: AdminCreateTaxRate required: - name - tax_region_id - - metadata properties: + name: + type: string + title: name + description: The tax rate's name. + tax_region_id: + type: string + title: tax_region_id + description: The tax rate's tax region id. rate: type: number title: rate @@ -18,24 +25,7 @@ properties: type: array description: The tax rate's rules. items: - type: object - description: The rule's rules. - required: - - reference - - reference_id - properties: - reference: - type: string - title: reference - description: The rule's reference. - reference_id: - type: string - title: reference_id - description: The rule's reference id. - name: - type: string - title: name - description: The tax rate's name. + $ref: ./AdminCreateTaxRateRule.yaml is_default: type: boolean title: is_default @@ -44,10 +34,6 @@ properties: type: boolean title: is_combinable description: The tax rate's is combinable. - tax_region_id: - type: string - title: tax_region_id - description: The tax rate's tax region id. metadata: type: object description: The tax rate's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml index 4958a3b256..2e24b98894 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml @@ -3,9 +3,6 @@ description: SUMMARY x-schemaName: AdminCreateTaxRegion required: - country_code - - province_code - - parent_id - - metadata properties: country_code: type: string @@ -24,7 +21,6 @@ properties: description: The tax region's default tax rate. required: - name - - metadata properties: rate: type: number diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomer.yaml index f1f78d98b3..efce81ce39 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomer.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomer.yaml @@ -1,5 +1,5 @@ type: object -description: The customer's details. +description: The order's customer. x-schemaName: AdminCustomer required: - has_account diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroup.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroup.yaml index c4610e86ec..ba7722625f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroup.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroup.yaml @@ -1,37 +1,3 @@ type: object description: The group's groups. x-schemaName: AdminCustomerGroup -required: - - id - - name - - customers - - metadata - - created_at - - updated_at -properties: - id: - type: string - title: id - description: The group's ID. - name: - type: string - title: name - description: The group's name. - customers: - type: array - description: The group's customers. - items: - $ref: ./BaseCustomer.yaml - metadata: - type: object - description: The group's metadata. - created_at: - type: string - format: date-time - title: created_at - description: The group's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The group's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerInGroupFilters.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerInGroupFilters.yaml new file mode 100644 index 0000000000..11fdbf8084 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerInGroupFilters.yaml @@ -0,0 +1,609 @@ +type: object +description: The customer group's customers. +x-schemaName: AdminCustomerInGroupFilters +properties: + 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. + 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: >- + Join 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`). + default_billing_address_id: + oneOf: + - type: string + title: default_billing_address_id + description: The customer's default billing address id. + - type: array + description: The customer's default billing address id. + items: + type: string + title: default_billing_address_id + description: The default billing address id's details. + default_shipping_address_id: + oneOf: + - type: string + title: default_shipping_address_id + description: The customer's default shipping address id. + - type: array + description: The customer's default shipping address id. + items: + type: string + title: default_shipping_address_id + description: The default shipping address id's details. + 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. + 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. + 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. + 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. + created_at: + type: object + description: The customer'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. + - 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: >- + Join 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`). + deleted_at: + type: object + description: The customer'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. + - 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`). diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePaymentCollectionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePaymentCollectionResponse.yaml new file mode 100644 index 0000000000..042dc95d6a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePaymentCollectionResponse.yaml @@ -0,0 +1,21 @@ +type: object +description: SUMMARY +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The payment collection's ID. + object: + type: string + title: object + description: The name of the deleted object. + default: payment-collection + deleted: + type: boolean + title: deleted + description: Whether the payment collection was deleted. +x-schemaName: AdminDeletePaymentCollectionResponse diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml index d56f162420..90011a0ac8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml @@ -95,7 +95,7 @@ properties: description: The exchange's email. format: email display_id: - type: string + type: number title: display_id description: The exchange's display id. shipping_address: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeDeleteResponse.yaml new file mode 100644 index 0000000000..78d029950c --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeDeleteResponse.yaml @@ -0,0 +1,21 @@ +type: object +description: SUMMARY +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The exchange's ID. + object: + type: string + title: object + description: The name of the deleted object. + default: exchange + deleted: + type: boolean + title: deleted + description: Whether the exchange was deleted. +x-schemaName: AdminExchangeDeleteResponse 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 01f7f452c6..3414f22b02 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSet.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSet.yaml @@ -1,6 +1,40 @@ type: object -description: The fulfillment set's details. -x-schemaName: AdminFulfillmentSet +description: The fulfillment set that the service zone belongs to. +properties: + id: + type: string + title: id + description: The parent's ID. + name: + type: string + title: name + description: The parent's name. + type: + type: string + title: type + description: The parent's type. + location: + $ref: ./AdminStockLocation.yaml + service_zones: + type: array + description: The parent's service zones. + items: + $ref: ./AdminServiceZone.yaml + created_at: + type: string + format: date-time + title: created_at + description: The parent's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The parent's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The parent's deleted at. required: - id - name @@ -10,38 +44,4 @@ required: - created_at - updated_at - deleted_at -properties: - id: - type: string - title: id - description: The fulfillment set's ID. - name: - type: string - title: name - description: The fulfillment set's name. - type: - type: string - title: type - description: The fulfillment set's type. - location: - $ref: ./AdminStockLocation.yaml - service_zones: - type: array - description: The fulfillment set's service zones. - items: - $ref: ./AdminServiceZone.yaml - created_at: - type: string - format: date-time - title: created_at - description: The fulfillment set's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The fulfillment set's updated at. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The fulfillment set's deleted at. +x-schemaName: AdminFulfillmentSet diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetDeleteResponse.yaml index e8068b4b01..130dc3c7b4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Fulfillment Set was deleted. - parent: - type: object - description: The fulfillment set's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGetUploadParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGetUploadParams.yaml deleted file mode 100644 index 16e5d808f7..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminGetUploadParams.yaml +++ /dev/null @@ -1,8 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminGetUploadParams -properties: - fields: - type: string - title: fields - description: The upload's fields. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItem.yaml index 58e6de4897..cf8ed2a6db 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItem.yaml @@ -64,3 +64,8 @@ properties: metadata: type: object description: The inventory item's metadata. + location_levels: + type: array + description: The inventory item's location levels. + items: + $ref: ./AdminInventoryLevel.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryLevel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryLevel.yaml new file mode 100644 index 0000000000..cf4a36a390 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryLevel.yaml @@ -0,0 +1,76 @@ +type: object +description: The location level's location levels. +x-schemaName: AdminInventoryLevel +required: + - id + - created_at + - updated_at + - deleted_at + - inventory_item_id + - location_id + - stocked_quantity + - raw_stocked_quantity + - reserved_quantity + - raw_reserved_quantity + - incoming_quantity + - raw_incoming_quantity + - metadata + - available_quantity +properties: + id: + type: string + title: id + description: The location level's ID. + created_at: + type: string + format: date-time + title: created_at + description: The location level's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The location level's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The location level's deleted at. + inventory_item_id: + type: string + title: inventory_item_id + description: The location level's inventory item id. + location_id: + type: string + title: location_id + description: The location level's location id. + stocked_quantity: + type: number + title: stocked_quantity + description: The location level's stocked quantity. + raw_stocked_quantity: + type: object + description: The location level's raw stocked quantity. + reserved_quantity: + type: number + title: reserved_quantity + description: The location level's reserved quantity. + raw_reserved_quantity: + type: object + description: The location level's raw reserved quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The location level's incoming quantity. + raw_incoming_quantity: + type: object + description: The location level's raw incoming quantity. + metadata: + type: object + description: The location level's metadata. + inventory_item: + type: object + available_quantity: + type: number + title: available_quantity + description: The location level's available quantity. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml index e26100a5de..fd216bb354 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml @@ -51,6 +51,14 @@ properties: description: The order's fulfillments. items: $ref: ./BaseOrderFulfillment.yaml + sales_channel: + $ref: ./AdminSalesChannel.yaml + customer: + $ref: ./AdminCustomer.yaml + shipping_address: + $ref: ./AdminOrderAddress.yaml + billing_address: + $ref: ./AdminOrderAddress.yaml id: type: string title: id @@ -81,13 +89,9 @@ properties: title: currency_code description: The order's currency code. display_id: - type: string + type: number title: display_id description: The order's display id. - shipping_address: - $ref: ./BaseOrderAddress.yaml - billing_address: - $ref: ./BaseOrderAddress.yaml items: type: array description: The order's items. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderAddress.yaml new file mode 100644 index 0000000000..0fda1d2756 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderAddress.yaml @@ -0,0 +1,72 @@ +type: object +description: The order's billing address. +x-schemaName: AdminOrderAddress +required: + - id + - metadata + - created_at + - updated_at +properties: + country: + $ref: ./AdminRegionCountry.yaml + id: + type: string + title: id + description: The billing address's ID. + customer_id: + type: string + title: customer_id + description: The billing address's customer id. + first_name: + type: string + title: first_name + description: The billing address's first name. + last_name: + type: string + title: last_name + description: The billing address's last name. + phone: + type: string + title: phone + description: The billing address's phone. + company: + type: string + title: company + description: The billing address's company. + address_1: + type: string + title: address_1 + description: The billing address's address 1. + address_2: + type: string + title: address_2 + description: The billing address's address 2. + city: + type: string + title: city + description: The billing address's city. + country_code: + type: string + title: country_code + description: The billing address's country code. + province: + type: string + title: province + description: The billing address's province. + postal_code: + type: string + title: postal_code + description: The billing address's postal code. + metadata: + type: object + description: The billing address's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The billing address's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The billing address's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml index b7b508bb87..c2149ed29a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml @@ -491,13 +491,13 @@ properties: description: The order preview's email. format: email display_id: - type: string + type: number title: display_id description: The order preview's display id. shipping_address: - $ref: ./BaseOrderAddress.yaml + $ref: ./AdminOrderAddress.yaml billing_address: - $ref: ./BaseOrderAddress.yaml + $ref: ./AdminOrderAddress.yaml payment_collections: type: array description: The order preview's payment collections. @@ -642,3 +642,7 @@ properties: type: number title: original_shipping_tax_total description: The order preview's original shipping tax total. + customer: + $ref: ./AdminCustomer.yaml + sales_channel: + $ref: ./AdminSalesChannel.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml index 310a95819b..d7e323c8f9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Price List was deleted. - parent: - type: object - description: The price list's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml index 88ad9e74bf..8f38315baa 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Price Preference was deleted. - parent: - type: object - description: The price preference's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml index fd29fa661a..3fe71d64f6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml @@ -3,9 +3,9 @@ description: The product's parent. x-schemaName: AdminProduct required: - type + - length - title - status - - length - options - description - id @@ -53,6 +53,10 @@ properties: description: The parent's tags. items: $ref: ./AdminProductTag.yaml + length: + type: number + title: length + description: The parent's length. title: type: string title: title @@ -65,10 +69,6 @@ properties: - proposed - published - rejected - length: - type: number - title: length - description: The parent's length. options: type: array description: The parent's options. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml index bbccf4934a..b2531e9fab 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Product Category was deleted. - parent: - type: object - description: The product category's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductDeleteResponse.yaml index e254c15d68..8a448dd6a4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Product was deleted. - parent: - type: object - description: The product's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionDeleteResponse.yaml index d3f1b213af..0873a46f9a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionDeleteResponse.yaml @@ -14,7 +14,6 @@ properties: type: string title: object description: The name of the deleted object. - default: product_option deleted: type: boolean title: deleted diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagDeleteResponse.yaml index 5304b49c5b..33697dcfd2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Product Tag was deleted. - parent: - type: object - description: The product tag's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeDeleteResponse.yaml index faa54a3337..797b5fd754 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Product Type was deleted. - parent: - type: object - description: The product type's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantDeleteResponse.yaml index 7663cc2969..52094f9db2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantDeleteResponse.yaml @@ -14,7 +14,6 @@ properties: type: string title: object description: The name of the deleted object. - default: variant deleted: type: boolean title: deleted 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 9aca47220c..5388547b61 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml @@ -17,31 +17,395 @@ properties: type: string title: id description: The id's ID. - sku: - oneOf: - - type: string - title: sku - description: The variant's sku. - - type: array - description: The variant's sku. - items: - type: string - title: sku - description: The sku's details. - product_id: - oneOf: - - type: string - title: product_id - description: The variant's product id. - - type: array - description: The variant's product id. - items: - type: string - title: product_id - description: The product id's details. - options: + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + allow_backorder: + type: boolean + title: allow_backorder + description: The variant's allow backorder. + created_at: type: object - description: The variant's options. + description: The variant'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. + - 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 variant'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. + - 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 variant'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. + - 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 @@ -60,13 +424,17 @@ properties: description: The variant's fields. $and: type: array - description: The variant'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 variant'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/components/schemas/AdminRegionCountry.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRegionCountry.yaml new file mode 100644 index 0000000000..04938da440 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRegionCountry.yaml @@ -0,0 +1,3 @@ +type: object +description: The billing address's country. +x-schemaName: AdminRegionCountry diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReservation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReservation.yaml index 29f54068a7..df021b64bd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReservation.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReservation.yaml @@ -24,7 +24,7 @@ properties: title: location_id description: The reservation's location id. quantity: - type: string + type: number title: quantity description: The reservation's quantity. external_id: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonDeleteResponse.yaml new file mode 100644 index 0000000000..78053ef89d --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonDeleteResponse.yaml @@ -0,0 +1,21 @@ +type: object +description: SUMMARY +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The return reason's ID. + object: + type: string + title: object + description: The name of the deleted object. + default: return_reason + deleted: + type: boolean + title: deleted + description: Whether the return reason was deleted. +x-schemaName: AdminReturnReasonDeleteResponse diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannel.yaml index 4fb73f820d..9b497e936c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannel.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannel.yaml @@ -1,5 +1,5 @@ type: object -description: The sales channel's sales channels. +description: The order's sales channel. x-schemaName: AdminSalesChannel required: - id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelDeleteResponse.yaml index d4e8756457..fc93322002 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Sales Channel was deleted. - parent: - type: object - description: The sales channel's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneDeleteResponse.yaml new file mode 100644 index 0000000000..62609511c4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneDeleteResponse.yaml @@ -0,0 +1,23 @@ +type: object +description: SUMMARY +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The service zone'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. + parent: + $ref: ./AdminFulfillmentSet.yaml +x-schemaName: AdminServiceZoneDeleteResponse diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionDeleteResponse.yaml index fb43eb3166..141ba6526b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Shipping Option was deleted. - parent: - type: object - description: The shipping option's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileDeleteResponse.yaml index 426860c955..bca17d5e8b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Shipping Profile was deleted. - parent: - type: object - description: The shipping profile's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocation.yaml index e4f23a4318..76f80ec99c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocation.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocation.yaml @@ -1,5 +1,5 @@ type: object -description: The fulfillment set's location. +description: The parent's location. x-schemaName: AdminStockLocation required: - id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationDeleteResponse.yaml index f3250de0ed..7d1160157d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Stock Location was deleted. - parent: - type: object - description: The stock location's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRate.yaml index 35d3b37a92..f0321f5651 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRate.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRate.yaml @@ -1,5 +1,5 @@ type: object -description: The tax rate's details. +description: The tax rate's parent. x-schemaName: AdminTaxRate required: - id @@ -20,57 +20,57 @@ properties: id: type: string title: id - description: The tax rate's ID. + description: The parent's ID. rate: type: number title: rate - description: The tax rate's rate. + description: The parent's rate. code: type: string title: code - description: The tax rate's code. + description: The parent's code. name: type: string title: name - description: The tax rate's name. + description: The parent's name. metadata: type: object - description: The tax rate's metadata. + description: The parent's metadata. tax_region_id: type: string title: tax_region_id - description: The tax rate's tax region id. + description: The parent's tax region id. is_combinable: type: boolean title: is_combinable - description: The tax rate's is combinable. + description: The parent's is combinable. is_default: type: boolean title: is_default - description: The tax rate's is default. + description: The parent's is default. created_at: type: string format: date-time title: created_at - description: The tax rate's created at. + description: The parent's created at. updated_at: type: string format: date-time title: updated_at - description: The tax rate's updated at. + description: The parent's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The tax rate's deleted at. + description: The parent's deleted at. created_by: type: string title: created_by - description: The tax rate's created by. + description: The parent's created by. tax_region: $ref: ./AdminTaxRegion.yaml rules: type: array - description: The tax rate's rules. + description: The parent's rules. items: $ref: ./AdminTaxRateRule.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateDeleteResponse.yaml index aa496ab053..6c284786d9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Tax Rate was deleted. - parent: - type: object - description: The tax rate's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml index a9597eba8a..5ee5e6b8e0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml @@ -1,5 +1,5 @@ type: object -description: The tax rate's tax region. +description: The parent's tax region. x-schemaName: AdminTaxRegion required: - id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionDeleteResponse.yaml index 4e2ac8feb4..235dd86a80 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Tax Region was deleted. - parent: - type: object - description: The tax region's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpsertStockLocationAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpsertStockLocationAddress.yaml new file mode 100644 index 0000000000..b0e8d7c033 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpsertStockLocationAddress.yaml @@ -0,0 +1,39 @@ +type: object +description: The stock location's address. +x-schemaName: AdminUpsertStockLocationAddress +required: + - address_1 + - country_code +properties: + address_1: + type: string + title: address_1 + description: The address's address 1. + address_2: + type: string + title: address_2 + description: The address's address 2. + company: + type: string + title: company + description: The address's company. + country_code: + type: string + title: country_code + description: The address's country code. + city: + type: string + title: city + description: The address's city. + phone: + type: string + title: phone + description: The address's phone. + postal_code: + type: string + title: postal_code + description: The address's postal code. + province: + type: string + title: province + description: The address's province. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUserDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUserDeleteResponse.yaml index eb3c002ae6..fb9888ff23 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUserDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUserDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the User was deleted. - parent: - type: object - description: The user's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCartAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCartAddress.yaml index 830384378e..0cc3faf4c1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCartAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCartAddress.yaml @@ -1,5 +1,5 @@ type: object -description: The cart's billing address. +description: The parent's billing address. x-schemaName: BaseCartAddress required: - id diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCustomer.yaml deleted file mode 100644 index 97d46ce957..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCustomer.yaml +++ /dev/null @@ -1,3 +0,0 @@ -type: object -description: The customer's customers. -x-schemaName: BaseCustomer diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCustomerAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCustomerAddress.yaml index b5f75c39e6..906bc9231d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCustomerAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCustomerAddress.yaml @@ -1,96 +1,3 @@ type: object description: The address's addresses. x-schemaName: BaseCustomerAddress -required: - - id - - address_name - - is_default_shipping - - is_default_billing - - customer_id - - company - - first_name - - last_name - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - phone - - metadata - - created_at - - updated_at -properties: - id: - type: string - title: id - description: The address's ID. - address_name: - type: string - title: address_name - description: The address's address name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: The address's is default shipping. - is_default_billing: - type: boolean - title: is_default_billing - description: The address's is default billing. - customer_id: - type: string - title: customer_id - description: The address's customer id. - company: - type: string - title: company - description: The address's company. - first_name: - type: string - title: first_name - description: The address's first name. - last_name: - type: string - title: last_name - description: The address's last name. - address_1: - type: string - title: address_1 - description: The address's address 1. - address_2: - type: string - title: address_2 - description: The address's address 2. - city: - type: string - title: city - description: The address's city. - country_code: - type: string - title: country_code - description: The address's country code. - province: - type: string - title: province - description: The address's province. - postal_code: - type: string - title: postal_code - description: The address's postal code. - phone: - type: string - title: phone - description: The address's phone. - metadata: - type: object - description: The address's metadata. - created_at: - type: string - format: date-time - title: created_at - description: The address's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The address's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml index 4c549387e7..f1896707cd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml @@ -1,5 +1,5 @@ type: object -description: The order's billing address. +description: The exchange's billing address. x-schemaName: BaseOrderAddress required: - id diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseRegion.yaml index c90e5373dc..778b10a689 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseRegion.yaml @@ -1,5 +1,5 @@ type: object -description: The cart's region. +description: The parent's region. x-schemaName: BaseRegion required: - id diff --git a/www/apps/api-reference/specs/admin/components/schemas/CustomerGroupInCustomerFilters.yaml b/www/apps/api-reference/specs/admin/components/schemas/CustomerGroupInCustomerFilters.yaml new file mode 100644 index 0000000000..fcc67cf89c --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/CustomerGroupInCustomerFilters.yaml @@ -0,0 +1,413 @@ +type: object +description: The customer's groups. +x-schemaName: CustomerGroupInCustomerFilters +required: + - id + - name + - created_at + - updated_at + - deleted_at +properties: + id: + oneOf: + - type: string + title: id + description: The group's ID. + - type: array + description: The group's ID. + items: + type: string + title: id + description: The id's ID. + name: + oneOf: + - type: string + title: name + description: The group's name. + - type: array + description: The group's name. + items: + type: string + title: name + description: The name's details. + created_at: + type: object + description: The group'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. + - 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 group'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. + - 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 group'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. + - 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`). diff --git a/www/apps/api-reference/specs/admin/components/schemas/FileList.yaml b/www/apps/api-reference/specs/admin/components/schemas/FileList.yaml new file mode 100644 index 0000000000..2bc70ab8fb --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/FileList.yaml @@ -0,0 +1,18 @@ +type: object +description: SUMMARY +x-schemaName: FileList +required: + - length + - item + - __@iterator@258 +properties: + length: + type: number + title: length + description: The upload's length. + item: + type: object + description: The upload's item. + __@iterator@258: + type: object + description: The upload's @iterator@258. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml index 9974725fda..73037779af 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml @@ -1,5 +1,5 @@ type: object -description: The cart's details. +description: The cart's parent. x-schemaName: StoreCart required: - id @@ -30,320 +30,320 @@ properties: id: type: string title: id - description: The cart's ID. + description: The parent's ID. region: $ref: ./BaseRegion.yaml region_id: type: string title: region_id - description: The cart's region id. + description: The parent's region id. customer_id: type: string title: customer_id - description: The cart's customer id. + description: The parent's customer id. sales_channel_id: type: string title: sales_channel_id - description: The cart's sales channel id. + description: The parent's sales channel id. email: type: string title: email - description: The cart's email. + description: The parent's email. format: email currency_code: type: string title: currency_code - description: The cart's currency code. + description: The parent's currency code. shipping_address: $ref: ./BaseCartAddress.yaml billing_address: $ref: ./BaseCartAddress.yaml items: type: array - description: The cart's items. + description: The parent's items. items: $ref: ./BaseCartLineItem.yaml shipping_methods: type: array - description: The cart's shipping methods. + description: The parent's shipping methods. items: $ref: ./BaseCartShippingMethod.yaml payment_collection: $ref: ./BasePaymentCollection.yaml metadata: type: object - description: The cart's metadata. + description: The parent's metadata. created_at: type: string format: date-time title: created_at - description: The cart's created at. + description: The parent's created at. updated_at: type: string format: date-time title: updated_at - description: The cart's updated at. + description: The parent's updated at. original_item_total: oneOf: - type: string title: original_item_total - description: The cart's original item total. + description: The parent's original item total. - type: number title: original_item_total - description: The cart's original item total. + description: The parent's original item total. - type: string title: original_item_total - description: The cart's original item total. + description: The parent's original item total. - $ref: ./IBigNumber.yaml original_item_subtotal: oneOf: - type: string title: original_item_subtotal - description: The cart's original item subtotal. + description: The parent's original item subtotal. - type: number title: original_item_subtotal - description: The cart's original item subtotal. + description: The parent's original item subtotal. - type: string title: original_item_subtotal - description: The cart's original item subtotal. + description: The parent's original item subtotal. - $ref: ./IBigNumber.yaml original_item_tax_total: oneOf: - type: string title: original_item_tax_total - description: The cart's original item tax total. + description: The parent's original item tax total. - type: number title: original_item_tax_total - description: The cart's original item tax total. + description: The parent's original item tax total. - type: string title: original_item_tax_total - description: The cart's original item tax total. + description: The parent's original item tax total. - $ref: ./IBigNumber.yaml item_total: oneOf: - type: string title: item_total - description: The cart's item total. + description: The parent's item total. - type: number title: item_total - description: The cart's item total. + description: The parent's item total. - type: string title: item_total - description: The cart's item total. + description: The parent's item total. - $ref: ./IBigNumber.yaml item_subtotal: oneOf: - type: string title: item_subtotal - description: The cart's item subtotal. + description: The parent's item subtotal. - type: number title: item_subtotal - description: The cart's item subtotal. + description: The parent's item subtotal. - type: string title: item_subtotal - description: The cart's item subtotal. + description: The parent's item subtotal. - $ref: ./IBigNumber.yaml item_tax_total: oneOf: - type: string title: item_tax_total - description: The cart's item tax total. + description: The parent's item tax total. - type: number title: item_tax_total - description: The cart's item tax total. + description: The parent's item tax total. - type: string title: item_tax_total - description: The cart's item tax total. + description: The parent's item tax total. - $ref: ./IBigNumber.yaml original_total: oneOf: - type: string title: original_total - description: The cart's original total. + description: The parent's original total. - type: number title: original_total - description: The cart's original total. + description: The parent's original total. - type: string title: original_total - description: The cart's original total. + description: The parent's original total. - $ref: ./IBigNumber.yaml original_subtotal: oneOf: - type: string title: original_subtotal - description: The cart's original subtotal. + description: The parent's original subtotal. - type: number title: original_subtotal - description: The cart's original subtotal. + description: The parent's original subtotal. - type: string title: original_subtotal - description: The cart's original subtotal. + description: The parent's original subtotal. - $ref: ./IBigNumber.yaml original_tax_total: oneOf: - type: string title: original_tax_total - description: The cart's original tax total. + description: The parent's original tax total. - type: number title: original_tax_total - description: The cart's original tax total. + description: The parent's original tax total. - type: string title: original_tax_total - description: The cart's original tax total. + description: The parent's original tax total. - $ref: ./IBigNumber.yaml total: oneOf: - type: string title: total - description: The cart's total. + description: The parent's total. - type: number title: total - description: The cart's total. + description: The parent's total. - type: string title: total - description: The cart's total. + description: The parent's total. - $ref: ./IBigNumber.yaml subtotal: oneOf: - type: string title: subtotal - description: The cart's subtotal. + description: The parent's subtotal. - type: number title: subtotal - description: The cart's subtotal. + description: The parent's subtotal. - type: string title: subtotal - description: The cart's subtotal. + description: The parent's subtotal. - $ref: ./IBigNumber.yaml tax_total: oneOf: - type: string title: tax_total - description: The cart's tax total. + description: The parent's tax total. - type: number title: tax_total - description: The cart's tax total. + description: The parent's tax total. - type: string title: tax_total - description: The cart's tax total. + description: The parent's tax total. - $ref: ./IBigNumber.yaml discount_total: oneOf: - type: string title: discount_total - description: The cart's discount total. + description: The parent's discount total. - type: number title: discount_total - description: The cart's discount total. + description: The parent's discount total. - type: string title: discount_total - description: The cart's discount total. + description: The parent's discount total. - $ref: ./IBigNumber.yaml discount_tax_total: oneOf: - type: string title: discount_tax_total - description: The cart's discount tax total. + description: The parent's discount tax total. - type: number title: discount_tax_total - description: The cart's discount tax total. + description: The parent's discount tax total. - type: string title: discount_tax_total - description: The cart's discount tax total. + description: The parent's discount tax total. - $ref: ./IBigNumber.yaml gift_card_total: oneOf: - type: string title: gift_card_total - description: The cart's gift card total. + description: The parent's gift card total. - type: number title: gift_card_total - description: The cart's gift card total. + description: The parent's gift card total. - type: string title: gift_card_total - description: The cart's gift card total. + description: The parent's gift card total. - $ref: ./IBigNumber.yaml gift_card_tax_total: oneOf: - type: string title: gift_card_tax_total - description: The cart's gift card tax total. + description: The parent's gift card tax total. - type: number title: gift_card_tax_total - description: The cart's gift card tax total. + description: The parent's gift card tax total. - type: string title: gift_card_tax_total - description: The cart's gift card tax total. + description: The parent's gift card tax total. - $ref: ./IBigNumber.yaml shipping_total: oneOf: - type: string title: shipping_total - description: The cart's shipping total. + description: The parent's shipping total. - type: number title: shipping_total - description: The cart's shipping total. + description: The parent's shipping total. - type: string title: shipping_total - description: The cart's shipping total. + description: The parent's shipping total. - $ref: ./IBigNumber.yaml shipping_subtotal: oneOf: - type: string title: shipping_subtotal - description: The cart's shipping subtotal. + description: The parent's shipping subtotal. - type: number title: shipping_subtotal - description: The cart's shipping subtotal. + description: The parent's shipping subtotal. - type: string title: shipping_subtotal - description: The cart's shipping subtotal. + description: The parent's shipping subtotal. - $ref: ./IBigNumber.yaml shipping_tax_total: oneOf: - type: string title: shipping_tax_total - description: The cart's shipping tax total. + description: The parent's shipping tax total. - type: number title: shipping_tax_total - description: The cart's shipping tax total. + description: The parent's shipping tax total. - type: string title: shipping_tax_total - description: The cart's shipping tax total. + description: The parent's shipping tax total. - $ref: ./IBigNumber.yaml original_shipping_total: oneOf: - type: string title: original_shipping_total - description: The cart's original shipping total. + description: The parent's original shipping total. - type: number title: original_shipping_total - description: The cart's original shipping total. + description: The parent's original shipping total. - type: string title: original_shipping_total - description: The cart's original shipping total. + description: The parent's original shipping total. - $ref: ./IBigNumber.yaml original_shipping_subtotal: oneOf: - type: string title: original_shipping_subtotal - description: The cart's original shipping subtotal. + description: The parent's original shipping subtotal. - type: number title: original_shipping_subtotal - description: The cart's original shipping subtotal. + description: The parent's original shipping subtotal. - type: string title: original_shipping_subtotal - description: The cart's original shipping subtotal. + description: The parent's original shipping subtotal. - $ref: ./IBigNumber.yaml original_shipping_tax_total: oneOf: - type: string title: original_shipping_tax_total - description: The cart's original shipping tax total. + description: The parent's original shipping tax total. - type: number title: original_shipping_tax_total - description: The cart's original shipping tax total. + description: The parent's original shipping tax total. - type: string title: original_shipping_tax_total - description: The cart's original shipping tax total. + description: The parent's original shipping tax total. - $ref: ./IBigNumber.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCustomer.yaml index 07e7bc885c..f8f116c0fa 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCustomer.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCustomer.yaml @@ -3,10 +3,6 @@ description: SUMMARY x-schemaName: StoreCreateCustomer required: - email - - company_name - - first_name - - last_name - - phone properties: email: type: string @@ -29,3 +25,6 @@ properties: type: string title: phone description: The customer's phone. + metadata: + type: object + description: The customer's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCreatePaymentCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCreatePaymentCollection.yaml new file mode 100644 index 0000000000..f0f56b1048 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCreatePaymentCollection.yaml @@ -0,0 +1,10 @@ +type: object +description: SUMMARY +required: + - cart_id +properties: + cart_id: + 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/StoreCreateReturn.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturn.yaml new file mode 100644 index 0000000000..60c6dc1fd5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturn.yaml @@ -0,0 +1,31 @@ +type: object +description: SUMMARY +x-schemaName: StoreCreateReturn +required: + - order_id + - items + - return_shipping +properties: + order_id: + type: string + title: order_id + description: The return's order id. + items: + type: array + description: The return's items. + items: + $ref: ./StoreCreateReturnItem.yaml + return_shipping: + $ref: ./StoreCreateReturnShipping.yaml + note: + type: string + title: note + description: The return's note. + receive_now: + type: boolean + title: receive_now + description: The return's receive now. + location_id: + type: string + title: location_id + description: The return's location id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnItem.yaml new file mode 100644 index 0000000000..839a17cf5c --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnItem.yaml @@ -0,0 +1,23 @@ +type: object +description: The item's items. +required: + - id + - quantity +properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + reason_id: + type: string + title: reason_id + description: The item's reason id. + note: + 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 new file mode 100644 index 0000000000..ad5ccf7fdc --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnShipping.yaml @@ -0,0 +1,14 @@ +type: object +description: The return's return shipping. +required: + - option_id +properties: + option_id: + type: string + title: option_id + description: The return shipping's option id. + price: + type: number + title: price + description: The return shipping's price. +x-schemaName: StoreCreateReturnShipping diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomer.yaml index bbb8caf8e9..c6626ecc9c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomer.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomer.yaml @@ -1,5 +1,5 @@ type: object -description: The customer's details. +description: The customer's parent. x-schemaName: StoreCustomer required: - id @@ -14,60 +14,60 @@ properties: id: type: string title: id - description: The customer's ID. + description: The parent's ID. email: type: string title: email - description: The customer's email. + description: The parent's email. format: email default_billing_address_id: type: string title: default_billing_address_id - description: The customer's default billing address id. + description: The parent's default billing address id. default_shipping_address_id: type: string title: default_shipping_address_id - description: The customer's default shipping address id. + description: The parent's default shipping address id. company_name: type: string title: company_name - description: The customer's company name. + description: The parent's company name. first_name: type: string title: first_name - description: The customer's first name. + description: The parent's first name. last_name: type: string title: last_name - description: The customer's last name. + description: The parent's last name. addresses: type: array - description: The customer's addresses. + description: The parent's addresses. items: $ref: ./BaseCustomerAddress.yaml phone: type: string title: phone - description: The customer's phone. + description: The parent's phone. metadata: type: object - description: The customer's metadata. + description: The parent's metadata. created_by: type: string title: created_by - description: The customer's created by. + description: The parent's created by. deleted_at: type: string format: date-time title: deleted_at - description: The customer's deleted at. + description: The parent's deleted at. created_at: type: string format: date-time title: created_at - description: The customer's created at. + description: The parent's created at. updated_at: type: string format: date-time title: updated_at - description: The customer's updated at. + description: The parent's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml index da0096fa7a..188ac9c5e5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml @@ -70,7 +70,7 @@ properties: title: currency_code description: The order's currency code. display_id: - type: string + type: number title: display_id description: The order's display id. shipping_address: diff --git a/www/apps/api-reference/specs/admin/components/schemas/StorePostReturnsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/StorePostReturnsReqSchema.yaml deleted file mode 100644 index 3ab63409b6..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/StorePostReturnsReqSchema.yaml +++ /dev/null @@ -1,68 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: StorePostReturnsReqSchema -required: - - order_id - - items - - return_shipping - - note - - location_id -properties: - order_id: - type: string - title: order_id - description: The return's order id. - items: - type: array - description: The return's items. - items: - type: object - description: The item's items. - required: - - id - - quantity - - reason_id - - note - properties: - id: - type: string - title: id - description: The item's ID. - quantity: - type: number - title: quantity - description: The item's quantity. - reason_id: - type: string - title: reason_id - description: The item's reason id. - note: - type: string - title: note - description: The item's note. - return_shipping: - type: object - description: The return's return shipping. - required: - - option_id - properties: - option_id: - type: string - title: option_id - description: The return shipping's option id. - price: - type: number - title: price - description: The return shipping's price. - note: - type: string - title: note - description: The return's note. - receive_now: - type: boolean - title: receive_now - description: The return's receive now. - location_id: - type: string - title: location_id - description: The return's location id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml index 42d6393938..7062d98f47 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml @@ -2,9 +2,9 @@ type: object description: The product's details. x-schemaName: StoreProduct required: + - length - title - status - - length - options - description - id @@ -36,6 +36,10 @@ properties: type: object type: type: object + length: + type: number + title: length + description: The product's length. title: type: string title: title @@ -48,10 +52,6 @@ properties: - proposed - published - rejected - length: - type: number - title: length - description: The product's length. options: type: array description: The product's options. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariantParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariantParams.yaml new file mode 100644 index 0000000000..295b3c1fdd --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariantParams.yaml @@ -0,0 +1,76 @@ +type: object +description: The product's variants. +x-schemaName: StoreProductVariantParams +properties: + q: + type: string + title: q + description: The variant's q. + id: + oneOf: + - type: string + title: id + description: The variant's ID. + - type: array + description: The variant's ID. + items: + type: string + title: id + description: The id's ID. + sku: + oneOf: + - type: string + title: sku + description: The variant's sku. + - type: array + description: The variant's sku. + items: + type: string + title: sku + description: The sku's details. + product_id: + oneOf: + - type: string + title: product_id + description: The variant's product id. + - type: array + description: The variant's product id. + items: + type: string + title: product_id + description: The product id's details. + options: + type: object + description: The variant's options. + limit: + type: number + title: limit + description: The variant's limit. + offset: + type: number + title: offset + description: The variant's offset. + order: + type: string + title: order + description: The variant's order. + fields: + type: string + title: fields + description: The variant'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. + 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 diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index b6e7853e32..aba8f1eb7e 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -10,7 +10,7 @@ servers: - url: https://api.medusajs.com tags: - name: Auth - description: > + description: | Auth API routes allow you to manage an admin user's authentication. - name: Api Keys description: | @@ -474,8 +474,8 @@ paths: /admin/api-keys: get: operationId: GetApiKeys - summary: List Api Keys - description: Retrieve a list of api keys. The api keys can be filtered by fields such as `id`. The api keys can also be sorted or paginated. + summary: List API Keys + description: Retrieve a list of API keys. The API keys can be filtered by fields such as `id`. The API keys can also be sorted or paginated. x-authenticated: true parameters: - name: expand @@ -518,6 +518,1009 @@ 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: A search term to search the API keys' searchable properties. + required: false + schema: + type: string + title: q + description: The search term. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: Filter by an API key's ID. + - type: array + description: Filter by API key IDs. + items: + type: string + title: id + description: The API key ID. + - name: title + in: query + required: false + schema: + oneOf: + - type: string + title: title + description: Filter by an API key's title. + - type: array + description: Filter by API key titles. + items: + type: string + title: title + description: The API key title. + - name: token + in: query + required: false + schema: + oneOf: + - type: string + title: token + description: Filter by an API key's token. + - type: array + description: Filter by API key tokens. + items: + type: string + title: token + description: The API key token. + - name: type + in: query + description: Filter by the API key's type. + required: false + schema: + type: string + enum: + - secret + - publishable + - name: created_at + in: query + description: Filter by the API key's creation date. + required: false + schema: + type: object + description: Filter by the API key'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 API key's update date. + required: false + schema: + type: object + description: Filter by the API key'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`). + - name: deleted_at + in: query + description: Filter by the API key's deletion date. + required: false + schema: + type: object + description: Filter by the API key'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 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: revoked_at + in: query + description: Filter by the API key's revoke date. + required: false + schema: + type: object + description: Filter by the API key's revoke 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: $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: [] @@ -538,7 +1541,6 @@ paths: schema: allOf: - type: object - description: SUMMARY required: - limit - offset @@ -547,23 +1549,22 @@ paths: limit: type: number title: limit - description: The api key's limit. + description: The maximum number of items returned in the list. offset: type: number title: offset - description: The api key's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The api key's count. + description: The total count of items. - type: object - description: SUMMARY required: - api_keys properties: api_keys: type: array - description: The api key's api keys. + description: The list of API keys. items: $ref: '#/components/schemas/ApiKeyResponse' '400': @@ -629,13 +1630,13 @@ paths: /admin/api-keys/{id}: get: operationId: GetApiKeysId - summary: Get a Api Key - description: Retrieve a api key by its ID. You can expand the api key's relations or select the fields that should be returned. + summary: Get API Key + description: Retrieve an API key by its ID. You can expand the API key's relations or select the fields that should be returned using the query parameters. x-authenticated: true parameters: - name: id in: path - description: The api key's ID. + description: The API key's ID. required: true schema: type: string @@ -854,9 +1855,6 @@ paths: type: boolean title: deleted description: Whether the API key was deleted. - parent: - type: object - description: The API key's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -1133,7 +2131,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of campaigns. required: - limit - offset @@ -1142,23 +2140,23 @@ paths: limit: type: number title: limit - description: The campaign's limit. + description: The maximum number of items retrieved. offset: type: number title: offset - description: The campaign's offset. + description: The number of its skipped before the returned items. count: type: number title: count - description: The campaign's count. + description: The total number of items. - type: object - description: SUMMARY + description: The list of campaigns required: - campaigns properties: campaigns: type: array - description: The campaign's campaigns. + description: The list of campaigns. items: $ref: '#/components/schemas/CampaignResponse' '400': @@ -1341,7 +2339,7 @@ paths: get: operationId: GetCampaignsId summary: Get a Campaign - description: Retrieve a campaign by its ID. You can expand the campaign's relations or select the fields that should be returned. + description: Retrieve a campaign by its ID. You can expand the campaign's relations or select the fields that should be returned using the query parameters. x-authenticated: true parameters: - name: id @@ -1626,9 +2624,6 @@ paths: type: boolean title: deleted description: Whether the campaign was deleted. - parent: - type: object - description: The campaign's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -1795,6 +2790,769 @@ 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: deleted_at + in: query + description: The claim's deleted at. + required: false + schema: + type: object + description: The claim'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: q + in: query + description: The claim's q. + required: false + schema: + type: string + title: q + description: The claim's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The claim's ID. + - type: array + description: The claim's ID. + items: + type: string + title: id + description: The id's ID. + - name: order_id + in: query + required: false + schema: + oneOf: + - type: string + title: order_id + description: The claim's order id. + - type: array + description: The claim's order id. + items: + type: string + title: order_id + description: The order id's details. + - name: status + in: query + required: false + schema: + oneOf: + - type: string + title: status + description: The claim's status. + - type: array + description: The claim's status. + items: + type: string + title: status + description: The status's details. + - name: created_at + in: query + description: The claim's created at. + required: false + schema: + type: object + description: The claim'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 claim's updated at. + required: false + schema: + type: object + description: The claim'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: $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: [] @@ -1919,7 +3677,7 @@ paths: get: operationId: GetClaimsId summary: Get a Claim - description: Retrieve a claim by its ID. You can expand the claim's relations or select the fields that should be returned. + description: Retrieve a claim by its ID. You can expand the claim's relations or select the fields that should be returned using the query parameters. x-authenticated: true parameters: - name: id @@ -3469,6 +5227,769 @@ 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: deleted_at + in: query + description: Filter by the collection's deletion date. + required: false + schema: + type: object + description: Filter by the collection'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 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: q + in: query + description: Search term to filter the collection's searchable properties by. + required: false + schema: + type: string + title: q + description: Search term to filter the collection's searchable properties by. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: Filter by a collection's ID. + - type: array + description: Filter by collection IDs. + items: + type: string + title: id + description: The collection's ID. + - name: handle + in: query + required: false + schema: + oneOf: + - type: string + title: handle + description: Filter by a collection's handle. + - type: array + description: Filter by collection handles. + items: + type: string + title: handle + description: The collection's handle. + - name: title + in: query + required: false + schema: + oneOf: + - type: string + title: title + description: Filter by a collection's title. + - type: array + description: Filter by collection titles. + items: + type: string + title: title + description: The collection's title. + - name: created_at + in: query + description: Filter by the collection's creation date. + required: false + schema: + type: object + description: Filter by the collection'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 collection's update date. + required: false + schema: + type: object + description: Filter by the collection'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`). + - 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: [] @@ -3592,7 +6113,7 @@ paths: get: operationId: GetCollectionsId summary: Get a Collection - description: Retrieve a collection by its ID. You can expand the collection's relations or select the fields that should be returned. + description: Retrieve a collection by its ID. You can expand the collection's relations or select the fields that should be returned using the query parameters. x-authenticated: true parameters: - name: id @@ -3962,6 +6483,48 @@ 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: The search term to filter the currency's searchable properties by. + required: false + schema: + type: string + title: q + description: The search term to filter the currency's searchable properties by. + - name: code + in: query + required: false + schema: + oneOf: + - type: string + title: code + description: Filter by a currency code. + - type: array + description: Filter by currency codes. + items: + type: string + title: code + description: A currency 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. + 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: [] @@ -3997,7 +6560,7 @@ paths: get: operationId: GetCurrenciesCode summary: Get a Currency - description: Retrieve a currency by its ID. You can expand the currency's relations or select the fields that should be returned. + description: Retrieve a currency by its code. You can expand the currency's relations or select the fields that should be returned using the query parameters. x-authenticated: true parameters: - name: code @@ -4124,6 +6687,784 @@ 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: The customer group's q. + required: false + schema: + type: string + title: q + description: The customer group's q. + - name: id + in: query + required: false + schema: + 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: name + in: query + required: false + schema: + 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. + - name: customers + in: query + required: false + schema: + 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' + - name: created_by + in: query + required: false + schema: + 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. + - name: created_at + in: query + description: The customer group's created at. + required: false + schema: + type: object + description: The customer group'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 customer group's updated at. + required: false + schema: + type: object + description: The customer group'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 customer group's deleted at. + required: false + schema: + type: object + description: The customer group'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 + 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: [] @@ -4500,9 +7841,6 @@ paths: type: boolean title: deleted description: The customer group's deleted. - parent: - type: object - description: The customer group's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -4669,6 +8007,2375 @@ 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: groups + in: query + required: false + schema: + oneOf: + - type: string + title: groups + description: The customer's groups. + - type: array + description: The customer's groups. + 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. + - name: q + in: query + description: The customer's q. + required: false + schema: + type: string + title: q + description: The customer's q. + - name: id + in: query + required: false + schema: + 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: Join 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: email + in: query + required: false + schema: + 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: Join 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: company_name + in: query + required: false + schema: + 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: Join 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: first_name + in: query + required: false + schema: + 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: Join 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: last_name + in: query + required: false + schema: + 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: Join 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: created_by + in: query + required: false + schema: + 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: Join 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: created_at + in: query + description: The customer's created at. + required: false + schema: + type: object + description: The customer'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 customer's updated at. + required: false + schema: + type: object + description: The customer'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 customer's deleted at. + required: false + schema: + type: object + description: The customer'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 + 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: [] @@ -5131,9 +10838,6 @@ paths: type: boolean title: deleted description: The customer's deleted. - parent: - type: object - description: The customer's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -5200,6 +10904,104 @@ 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: The customer's q. + required: false + schema: + type: string + title: q + description: The customer's q. + - name: company + in: query + required: false + schema: + 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. + - name: city + in: query + required: false + schema: + 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. + - name: country_code + in: query + required: false + schema: + 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. + - name: province + in: query + required: false + schema: + 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. + - name: postal_code + in: query + required: false + schema: + 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. + - 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: [] @@ -5794,28 +11596,32 @@ paths: content: application/json: schema: - type: object + allOf: + - type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The customer's ID. + object: + type: string + title: object + description: The name of the deleted object. + deleted: + type: boolean + title: deleted + description: Whether the Customer was deleted. + - type: object + description: SUMMARY + properties: + parent: + $ref: '#/components/schemas/AdminCustomer' description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The customer's ID. - object: - type: string - title: object - description: The customer's object. - deleted: - type: boolean - title: deleted - description: The customer's deleted. - parent: - type: object - description: The customer's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -5876,6 +11682,991 @@ 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: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The draft order's ID. + - type: array + description: The draft order's ID. + items: + type: string + title: id + description: The id's ID. + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The draft order's name. + - type: array + description: The draft order's name. + items: + type: string + title: name + description: The name's details. + - name: sales_channel_id + in: query + description: The draft order's sales channel id. + required: false + schema: + type: array + description: The draft order's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + - name: fulfillment_status + in: query + description: The draft order's fulfillment status. + required: false + schema: + type: array + description: The draft order's fulfillment status. + items: + type: string + title: fulfillment_status + description: The fulfillment status's details. + - name: payment_status + in: query + description: The draft order's payment status. + required: false + schema: + type: array + description: The draft order's payment status. + items: + type: string + title: payment_status + description: The payment status's details. + - name: region_id + in: query + description: The draft order's region id. + required: false + schema: + type: array + description: The draft order's region id. + items: + type: string + title: region_id + description: The region id's details. + - name: q + in: query + description: The draft order's q. + required: false + schema: + type: string + title: q + description: The draft order's q. + - name: created_at + in: query + description: The draft order's created at. + required: false + schema: + type: object + description: The draft order'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 draft order's updated at. + required: false + schema: + type: object + description: The draft order'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: 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: [] @@ -6413,6 +13204,769 @@ 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: deleted_at + in: query + description: The exchange's deleted at. + required: false + schema: + type: object + description: The exchange'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: q + in: query + description: The exchange's q. + required: false + schema: + type: string + title: q + description: The exchange's q. + - name: id + in: query + required: false + schema: + 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. + - name: order_id + in: query + required: false + schema: + 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. + - name: status + in: query + required: false + schema: + 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. + - name: created_at + in: query + description: The exchange's created at. + required: false + schema: + type: object + description: The exchange'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 exchange's updated at. + required: false + schema: + type: object + description: The exchange'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: $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: [] @@ -7771,29 +15325,7 @@ paths: content: application/json: schema: - type: object - description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The exchange's ID. - object: - type: string - title: object - description: The name of the deleted object. - default: exchange - deleted: - type: boolean - title: deleted - description: Whether the exchange was deleted. - parent: - type: object - description: The exchange's parent. + $ref: '#/components/schemas/AdminExchangeDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -8536,29 +16068,7 @@ paths: content: application/json: schema: - type: object - description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The service zone'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. - parent: - type: object - description: The fulfillment set that the service zone belongs to. + $ref: '#/components/schemas/AdminServiceZoneDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -9184,6 +16694,8 @@ paths: type: string title: location_id description: The location id's details. + required: + - location_id - name: $and in: query required: false @@ -9316,99 +16828,7 @@ paths: content: application/json: schema: - type: object - description: SUMMARY - required: - - sku - - hs_code - - weight - - length - - height - - width - - origin_country - - mid_code - - material - - title - - description - - thumbnail - - metadata - properties: - sku: - type: string - title: sku - description: The inventory item's sku. - hs_code: - type: string - title: hs_code - description: The inventory item's hs code. - weight: - type: number - title: weight - description: The inventory item's weight. - length: - type: number - title: length - description: The inventory item's length. - height: - type: number - title: height - description: The inventory item's height. - width: - type: number - title: width - description: The inventory item's width. - origin_country: - type: string - title: origin_country - description: The inventory item's origin country. - mid_code: - type: string - title: mid_code - description: The inventory item's mid code. - material: - type: string - title: material - description: The inventory item's material. - title: - type: string - title: title - description: The inventory item's title. - description: - type: string - title: description - description: The inventory item's description. - requires_shipping: - type: boolean - title: requires_shipping - description: The inventory item's requires shipping. - thumbnail: - type: string - title: thumbnail - description: The inventory item's thumbnail. - metadata: - type: object - description: The inventory item's metadata. - location_levels: - type: array - description: The inventory item's location levels. - items: - type: object - description: The location level's location levels. - required: - - location_id - properties: - location_id: - type: string - title: location_id - description: The location level's location id. - stocked_quantity: - type: number - title: stocked_quantity - description: The location level's stocked quantity. - incoming_quantity: - type: number - title: incoming_quantity - description: The location level's incoming quantity. + $ref: '#/components/schemas/AdminCreateInventoryItem' x-codeSamples: - lang: Shell label: cURL @@ -9763,9 +17183,6 @@ paths: type: boolean title: deleted description: Whether the inventory item was deleted. - parent: - type: object - description: The inventory item's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -10319,29 +17736,32 @@ paths: content: application/json: schema: - type: object + allOf: + - type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The inventory item's ID. + object: + type: string + title: object + description: The name of the deleted object. + deleted: + type: boolean + title: deleted + description: Whether the Inventory Item was deleted. + - type: object + description: SUMMARY + properties: + parent: + $ref: '#/components/schemas/AdminInventoryItem' description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The inventory level's ID. - object: - type: string - title: object - description: The name of the deleted object. - default: inventory-level - deleted: - type: boolean - title: deleted - description: Whether the inventory level was deleted. - parent: - type: object - description: The inventory item of the level. '400': $ref: '#/components/responses/400_error' '401': @@ -10444,17 +17864,695 @@ paths: in: query description: The invite's created at. required: false - schema: {} + schema: + type: object + description: The invite'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 invite's updated at. required: false - schema: {} + schema: + type: object + description: The invite'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 invite's deleted at. required: false - schema: {} + schema: + type: object + description: The invite'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 @@ -10587,6 +18685,9 @@ paths: title: email description: The invite's email. format: email + metadata: + type: object + description: The invite's metadata. x-codeSamples: - lang: Shell label: cURL @@ -10860,9 +18961,6 @@ paths: type: boolean title: deleted description: Whether the invite was deleted. - parent: - type: object - description: The invite's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -11275,9 +19373,6 @@ paths: type: boolean title: deleted description: Whether the order edit was deleted. - parent: - type: object - description: The order edit's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -11820,6 +19915,991 @@ 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: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The order's ID. + - type: array + description: The order's ID. + items: + type: string + title: id + description: The id's ID. + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The order's name. + - type: array + description: The order's name. + items: + type: string + title: name + description: The name's details. + - name: sales_channel_id + in: query + description: The order's sales channel id. + required: false + schema: + type: array + description: The order's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + - name: fulfillment_status + in: query + description: The order's fulfillment status. + required: false + schema: + type: array + description: The order's fulfillment status. + items: + type: string + title: fulfillment_status + description: The fulfillment status's details. + - name: payment_status + in: query + description: The order's payment status. + required: false + schema: + type: array + description: The order's payment status. + items: + type: string + title: payment_status + description: The payment status's details. + - name: region_id + in: query + description: The order's region id. + required: false + schema: + type: array + description: The order's region id. + items: + type: string + title: region_id + description: The region id's details. + - name: q + in: query + description: The order's q. + required: false + schema: + type: string + title: q + description: The order's q. + - name: created_at + in: query + description: The order's created at. + required: false + schema: + type: object + description: The order'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 order's updated at. + required: false + schema: + type: object + description: The order'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: 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: [] @@ -12261,16 +21341,16 @@ paths: in: query description: |- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + without prefix it will replace the entire default fields. required: false schema: type: string title: fields description: |- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -13033,29 +22113,7 @@ paths: content: application/json: schema: - type: object - description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The payment collection's ID. - object: - type: string - title: object - description: The name of the deleted object. - default: payment-collection - deleted: - type: boolean - title: deleted - description: Whether the payment collection was deleted. - parent: - type: object - description: The payment collection's parent. + $ref: '#/components/schemas/AdminDeletePaymentCollectionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -13258,17 +22316,695 @@ paths: in: query description: The payment's created at. required: false - schema: {} + schema: + type: object + description: The payment'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 payment's updated at. required: false - schema: {} + schema: + type: object + description: The payment'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 payment's deleted at. required: false - schema: {} + schema: + type: object + description: The payment'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 @@ -13825,6 +23561,534 @@ 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: The price list's q. + required: false + schema: + type: string + title: q + description: The price list's q. + - name: id + in: query + required: false + schema: + 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. + - name: starts_at + in: query + description: The price list's starts at. + required: false + schema: + type: object + description: The price list's starts 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: ends_at + in: query + description: The price list's ends at. + required: false + schema: + type: object + description: The price list's ends 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: status + in: query + description: The price list's status. + required: false + schema: + type: array + description: The price list's status. + items: + type: string + description: The status's details. + enum: + - draft + - active + - name: rules_count + in: query + description: The price list's rules count. + required: false + schema: + type: array + description: The price list's rules count. + items: + type: number + title: rules_count + description: The rules count's details. + - 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: [] @@ -14456,6 +24720,76 @@ 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: id + in: query + required: false + schema: + 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. + - name: attribute + in: query + required: false + schema: + 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. + - name: value + in: query + required: false + schema: + 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. + - name: q + in: query + description: The price preference's q. + required: false + schema: + type: string + title: q + description: The price preference's q. + - 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: [] @@ -14934,17 +25268,695 @@ paths: in: query description: The product category's created at. required: false - schema: {} + schema: + type: object + description: The product category'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 product category's updated at. required: false - schema: {} + schema: + type: object + description: The product category'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 product category's deleted at. required: false - schema: {} + schema: + type: object + description: The product category'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 @@ -14963,6 +25975,20 @@ paths: items: type: object title: $or + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The product category's name. + - type: array + description: The product category's name. + items: + type: string + title: name + description: The name's details. security: - api_token: [] - cookie_auth: [] @@ -15048,44 +26074,7 @@ paths: content: application/json: schema: - type: object - description: SUMMARY - required: - - name - - parent_category_id - - metadata - properties: - name: - type: string - title: name - description: The product category's name. - description: - type: string - title: description - description: The product category's description. - handle: - type: string - title: handle - description: The product category's handle. - is_internal: - type: boolean - title: is_internal - description: The product category's is internal. - is_active: - type: boolean - title: is_active - description: The product category's is active. - parent_category_id: - 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. + $ref: '#/components/schemas/AdminCreateProductCategory' x-codeSamples: - lang: Shell label: cURL @@ -15587,17 +26576,695 @@ paths: in: query description: The product tag's created at. required: false - schema: {} + schema: + type: object + description: The product tag'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 product tag's updated at. required: false - schema: {} + schema: + type: object + description: The product tag'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 product tag's deleted at. required: false - schema: {} + schema: + type: object + description: The product tag'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 @@ -15701,19 +27368,7 @@ paths: content: application/json: schema: - type: object - description: SUMMARY - required: - - value - - metadata - properties: - value: - type: string - title: value - description: The product tag's value. - metadata: - type: object - description: The product tag's metadata. + $ref: '#/components/schemas/AdminCreateProductTag' x-codeSamples: - lang: Shell label: cURL @@ -16066,17 +27721,695 @@ paths: in: query description: The product type's created at. required: false - schema: {} + schema: + type: object + description: The product type'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 product type's updated at. required: false - schema: {} + schema: + type: object + description: The product type'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 product type's deleted at. required: false - schema: {} + schema: + type: object + description: The product type'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 @@ -16180,19 +28513,7 @@ paths: content: application/json: schema: - type: object - description: SUMMARY - required: - - value - - metadata - properties: - value: - type: string - title: value - description: The product type's value. - metadata: - type: object - description: The product type's metadata. + $ref: '#/components/schemas/AdminCreateProduct' x-codeSamples: - lang: Shell label: cURL @@ -16505,6 +28826,757 @@ 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: The product variant's q. + required: false + schema: + type: string + title: q + description: The product variant's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product variant's ID. + - type: array + description: The product variant's ID. + items: + type: string + title: id + description: The id's ID. + - name: manage_inventory + in: query + description: The product variant's manage inventory. + required: false + schema: + type: boolean + title: manage_inventory + description: The product variant's manage inventory. + - name: allow_backorder + in: query + description: The product variant's allow backorder. + required: false + schema: + type: boolean + title: allow_backorder + description: The product variant's allow backorder. + - name: created_at + in: query + description: The product variant's created at. + required: false + schema: + type: object + description: The product variant'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 product variant's updated at. + required: false + schema: + type: object + description: The product variant'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 product variant's deleted at. + required: false + schema: + type: object + description: The product variant'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 + 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: [] @@ -23967,17 +37039,695 @@ paths: in: query description: The promotion's created at. required: false - schema: {} + schema: + type: object + description: The promotion'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 promotion's updated at. required: false - schema: {} + schema: + type: object + description: The promotion'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 promotion's deleted at. required: false - schema: {} + schema: + type: object + description: The promotion'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 @@ -25113,9 +38863,6 @@ paths: type: boolean title: deleted description: Whether the promotion was deleted. - parent: - type: object - description: The promotion's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -25944,6 +39691,48 @@ 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: id + in: query + required: false + schema: + 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. + - name: q + in: query + description: The refund reason's q. + required: false + schema: + type: string + title: q + description: The refund reason's q. + - 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: [] @@ -26058,20 +39847,7 @@ paths: content: application/json: schema: - type: object - description: SUMMARY - required: - - label - - description - properties: - label: - type: string - title: label - description: The refund reason's label. - description: - type: string - title: description - description: The refund reason's description. + $ref: '#/components/schemas/AdminCreateRefundReason' x-codeSamples: - lang: Shell label: cURL @@ -26344,9 +40120,6 @@ paths: type: boolean title: deleted description: Whether the refund reason was deleted. - parent: - type: object - description: The refund reason's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -26461,17 +40234,695 @@ paths: in: query description: The region's created at. required: false - schema: {} + schema: + type: object + description: The 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 region's updated at. required: false - schema: {} + schema: + type: object + description: The 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 region's deleted at. required: false - schema: {} + schema: + type: object + description: The 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 @@ -26604,46 +41055,7 @@ paths: content: application/json: schema: - type: object - description: SUMMARY - required: - - name - - currency_code - - metadata - properties: - name: - type: string - title: name - description: The region's name. - currency_code: - type: string - title: currency_code - description: The region's currency code. - countries: - type: array - description: The region's countries. - items: - type: string - title: countries - description: The country's countries. - automatic_taxes: - type: boolean - title: automatic_taxes - description: The region's automatic taxes. - payment_providers: - type: array - description: The region's payment providers. - items: - type: string - title: payment_providers - description: The payment provider's payment providers. - metadata: - type: object - description: The region's metadata. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The region's is tax inclusive. + $ref: '#/components/schemas/AdminCreateRegion' x-codeSamples: - lang: Shell label: cURL @@ -26942,9 +41354,6 @@ paths: type: boolean title: deleted description: Whether the region was deleted. - parent: - type: object - description: The region's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -27097,53 +41506,699 @@ paths: $gte: {} $lt: {} $lte: {} - - name: quantity - in: query - description: The reservation's quantity. - required: false - schema: - description: The reservation's quantity. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - name: created_at in: query description: The reservation's created at. required: false - schema: {} + schema: + type: object + description: The reservation'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 reservation's updated at. required: false - schema: {} + schema: + type: object + description: The reservation'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 reservation's deleted at. required: false - schema: {} + schema: + type: object + description: The reservation'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`). security: - api_token: [] - cookie_auth: [] @@ -27258,39 +42313,7 @@ paths: content: application/json: schema: - type: object - description: SUMMARY - required: - - line_item_id - - location_id - - inventory_item_id - - quantity - - description - - metadata - properties: - line_item_id: - type: string - title: line_item_id - description: The reservation's line item id. - location_id: - type: string - title: location_id - description: The reservation's location id. - inventory_item_id: - type: string - title: inventory_item_id - description: The reservation's inventory item id. - quantity: - type: number - title: quantity - description: The reservation's quantity. - description: - type: string - title: description - description: The reservation's description. - metadata: - type: object - description: The reservation's metadata. + $ref: '#/components/schemas/AdminCreateReservation' x-codeSamples: - lang: Shell label: cURL @@ -27576,9 +42599,6 @@ paths: type: boolean title: deleted description: Whether the reservation was deleted. - parent: - type: object - description: The reservation's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -27721,17 +42741,695 @@ paths: in: query description: The return reason's created at. required: false - schema: {} + schema: + type: object + description: The return reason'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 return reason's updated at. required: false - schema: {} + schema: + type: object + description: The return reason'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 return reason's deleted at. required: false - schema: {} + schema: + type: object + description: The return reason'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 description: The return reason's $and. @@ -28074,29 +43772,7 @@ paths: content: application/json: schema: - type: object - description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The return reason's ID. - object: - type: string - title: object - description: The name of the deleted object. - default: return_reason - deleted: - type: boolean - title: deleted - description: Whether the return reason was deleted. - parent: - type: object - description: The return reason's parent. + $ref: '#/components/schemas/AdminReturnReasonDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -28157,6 +43833,991 @@ 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: id + in: query + required: false + schema: + 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: name + in: query + required: false + schema: + 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. + - name: sales_channel_id + in: query + description: The return's sales channel id. + required: false + schema: + type: array + description: The return's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + - name: fulfillment_status + in: query + description: The return's fulfillment status. + required: false + schema: + type: array + description: The return's fulfillment status. + items: + type: string + title: fulfillment_status + description: The fulfillment status's details. + - name: payment_status + in: query + description: The return's payment status. + required: false + schema: + type: array + description: The return's payment status. + items: + type: string + title: payment_status + description: The payment status's details. + - name: region_id + in: query + description: The return's region id. + required: false + schema: + type: array + description: The return's region id. + items: + type: string + title: region_id + description: The region id's details. + - name: q + in: query + description: The return's q. + required: false + schema: + type: string + title: q + description: The return's q. + - name: created_at + in: query + description: The return's created at. + required: false + schema: + type: object + description: The return'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 return's updated at. + required: false + schema: + type: object + description: The return'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: 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: [] @@ -28978,9 +45639,6 @@ paths: type: boolean title: deleted description: Whether the return was deleted. - parent: - type: object - description: The return's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -29504,9 +46162,6 @@ paths: type: boolean title: deleted description: Whether the return was deleted. - parent: - type: object - description: The return's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -29992,8 +46647,12 @@ paths: x-workflow: updateReturnShippingMethodWorkflow delete: operationId: DeleteReturnsIdShippingMethodAction_id - summary: Remove Shipping Methods from Return - description: Remove a list of shipping methods from a return. This doesn't delete the Shipping Method, only the association between the Shipping Method and the return. + summary: Remove Shipping Method from Return + x-sidebar-summary: Remove Shipping Method + description: | + Remove a shipping method of the return by the ID of the item's `SHIPPING_ADD` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -30004,7 +46663,7 @@ paths: type: string - name: action_id in: path - description: The return's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string @@ -30183,17 +46842,695 @@ paths: in: query description: The sales channel's created at. required: false - schema: {} + schema: + type: object + description: The sales channel'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 sales channel's updated at. required: false - schema: {} + schema: + type: object + description: The sales channel'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 sales channel's deleted at. required: false - schema: {} + schema: + type: object + description: The sales channel'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: location_id in: query required: false @@ -30846,17 +48183,695 @@ paths: in: query description: The shipping option's created at. required: false - schema: {} + schema: + type: object + description: The shipping option'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 shipping option's updated at. required: false - schema: {} + schema: + type: object + description: The shipping option'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 shipping option's deleted at. required: false - schema: {} + schema: + type: object + description: The shipping option'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: stock_location_id in: query required: false @@ -30871,6 +48886,22 @@ paths: type: string title: stock_location_id description: The stock location id's details. + - name: is_return + in: query + description: The shipping option's is return. + required: false + schema: + type: boolean + title: is_return + description: The shipping option's is return. + - name: admin_only + in: query + description: The shipping option's admin only. + required: false + schema: + type: boolean + title: admin_only + description: The shipping option's admin only. security: - api_token: [] - cookie_auth: [] @@ -30986,130 +49017,6 @@ paths: application/json: schema: type: object - description: SUMMARY - required: - - name - - service_zone_id - - shipping_profile_id - - price_type - - provider_id - - type - - prices - properties: - name: - type: string - title: name - description: The shipping option's name. - service_zone_id: - type: string - title: service_zone_id - description: The shipping option's service zone id. - shipping_profile_id: - type: string - title: shipping_profile_id - description: The shipping option's shipping profile id. - data: - type: object - description: The shipping option's data. - price_type: - type: string - enum: - - calculated - - flat - provider_id: - type: string - title: provider_id - description: The shipping option's provider id. - type: - type: object - description: The shipping option's type. - required: - - label - - description - - code - properties: - label: - type: string - title: label - description: The type's label. - description: - type: string - title: description - description: The type's description. - code: - type: string - title: code - description: The type's code. - prices: - type: array - description: The shipping option's prices. - items: - oneOf: - - type: object - description: The price's prices. - required: - - currency_code - - amount - properties: - currency_code: - type: string - title: currency_code - description: The price's currency code. - amount: - type: number - title: amount - description: The price's amount. - - type: object - description: The price's prices. - required: - - region_id - - amount - properties: - region_id: - type: string - title: region_id - description: The price's region id. - amount: - type: number - title: amount - description: The price's amount. - rules: - type: array - description: The shipping option's rules. - items: - type: object - description: The rule's rules. - required: - - operator - - attribute - - value - properties: - operator: - type: string - enum: - - in - - eq - - ne - - gt - - gte - - lt - - lte - - nin - attribute: - type: string - title: attribute - description: The rule's attribute. - value: - oneOf: - - type: string - title: value - description: The rule's value. - - type: array - description: The rule's value. - items: - type: string - title: value - description: The value's details. x-codeSamples: - lang: Shell label: cURL @@ -32291,17 +50198,695 @@ paths: in: query description: The stock location's created at. required: false - schema: {} + schema: + type: object + description: The stock location'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 stock location's updated at. required: false - schema: {} + schema: + type: object + description: The stock location'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 stock location's deleted at. required: false - schema: {} + schema: + type: object + description: The stock location'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 @@ -33400,21 +51985,700 @@ paths: enum: - 'true' - 'false' + title: is_default - name: created_at in: query description: The tax rate's created at. required: false - schema: {} + schema: + type: object + description: The tax rate'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 rate's updated at. required: false - schema: {} + schema: + type: object + description: The tax rate'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 rate's deleted at. required: false - schema: {} + schema: + type: object + description: The tax rate'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 @@ -33433,6 +52697,38 @@ paths: items: type: object title: $or + - name: service_zone_id + in: query + description: The tax rate's service zone id. + required: false + schema: + type: string + title: service_zone_id + description: The tax rate's service zone id. + - name: shipping_profile_id + in: query + description: The tax rate's shipping profile id. + required: false + schema: + type: string + title: shipping_profile_id + description: The tax rate's shipping profile id. + - name: provider_id + in: query + description: The tax rate's provider id. + required: false + schema: + type: string + title: provider_id + description: The tax rate's provider id. + - name: shipping_option_type_id + in: query + description: The tax rate's shipping option type id. + required: false + schema: + type: string + title: shipping_option_type_id + description: The tax rate's shipping option type id. security: - api_token: [] - cookie_auth: [] @@ -33901,8 +53197,9 @@ paths: /admin/tax-rates/{id}/rules/{rule_id}: delete: operationId: DeleteTaxRatesIdRulesRule_id - summary: Remove Rules from Tax Rate - description: Remove a list of rules from a tax rate. This doesn't delete the Rule, only the association between the Rule and the tax rate. + summary: Remove Rule of Tax Rate + x-sidebar-summary: Remove Rule + description: Remove a tax rate's rule. x-authenticated: true parameters: - name: id @@ -33913,7 +53210,7 @@ paths: type: string - name: rule_id in: path - description: The tax rate's rule id. + description: The tax rate rule's ID. required: true schema: type: string @@ -33975,28 +53272,32 @@ paths: content: application/json: schema: - type: object + allOf: + - type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The tax rate's ID. + object: + type: string + title: object + description: The name of the deleted object. + deleted: + type: boolean + title: deleted + description: Whether the Tax Rate was deleted. + - type: object + description: SUMMARY + properties: + parent: + $ref: '#/components/schemas/AdminTaxRate' description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The tax rate's ID. - object: - type: string - title: object - description: The tax rate's object. - deleted: - type: boolean - title: deleted - description: The tax rate's deleted. - parent: - type: object - description: The tax rate's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -34545,7 +53846,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminGetUploadParams' + oneOf: + - type: object + description: SUMMARY + required: + - files + properties: + files: + type: array + description: The upload's files. + items: + oneOf: + - type: object + description: The file's files. + required: + - name + - content + properties: + name: + type: string + title: name + description: The file's name. + content: + type: string + title: content + description: The file's content. + - $ref: '#/components/schemas/File' + - $ref: '#/components/schemas/FileList' + description: SUMMARY x-codeSamples: - lang: Shell label: cURL @@ -34660,13 +53988,13 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteUploadsId - summary: Delete a Upload - description: Delete a upload. + summary: Delete a File + description: Delete a file. Uses the installed file module provider to delete the file. x-authenticated: true parameters: - name: id in: path - description: The upload's ID. + description: The file's ID. required: true schema: type: string @@ -34698,18 +54026,16 @@ paths: id: type: string title: id - description: The upload's ID. + description: The file's ID. object: type: string title: object - description: The upload's object. + description: The name of the deleted object. + default: file deleted: type: boolean title: deleted - description: The upload's deleted. - parent: - type: object - description: The upload's parent. + description: Whether the file was deleted. '400': $ref: '#/components/responses/400_error' '401': @@ -34770,6 +54096,746 @@ 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: The user's q. + required: false + schema: + type: string + title: q + description: The user's q. + - name: id + in: query + required: false + schema: + 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. + - name: email + in: query + description: The user's email. + required: false + schema: + type: string + title: email + description: The user's email. + format: email + - name: first_name + in: query + description: The user's first name. + required: false + schema: + type: string + title: first_name + description: The user's first name. + - name: last_name + in: query + description: The user's last name. + required: false + schema: + type: string + title: last_name + description: The user's last name. + - name: created_at + in: query + description: The user's created at. + required: false + schema: + type: object + description: The user'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 user's updated at. + required: false + schema: + type: object + description: The user'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 user's deleted at. + required: false + schema: + type: object + description: The user'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`). x-codeSamples: - lang: Shell label: cURL @@ -36233,7 +56299,7 @@ components: description: The claim's email. format: email display_id: - type: string + type: number title: display_id description: The claim's display id. shipping_address: @@ -36411,9 +56477,6 @@ components: type: boolean title: deleted description: Whether the Claim was deleted. - parent: - type: object - description: The claim's parent. AdminClaimListResponse: type: object description: SUMMARY @@ -36571,9 +56634,6 @@ components: type: boolean title: deleted description: Whether the Collection was deleted. - parent: - type: object - description: The collection's parent. AdminCollectionListResponse: type: object description: SUMMARY @@ -36628,6 +56688,117 @@ components: enum: - publishable - secret + AdminCreateApplicationMethod: + type: object + description: The promotion's application method. + x-schemaName: AdminCreateApplicationMethod + required: + - value + - type + - target_type + properties: + description: + type: string + title: description + description: The application method's description. + value: + type: number + title: value + description: The application method's value. + currency_code: + type: string + title: currency_code + description: The application method's currency code. + max_quantity: + type: number + title: max_quantity + description: The application method's max quantity. + type: + type: string + description: The application method's type. + enum: + - fixed + - percentage + target_type: + type: string + description: The application method's target type. + enum: + - items + - shipping_methods + - order + allocation: + type: string + description: The application method's allocation. + enum: + - each + - across + target_rules: + type: array + description: The application method's target rules. + items: + $ref: '#/components/schemas/AdminCreatePromotionRule' + buy_rules: + type: array + description: The application method's buy rules. + items: + $ref: '#/components/schemas/AdminCreatePromotionRule' + apply_to_quantity: + type: number + title: apply_to_quantity + description: The application method's apply to quantity. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The application method's buy rules min quantity. + AdminCreateCampaign: + type: object + description: The promotion's campaign. + x-schemaName: AdminCreateCampaign + properties: + name: + type: string + title: name + description: The campaign's name. + description: + type: string + title: description + description: The campaign's description. + currency: + type: string + title: currency + description: The campaign's currency. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + budget: + type: object + description: The campaign's budget. + properties: + type: + type: string + description: The budget's type. + enum: + - spend + - usage + currency_code: + type: string + title: currency_code + description: The budget's currency code. + limit: + type: number + title: limit + description: The budget's limit. AdminCreateCollection: type: object description: SUMMARY @@ -36847,6 +57018,66 @@ components: metadata: type: object description: The fulfillment's metadata. + AdminCreateInventoryItem: + type: object + description: SUMMARY + properties: + sku: + type: string + title: sku + description: The inventory item's sku. + hs_code: + type: string + title: hs_code + description: The inventory item's hs code. + weight: + type: number + title: weight + description: The inventory item's weight. + length: + type: number + title: length + description: The inventory item's length. + height: + type: number + title: height + description: The inventory item's height. + width: + type: number + title: width + description: The inventory item's width. + origin_country: + type: string + title: origin_country + description: The inventory item's origin country. + mid_code: + type: string + title: mid_code + description: The inventory item's mid code. + material: + type: string + title: material + description: The inventory item's material. + title: + type: string + title: title + description: The inventory item's title. + description: + type: string + title: description + description: The inventory item's description. + requires_shipping: + type: boolean + title: requires_shipping + description: The inventory item's requires shipping. + thumbnail: + type: string + title: thumbnail + description: The inventory item's thumbnail. + metadata: + type: object + description: The inventory item's metadata. + x-schemaName: AdminCreateInventoryItem AdminCreatePriceList: type: object description: SUMMARY @@ -37089,6 +57320,44 @@ components: metadata: type: object description: The create's metadata. + AdminCreateProductCategory: + type: object + description: SUMMARY + required: + - name + properties: + name: + type: string + title: name + description: The product category's name. + description: + type: string + title: description + description: The product category's description. + handle: + type: string + title: handle + description: The product category's handle. + is_internal: + type: boolean + title: is_internal + description: The product category's is internal. + is_active: + type: boolean + title: is_active + description: The product category's is active. + parent_category_id: + 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 AdminCreateProductOption: type: object description: SUMMARY @@ -37108,6 +57377,20 @@ components: type: string title: values description: The value's values. + AdminCreateProductTag: + type: object + description: SUMMARY + required: + - value + properties: + value: + type: string + title: value + description: The product tag's value. + metadata: + type: object + description: The product tag's metadata. + x-schemaName: AdminCreateProductTag AdminCreateProductVariant: type: object description: The create's details. @@ -37218,14 +57501,139 @@ components: rules: type: object description: The price's rules. + AdminCreatePromotionRule: + type: object + description: The rule's rules. + x-schemaName: AdminCreatePromotionRule + required: + - operator + - attribute + - values + properties: + operator: + type: string + description: The rule's operator. + enum: + - gt + - lt + - eq + - ne + - in + - lte + - gte + description: + type: string + title: description + description: The rule's description. + attribute: + type: string + title: attribute + description: The rule's attribute. + values: + oneOf: + - type: string + title: values + description: The rule's values. + - type: array + description: The rule's values. + items: + type: string + title: values + description: The value's values. + AdminCreateRefundReason: + type: object + description: SUMMARY + required: + - label + properties: + label: + type: string + title: label + description: The refund reason's label. + description: + type: string + title: description + description: The refund reason's description. + x-schemaName: AdminCreateRefundReason + AdminCreateRegion: + type: object + description: SUMMARY + required: + - name + - currency_code + properties: + name: + type: string + title: name + description: The region's name. + currency_code: + type: string + title: currency_code + description: The region's currency code. + countries: + type: array + description: The region's countries. + items: + type: string + title: countries + description: The country's countries. + automatic_taxes: + type: boolean + title: automatic_taxes + description: The region's automatic taxes. + payment_providers: + type: array + description: The region's payment providers. + items: + type: string + title: payment_providers + description: The payment provider's payment providers. + 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 + required: + - location_id + - inventory_item_id + - quantity + properties: + line_item_id: + type: string + title: line_item_id + description: The reservation's line item id. + location_id: + type: string + title: location_id + description: The reservation's location id. + inventory_item_id: + type: string + title: inventory_item_id + description: The reservation's inventory item id. + quantity: + type: number + title: quantity + description: The reservation's quantity. + description: + type: string + title: description + description: The reservation's description. + metadata: + type: object + description: The reservation's metadata. + x-schemaName: AdminCreateReservation AdminCreateSalesChannel: type: object description: SUMMARY x-schemaName: AdminCreateSalesChannel required: - name - - description - - metadata properties: name: type: string @@ -37272,68 +57680,135 @@ components: type: string title: label_url description: The label's label url. + AdminCreateShippingOption: + type: object + description: SUMMARY + required: + - name + - service_zone_id + - shipping_profile_id + - price_type + - provider_id + - type + - prices + properties: + name: + type: string + title: name + description: The shipping option's name. + service_zone_id: + type: string + title: service_zone_id + description: The shipping option's service zone id. + shipping_profile_id: + type: string + title: shipping_profile_id + description: The shipping option's shipping profile id. + data: + type: object + description: The shipping option's data. + price_type: + type: string + enum: + - calculated + - flat + provider_id: + type: string + title: provider_id + description: The shipping option's provider id. + type: + type: object + prices: + type: array + description: The shipping option's prices. + items: + oneOf: + - type: object + description: The price's prices. + required: + - currency_code + - amount + properties: + currency_code: + type: string + title: currency_code + description: The price's currency code. + amount: + type: number + title: amount + description: The price's amount. + - type: object + description: The price's prices. + required: + - region_id + - amount + properties: + region_id: + type: string + title: region_id + description: The price's region id. + amount: + type: number + title: amount + description: The price's amount. + rules: + type: array + description: The shipping option's rules. + items: + $ref: '#/components/schemas/AdminCreateShippingOptionRule' + x-schemaName: AdminCreateShippingOption + AdminCreateShippingOptionRule: + type: object + description: The rule's rules. + required: + - operator + - attribute + - value + properties: + operator: + type: string + enum: + - in + - eq + - ne + - gt + - gte + - lt + - lte + - nin + attribute: + type: string + title: attribute + description: The rule's attribute. + value: + oneOf: + - type: string + title: value + description: The rule's value. + - type: array + description: The rule's value. + items: + type: string + title: value + description: The value's details. + x-schemaName: AdminCreateShippingOptionRule AdminCreateStockLocation: type: object description: SUMMARY x-schemaName: AdminCreateStockLocation required: - name - - address_id - - metadata properties: name: type: string title: name description: The stock location's name. - address: - type: object - description: The stock location's address. - required: - - address_1 - - address_2 - - company - - city - - country_code - - phone - - postal_code - - province - properties: - address_1: - type: string - title: address_1 - description: The address's address 1. - address_2: - type: string - title: address_2 - description: The address's address 2. - company: - type: string - title: company - description: The address's company. - city: - type: string - title: city - description: The address's city. - country_code: - type: string - title: country_code - description: The address's country code. - phone: - type: string - title: phone - description: The address's phone. - postal_code: - type: string - title: postal_code - description: The address's postal code. - province: - type: string - title: province - description: The address's province. address_id: type: string title: address_id description: The stock location's address id. + address: + $ref: '#/components/schemas/AdminUpsertStockLocationAddress' metadata: type: object description: The stock location's metadata. @@ -37344,8 +57819,15 @@ components: required: - name - tax_region_id - - metadata properties: + name: + type: string + title: name + description: The tax rate's name. + tax_region_id: + type: string + title: tax_region_id + description: The tax rate's tax region id. rate: type: number title: rate @@ -37358,24 +57840,7 @@ components: type: array description: The tax rate's rules. items: - type: object - description: The rule's rules. - required: - - reference - - reference_id - properties: - reference: - type: string - title: reference - description: The rule's reference. - reference_id: - type: string - title: reference_id - description: The rule's reference id. - name: - type: string - title: name - description: The tax rate's name. + $ref: '#/components/schemas/AdminCreateTaxRateRule' is_default: type: boolean title: is_default @@ -37384,10 +57849,6 @@ components: type: boolean title: is_combinable description: The tax rate's is combinable. - tax_region_id: - type: string - title: tax_region_id - description: The tax rate's tax region id. metadata: type: object description: The tax rate's metadata. @@ -37413,9 +57874,6 @@ components: x-schemaName: AdminCreateTaxRegion required: - country_code - - province_code - - parent_id - - metadata properties: country_code: type: string @@ -37434,7 +57892,6 @@ components: description: The tax region's default tax rate. required: - name - - metadata properties: rate: type: number @@ -37550,7 +58007,7 @@ components: $ref: '#/components/schemas/AdminCurrency' AdminCustomer: type: object - description: The customer's details. + description: The order's customer. x-schemaName: AdminCustomer required: - has_account @@ -37742,40 +58199,6 @@ components: type: object description: The group's groups. x-schemaName: AdminCustomerGroup - required: - - id - - name - - customers - - metadata - - created_at - - updated_at - properties: - id: - type: string - title: id - description: The group's ID. - name: - type: string - title: name - description: The group's name. - customers: - type: array - description: The group's customers. - items: - $ref: '#/components/schemas/BaseCustomer' - metadata: - type: object - description: The group's metadata. - created_at: - type: string - format: date-time - title: created_at - description: The group's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The group's updated at. AdminCustomerGroupResponse: type: object description: SUMMARY @@ -37785,6 +58208,560 @@ components: properties: customer_group: $ref: '#/components/schemas/AdminCustomerGroup' + AdminCustomerInGroupFilters: + type: object + description: The customer group's customers. + x-schemaName: AdminCustomerInGroupFilters + properties: + 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. + 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: Join 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`). + default_billing_address_id: + oneOf: + - type: string + title: default_billing_address_id + description: The customer's default billing address id. + - type: array + description: The customer's default billing address id. + items: + type: string + title: default_billing_address_id + description: The default billing address id's details. + default_shipping_address_id: + oneOf: + - type: string + title: default_shipping_address_id + description: The customer's default shipping address id. + - type: array + description: The customer's default shipping address id. + items: + type: string + title: default_shipping_address_id + description: The default shipping address id's details. + 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. + 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. + 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. + 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. + created_at: + type: object + description: The customer'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. + - 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: Join 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`). + deleted_at: + type: object + description: The customer'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. + - 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`). AdminCustomerResponse: type: object description: SUMMARY @@ -37794,6 +58771,28 @@ components: properties: customer: $ref: '#/components/schemas/AdminCustomer' + AdminDeletePaymentCollectionResponse: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The payment collection's ID. + object: + type: string + title: object + description: The name of the deleted object. + default: payment-collection + deleted: + type: boolean + title: deleted + description: Whether the payment collection was deleted. + x-schemaName: AdminDeletePaymentCollectionResponse AdminDraftOrderResponse: type: object description: SUMMARY @@ -37901,7 +58900,7 @@ components: description: The exchange's email. format: email display_id: - type: string + type: number title: display_id description: The exchange's display id. shipping_address: @@ -38057,6 +59056,28 @@ components: type: number title: original_shipping_tax_total description: The exchange's original shipping tax total. + AdminExchangeDeleteResponse: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The exchange's ID. + object: + type: string + title: object + description: The name of the deleted object. + default: exchange + deleted: + type: boolean + title: deleted + description: Whether the exchange was deleted. + x-schemaName: AdminExchangeDeleteResponse AdminExchangeOrderResponse: type: object description: SUMMARY @@ -38502,8 +59523,42 @@ components: $ref: '#/components/schemas/AdminFulfillment' AdminFulfillmentSet: type: object - description: The fulfillment set's details. - x-schemaName: AdminFulfillmentSet + description: The fulfillment set that the service zone belongs to. + properties: + id: + type: string + title: id + description: The parent's ID. + name: + type: string + title: name + description: The parent's name. + type: + type: string + title: type + description: The parent's type. + location: + $ref: '#/components/schemas/AdminStockLocation' + service_zones: + type: array + description: The parent's service zones. + items: + $ref: '#/components/schemas/AdminServiceZone' + created_at: + type: string + format: date-time + title: created_at + description: The parent's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The parent's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The parent's deleted at. required: - id - name @@ -38513,41 +59568,7 @@ components: - created_at - updated_at - deleted_at - properties: - id: - type: string - title: id - description: The fulfillment set's ID. - name: - type: string - title: name - description: The fulfillment set's name. - type: - type: string - title: type - description: The fulfillment set's type. - location: - $ref: '#/components/schemas/AdminStockLocation' - service_zones: - type: array - description: The fulfillment set's service zones. - items: - $ref: '#/components/schemas/AdminServiceZone' - created_at: - type: string - format: date-time - title: created_at - description: The fulfillment set's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The fulfillment set's updated at. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The fulfillment set's deleted at. + x-schemaName: AdminFulfillmentSet AdminFulfillmentSetDeleteResponse: type: object description: SUMMARY @@ -38570,9 +59591,6 @@ components: type: boolean title: deleted description: Whether the Fulfillment Set was deleted. - parent: - type: object - description: The fulfillment set's parent. AdminFulfillmentSetResponse: type: object description: SUMMARY @@ -38586,15 +59604,6 @@ components: type: object description: The geo zone's geo zones. x-schemaName: AdminGeoZone - AdminGetUploadParams: - type: object - description: SUMMARY - x-schemaName: AdminGetUploadParams - properties: - fields: - type: string - title: fields - description: The upload's fields. AdminImportProductRequest: type: object description: SUMMARY @@ -38698,6 +59707,11 @@ components: metadata: type: object description: The inventory item's metadata. + location_levels: + type: array + description: The inventory item's location levels. + items: + $ref: '#/components/schemas/AdminInventoryLevel' AdminInventoryItemResponse: type: object description: SUMMARY @@ -38707,6 +59721,83 @@ components: properties: inventory_item: $ref: '#/components/schemas/AdminInventoryItem' + AdminInventoryLevel: + type: object + description: The location level's location levels. + x-schemaName: AdminInventoryLevel + required: + - id + - created_at + - updated_at + - deleted_at + - inventory_item_id + - location_id + - stocked_quantity + - raw_stocked_quantity + - reserved_quantity + - raw_reserved_quantity + - incoming_quantity + - raw_incoming_quantity + - metadata + - available_quantity + properties: + id: + type: string + title: id + description: The location level's ID. + created_at: + type: string + format: date-time + title: created_at + description: The location level's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The location level's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The location level's deleted at. + inventory_item_id: + type: string + title: inventory_item_id + description: The location level's inventory item id. + location_id: + type: string + title: location_id + description: The location level's location id. + stocked_quantity: + type: number + title: stocked_quantity + description: The location level's stocked quantity. + raw_stocked_quantity: + type: object + description: The location level's raw stocked quantity. + reserved_quantity: + type: number + title: reserved_quantity + description: The location level's reserved quantity. + raw_reserved_quantity: + type: object + description: The location level's raw reserved quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The location level's incoming quantity. + raw_incoming_quantity: + type: object + description: The location level's raw incoming quantity. + metadata: + type: object + description: The location level's metadata. + inventory_item: + type: object + available_quantity: + type: number + title: available_quantity + description: The location level's available quantity. AdminInvite: type: object description: The invite's details. @@ -38915,6 +60006,14 @@ components: description: The order's fulfillments. items: $ref: '#/components/schemas/BaseOrderFulfillment' + sales_channel: + $ref: '#/components/schemas/AdminSalesChannel' + customer: + $ref: '#/components/schemas/AdminCustomer' + shipping_address: + $ref: '#/components/schemas/AdminOrderAddress' + billing_address: + $ref: '#/components/schemas/AdminOrderAddress' id: type: string title: id @@ -38945,13 +60044,9 @@ components: title: currency_code description: The order's currency code. display_id: - type: string + type: number title: display_id description: The order's display id. - shipping_address: - $ref: '#/components/schemas/BaseOrderAddress' - billing_address: - $ref: '#/components/schemas/BaseOrderAddress' items: type: array description: The order's items. @@ -39096,6 +60191,79 @@ components: type: number title: original_shipping_tax_total description: The order's original shipping tax total. + AdminOrderAddress: + type: object + description: The order's billing address. + x-schemaName: AdminOrderAddress + required: + - id + - metadata + - created_at + - updated_at + properties: + country: + $ref: '#/components/schemas/AdminRegionCountry' + id: + type: string + title: id + description: The billing address's ID. + customer_id: + type: string + title: customer_id + description: The billing address's customer id. + first_name: + type: string + title: first_name + description: The billing address's first name. + last_name: + type: string + title: last_name + description: The billing address's last name. + phone: + type: string + title: phone + description: The billing address's phone. + company: + type: string + title: company + description: The billing address's company. + address_1: + type: string + title: address_1 + description: The billing address's address 1. + address_2: + type: string + title: address_2 + description: The billing address's address 2. + city: + type: string + title: city + description: The billing address's city. + country_code: + type: string + title: country_code + description: The billing address's country code. + province: + type: string + title: province + description: The billing address's province. + postal_code: + type: string + title: postal_code + description: The billing address's postal code. + metadata: + type: object + description: The billing address's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The billing address's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The billing address's updated at. AdminOrderChangesResponse: type: object description: SUMMARY @@ -39620,13 +60788,13 @@ components: description: The order preview's email. format: email display_id: - type: string + type: number title: display_id description: The order preview's display id. shipping_address: - $ref: '#/components/schemas/BaseOrderAddress' + $ref: '#/components/schemas/AdminOrderAddress' billing_address: - $ref: '#/components/schemas/BaseOrderAddress' + $ref: '#/components/schemas/AdminOrderAddress' payment_collections: type: array description: The order preview's payment collections. @@ -39771,6 +60939,10 @@ components: type: number title: original_shipping_tax_total description: The order preview's original shipping tax total. + customer: + $ref: '#/components/schemas/AdminCustomer' + sales_channel: + $ref: '#/components/schemas/AdminSalesChannel' AdminOrderPreviewResponse: type: object description: SUMMARY @@ -41006,9 +62178,6 @@ components: type: boolean title: deleted description: Whether the Price List was deleted. - parent: - type: object - description: The price list's parent. AdminPriceListListResponse: type: object description: SUMMARY @@ -41183,9 +62352,6 @@ components: type: boolean title: deleted description: Whether the Price Preference was deleted. - parent: - type: object - description: The price preference's parent. AdminPricePreferenceListResponse: type: object description: SUMMARY @@ -41228,9 +62394,9 @@ components: x-schemaName: AdminProduct required: - type + - length - title - status - - length - options - description - id @@ -41278,6 +62444,10 @@ components: description: The parent's tags. items: $ref: '#/components/schemas/AdminProductTag' + length: + type: number + title: length + description: The parent's length. title: type: string title: title @@ -41290,10 +62460,6 @@ components: - proposed - published - rejected - length: - type: number - title: length - description: The parent's length. options: type: array description: The parent's options. @@ -41493,9 +62659,6 @@ components: type: boolean title: deleted description: Whether the Product Category was deleted. - parent: - type: object - description: The product category's parent. AdminProductCategoryListResponse: type: object description: SUMMARY @@ -41554,9 +62717,6 @@ components: type: boolean title: deleted description: Whether the Product was deleted. - parent: - type: object - description: The product's parent. AdminProductOption: type: object description: The product's product option. @@ -41619,7 +62779,6 @@ components: type: string title: object description: The name of the deleted object. - default: product_option deleted: type: boolean title: deleted @@ -41702,9 +62861,6 @@ components: type: boolean title: deleted description: Whether the Product Tag was deleted. - parent: - type: object - description: The product tag's parent. AdminProductTagListResponse: type: object description: SUMMARY @@ -41799,9 +62955,6 @@ components: type: boolean title: deleted description: Whether the Product Type was deleted. - parent: - type: object - description: The product type's parent. AdminProductTypeListResponse: type: object description: SUMMARY @@ -41986,7 +63139,6 @@ components: type: string title: object description: The name of the deleted object. - default: variant deleted: type: boolean title: deleted @@ -42171,31 +63323,359 @@ components: type: string title: id description: The id's ID. - sku: - oneOf: - - type: string - title: sku - description: The variant's sku. - - type: array - description: The variant's sku. - items: - type: string - title: sku - description: The sku's details. - product_id: - oneOf: - - type: string - title: product_id - description: The variant's product id. - - type: array - description: The variant's product id. - items: - type: string - title: product_id - description: The product id's details. - options: + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + allow_backorder: + type: boolean + title: allow_backorder + description: The variant's allow backorder. + created_at: type: object - description: The variant's options. + description: The variant'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. + - 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 variant'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. + - 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 variant'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. + - 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 @@ -42214,13 +63694,13 @@ components: description: The variant's fields. $and: type: array - description: The variant'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 variant'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 @@ -42400,6 +63880,10 @@ components: format: date-time title: updated_at description: The region's updated at. + AdminRegionCountry: + type: object + description: The billing address's country. + x-schemaName: AdminRegionCountry AdminRegionResponse: type: object description: SUMMARY @@ -42436,7 +63920,7 @@ components: title: location_id description: The reservation's location id. quantity: - type: string + type: number title: quantity description: The reservation's quantity. external_id: @@ -42656,6 +64140,28 @@ components: format: date-time title: updated_at description: The return reason's updated at. + AdminReturnReasonDeleteResponse: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The return reason's ID. + object: + type: string + title: object + description: The name of the deleted object. + default: return_reason + deleted: + type: boolean + title: deleted + description: Whether the return reason was deleted. + x-schemaName: AdminReturnReasonDeleteResponse AdminReturnReasonListResponse: type: object description: SUMMARY @@ -42775,7 +64281,7 @@ components: description: The value's label. AdminSalesChannel: type: object - description: The sales channel's sales channels. + description: The order's sales channel. x-schemaName: AdminSalesChannel required: - id @@ -42843,9 +64349,6 @@ components: type: boolean title: deleted description: Whether the Sales Channel was deleted. - parent: - type: object - description: The sales channel's parent. AdminSalesChannelResponse: type: object description: SUMMARY @@ -42909,6 +64412,30 @@ components: format: date-time title: deleted_at description: The service zone's deleted at. + AdminServiceZoneDeleteResponse: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The service zone'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. + parent: + $ref: '#/components/schemas/AdminFulfillmentSet' + x-schemaName: AdminServiceZoneDeleteResponse AdminServiceZoneResponse: type: object description: SUMMARY @@ -42944,9 +64471,6 @@ components: type: boolean title: deleted description: Whether the Shipping Option was deleted. - parent: - type: object - description: The shipping option's parent. AdminShippingOptionResponse: type: object description: SUMMARY @@ -43038,9 +64562,6 @@ components: type: boolean title: deleted description: Whether the Shipping Profile was deleted. - parent: - type: object - description: The shipping profile's parent. AdminShippingProfileResponse: type: object description: SUMMARY @@ -43052,7 +64573,7 @@ components: $ref: '#/components/schemas/AdminShippingProfile' AdminStockLocation: type: object - description: The fulfillment set's location. + description: The parent's location. x-schemaName: AdminStockLocation required: - id @@ -43114,9 +64635,6 @@ components: type: boolean title: deleted description: Whether the Stock Location was deleted. - parent: - type: object - description: The stock location's parent. AdminStockLocationListResponse: type: object description: SUMMARY @@ -43291,7 +64809,7 @@ components: $ref: '#/components/schemas/AdminStore' AdminTaxRate: type: object - description: The tax rate's details. + description: The tax rate's parent. x-schemaName: AdminTaxRate required: - id @@ -43312,58 +64830,58 @@ components: id: type: string title: id - description: The tax rate's ID. + description: The parent's ID. rate: type: number title: rate - description: The tax rate's rate. + description: The parent's rate. code: type: string title: code - description: The tax rate's code. + description: The parent's code. name: type: string title: name - description: The tax rate's name. + description: The parent's name. metadata: type: object - description: The tax rate's metadata. + description: The parent's metadata. tax_region_id: type: string title: tax_region_id - description: The tax rate's tax region id. + description: The parent's tax region id. is_combinable: type: boolean title: is_combinable - description: The tax rate's is combinable. + description: The parent's is combinable. is_default: type: boolean title: is_default - description: The tax rate's is default. + description: The parent's is default. created_at: type: string format: date-time title: created_at - description: The tax rate's created at. + description: The parent's created at. updated_at: type: string format: date-time title: updated_at - description: The tax rate's updated at. + description: The parent's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The tax rate's deleted at. + description: The parent's deleted at. created_by: type: string title: created_by - description: The tax rate's created by. + description: The parent's created by. tax_region: $ref: '#/components/schemas/AdminTaxRegion' rules: type: array - description: The tax rate's rules. + description: The parent's rules. items: $ref: '#/components/schemas/AdminTaxRateRule' AdminTaxRateDeleteResponse: @@ -43388,9 +64906,6 @@ components: type: boolean title: deleted description: Whether the Tax Rate was deleted. - parent: - type: object - description: The tax rate's parent. AdminTaxRateResponse: type: object description: SUMMARY @@ -43418,7 +64933,7 @@ components: description: The rule's reference id. AdminTaxRegion: type: object - description: The tax rate's tax region. + description: The parent's tax region. x-schemaName: AdminTaxRegion required: - id @@ -43536,9 +65051,6 @@ components: type: boolean title: deleted description: Whether the Tax Region was deleted. - parent: - type: object - description: The tax region's parent. AdminTaxRegionResponse: type: object description: SUMMARY @@ -44269,6 +65781,46 @@ components: type: number title: required_quantity description: The product's required quantity. + AdminUpsertStockLocationAddress: + type: object + description: The stock location's address. + x-schemaName: AdminUpsertStockLocationAddress + required: + - address_1 + - country_code + properties: + address_1: + type: string + title: address_1 + description: The address's address 1. + address_2: + type: string + title: address_2 + description: The address's address 2. + company: + type: string + title: company + description: The address's company. + country_code: + type: string + title: country_code + description: The address's country code. + city: + type: string + title: city + description: The address's city. + phone: + type: string + title: phone + description: The address's phone. + postal_code: + type: string + title: postal_code + description: The address's postal code. + province: + type: string + title: province + description: The address's province. AdminUser: type: object description: The user's details. @@ -44345,9 +65897,6 @@ components: type: boolean title: deleted description: Whether the User was deleted. - parent: - type: object - description: The user's parent. AdminUserListResponse: type: object description: SUMMARY @@ -44680,7 +66229,7 @@ components: x-schemaName: BaseCart BaseCartAddress: type: object - description: The cart's billing address. + description: The parent's billing address. x-schemaName: BaseCartAddress required: - id @@ -45299,107 +66848,10 @@ components: type: object description: The product's collection. x-schemaName: BaseCollection - BaseCustomer: - type: object - description: The customer's customers. - x-schemaName: BaseCustomer BaseCustomerAddress: type: object description: The address's addresses. x-schemaName: BaseCustomerAddress - required: - - id - - address_name - - is_default_shipping - - is_default_billing - - customer_id - - company - - first_name - - last_name - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - phone - - metadata - - created_at - - updated_at - properties: - id: - type: string - title: id - description: The address's ID. - address_name: - type: string - title: address_name - description: The address's address name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: The address's is default shipping. - is_default_billing: - type: boolean - title: is_default_billing - description: The address's is default billing. - customer_id: - type: string - title: customer_id - description: The address's customer id. - company: - type: string - title: company - description: The address's company. - first_name: - type: string - title: first_name - description: The address's first name. - last_name: - type: string - title: last_name - description: The address's last name. - address_1: - type: string - title: address_1 - description: The address's address 1. - address_2: - type: string - title: address_2 - description: The address's address 2. - city: - type: string - title: city - description: The address's city. - country_code: - type: string - title: country_code - description: The address's country code. - province: - type: string - title: province - description: The address's province. - postal_code: - type: string - title: postal_code - description: The address's postal code. - phone: - type: string - title: phone - description: The address's phone. - metadata: - type: object - description: The address's metadata. - created_at: - type: string - format: date-time - title: created_at - description: The address's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The address's updated at. BaseExchangeItem: type: object description: The additional item's additional items. @@ -45476,7 +66928,7 @@ components: x-schemaName: BaseOrder BaseOrderAddress: type: object - description: The order's billing address. + description: The exchange's billing address. x-schemaName: BaseOrderAddress required: - id @@ -46719,7 +68171,7 @@ components: x-schemaName: BaseRefund BaseRegion: type: object - description: The cart's region. + description: The parent's region. x-schemaName: BaseRegion required: - id @@ -47161,6 +68613,384 @@ components: metadata: type: object description: The return reason's metadata. + CustomerGroupInCustomerFilters: + type: object + description: The customer's groups. + x-schemaName: CustomerGroupInCustomerFilters + required: + - id + - name + - created_at + - updated_at + - deleted_at + properties: + id: + oneOf: + - type: string + title: id + description: The group's ID. + - type: array + description: The group's ID. + items: + type: string + title: id + description: The id's ID. + name: + oneOf: + - type: string + title: name + description: The group's name. + - type: array + description: The group's name. + items: + type: string + title: name + description: The name's details. + created_at: + type: object + description: The group'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. + - 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 group'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. + - 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 group'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. + - 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`). Error: title: Response Error type: object @@ -47241,6 +69071,25 @@ components: text: type: object description: The file's text. + FileList: + type: object + description: SUMMARY + x-schemaName: FileList + required: + - length + - item + - __@iterator@258 + properties: + length: + type: number + title: length + description: The upload's length. + item: + type: object + description: The upload's item. + __@iterator@258: + type: object + description: The upload's @iterator@258. IBigNumber: type: object description: The shipping method's discount tax total. @@ -49253,7 +71102,7 @@ components: description: The cart's fields. StoreCart: type: object - description: The cart's details. + description: The cart's parent. x-schemaName: StoreCart required: - id @@ -49284,322 +71133,322 @@ components: id: type: string title: id - description: The cart's ID. + description: The parent's ID. region: $ref: '#/components/schemas/BaseRegion' region_id: type: string title: region_id - description: The cart's region id. + description: The parent's region id. customer_id: type: string title: customer_id - description: The cart's customer id. + description: The parent's customer id. sales_channel_id: type: string title: sales_channel_id - description: The cart's sales channel id. + description: The parent's sales channel id. email: type: string title: email - description: The cart's email. + description: The parent's email. format: email currency_code: type: string title: currency_code - description: The cart's currency code. + description: The parent's currency code. shipping_address: $ref: '#/components/schemas/BaseCartAddress' billing_address: $ref: '#/components/schemas/BaseCartAddress' items: type: array - description: The cart's items. + description: The parent's items. items: $ref: '#/components/schemas/BaseCartLineItem' shipping_methods: type: array - description: The cart's shipping methods. + description: The parent's shipping methods. items: $ref: '#/components/schemas/BaseCartShippingMethod' payment_collection: $ref: '#/components/schemas/BasePaymentCollection' metadata: type: object - description: The cart's metadata. + description: The parent's metadata. created_at: type: string format: date-time title: created_at - description: The cart's created at. + description: The parent's created at. updated_at: type: string format: date-time title: updated_at - description: The cart's updated at. + description: The parent's updated at. original_item_total: oneOf: - type: string title: original_item_total - description: The cart's original item total. + description: The parent's original item total. - type: number title: original_item_total - description: The cart's original item total. + description: The parent's original item total. - type: string title: original_item_total - description: The cart's original item total. + description: The parent's original item total. - $ref: '#/components/schemas/IBigNumber' original_item_subtotal: oneOf: - type: string title: original_item_subtotal - description: The cart's original item subtotal. + description: The parent's original item subtotal. - type: number title: original_item_subtotal - description: The cart's original item subtotal. + description: The parent's original item subtotal. - type: string title: original_item_subtotal - description: The cart's original item subtotal. + description: The parent's original item subtotal. - $ref: '#/components/schemas/IBigNumber' original_item_tax_total: oneOf: - type: string title: original_item_tax_total - description: The cart's original item tax total. + description: The parent's original item tax total. - type: number title: original_item_tax_total - description: The cart's original item tax total. + description: The parent's original item tax total. - type: string title: original_item_tax_total - description: The cart's original item tax total. + description: The parent's original item tax total. - $ref: '#/components/schemas/IBigNumber' item_total: oneOf: - type: string title: item_total - description: The cart's item total. + description: The parent's item total. - type: number title: item_total - description: The cart's item total. + description: The parent's item total. - type: string title: item_total - description: The cart's item total. + description: The parent's item total. - $ref: '#/components/schemas/IBigNumber' item_subtotal: oneOf: - type: string title: item_subtotal - description: The cart's item subtotal. + description: The parent's item subtotal. - type: number title: item_subtotal - description: The cart's item subtotal. + description: The parent's item subtotal. - type: string title: item_subtotal - description: The cart's item subtotal. + description: The parent's item subtotal. - $ref: '#/components/schemas/IBigNumber' item_tax_total: oneOf: - type: string title: item_tax_total - description: The cart's item tax total. + description: The parent's item tax total. - type: number title: item_tax_total - description: The cart's item tax total. + description: The parent's item tax total. - type: string title: item_tax_total - description: The cart's item tax total. + description: The parent's item tax total. - $ref: '#/components/schemas/IBigNumber' original_total: oneOf: - type: string title: original_total - description: The cart's original total. + description: The parent's original total. - type: number title: original_total - description: The cart's original total. + description: The parent's original total. - type: string title: original_total - description: The cart's original total. + description: The parent's original total. - $ref: '#/components/schemas/IBigNumber' original_subtotal: oneOf: - type: string title: original_subtotal - description: The cart's original subtotal. + description: The parent's original subtotal. - type: number title: original_subtotal - description: The cart's original subtotal. + description: The parent's original subtotal. - type: string title: original_subtotal - description: The cart's original subtotal. + description: The parent's original subtotal. - $ref: '#/components/schemas/IBigNumber' original_tax_total: oneOf: - type: string title: original_tax_total - description: The cart's original tax total. + description: The parent's original tax total. - type: number title: original_tax_total - description: The cart's original tax total. + description: The parent's original tax total. - type: string title: original_tax_total - description: The cart's original tax total. + description: The parent's original tax total. - $ref: '#/components/schemas/IBigNumber' total: oneOf: - type: string title: total - description: The cart's total. + description: The parent's total. - type: number title: total - description: The cart's total. + description: The parent's total. - type: string title: total - description: The cart's total. + description: The parent's total. - $ref: '#/components/schemas/IBigNumber' subtotal: oneOf: - type: string title: subtotal - description: The cart's subtotal. + description: The parent's subtotal. - type: number title: subtotal - description: The cart's subtotal. + description: The parent's subtotal. - type: string title: subtotal - description: The cart's subtotal. + description: The parent's subtotal. - $ref: '#/components/schemas/IBigNumber' tax_total: oneOf: - type: string title: tax_total - description: The cart's tax total. + description: The parent's tax total. - type: number title: tax_total - description: The cart's tax total. + description: The parent's tax total. - type: string title: tax_total - description: The cart's tax total. + description: The parent's tax total. - $ref: '#/components/schemas/IBigNumber' discount_total: oneOf: - type: string title: discount_total - description: The cart's discount total. + description: The parent's discount total. - type: number title: discount_total - description: The cart's discount total. + description: The parent's discount total. - type: string title: discount_total - description: The cart's discount total. + description: The parent's discount total. - $ref: '#/components/schemas/IBigNumber' discount_tax_total: oneOf: - type: string title: discount_tax_total - description: The cart's discount tax total. + description: The parent's discount tax total. - type: number title: discount_tax_total - description: The cart's discount tax total. + description: The parent's discount tax total. - type: string title: discount_tax_total - description: The cart's discount tax total. + description: The parent's discount tax total. - $ref: '#/components/schemas/IBigNumber' gift_card_total: oneOf: - type: string title: gift_card_total - description: The cart's gift card total. + description: The parent's gift card total. - type: number title: gift_card_total - description: The cart's gift card total. + description: The parent's gift card total. - type: string title: gift_card_total - description: The cart's gift card total. + description: The parent's gift card total. - $ref: '#/components/schemas/IBigNumber' gift_card_tax_total: oneOf: - type: string title: gift_card_tax_total - description: The cart's gift card tax total. + description: The parent's gift card tax total. - type: number title: gift_card_tax_total - description: The cart's gift card tax total. + description: The parent's gift card tax total. - type: string title: gift_card_tax_total - description: The cart's gift card tax total. + description: The parent's gift card tax total. - $ref: '#/components/schemas/IBigNumber' shipping_total: oneOf: - type: string title: shipping_total - description: The cart's shipping total. + description: The parent's shipping total. - type: number title: shipping_total - description: The cart's shipping total. + description: The parent's shipping total. - type: string title: shipping_total - description: The cart's shipping total. + description: The parent's shipping total. - $ref: '#/components/schemas/IBigNumber' shipping_subtotal: oneOf: - type: string title: shipping_subtotal - description: The cart's shipping subtotal. + description: The parent's shipping subtotal. - type: number title: shipping_subtotal - description: The cart's shipping subtotal. + description: The parent's shipping subtotal. - type: string title: shipping_subtotal - description: The cart's shipping subtotal. + description: The parent's shipping subtotal. - $ref: '#/components/schemas/IBigNumber' shipping_tax_total: oneOf: - type: string title: shipping_tax_total - description: The cart's shipping tax total. + description: The parent's shipping tax total. - type: number title: shipping_tax_total - description: The cart's shipping tax total. + description: The parent's shipping tax total. - type: string title: shipping_tax_total - description: The cart's shipping tax total. + description: The parent's shipping tax total. - $ref: '#/components/schemas/IBigNumber' original_shipping_total: oneOf: - type: string title: original_shipping_total - description: The cart's original shipping total. + description: The parent's original shipping total. - type: number title: original_shipping_total - description: The cart's original shipping total. + description: The parent's original shipping total. - type: string title: original_shipping_total - description: The cart's original shipping total. + description: The parent's original shipping total. - $ref: '#/components/schemas/IBigNumber' original_shipping_subtotal: oneOf: - type: string title: original_shipping_subtotal - description: The cart's original shipping subtotal. + description: The parent's original shipping subtotal. - type: number title: original_shipping_subtotal - description: The cart's original shipping subtotal. + description: The parent's original shipping subtotal. - type: string title: original_shipping_subtotal - description: The cart's original shipping subtotal. + description: The parent's original shipping subtotal. - $ref: '#/components/schemas/IBigNumber' original_shipping_tax_total: oneOf: - type: string title: original_shipping_tax_total - description: The cart's original shipping tax total. + description: The parent's original shipping tax total. - type: number title: original_shipping_tax_total - description: The cart's original shipping tax total. + description: The parent's original shipping tax total. - type: string title: original_shipping_tax_total - description: The cart's original shipping tax total. + description: The parent's original shipping tax total. - $ref: '#/components/schemas/IBigNumber' StoreCartAddress: type: object @@ -50058,10 +71907,6 @@ components: x-schemaName: StoreCreateCustomer required: - email - - company_name - - first_name - - last_name - - phone properties: email: type: string @@ -50084,6 +71929,91 @@ components: type: string title: phone description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + StoreCreatePaymentCollection: + type: object + description: SUMMARY + required: + - cart_id + properties: + cart_id: + type: string + title: cart_id + description: The payment collection's cart id. + x-schemaName: StoreCreatePaymentCollection + StoreCreateReturn: + type: object + description: SUMMARY + x-schemaName: StoreCreateReturn + required: + - order_id + - items + - return_shipping + properties: + order_id: + type: string + title: order_id + description: The return's order id. + items: + type: array + description: The return's items. + items: + $ref: '#/components/schemas/StoreCreateReturnItem' + return_shipping: + $ref: '#/components/schemas/StoreCreateReturnShipping' + note: + type: string + title: note + description: The return's note. + receive_now: + type: boolean + title: receive_now + description: The return's receive now. + location_id: + type: string + title: location_id + description: The return's location id. + StoreCreateReturnItem: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + reason_id: + type: string + title: reason_id + description: The item's reason id. + note: + type: string + title: note + description: The item's note. + x-schemaName: StoreCreateReturnItem + StoreCreateReturnShipping: + type: object + description: The return's return shipping. + required: + - option_id + properties: + option_id: + type: string + title: option_id + description: The return shipping's option id. + price: + type: number + title: price + description: The return shipping's price. + x-schemaName: StoreCreateReturnShipping StoreCurrency: type: object description: The currency's details. @@ -50192,7 +72122,7 @@ components: $ref: '#/components/schemas/StoreCurrency' StoreCustomer: type: object - description: The customer's details. + description: The customer's parent. x-schemaName: StoreCustomer required: - id @@ -50207,63 +72137,63 @@ components: id: type: string title: id - description: The customer's ID. + description: The parent's ID. email: type: string title: email - description: The customer's email. + description: The parent's email. format: email default_billing_address_id: type: string title: default_billing_address_id - description: The customer's default billing address id. + description: The parent's default billing address id. default_shipping_address_id: type: string title: default_shipping_address_id - description: The customer's default shipping address id. + description: The parent's default shipping address id. company_name: type: string title: company_name - description: The customer's company name. + description: The parent's company name. first_name: type: string title: first_name - description: The customer's first name. + description: The parent's first name. last_name: type: string title: last_name - description: The customer's last name. + description: The parent's last name. addresses: type: array - description: The customer's addresses. + description: The parent's addresses. items: $ref: '#/components/schemas/BaseCustomerAddress' phone: type: string title: phone - description: The customer's phone. + description: The parent's phone. metadata: type: object - description: The customer's metadata. + description: The parent's metadata. created_by: type: string title: created_by - description: The customer's created by. + description: The parent's created by. deleted_at: type: string format: date-time title: deleted_at - description: The customer's deleted at. + description: The parent's deleted at. created_at: type: string format: date-time title: created_at - description: The customer's created at. + description: The parent's created at. updated_at: type: string format: date-time title: updated_at - description: The customer's updated at. + description: The parent's updated at. StoreCustomerAddress: type: object description: The customer's address. @@ -50479,7 +72409,7 @@ components: title: currency_code description: The order's currency code. display_id: - type: string + type: number title: display_id description: The order's display id. shipping_address: @@ -50787,83 +72717,14 @@ components: type: string title: id description: The payment provider's ID. - StorePostReturnsReqSchema: - type: object - description: SUMMARY - x-schemaName: StorePostReturnsReqSchema - required: - - order_id - - items - - return_shipping - - note - - location_id - properties: - order_id: - type: string - title: order_id - description: The return's order id. - items: - type: array - description: The return's items. - items: - type: object - description: The item's items. - required: - - id - - quantity - - reason_id - - note - properties: - id: - type: string - title: id - description: The item's ID. - quantity: - type: number - title: quantity - description: The item's quantity. - reason_id: - type: string - title: reason_id - description: The item's reason id. - note: - type: string - title: note - description: The item's note. - return_shipping: - type: object - description: The return's return shipping. - required: - - option_id - properties: - option_id: - type: string - title: option_id - description: The return shipping's option id. - price: - type: number - title: price - description: The return shipping's price. - note: - type: string - title: note - description: The return's note. - receive_now: - type: boolean - title: receive_now - description: The return's receive now. - location_id: - type: string - title: location_id - description: The return's location id. StoreProduct: type: object description: The product's details. x-schemaName: StoreProduct required: + - length - title - status - - length - options - description - id @@ -50895,6 +72756,10 @@ components: type: object type: type: object + length: + type: number + title: length + description: The product's length. title: type: string title: title @@ -50907,10 +72772,6 @@ components: - proposed - published - rejected - length: - type: number - title: length - description: The product's length. options: type: array description: The product's options. @@ -51145,6 +73006,79 @@ components: properties: product: $ref: '#/components/schemas/StoreProduct' + StoreProductVariantParams: + type: object + description: The product's variants. + x-schemaName: StoreProductVariantParams + properties: + q: + type: string + title: q + description: The variant's q. + id: + oneOf: + - type: string + title: id + description: The variant's ID. + - type: array + description: The variant's ID. + items: + type: string + title: id + description: The id's ID. + sku: + oneOf: + - type: string + title: sku + description: The variant's sku. + - type: array + description: The variant's sku. + items: + type: string + title: sku + description: The sku's details. + product_id: + oneOf: + - type: string + title: product_id + description: The variant's product id. + - type: array + description: The variant's product id. + items: + type: string + title: product_id + description: The product id's details. + options: + type: object + description: The variant's options. + limit: + type: number + title: limit + description: The variant's limit. + offset: + type: number + title: offset + description: The variant's offset. + order: + type: string + title: order + description: The variant's order. + fields: + type: string + title: fields + description: The variant'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. + 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 StoreRegion: type: object description: The region's details. diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index 1aea8a9b69..68296ff6b8 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -10,7 +10,7 @@ servers: - url: https://api.medusajs.com tags: - name: Auth - description: > + description: | Auth API routes allow you to manage an admin user's authentication. - name: Api Keys description: > diff --git a/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml index 840a40413d..0bea9ac00b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml @@ -1,9 +1,9 @@ get: operationId: GetApiKeys - summary: List Api Keys + summary: List API Keys description: >- - Retrieve a list of api keys. The api keys can be filtered by fields such as - `id`. The api keys can also be sorted or paginated. + Retrieve a list of API keys. The API keys can be filtered by fields such as + `id`. The API keys can also be sorted or paginated. x-authenticated: true parameters: - name: expand @@ -61,6 +61,1169 @@ 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: A search term to search the API keys' searchable properties. + required: false + schema: + type: string + title: q + description: The search term. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: Filter by an API key's ID. + - type: array + description: Filter by API key IDs. + items: + type: string + title: id + description: The API key ID. + - name: title + in: query + required: false + schema: + oneOf: + - type: string + title: title + description: Filter by an API key's title. + - type: array + description: Filter by API key titles. + items: + type: string + title: title + description: The API key title. + - name: token + in: query + required: false + schema: + oneOf: + - type: string + title: token + description: Filter by an API key's token. + - type: array + description: Filter by API key tokens. + items: + type: string + title: token + description: The API key token. + - name: type + in: query + description: Filter by the API key's type. + required: false + schema: + type: string + enum: + - secret + - publishable + - name: created_at + in: query + description: Filter by the API key's creation date. + required: false + schema: + type: object + description: Filter by the API key'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 API key's update date. + required: false + schema: + type: object + description: Filter by the API key'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`). + - name: deleted_at + in: query + description: Filter by the API key's deletion date. + required: false + schema: + type: object + description: Filter by the API key'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 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: revoked_at + in: query + description: Filter by the API key's revoke date. + required: false + schema: + type: object + description: Filter by the API key's revoke 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: $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: [] @@ -80,7 +1243,6 @@ get: schema: allOf: - type: object - description: SUMMARY required: - limit - offset @@ -89,23 +1251,24 @@ get: limit: type: number title: limit - description: The api key's limit. + description: The maximum number of items returned in the list. offset: type: number title: offset - description: The api key's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The api key's count. + description: The total count of items. - type: object - description: SUMMARY required: - api_keys properties: api_keys: type: array - description: The api key's api keys. + description: The list of API keys. items: $ref: ../components/schemas/ApiKeyResponse.yaml '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml index 895e09aeaa..988877cefe 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml @@ -1,14 +1,14 @@ get: operationId: GetApiKeysId - summary: Get a Api Key + summary: Get API Key description: >- - Retrieve a api key by its ID. You can expand the api key's relations or - select the fields that should be returned. + Retrieve an API key by its ID. You can expand the API key's relations or + select the fields that should be returned using the query parameters. x-authenticated: true parameters: - name: id in: path - description: The api key's ID. + description: The API key's ID. required: true schema: type: string @@ -250,9 +250,6 @@ delete: type: boolean title: deleted description: Whether the API key was deleted. - parent: - type: object - description: The API key's parent. '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml index 59dd03a7b0..b79b28444b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml @@ -80,7 +80,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of campaigns. required: - limit - offset @@ -89,23 +89,23 @@ get: limit: type: number title: limit - description: The campaign's limit. + description: The maximum number of items retrieved. offset: type: number title: offset - description: The campaign's offset. + description: The number of its skipped before the returned items. count: type: number title: count - description: The campaign's count. + description: The total number of items. - type: object - description: SUMMARY + description: The list of campaigns required: - campaigns properties: campaigns: type: array - description: The campaign's campaigns. + description: The list of campaigns. items: $ref: ../components/schemas/CampaignResponse.yaml '400': diff --git a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml index 6146db68a8..e085948ba2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml @@ -3,7 +3,7 @@ get: summary: Get a Campaign description: >- Retrieve a campaign by its ID. You can expand the campaign's relations or - select the fields that should be returned. + select the fields that should be returned using the query parameters. x-authenticated: true parameters: - name: id @@ -313,9 +313,6 @@ delete: type: boolean title: deleted description: Whether the campaign was deleted. - parent: - type: object - description: The campaign's parent. '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims.yaml index bb90f6b589..b2699dca70 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims.yaml @@ -61,6 +61,933 @@ 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: deleted_at + in: query + description: The claim's deleted at. + required: false + schema: + type: object + description: The claim'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: q + in: query + description: The claim's q. + required: false + schema: + type: string + title: q + description: The claim's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The claim's ID. + - type: array + description: The claim's ID. + items: + type: string + title: id + description: The id's ID. + - name: order_id + in: query + required: false + schema: + oneOf: + - type: string + title: order_id + description: The claim's order id. + - type: array + description: The claim's order id. + items: + type: string + title: order_id + description: The order id's details. + - name: status + in: query + required: false + schema: + oneOf: + - type: string + title: status + description: The claim's status. + - type: array + description: The claim's status. + items: + type: string + title: status + description: The status's details. + - name: created_at + in: query + description: The claim's created at. + required: false + schema: + type: object + description: The claim'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 claim's updated at. + required: false + schema: + type: object + description: The claim'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: $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_claims_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}.yaml index fd266eb262..c4cc700cb9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}.yaml @@ -3,7 +3,7 @@ get: summary: Get a Claim description: >- Retrieve a claim by its ID. You can expand the claim's relations or select - the fields that should be returned. + 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_collections.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections.yaml index fc6468e914..10ec30cef4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections.yaml @@ -61,6 +61,891 @@ 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: deleted_at + in: query + description: Filter by the collection's deletion date. + required: false + schema: + type: object + description: Filter by the collection'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 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: q + in: query + description: Search term to filter the collection's searchable properties by. + required: false + schema: + type: string + title: q + description: Search term to filter the collection's searchable properties by. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: Filter by a collection's ID. + - type: array + description: Filter by collection IDs. + items: + type: string + title: id + description: The collection's ID. + - name: handle + in: query + required: false + schema: + oneOf: + - type: string + title: handle + description: Filter by a collection's handle. + - type: array + description: Filter by collection handles. + items: + type: string + title: handle + description: The collection's handle. + - name: title + in: query + required: false + schema: + oneOf: + - type: string + title: title + description: Filter by a collection's title. + - type: array + description: Filter by collection titles. + items: + type: string + title: title + description: The collection's title. + - name: created_at + in: query + description: Filter by the collection's creation date. + required: false + schema: + type: object + description: Filter by the collection'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 collection's update date. + required: false + schema: + type: object + description: Filter by the collection'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`). + - 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_collections_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml index 90222acdff..6de792ec28 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml @@ -3,7 +3,7 @@ get: summary: Get a Collection description: >- Retrieve a collection by its ID. You can expand the collection's relations - or select the fields that should be returned. + 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_currencies.yaml b/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml index 13c728e3f8..9d26c52d07 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml @@ -61,6 +61,56 @@ 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: The search term to filter the currency's searchable properties by. + required: false + schema: + type: string + title: q + description: The search term to filter the currency's searchable properties by. + - name: code + in: query + required: false + schema: + oneOf: + - type: string + title: code + description: Filter by a currency code. + - type: array + description: Filter by currency codes. + items: + type: string + title: code + description: A currency 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. + 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_currencies_{code}.yaml b/www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml index 68d71cf2d1..b081a745b5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml @@ -2,8 +2,8 @@ get: operationId: GetCurrenciesCode summary: Get a Currency description: >- - Retrieve a currency by its ID. You can expand the currency's relations or - select the fields that should be returned. + Retrieve a currency by its code. You can expand the currency's relations or + select the fields that should be returned using the query parameters. x-authenticated: true parameters: - name: code 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 d4db25ec9e..3b154f4ded 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 @@ -61,6 +61,948 @@ 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: The customer group's q. + required: false + schema: + type: string + title: q + description: The customer group's q. + - name: id + in: query + required: false + schema: + 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: name + in: query + required: false + schema: + 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. + - name: customers + in: query + required: false + schema: + 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.yaml + - name: created_by + in: query + required: false + schema: + 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. + - name: created_at + in: query + description: The customer group's created at. + required: false + schema: + type: object + description: The customer group'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 customer group's updated at. + required: false + schema: + type: object + description: The customer group'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 customer group's deleted at. + required: false + schema: + type: object + description: The customer group'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 + 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_customer-groups_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml index d238d4b844..ea63382b88 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml @@ -249,9 +249,6 @@ delete: type: boolean title: deleted description: The customer group's deleted. - parent: - type: object - description: The customer group's parent. '400': $ref: ../components/responses/400_error.yaml '401': 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 61e0d0413c..711935361a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml @@ -61,6 +61,3019 @@ 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: groups + in: query + required: false + schema: + oneOf: + - type: string + title: groups + description: The customer's groups. + - type: array + description: The customer's groups. + 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. + - name: q + in: query + description: The customer's q. + required: false + schema: + type: string + title: q + description: The customer's q. + - name: id + in: query + required: false + schema: + 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: >- + Join 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: email + in: query + required: false + schema: + 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: >- + Join 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: company_name + in: query + required: false + schema: + 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: >- + Join 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: first_name + in: query + required: false + schema: + 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: >- + Join 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: last_name + in: query + required: false + schema: + 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: >- + Join 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: created_by + in: query + required: false + schema: + 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: >- + Join 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: created_at + in: query + description: The customer's created at. + required: false + schema: + type: object + description: The customer'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 customer's updated at. + required: false + schema: + type: object + description: The customer'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 customer's deleted at. + required: false + schema: + type: object + description: The customer'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 + 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_customers_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml index 4fc041cabe..165da2be24 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml @@ -292,9 +292,6 @@ delete: type: boolean title: deleted description: The customer's deleted. - parent: - type: object - description: The customer's parent. '400': $ref: ../components/responses/400_error.yaml '401': 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 f5b482c8e6..2de4700c6c 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 @@ -67,6 +67,112 @@ 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: The customer's q. + required: false + schema: + type: string + title: q + description: The customer's q. + - name: company + in: query + required: false + schema: + 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. + - name: city + in: query + required: false + schema: + 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. + - name: country_code + in: query + required: false + schema: + 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. + - name: province + in: query + required: false + schema: + 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. + - name: postal_code + in: query + required: false + schema: + 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. + - 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_customers_{id}_addresses_{address_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml index 28b44957e2..9e2c05b134 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 @@ -386,28 +386,32 @@ delete: content: application/json: schema: - type: object + allOf: + - type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The customer's ID. + object: + type: string + title: object + description: The name of the deleted object. + deleted: + type: boolean + title: deleted + description: Whether the Customer was deleted. + - type: object + description: SUMMARY + properties: + parent: + $ref: ../components/schemas/AdminCustomer.yaml description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The customer's ID. - object: - type: string - title: object - description: The customer's object. - deleted: - type: boolean - title: deleted - description: The customer's deleted. - parent: - type: object - description: The customer's parent. '400': $ref: ../components/responses/400_error.yaml '401': 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 86b04d2212..124d24a623 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 @@ -61,6 +61,1233 @@ 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: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The draft order's ID. + - type: array + description: The draft order's ID. + items: + type: string + title: id + description: The id's ID. + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The draft order's name. + - type: array + description: The draft order's name. + items: + type: string + title: name + description: The name's details. + - name: sales_channel_id + in: query + description: The draft order's sales channel id. + required: false + schema: + type: array + description: The draft order's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + - name: fulfillment_status + in: query + description: The draft order's fulfillment status. + required: false + schema: + type: array + description: The draft order's fulfillment status. + items: + type: string + title: fulfillment_status + description: The fulfillment status's details. + - name: payment_status + in: query + description: The draft order's payment status. + required: false + schema: + type: array + description: The draft order's payment status. + items: + type: string + title: payment_status + description: The payment status's details. + - name: region_id + in: query + description: The draft order's region id. + required: false + schema: + type: array + description: The draft order's region id. + items: + type: string + title: region_id + description: The region id's details. + - name: q + in: query + description: The draft order's q. + required: false + schema: + type: string + title: q + description: The draft order's q. + - name: created_at + in: query + description: The draft order's created at. + required: false + schema: + type: object + description: The draft order'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 draft order's updated at. + required: false + schema: + type: object + description: The draft order'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: 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_exchanges.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml index ff659d19f6..0714737f95 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml @@ -61,6 +61,933 @@ 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: deleted_at + in: query + description: The exchange's deleted at. + required: false + schema: + type: object + description: The exchange'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: q + in: query + description: The exchange's q. + required: false + schema: + type: string + title: q + description: The exchange's q. + - name: id + in: query + required: false + schema: + 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. + - name: order_id + in: query + required: false + schema: + 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. + - name: status + in: query + required: false + schema: + 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. + - name: created_at + in: query + description: The exchange's created at. + required: false + schema: + type: object + description: The exchange'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 exchange's updated at. + required: false + schema: + type: object + description: The exchange'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: $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_exchanges_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml index e93149966c..092df7975e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml @@ -129,29 +129,7 @@ delete: content: application/json: schema: - type: object - description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The exchange's ID. - object: - type: string - title: object - description: The name of the deleted object. - default: exchange - deleted: - type: boolean - title: deleted - description: Whether the exchange was deleted. - parent: - type: object - description: The exchange's parent. + $ref: ../components/schemas/AdminExchangeDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 59283fed8a..3339cf05fd 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 @@ -382,29 +382,7 @@ delete: content: application/json: schema: - type: object - description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The service zone'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. - parent: - type: object - description: The fulfillment set that the service zone belongs to. + $ref: ../components/schemas/AdminServiceZoneDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 64afe35e58..1ef1574ae7 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 @@ -308,6 +308,8 @@ get: type: string title: location_id description: The location id's details. + required: + - location_id - name: $and in: query required: false @@ -454,99 +456,7 @@ post: content: application/json: schema: - type: object - description: SUMMARY - required: - - sku - - hs_code - - weight - - length - - height - - width - - origin_country - - mid_code - - material - - title - - description - - thumbnail - - metadata - properties: - sku: - type: string - title: sku - description: The inventory item's sku. - hs_code: - type: string - title: hs_code - description: The inventory item's hs code. - weight: - type: number - title: weight - description: The inventory item's weight. - length: - type: number - title: length - description: The inventory item's length. - height: - type: number - title: height - description: The inventory item's height. - width: - type: number - title: width - description: The inventory item's width. - origin_country: - type: string - title: origin_country - description: The inventory item's origin country. - mid_code: - type: string - title: mid_code - description: The inventory item's mid code. - material: - type: string - title: material - description: The inventory item's material. - title: - type: string - title: title - description: The inventory item's title. - description: - type: string - title: description - description: The inventory item's description. - requires_shipping: - type: boolean - title: requires_shipping - description: The inventory item's requires shipping. - thumbnail: - type: string - title: thumbnail - description: The inventory item's thumbnail. - metadata: - type: object - description: The inventory item's metadata. - location_levels: - type: array - description: The inventory item's location levels. - items: - type: object - description: The location level's location levels. - required: - - location_id - properties: - location_id: - type: string - title: location_id - description: The location level's location id. - stocked_quantity: - type: number - title: stocked_quantity - description: The location level's stocked quantity. - incoming_quantity: - type: number - title: incoming_quantity - description: The location level's incoming quantity. + $ref: ../components/schemas/AdminCreateInventoryItem.yaml x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml index 43c436adb6..9f12c0f75c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml @@ -320,9 +320,6 @@ delete: type: boolean title: deleted description: Whether the inventory item was deleted. - parent: - type: object - description: The inventory item's parent. '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml index db60f216cd..c03daa2c49 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml @@ -215,29 +215,32 @@ delete: content: application/json: schema: - type: object + allOf: + - type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The inventory item's ID. + object: + type: string + title: object + description: The name of the deleted object. + deleted: + type: boolean + title: deleted + description: Whether the Inventory Item was deleted. + - type: object + description: SUMMARY + properties: + parent: + $ref: ../components/schemas/AdminInventoryItem.yaml description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The inventory level's ID. - object: - type: string - title: object - description: The name of the deleted object. - default: inventory-level - deleted: - type: boolean - title: deleted - description: Whether the inventory level was deleted. - parent: - type: object - description: The inventory item of the level. '400': $ref: ../components/responses/400_error.yaml '401': 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 6f5d2cdd8b..35d661058b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml @@ -103,17 +103,851 @@ get: in: query description: The invite's created at. required: false - schema: {} + schema: + type: object + description: The invite'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 invite's updated at. required: false - schema: {} + schema: + type: object + description: The invite'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 invite's deleted at. required: false - schema: {} + schema: + type: object + description: The invite'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 @@ -262,6 +1096,9 @@ post: title: email description: The invite's email. format: email + metadata: + type: object + description: The invite's metadata. x-codeSamples: - lang: Shell label: cURL 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 d64a3e8b34..1f3833319e 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 @@ -138,9 +138,6 @@ delete: type: boolean title: deleted description: Whether the invite was deleted. - parent: - type: object - description: The invite's parent. '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml index 9a2d2b2eae..c0e27ac3ee 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml @@ -47,9 +47,6 @@ delete: type: boolean title: deleted description: Whether the order edit was deleted. - parent: - type: object - description: The order edit's parent. '400': $ref: ../components/responses/400_error.yaml '401': 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 00c1debacd..19e94d0efd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml @@ -61,6 +61,1233 @@ 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: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The order's ID. + - type: array + description: The order's ID. + items: + type: string + title: id + description: The id's ID. + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The order's name. + - type: array + description: The order's name. + items: + type: string + title: name + description: The name's details. + - name: sales_channel_id + in: query + description: The order's sales channel id. + required: false + schema: + type: array + description: The order's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + - name: fulfillment_status + in: query + description: The order's fulfillment status. + required: false + schema: + type: array + description: The order's fulfillment status. + items: + type: string + title: fulfillment_status + description: The fulfillment status's details. + - name: payment_status + in: query + description: The order's payment status. + required: false + schema: + type: array + description: The order's payment status. + items: + type: string + title: payment_status + description: The payment status's details. + - name: region_id + in: query + description: The order's region id. + required: false + schema: + type: array + description: The order's region id. + items: + type: string + title: region_id + description: The region id's details. + - name: q + in: query + description: The order's q. + required: false + schema: + type: string + title: q + description: The order's q. + - name: created_at + in: query + description: The order's created at. + required: false + schema: + type: object + description: The order'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 order's updated at. + required: false + schema: + type: object + description: The order'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: 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: [] 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 8dacb2f2ef..7b5f1d3d53 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 @@ -24,18 +24,24 @@ get: data. - name: fields in: query - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + + if a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. + + without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. + + without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml index 0691343935..35f2fecee9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml @@ -27,29 +27,7 @@ delete: content: application/json: schema: - type: object - description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The payment collection's ID. - object: - type: string - title: object - description: The name of the deleted object. - default: payment-collection - deleted: - type: boolean - title: deleted - description: Whether the payment collection was deleted. - parent: - type: object - description: The payment collection's parent. + $ref: ../components/schemas/AdminDeletePaymentCollectionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 55ef2c0f5b..df26b84f73 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments.yaml @@ -101,17 +101,851 @@ get: in: query description: The payment's created at. required: false - schema: {} + schema: + type: object + description: The payment'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 payment's updated at. required: false - schema: {} + schema: + type: object + description: The payment'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 payment's deleted at. required: false - schema: {} + schema: + type: object + description: The payment'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 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 63fa45804a..2da86bac87 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 @@ -61,6 +61,646 @@ 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: The price list's q. + required: false + schema: + type: string + title: q + description: The price list's q. + - name: id + in: query + required: false + schema: + 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. + - name: starts_at + in: query + description: The price list's starts at. + required: false + schema: + type: object + description: The price list's starts 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: ends_at + in: query + description: The price list's ends at. + required: false + schema: + type: object + description: The price list's ends 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: status + in: query + description: The price list's status. + required: false + schema: + type: array + description: The price list's status. + items: + type: string + description: The status's details. + enum: + - draft + - active + - name: rules_count + in: query + description: The price list's rules count. + required: false + schema: + type: array + description: The price list's rules count. + items: + type: number + title: rules_count + description: The rules count's details. + - 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_price-preferences.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml index 77dbe8ed0e..39071efaa2 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 @@ -62,6 +62,84 @@ 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: id + in: query + required: false + schema: + 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. + - name: attribute + in: query + required: false + schema: + 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. + - name: value + in: query + required: false + schema: + 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. + - name: q + in: query + description: The price preference's q. + required: false + schema: + type: string + title: q + description: The price preference's q. + - 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_product-categories.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml index 4e75732886..68b0b20888 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 @@ -162,17 +162,851 @@ get: in: query description: The product category's created at. required: false - schema: {} + schema: + type: object + description: The product category'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 product category's updated at. required: false - schema: {} + schema: + type: object + description: The product category'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 product category's deleted at. required: false - schema: {} + schema: + type: object + description: The product category'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 @@ -191,6 +1025,20 @@ get: items: type: object title: $or + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The product category's name. + - type: array + description: The product category's name. + items: + type: string + title: name + description: The name's details. security: - api_token: [] - cookie_auth: [] @@ -290,44 +1138,7 @@ post: content: application/json: schema: - type: object - description: SUMMARY - required: - - name - - parent_category_id - - metadata - properties: - name: - type: string - title: name - description: The product category's name. - description: - type: string - title: description - description: The product category's description. - handle: - type: string - title: handle - description: The product category's handle. - is_internal: - type: boolean - title: is_internal - description: The product category's is internal. - is_active: - type: boolean - title: is_active - description: The product category's is active. - parent_category_id: - 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. + $ref: ../components/schemas/AdminCreateProductCategory.yaml x-codeSamples: - lang: Shell label: cURL 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 c5c9d1bccf..b103aa4885 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 @@ -101,17 +101,851 @@ get: in: query description: The product tag's created at. required: false - schema: {} + schema: + type: object + description: The product tag'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 product tag's updated at. required: false - schema: {} + schema: + type: object + description: The product tag'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 product tag's deleted at. required: false - schema: {} + schema: + type: object + description: The product tag'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 @@ -229,19 +1063,7 @@ post: content: application/json: schema: - type: object - description: SUMMARY - required: - - value - - metadata - properties: - value: - type: string - title: value - description: The product tag's value. - metadata: - type: object - description: The product tag's metadata. + $ref: ../components/schemas/AdminCreateProductTag.yaml x-codeSamples: - lang: Shell label: cURL 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 c9e49b0ba9..d2a2df313a 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 @@ -101,17 +101,851 @@ get: in: query description: The product type's created at. required: false - schema: {} + schema: + type: object + description: The product type'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 product type's updated at. required: false - schema: {} + schema: + type: object + description: The product type'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 product type's deleted at. required: false - schema: {} + schema: + type: object + description: The product type'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 @@ -229,19 +1063,7 @@ post: content: application/json: schema: - type: object - description: SUMMARY - required: - - value - - metadata - properties: - value: - type: string - title: value - description: The product type's value. - metadata: - type: object - description: The product type's metadata. + $ref: ../components/schemas/AdminCreateProduct.yaml x-codeSamples: - lang: Shell label: cURL 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 14aa800995..a80dad2752 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 @@ -61,6 +61,921 @@ 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: The product variant's q. + required: false + schema: + type: string + title: q + description: The product variant's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product variant's ID. + - type: array + description: The product variant's ID. + items: + type: string + title: id + description: The id's ID. + - name: manage_inventory + in: query + description: The product variant's manage inventory. + required: false + schema: + type: boolean + title: manage_inventory + description: The product variant's manage inventory. + - name: allow_backorder + in: query + description: The product variant's allow backorder. + required: false + schema: + type: boolean + title: allow_backorder + description: The product variant's allow backorder. + - name: created_at + in: query + description: The product variant's created at. + required: false + schema: + type: object + description: The product variant'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 product variant's updated at. + required: false + schema: + type: object + description: The product variant'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 product variant's deleted at. + required: false + schema: + type: object + description: The product variant'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 + 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_promotions.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml index 9e7b1810e9..403314e58e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml @@ -120,17 +120,851 @@ get: in: query description: The promotion's created at. required: false - schema: {} + schema: + type: object + description: The promotion'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 promotion's updated at. required: false - schema: {} + schema: + type: object + description: The promotion'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 promotion's deleted at. required: false - schema: {} + schema: + type: object + description: The promotion'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 diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml index 1f207b542e..70de8fc96c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml @@ -521,9 +521,6 @@ delete: type: boolean title: deleted description: Whether the promotion was deleted. - parent: - type: object - description: The promotion's parent. '400': $ref: ../components/responses/400_error.yaml '401': 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 51b28e725f..d00be7676a 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 @@ -61,6 +61,56 @@ 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: id + in: query + required: false + schema: + 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. + - name: q + in: query + description: The refund reason's q. + required: false + schema: + type: string + title: q + description: The refund reason's q. + - 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: [] @@ -189,20 +239,7 @@ post: content: application/json: schema: - type: object - description: SUMMARY - required: - - label - - description - properties: - label: - type: string - title: label - description: The refund reason's label. - description: - type: string - title: description - description: The refund reason's description. + $ref: ../components/schemas/AdminCreateRefundReason.yaml x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml index 0d5fb886b4..259e197ef5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml @@ -261,9 +261,6 @@ delete: type: boolean title: deleted description: Whether the refund reason was deleted. - parent: - type: object - description: The refund reason's parent. '400': $ref: ../components/responses/400_error.yaml '401': 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 1b25d3ceaf..4757290536 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml @@ -115,17 +115,851 @@ get: in: query description: The region's created at. required: false - schema: {} + schema: + type: object + description: The 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 region's updated at. required: false - schema: {} + schema: + type: object + description: The 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 region's deleted at. required: false - schema: {} + schema: + type: object + description: The 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 @@ -272,46 +1106,7 @@ post: content: application/json: schema: - type: object - description: SUMMARY - required: - - name - - currency_code - - metadata - properties: - name: - type: string - title: name - description: The region's name. - currency_code: - type: string - title: currency_code - description: The region's currency code. - countries: - type: array - description: The region's countries. - items: - type: string - title: countries - description: The country's countries. - automatic_taxes: - type: boolean - title: automatic_taxes - description: The region's automatic taxes. - payment_providers: - type: array - description: The region's payment providers. - items: - type: string - title: payment_providers - description: The payment provider's payment providers. - metadata: - type: object - description: The region's metadata. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The region's is tax inclusive. + $ref: ../components/schemas/AdminCreateRegion.yaml x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml index 548e50929b..740cbf772d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml @@ -286,9 +286,6 @@ delete: type: boolean title: deleted description: Whether the region was deleted. - parent: - type: object - description: The region's parent. '400': $ref: ../components/responses/400_error.yaml '401': 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 10ccadb65d..c26cde604f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml @@ -153,53 +153,855 @@ get: $gte: {} $lt: {} $lte: {} - - name: quantity - in: query - description: The reservation's quantity. - required: false - schema: - description: The reservation's quantity. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - name: created_at in: query description: The reservation's created at. required: false - schema: {} + schema: + type: object + description: The reservation'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 reservation's updated at. required: false - schema: {} + schema: + type: object + description: The reservation'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 reservation's deleted at. required: false - schema: {} + schema: + type: object + description: The reservation'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`). security: - api_token: [] - cookie_auth: [] @@ -328,39 +1130,7 @@ post: content: application/json: schema: - type: object - description: SUMMARY - required: - - line_item_id - - location_id - - inventory_item_id - - quantity - - description - - metadata - properties: - line_item_id: - type: string - title: line_item_id - description: The reservation's line item id. - location_id: - type: string - title: location_id - description: The reservation's location id. - inventory_item_id: - type: string - title: inventory_item_id - description: The reservation's inventory item id. - quantity: - type: number - title: quantity - description: The reservation's quantity. - description: - type: string - title: description - description: The reservation's description. - metadata: - type: object - description: The reservation's metadata. + $ref: ../components/schemas/AdminCreateReservation.yaml x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml index a6b197aeda..6c8b2b484d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml @@ -269,9 +269,6 @@ delete: type: boolean title: deleted description: Whether the reservation was deleted. - parent: - type: object - description: The reservation's parent. '400': $ref: ../components/responses/400_error.yaml '401': 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 8e43cb2c81..fbe79e7960 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 @@ -143,17 +143,851 @@ get: in: query description: The return reason's created at. required: false - schema: {} + schema: + type: object + description: The return reason'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 return reason's updated at. required: false - schema: {} + schema: + type: object + description: The return reason'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 return reason's deleted at. required: false - schema: {} + schema: + type: object + description: The return reason'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 description: The return reason's $and. diff --git a/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml index 87ca025fb9..a164fc8d1e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml @@ -229,29 +229,7 @@ delete: content: application/json: schema: - type: object - description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The return reason's ID. - object: - type: string - title: object - description: The name of the deleted object. - default: return_reason - deleted: - type: boolean - title: deleted - description: Whether the return reason was deleted. - parent: - type: object - description: The return reason's parent. + $ref: ../components/schemas/AdminReturnReasonDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 39be2f7f9c..a0771e28a8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml @@ -61,6 +61,1233 @@ 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: id + in: query + required: false + schema: + 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: name + in: query + required: false + schema: + 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. + - name: sales_channel_id + in: query + description: The return's sales channel id. + required: false + schema: + type: array + description: The return's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + - name: fulfillment_status + in: query + description: The return's fulfillment status. + required: false + schema: + type: array + description: The return's fulfillment status. + items: + type: string + title: fulfillment_status + description: The fulfillment status's details. + - name: payment_status + in: query + description: The return's payment status. + required: false + schema: + type: array + description: The return's payment status. + items: + type: string + title: payment_status + description: The payment status's details. + - name: region_id + in: query + description: The return's region id. + required: false + schema: + type: array + description: The return's region id. + items: + type: string + title: region_id + description: The region id's details. + - name: q + in: query + description: The return's q. + required: false + schema: + type: string + title: q + description: The return's q. + - name: created_at + in: query + description: The return's created at. + required: false + schema: + type: object + description: The return'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 return's updated at. + required: false + schema: + type: object + description: The return'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: 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_returns_{id}_receive.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml index c97503f988..1000aa992d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml @@ -152,9 +152,6 @@ delete: type: boolean title: deleted description: Whether the return was deleted. - parent: - type: object - description: The return's parent. '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml index dae1bff6dc..2948468390 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml @@ -150,9 +150,6 @@ delete: type: boolean title: deleted description: Whether the return was deleted. - parent: - type: object - description: The return's parent. '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml index 1c835692c1..bbd82a7752 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml @@ -110,11 +110,16 @@ post: x-workflow: updateReturnShippingMethodWorkflow delete: operationId: DeleteReturnsIdShippingMethodAction_id - summary: Remove Shipping Methods from Return - description: >- - Remove a list of shipping methods from a return. This doesn't delete the - Shipping Method, only the association between the Shipping Method and the - return. + summary: Remove Shipping Method from Return + x-sidebar-summary: Remove Shipping Method + description: > + Remove a shipping method of the return by the ID of the item's + `SHIPPING_ADD` action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. x-authenticated: true parameters: - name: id @@ -125,7 +130,7 @@ delete: type: string - name: action_id in: path - description: The return's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string 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 3394dcecbe..af1cdff583 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 @@ -117,17 +117,851 @@ get: in: query description: The sales channel's created at. required: false - schema: {} + schema: + type: object + description: The sales channel'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 sales channel's updated at. required: false - schema: {} + schema: + type: object + description: The sales channel'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 sales channel's deleted at. required: false - schema: {} + schema: + type: object + description: The sales channel'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: location_id in: query required: false 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 259591cfb2..ddd9a68d4d 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 @@ -143,17 +143,851 @@ get: in: query description: The shipping option's created at. required: false - schema: {} + schema: + type: object + description: The shipping option'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 shipping option's updated at. required: false - schema: {} + schema: + type: object + description: The shipping option'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 shipping option's deleted at. required: false - schema: {} + schema: + type: object + description: The shipping option'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: stock_location_id in: query required: false @@ -168,6 +1002,22 @@ get: type: string title: stock_location_id description: The stock location id's details. + - name: is_return + in: query + description: The shipping option's is return. + required: false + schema: + type: boolean + title: is_return + description: The shipping option's is return. + - name: admin_only + in: query + description: The shipping option's admin only. + required: false + schema: + type: boolean + title: admin_only + description: The shipping option's admin only. security: - api_token: [] - cookie_auth: [] @@ -297,130 +1147,6 @@ post: application/json: schema: type: object - description: SUMMARY - required: - - name - - service_zone_id - - shipping_profile_id - - price_type - - provider_id - - type - - prices - properties: - name: - type: string - title: name - description: The shipping option's name. - service_zone_id: - type: string - title: service_zone_id - description: The shipping option's service zone id. - shipping_profile_id: - type: string - title: shipping_profile_id - description: The shipping option's shipping profile id. - data: - type: object - description: The shipping option's data. - price_type: - type: string - enum: - - calculated - - flat - provider_id: - type: string - title: provider_id - description: The shipping option's provider id. - type: - type: object - description: The shipping option's type. - required: - - label - - description - - code - properties: - label: - type: string - title: label - description: The type's label. - description: - type: string - title: description - description: The type's description. - code: - type: string - title: code - description: The type's code. - prices: - type: array - description: The shipping option's prices. - items: - oneOf: - - type: object - description: The price's prices. - required: - - currency_code - - amount - properties: - currency_code: - type: string - title: currency_code - description: The price's currency code. - amount: - type: number - title: amount - description: The price's amount. - - type: object - description: The price's prices. - required: - - region_id - - amount - properties: - region_id: - type: string - title: region_id - description: The price's region id. - amount: - type: number - title: amount - description: The price's amount. - rules: - type: array - description: The shipping option's rules. - items: - type: object - description: The rule's rules. - required: - - operator - - attribute - - value - properties: - operator: - type: string - enum: - - in - - eq - - ne - - gt - - gte - - lt - - lte - - nin - attribute: - type: string - title: attribute - description: The rule's attribute. - value: - oneOf: - - type: string - title: value - description: The rule's value. - - type: array - description: The rule's value. - items: - type: string - title: value - description: The value's details. 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 e2a7319f53..dae26ff185 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 @@ -129,17 +129,851 @@ get: in: query description: The stock location's created at. required: false - schema: {} + schema: + type: object + description: The stock location'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 stock location's updated at. required: false - schema: {} + schema: + type: object + description: The stock location'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 stock location's deleted at. required: false - schema: {} + schema: + type: object + description: The stock location'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 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 1648ee0ebd..fe5d3c209d 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 @@ -119,21 +119,856 @@ get: enum: - 'true' - 'false' + title: is_default - name: created_at in: query description: The tax rate's created at. required: false - schema: {} + schema: + type: object + description: The tax rate'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 rate's updated at. required: false - schema: {} + schema: + type: object + description: The tax rate'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 rate's deleted at. required: false - schema: {} + schema: + type: object + description: The tax rate'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 @@ -152,6 +987,38 @@ get: items: type: object title: $or + - name: service_zone_id + in: query + description: The tax rate's service zone id. + required: false + schema: + type: string + title: service_zone_id + description: The tax rate's service zone id. + - name: shipping_profile_id + in: query + description: The tax rate's shipping profile id. + required: false + schema: + type: string + title: shipping_profile_id + description: The tax rate's shipping profile id. + - name: provider_id + in: query + description: The tax rate's provider id. + required: false + schema: + type: string + title: provider_id + description: The tax rate's provider id. + - name: shipping_option_type_id + in: query + description: The tax rate's shipping option type id. + required: false + schema: + type: string + title: shipping_option_type_id + description: The tax rate's shipping option type id. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml index 5906af6a84..2b52812692 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml @@ -1,9 +1,8 @@ delete: operationId: DeleteTaxRatesIdRulesRule_id - summary: Remove Rules from Tax Rate - description: >- - Remove a list of rules from a tax rate. This doesn't delete the Rule, only - the association between the Rule and the tax rate. + summary: Remove Rule of Tax Rate + x-sidebar-summary: Remove Rule + description: Remove a tax rate's rule. x-authenticated: true parameters: - name: id @@ -14,7 +13,7 @@ delete: type: string - name: rule_id in: path - description: The tax rate's rule id. + description: The tax rate rule's ID. required: true schema: type: string @@ -90,28 +89,32 @@ delete: content: application/json: schema: - type: object + allOf: + - type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The tax rate's ID. + object: + type: string + title: object + description: The name of the deleted object. + deleted: + type: boolean + title: deleted + description: Whether the Tax Rate was deleted. + - type: object + description: SUMMARY + properties: + parent: + $ref: ../components/schemas/AdminTaxRate.yaml description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The tax rate's ID. - object: - type: string - title: object - description: The tax rate's object. - deleted: - type: boolean - title: deleted - description: The tax rate's deleted. - parent: - type: object - description: The tax rate's parent. '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml b/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml index fc96d3c521..f64a477959 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml @@ -12,7 +12,34 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminGetUploadParams.yaml + oneOf: + - type: object + description: SUMMARY + required: + - files + properties: + files: + type: array + description: The upload's files. + items: + oneOf: + - type: object + description: The file's files. + required: + - name + - content + properties: + name: + type: string + title: name + description: The file's name. + content: + type: string + title: content + description: The file's content. + - $ref: ../components/schemas/File.yaml + - $ref: ../components/schemas/FileList.yaml + description: SUMMARY x-codeSamples: - lang: Shell label: cURL 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 20d3772217..5c051787d8 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 @@ -99,13 +99,13 @@ get: $ref: ../components/responses/500_error.yaml delete: operationId: DeleteUploadsId - summary: Delete a Upload - description: Delete a upload. + summary: Delete a File + description: Delete a file. Uses the installed file module provider to delete the file. x-authenticated: true parameters: - name: id in: path - description: The upload's ID. + description: The file's ID. required: true schema: type: string @@ -136,18 +136,16 @@ delete: id: type: string title: id - description: The upload's ID. + description: The file's ID. object: type: string title: object - description: The upload's object. + description: The name of the deleted object. + default: file deleted: type: boolean title: deleted - description: The upload's deleted. - parent: - type: object - description: The upload's parent. + description: Whether the file was deleted. '400': $ref: ../components/responses/400_error.yaml '401': 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 557254d105..65b8918ad5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users.yaml @@ -61,6 +61,902 @@ 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: The user's q. + required: false + schema: + type: string + title: q + description: The user's q. + - name: id + in: query + required: false + schema: + 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. + - name: email + in: query + description: The user's email. + required: false + schema: + type: string + title: email + description: The user's email. + format: email + - name: first_name + in: query + description: The user's first name. + required: false + schema: + type: string + title: first_name + description: The user's first name. + - name: last_name + in: query + description: The user's last name. + required: false + schema: + type: string + title: last_name + description: The user's last name. + - name: created_at + in: query + description: The user's created at. + required: false + schema: + type: object + description: The user'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 user's updated at. + required: false + schema: + type: object + description: The user'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 user's deleted at. + required: false + schema: + type: object + description: The user'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`). x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml index c92a30e4e8..4bd73651ee 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml @@ -94,7 +94,7 @@ properties: description: The claim's email. format: email display_id: - type: string + type: number title: display_id description: The claim's display id. shipping_address: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaimDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaimDeleteResponse.yaml index 7262c162bf..762248df11 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminClaimDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Claim was deleted. - parent: - type: object - description: The claim's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCollectionDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCollectionDeleteResponse.yaml index 8fb21f0636..c49daa3bbe 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCollectionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCollectionDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Collection was deleted. - parent: - type: object - description: The collection's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateApplicationMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateApplicationMethod.yaml new file mode 100644 index 0000000000..7bc1869e1f --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateApplicationMethod.yaml @@ -0,0 +1,61 @@ +type: object +description: The promotion's application method. +x-schemaName: AdminCreateApplicationMethod +required: + - value + - type + - target_type +properties: + description: + type: string + title: description + description: The application method's description. + value: + type: number + title: value + description: The application method's value. + currency_code: + type: string + title: currency_code + description: The application method's currency code. + max_quantity: + type: number + title: max_quantity + description: The application method's max quantity. + type: + type: string + description: The application method's type. + enum: + - fixed + - percentage + target_type: + type: string + description: The application method's target type. + enum: + - items + - shipping_methods + - order + allocation: + type: string + description: The application method's allocation. + enum: + - each + - across + target_rules: + type: array + description: The application method's target rules. + items: + $ref: ./AdminCreatePromotionRule.yaml + buy_rules: + type: array + description: The application method's buy rules. + items: + $ref: ./AdminCreatePromotionRule.yaml + apply_to_quantity: + type: number + title: apply_to_quantity + description: The application method's apply to quantity. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The application method's buy rules min quantity. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateCampaign.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCampaign.yaml new file mode 100644 index 0000000000..f5219bcaee --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCampaign.yaml @@ -0,0 +1,48 @@ +type: object +description: The promotion's campaign. +x-schemaName: AdminCreateCampaign +properties: + name: + type: string + title: name + description: The campaign's name. + description: + type: string + title: description + description: The campaign's description. + currency: + type: string + title: currency + description: The campaign's currency. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + budget: + type: object + description: The campaign's budget. + properties: + type: + type: string + description: The budget's type. + enum: + - spend + - usage + currency_code: + type: string + title: currency_code + description: The budget's currency code. + limit: + type: number + title: limit + description: The budget's limit. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateInventoryItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateInventoryItem.yaml new file mode 100644 index 0000000000..a974fc3ee4 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateInventoryItem.yaml @@ -0,0 +1,59 @@ +type: object +description: SUMMARY +properties: + sku: + type: string + title: sku + description: The inventory item's sku. + hs_code: + type: string + title: hs_code + description: The inventory item's hs code. + weight: + type: number + title: weight + description: The inventory item's weight. + length: + type: number + title: length + description: The inventory item's length. + height: + type: number + title: height + description: The inventory item's height. + width: + type: number + title: width + description: The inventory item's width. + origin_country: + type: string + title: origin_country + description: The inventory item's origin country. + mid_code: + type: string + title: mid_code + description: The inventory item's mid code. + material: + type: string + title: material + description: The inventory item's material. + title: + type: string + title: title + description: The inventory item's title. + description: + type: string + title: description + description: The inventory item's description. + requires_shipping: + type: boolean + title: requires_shipping + description: The inventory item's requires shipping. + thumbnail: + type: string + title: thumbnail + description: The inventory item's thumbnail. + 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 new file mode 100644 index 0000000000..35a28c81d9 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductCategory.yaml @@ -0,0 +1,37 @@ +type: object +description: SUMMARY +required: + - name +properties: + name: + type: string + title: name + description: The product category's name. + description: + type: string + title: description + description: The product category's description. + handle: + type: string + title: handle + description: The product category's handle. + is_internal: + type: boolean + title: is_internal + description: The product category's is internal. + is_active: + type: boolean + title: is_active + description: The product category's is active. + parent_category_id: + 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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductTag.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductTag.yaml new file mode 100644 index 0000000000..18462a72a4 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductTag.yaml @@ -0,0 +1,13 @@ +type: object +description: SUMMARY +required: + - value +properties: + value: + type: string + title: value + description: The product tag's value. + metadata: + type: object + description: The product tag's metadata. +x-schemaName: AdminCreateProductTag diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreatePromotionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreatePromotionRule.yaml new file mode 100644 index 0000000000..71606d0bd6 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreatePromotionRule.yaml @@ -0,0 +1,38 @@ +type: object +description: The rule's rules. +x-schemaName: AdminCreatePromotionRule +required: + - operator + - attribute + - values +properties: + operator: + type: string + description: The rule's operator. + enum: + - gt + - lt + - eq + - ne + - in + - lte + - gte + description: + type: string + title: description + description: The rule's description. + attribute: + type: string + title: attribute + description: The rule's attribute. + values: + oneOf: + - type: string + title: values + description: The rule's values. + - type: array + description: The rule's values. + items: + type: string + title: values + description: The value's values. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateRefundReason.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateRefundReason.yaml new file mode 100644 index 0000000000..1cac026bcd --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateRefundReason.yaml @@ -0,0 +1,14 @@ +type: object +description: SUMMARY +required: + - label +properties: + label: + type: string + title: label + description: The refund reason's label. + description: + 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 new file mode 100644 index 0000000000..a25a942ec7 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateRegion.yaml @@ -0,0 +1,40 @@ +type: object +description: SUMMARY +required: + - name + - currency_code +properties: + name: + type: string + title: name + description: The region's name. + currency_code: + type: string + title: currency_code + description: The region's currency code. + countries: + type: array + description: The region's countries. + items: + type: string + title: countries + description: The country's countries. + automatic_taxes: + type: boolean + title: automatic_taxes + description: The region's automatic taxes. + payment_providers: + type: array + description: The region's payment providers. + items: + type: string + title: payment_providers + description: The payment provider's payment providers. + 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 new file mode 100644 index 0000000000..928e366407 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateReservation.yaml @@ -0,0 +1,31 @@ +type: object +description: SUMMARY +required: + - location_id + - inventory_item_id + - quantity +properties: + line_item_id: + type: string + title: line_item_id + description: The reservation's line item id. + location_id: + type: string + title: location_id + description: The reservation's location id. + inventory_item_id: + type: string + title: inventory_item_id + description: The reservation's inventory item id. + quantity: + type: number + title: quantity + description: The reservation's quantity. + description: + type: string + title: description + description: The reservation's description. + metadata: + type: object + description: The reservation's metadata. +x-schemaName: AdminCreateReservation diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateSalesChannel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateSalesChannel.yaml index 95757db18b..21e8775112 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateSalesChannel.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateSalesChannel.yaml @@ -3,8 +3,6 @@ description: SUMMARY x-schemaName: AdminCreateSalesChannel required: - name - - description - - metadata properties: name: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml new file mode 100644 index 0000000000..7d87bda7e1 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml @@ -0,0 +1,76 @@ +type: object +description: SUMMARY +required: + - name + - service_zone_id + - shipping_profile_id + - price_type + - provider_id + - type + - prices +properties: + name: + type: string + title: name + description: The shipping option's name. + service_zone_id: + type: string + title: service_zone_id + description: The shipping option's service zone id. + shipping_profile_id: + type: string + title: shipping_profile_id + description: The shipping option's shipping profile id. + data: + type: object + description: The shipping option's data. + price_type: + type: string + enum: + - calculated + - flat + provider_id: + type: string + title: provider_id + description: The shipping option's provider id. + type: + $ref: ./AdminCreateShippingOption.yaml + prices: + type: array + description: The shipping option's prices. + items: + oneOf: + - type: object + description: The price's prices. + required: + - currency_code + - amount + properties: + currency_code: + type: string + title: currency_code + description: The price's currency code. + amount: + type: number + title: amount + description: The price's amount. + - type: object + description: The price's prices. + required: + - region_id + - amount + properties: + region_id: + type: string + title: region_id + description: The price's region id. + amount: + type: number + title: amount + description: The price's amount. + rules: + type: array + 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 new file mode 100644 index 0000000000..c974d26878 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOptionRule.yaml @@ -0,0 +1,34 @@ +type: object +description: The rule's rules. +required: + - operator + - attribute + - value +properties: + operator: + type: string + enum: + - in + - eq + - ne + - gt + - gte + - lt + - lte + - nin + attribute: + type: string + title: attribute + description: The rule's attribute. + value: + oneOf: + - type: string + title: value + description: The rule's value. + - type: array + description: The rule's value. + items: + type: string + title: value + description: The value's details. +x-schemaName: AdminCreateShippingOptionRule diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateStockLocation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateStockLocation.yaml index 8e3ef68737..3766f7c914 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateStockLocation.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateStockLocation.yaml @@ -3,62 +3,17 @@ description: SUMMARY x-schemaName: AdminCreateStockLocation required: - name - - address_id - - metadata properties: name: type: string title: name description: The stock location's name. - address: - type: object - description: The stock location's address. - required: - - address_1 - - address_2 - - company - - city - - country_code - - phone - - postal_code - - province - properties: - address_1: - type: string - title: address_1 - description: The address's address 1. - address_2: - type: string - title: address_2 - description: The address's address 2. - company: - type: string - title: company - description: The address's company. - city: - type: string - title: city - description: The address's city. - country_code: - type: string - title: country_code - description: The address's country code. - phone: - type: string - title: phone - description: The address's phone. - postal_code: - type: string - title: postal_code - description: The address's postal code. - province: - type: string - title: province - description: The address's province. address_id: type: string title: address_id description: The stock location's address id. + address: + $ref: ./AdminUpsertStockLocationAddress.yaml metadata: type: object description: The stock location's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRate.yaml index 0ae78fdda5..32492385be 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRate.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRate.yaml @@ -4,8 +4,15 @@ x-schemaName: AdminCreateTaxRate required: - name - tax_region_id - - metadata properties: + name: + type: string + title: name + description: The tax rate's name. + tax_region_id: + type: string + title: tax_region_id + description: The tax rate's tax region id. rate: type: number title: rate @@ -18,24 +25,7 @@ properties: type: array description: The tax rate's rules. items: - type: object - description: The rule's rules. - required: - - reference - - reference_id - properties: - reference: - type: string - title: reference - description: The rule's reference. - reference_id: - type: string - title: reference_id - description: The rule's reference id. - name: - type: string - title: name - description: The tax rate's name. + $ref: ./AdminCreateTaxRateRule.yaml is_default: type: boolean title: is_default @@ -44,10 +34,6 @@ properties: type: boolean title: is_combinable description: The tax rate's is combinable. - tax_region_id: - type: string - title: tax_region_id - description: The tax rate's tax region id. metadata: type: object description: The tax rate's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml index 4958a3b256..2e24b98894 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml @@ -3,9 +3,6 @@ description: SUMMARY x-schemaName: AdminCreateTaxRegion required: - country_code - - province_code - - parent_id - - metadata properties: country_code: type: string @@ -24,7 +21,6 @@ properties: description: The tax region's default tax rate. required: - name - - metadata properties: rate: type: number diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCustomer.yaml index f1f78d98b3..efce81ce39 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCustomer.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCustomer.yaml @@ -1,5 +1,5 @@ type: object -description: The customer's details. +description: The order's customer. x-schemaName: AdminCustomer required: - has_account diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroup.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroup.yaml index c4610e86ec..ba7722625f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroup.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroup.yaml @@ -1,37 +1,3 @@ type: object description: The group's groups. x-schemaName: AdminCustomerGroup -required: - - id - - name - - customers - - metadata - - created_at - - updated_at -properties: - id: - type: string - title: id - description: The group's ID. - name: - type: string - title: name - description: The group's name. - customers: - type: array - description: The group's customers. - items: - $ref: ./BaseCustomer.yaml - metadata: - type: object - description: The group's metadata. - created_at: - type: string - format: date-time - title: created_at - description: The group's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The group's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerInGroupFilters.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerInGroupFilters.yaml new file mode 100644 index 0000000000..11fdbf8084 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerInGroupFilters.yaml @@ -0,0 +1,609 @@ +type: object +description: The customer group's customers. +x-schemaName: AdminCustomerInGroupFilters +properties: + 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. + 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: >- + Join 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`). + default_billing_address_id: + oneOf: + - type: string + title: default_billing_address_id + description: The customer's default billing address id. + - type: array + description: The customer's default billing address id. + items: + type: string + title: default_billing_address_id + description: The default billing address id's details. + default_shipping_address_id: + oneOf: + - type: string + title: default_shipping_address_id + description: The customer's default shipping address id. + - type: array + description: The customer's default shipping address id. + items: + type: string + title: default_shipping_address_id + description: The default shipping address id's details. + 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. + 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. + 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. + 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. + created_at: + type: object + description: The customer'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. + - 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: >- + Join 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`). + deleted_at: + type: object + description: The customer'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. + - 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`). diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminDeletePaymentCollectionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminDeletePaymentCollectionResponse.yaml new file mode 100644 index 0000000000..042dc95d6a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminDeletePaymentCollectionResponse.yaml @@ -0,0 +1,21 @@ +type: object +description: SUMMARY +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The payment collection's ID. + object: + type: string + title: object + description: The name of the deleted object. + default: payment-collection + deleted: + type: boolean + title: deleted + description: Whether the payment collection was deleted. +x-schemaName: AdminDeletePaymentCollectionResponse diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml index d56f162420..90011a0ac8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml @@ -95,7 +95,7 @@ properties: description: The exchange's email. format: email display_id: - type: string + type: number title: display_id description: The exchange's display id. shipping_address: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeDeleteResponse.yaml new file mode 100644 index 0000000000..78d029950c --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeDeleteResponse.yaml @@ -0,0 +1,21 @@ +type: object +description: SUMMARY +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The exchange's ID. + object: + type: string + title: object + description: The name of the deleted object. + default: exchange + deleted: + type: boolean + title: deleted + description: Whether the exchange was deleted. +x-schemaName: AdminExchangeDeleteResponse 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 01f7f452c6..3414f22b02 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSet.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSet.yaml @@ -1,6 +1,40 @@ type: object -description: The fulfillment set's details. -x-schemaName: AdminFulfillmentSet +description: The fulfillment set that the service zone belongs to. +properties: + id: + type: string + title: id + description: The parent's ID. + name: + type: string + title: name + description: The parent's name. + type: + type: string + title: type + description: The parent's type. + location: + $ref: ./AdminStockLocation.yaml + service_zones: + type: array + description: The parent's service zones. + items: + $ref: ./AdminServiceZone.yaml + created_at: + type: string + format: date-time + title: created_at + description: The parent's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The parent's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The parent's deleted at. required: - id - name @@ -10,38 +44,4 @@ required: - created_at - updated_at - deleted_at -properties: - id: - type: string - title: id - description: The fulfillment set's ID. - name: - type: string - title: name - description: The fulfillment set's name. - type: - type: string - title: type - description: The fulfillment set's type. - location: - $ref: ./AdminStockLocation.yaml - service_zones: - type: array - description: The fulfillment set's service zones. - items: - $ref: ./AdminServiceZone.yaml - created_at: - type: string - format: date-time - title: created_at - description: The fulfillment set's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The fulfillment set's updated at. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The fulfillment set's deleted at. +x-schemaName: AdminFulfillmentSet diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetDeleteResponse.yaml index e8068b4b01..130dc3c7b4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Fulfillment Set was deleted. - parent: - type: object - description: The fulfillment set's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminGetUploadParams.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminGetUploadParams.yaml deleted file mode 100644 index 16e5d808f7..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminGetUploadParams.yaml +++ /dev/null @@ -1,8 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminGetUploadParams -properties: - fields: - type: string - title: fields - description: The upload's fields. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminInventoryItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminInventoryItem.yaml index 58e6de4897..cf8ed2a6db 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminInventoryItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminInventoryItem.yaml @@ -64,3 +64,8 @@ properties: metadata: type: object description: The inventory item's metadata. + location_levels: + type: array + description: The inventory item's location levels. + items: + $ref: ./AdminInventoryLevel.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminInventoryLevel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminInventoryLevel.yaml new file mode 100644 index 0000000000..33bf6814f0 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminInventoryLevel.yaml @@ -0,0 +1,76 @@ +type: object +description: The location level's location levels. +x-schemaName: AdminInventoryLevel +required: + - id + - created_at + - updated_at + - deleted_at + - inventory_item_id + - location_id + - stocked_quantity + - raw_stocked_quantity + - reserved_quantity + - raw_reserved_quantity + - incoming_quantity + - raw_incoming_quantity + - metadata + - available_quantity +properties: + id: + type: string + title: id + description: The location level's ID. + created_at: + type: string + format: date-time + title: created_at + description: The location level's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The location level's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The location level's deleted at. + inventory_item_id: + type: string + title: inventory_item_id + description: The location level's inventory item id. + location_id: + type: string + title: location_id + description: The location level's location id. + stocked_quantity: + type: number + title: stocked_quantity + description: The location level's stocked quantity. + raw_stocked_quantity: + type: object + description: The location level's raw stocked quantity. + reserved_quantity: + type: number + title: reserved_quantity + description: The location level's reserved quantity. + raw_reserved_quantity: + type: object + description: The location level's raw reserved quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The location level's incoming quantity. + raw_incoming_quantity: + type: object + description: The location level's raw incoming quantity. + metadata: + type: object + description: The location level's metadata. + inventory_item: + $ref: ./AdminInventoryItem.yaml + available_quantity: + type: number + title: available_quantity + description: The location level's available quantity. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml index e26100a5de..fd216bb354 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml @@ -51,6 +51,14 @@ properties: description: The order's fulfillments. items: $ref: ./BaseOrderFulfillment.yaml + sales_channel: + $ref: ./AdminSalesChannel.yaml + customer: + $ref: ./AdminCustomer.yaml + shipping_address: + $ref: ./AdminOrderAddress.yaml + billing_address: + $ref: ./AdminOrderAddress.yaml id: type: string title: id @@ -81,13 +89,9 @@ properties: title: currency_code description: The order's currency code. display_id: - type: string + type: number title: display_id description: The order's display id. - shipping_address: - $ref: ./BaseOrderAddress.yaml - billing_address: - $ref: ./BaseOrderAddress.yaml items: type: array description: The order's items. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderAddress.yaml new file mode 100644 index 0000000000..0fda1d2756 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderAddress.yaml @@ -0,0 +1,72 @@ +type: object +description: The order's billing address. +x-schemaName: AdminOrderAddress +required: + - id + - metadata + - created_at + - updated_at +properties: + country: + $ref: ./AdminRegionCountry.yaml + id: + type: string + title: id + description: The billing address's ID. + customer_id: + type: string + title: customer_id + description: The billing address's customer id. + first_name: + type: string + title: first_name + description: The billing address's first name. + last_name: + type: string + title: last_name + description: The billing address's last name. + phone: + type: string + title: phone + description: The billing address's phone. + company: + type: string + title: company + description: The billing address's company. + address_1: + type: string + title: address_1 + description: The billing address's address 1. + address_2: + type: string + title: address_2 + description: The billing address's address 2. + city: + type: string + title: city + description: The billing address's city. + country_code: + type: string + title: country_code + description: The billing address's country code. + province: + type: string + title: province + description: The billing address's province. + postal_code: + type: string + title: postal_code + description: The billing address's postal code. + metadata: + type: object + description: The billing address's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The billing address's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The billing address's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml index b7b508bb87..c2149ed29a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml @@ -491,13 +491,13 @@ properties: description: The order preview's email. format: email display_id: - type: string + type: number title: display_id description: The order preview's display id. shipping_address: - $ref: ./BaseOrderAddress.yaml + $ref: ./AdminOrderAddress.yaml billing_address: - $ref: ./BaseOrderAddress.yaml + $ref: ./AdminOrderAddress.yaml payment_collections: type: array description: The order preview's payment collections. @@ -642,3 +642,7 @@ properties: type: number title: original_shipping_tax_total description: The order preview's original shipping tax total. + customer: + $ref: ./AdminCustomer.yaml + sales_channel: + $ref: ./AdminSalesChannel.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListDeleteResponse.yaml index 310a95819b..d7e323c8f9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Price List was deleted. - parent: - type: object - description: The price list's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceDeleteResponse.yaml index 88ad9e74bf..8f38315baa 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Price Preference was deleted. - parent: - type: object - description: The price preference's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml index fd29fa661a..3fe71d64f6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml @@ -3,9 +3,9 @@ description: The product's parent. x-schemaName: AdminProduct required: - type + - length - title - status - - length - options - description - id @@ -53,6 +53,10 @@ properties: description: The parent's tags. items: $ref: ./AdminProductTag.yaml + length: + type: number + title: length + description: The parent's length. title: type: string title: title @@ -65,10 +69,6 @@ properties: - proposed - published - rejected - length: - type: number - title: length - description: The parent's length. options: type: array description: The parent's options. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryDeleteResponse.yaml index bbccf4934a..b2531e9fab 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Product Category was deleted. - parent: - type: object - description: The product category's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductDeleteResponse.yaml index e254c15d68..8a448dd6a4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Product was deleted. - parent: - type: object - description: The product's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionDeleteResponse.yaml index d3f1b213af..0873a46f9a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionDeleteResponse.yaml @@ -14,7 +14,6 @@ properties: type: string title: object description: The name of the deleted object. - default: product_option deleted: type: boolean title: deleted diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTagDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTagDeleteResponse.yaml index 5304b49c5b..33697dcfd2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductTagDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTagDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Product Tag was deleted. - parent: - type: object - description: The product tag's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeDeleteResponse.yaml index faa54a3337..797b5fd754 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Product Type was deleted. - parent: - type: object - description: The product type's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantDeleteResponse.yaml index 7663cc2969..52094f9db2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantDeleteResponse.yaml @@ -14,7 +14,6 @@ properties: type: string title: object description: The name of the deleted object. - default: variant deleted: type: boolean title: deleted 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 9aca47220c..5388547b61 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml @@ -17,31 +17,395 @@ properties: type: string title: id description: The id's ID. - sku: - oneOf: - - type: string - title: sku - description: The variant's sku. - - type: array - description: The variant's sku. - items: - type: string - title: sku - description: The sku's details. - product_id: - oneOf: - - type: string - title: product_id - description: The variant's product id. - - type: array - description: The variant's product id. - items: - type: string - title: product_id - description: The product id's details. - options: + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + allow_backorder: + type: boolean + title: allow_backorder + description: The variant's allow backorder. + created_at: type: object - description: The variant's options. + description: The variant'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. + - 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 variant'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. + - 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 variant'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. + - 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 @@ -60,13 +424,17 @@ properties: description: The variant's fields. $and: type: array - description: The variant'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 variant'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/store/components/schemas/AdminRegionCountry.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRegionCountry.yaml new file mode 100644 index 0000000000..04938da440 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRegionCountry.yaml @@ -0,0 +1,3 @@ +type: object +description: The billing address's country. +x-schemaName: AdminRegionCountry diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReservation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReservation.yaml index 29f54068a7..df021b64bd 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReservation.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReservation.yaml @@ -24,7 +24,7 @@ properties: title: location_id description: The reservation's location id. quantity: - type: string + type: number title: quantity description: The reservation's quantity. external_id: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonDeleteResponse.yaml new file mode 100644 index 0000000000..78053ef89d --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonDeleteResponse.yaml @@ -0,0 +1,21 @@ +type: object +description: SUMMARY +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The return reason's ID. + object: + type: string + title: object + description: The name of the deleted object. + default: return_reason + deleted: + type: boolean + title: deleted + description: Whether the return reason was deleted. +x-schemaName: AdminReturnReasonDeleteResponse diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannel.yaml index 4fb73f820d..9b497e936c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannel.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannel.yaml @@ -1,5 +1,5 @@ type: object -description: The sales channel's sales channels. +description: The order's sales channel. x-schemaName: AdminSalesChannel required: - id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelDeleteResponse.yaml index d4e8756457..fc93322002 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Sales Channel was deleted. - parent: - type: object - description: The sales channel's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneDeleteResponse.yaml new file mode 100644 index 0000000000..62609511c4 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneDeleteResponse.yaml @@ -0,0 +1,23 @@ +type: object +description: SUMMARY +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The service zone'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. + parent: + $ref: ./AdminFulfillmentSet.yaml +x-schemaName: AdminServiceZoneDeleteResponse diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionDeleteResponse.yaml index fb43eb3166..141ba6526b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Shipping Option was deleted. - parent: - type: object - description: The shipping option's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileDeleteResponse.yaml index 426860c955..bca17d5e8b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Shipping Profile was deleted. - parent: - type: object - description: The shipping profile's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocation.yaml index e4f23a4318..76f80ec99c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocation.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocation.yaml @@ -1,5 +1,5 @@ type: object -description: The fulfillment set's location. +description: The parent's location. x-schemaName: AdminStockLocation required: - id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationDeleteResponse.yaml index f3250de0ed..7d1160157d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Stock Location was deleted. - parent: - type: object - description: The stock location's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRate.yaml index 35d3b37a92..f0321f5651 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRate.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRate.yaml @@ -1,5 +1,5 @@ type: object -description: The tax rate's details. +description: The tax rate's parent. x-schemaName: AdminTaxRate required: - id @@ -20,57 +20,57 @@ properties: id: type: string title: id - description: The tax rate's ID. + description: The parent's ID. rate: type: number title: rate - description: The tax rate's rate. + description: The parent's rate. code: type: string title: code - description: The tax rate's code. + description: The parent's code. name: type: string title: name - description: The tax rate's name. + description: The parent's name. metadata: type: object - description: The tax rate's metadata. + description: The parent's metadata. tax_region_id: type: string title: tax_region_id - description: The tax rate's tax region id. + description: The parent's tax region id. is_combinable: type: boolean title: is_combinable - description: The tax rate's is combinable. + description: The parent's is combinable. is_default: type: boolean title: is_default - description: The tax rate's is default. + description: The parent's is default. created_at: type: string format: date-time title: created_at - description: The tax rate's created at. + description: The parent's created at. updated_at: type: string format: date-time title: updated_at - description: The tax rate's updated at. + description: The parent's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The tax rate's deleted at. + description: The parent's deleted at. created_by: type: string title: created_by - description: The tax rate's created by. + description: The parent's created by. tax_region: $ref: ./AdminTaxRegion.yaml rules: type: array - description: The tax rate's rules. + description: The parent's rules. items: $ref: ./AdminTaxRateRule.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateDeleteResponse.yaml index aa496ab053..6c284786d9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Tax Rate was deleted. - parent: - type: object - description: The tax rate's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml index a9597eba8a..5ee5e6b8e0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml @@ -1,5 +1,5 @@ type: object -description: The tax rate's tax region. +description: The parent's tax region. x-schemaName: AdminTaxRegion required: - id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionDeleteResponse.yaml index 4e2ac8feb4..235dd86a80 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the Tax Region was deleted. - parent: - type: object - description: The tax region's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpsertStockLocationAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpsertStockLocationAddress.yaml new file mode 100644 index 0000000000..b0e8d7c033 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpsertStockLocationAddress.yaml @@ -0,0 +1,39 @@ +type: object +description: The stock location's address. +x-schemaName: AdminUpsertStockLocationAddress +required: + - address_1 + - country_code +properties: + address_1: + type: string + title: address_1 + description: The address's address 1. + address_2: + type: string + title: address_2 + description: The address's address 2. + company: + type: string + title: company + description: The address's company. + country_code: + type: string + title: country_code + description: The address's country code. + city: + type: string + title: city + description: The address's city. + phone: + type: string + title: phone + description: The address's phone. + postal_code: + type: string + title: postal_code + description: The address's postal code. + province: + type: string + title: province + description: The address's province. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUserDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUserDeleteResponse.yaml index eb3c002ae6..fb9888ff23 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUserDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUserDeleteResponse.yaml @@ -19,6 +19,3 @@ properties: type: boolean title: deleted description: Whether the User was deleted. - parent: - type: object - description: The user's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCartAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCartAddress.yaml index 830384378e..0cc3faf4c1 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCartAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCartAddress.yaml @@ -1,5 +1,5 @@ type: object -description: The cart's billing address. +description: The parent's billing address. x-schemaName: BaseCartAddress required: - id diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCustomer.yaml deleted file mode 100644 index 97d46ce957..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCustomer.yaml +++ /dev/null @@ -1,3 +0,0 @@ -type: object -description: The customer's customers. -x-schemaName: BaseCustomer diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCustomerAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCustomerAddress.yaml index b5f75c39e6..906bc9231d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCustomerAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCustomerAddress.yaml @@ -1,96 +1,3 @@ type: object description: The address's addresses. x-schemaName: BaseCustomerAddress -required: - - id - - address_name - - is_default_shipping - - is_default_billing - - customer_id - - company - - first_name - - last_name - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - phone - - metadata - - created_at - - updated_at -properties: - id: - type: string - title: id - description: The address's ID. - address_name: - type: string - title: address_name - description: The address's address name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: The address's is default shipping. - is_default_billing: - type: boolean - title: is_default_billing - description: The address's is default billing. - customer_id: - type: string - title: customer_id - description: The address's customer id. - company: - type: string - title: company - description: The address's company. - first_name: - type: string - title: first_name - description: The address's first name. - last_name: - type: string - title: last_name - description: The address's last name. - address_1: - type: string - title: address_1 - description: The address's address 1. - address_2: - type: string - title: address_2 - description: The address's address 2. - city: - type: string - title: city - description: The address's city. - country_code: - type: string - title: country_code - description: The address's country code. - province: - type: string - title: province - description: The address's province. - postal_code: - type: string - title: postal_code - description: The address's postal code. - phone: - type: string - title: phone - description: The address's phone. - metadata: - type: object - description: The address's metadata. - created_at: - type: string - format: date-time - title: created_at - description: The address's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The address's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml index 4c549387e7..f1896707cd 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml @@ -1,5 +1,5 @@ type: object -description: The order's billing address. +description: The exchange's billing address. x-schemaName: BaseOrderAddress required: - id diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseRegion.yaml index c90e5373dc..778b10a689 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseRegion.yaml @@ -1,5 +1,5 @@ type: object -description: The cart's region. +description: The parent's region. x-schemaName: BaseRegion required: - id diff --git a/www/apps/api-reference/specs/store/components/schemas/CustomerGroupInCustomerFilters.yaml b/www/apps/api-reference/specs/store/components/schemas/CustomerGroupInCustomerFilters.yaml new file mode 100644 index 0000000000..fcc67cf89c --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/CustomerGroupInCustomerFilters.yaml @@ -0,0 +1,413 @@ +type: object +description: The customer's groups. +x-schemaName: CustomerGroupInCustomerFilters +required: + - id + - name + - created_at + - updated_at + - deleted_at +properties: + id: + oneOf: + - type: string + title: id + description: The group's ID. + - type: array + description: The group's ID. + items: + type: string + title: id + description: The id's ID. + name: + oneOf: + - type: string + title: name + description: The group's name. + - type: array + description: The group's name. + items: + type: string + title: name + description: The name's details. + created_at: + type: object + description: The group'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. + - 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 group'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. + - 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 group'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. + - 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`). diff --git a/www/apps/api-reference/specs/store/components/schemas/FileList.yaml b/www/apps/api-reference/specs/store/components/schemas/FileList.yaml new file mode 100644 index 0000000000..2bc70ab8fb --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/FileList.yaml @@ -0,0 +1,18 @@ +type: object +description: SUMMARY +x-schemaName: FileList +required: + - length + - item + - __@iterator@258 +properties: + length: + type: number + title: length + description: The upload's length. + item: + type: object + description: The upload's item. + __@iterator@258: + type: object + description: The upload's @iterator@258. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml index 9974725fda..73037779af 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml @@ -1,5 +1,5 @@ type: object -description: The cart's details. +description: The cart's parent. x-schemaName: StoreCart required: - id @@ -30,320 +30,320 @@ properties: id: type: string title: id - description: The cart's ID. + description: The parent's ID. region: $ref: ./BaseRegion.yaml region_id: type: string title: region_id - description: The cart's region id. + description: The parent's region id. customer_id: type: string title: customer_id - description: The cart's customer id. + description: The parent's customer id. sales_channel_id: type: string title: sales_channel_id - description: The cart's sales channel id. + description: The parent's sales channel id. email: type: string title: email - description: The cart's email. + description: The parent's email. format: email currency_code: type: string title: currency_code - description: The cart's currency code. + description: The parent's currency code. shipping_address: $ref: ./BaseCartAddress.yaml billing_address: $ref: ./BaseCartAddress.yaml items: type: array - description: The cart's items. + description: The parent's items. items: $ref: ./BaseCartLineItem.yaml shipping_methods: type: array - description: The cart's shipping methods. + description: The parent's shipping methods. items: $ref: ./BaseCartShippingMethod.yaml payment_collection: $ref: ./BasePaymentCollection.yaml metadata: type: object - description: The cart's metadata. + description: The parent's metadata. created_at: type: string format: date-time title: created_at - description: The cart's created at. + description: The parent's created at. updated_at: type: string format: date-time title: updated_at - description: The cart's updated at. + description: The parent's updated at. original_item_total: oneOf: - type: string title: original_item_total - description: The cart's original item total. + description: The parent's original item total. - type: number title: original_item_total - description: The cart's original item total. + description: The parent's original item total. - type: string title: original_item_total - description: The cart's original item total. + description: The parent's original item total. - $ref: ./IBigNumber.yaml original_item_subtotal: oneOf: - type: string title: original_item_subtotal - description: The cart's original item subtotal. + description: The parent's original item subtotal. - type: number title: original_item_subtotal - description: The cart's original item subtotal. + description: The parent's original item subtotal. - type: string title: original_item_subtotal - description: The cart's original item subtotal. + description: The parent's original item subtotal. - $ref: ./IBigNumber.yaml original_item_tax_total: oneOf: - type: string title: original_item_tax_total - description: The cart's original item tax total. + description: The parent's original item tax total. - type: number title: original_item_tax_total - description: The cart's original item tax total. + description: The parent's original item tax total. - type: string title: original_item_tax_total - description: The cart's original item tax total. + description: The parent's original item tax total. - $ref: ./IBigNumber.yaml item_total: oneOf: - type: string title: item_total - description: The cart's item total. + description: The parent's item total. - type: number title: item_total - description: The cart's item total. + description: The parent's item total. - type: string title: item_total - description: The cart's item total. + description: The parent's item total. - $ref: ./IBigNumber.yaml item_subtotal: oneOf: - type: string title: item_subtotal - description: The cart's item subtotal. + description: The parent's item subtotal. - type: number title: item_subtotal - description: The cart's item subtotal. + description: The parent's item subtotal. - type: string title: item_subtotal - description: The cart's item subtotal. + description: The parent's item subtotal. - $ref: ./IBigNumber.yaml item_tax_total: oneOf: - type: string title: item_tax_total - description: The cart's item tax total. + description: The parent's item tax total. - type: number title: item_tax_total - description: The cart's item tax total. + description: The parent's item tax total. - type: string title: item_tax_total - description: The cart's item tax total. + description: The parent's item tax total. - $ref: ./IBigNumber.yaml original_total: oneOf: - type: string title: original_total - description: The cart's original total. + description: The parent's original total. - type: number title: original_total - description: The cart's original total. + description: The parent's original total. - type: string title: original_total - description: The cart's original total. + description: The parent's original total. - $ref: ./IBigNumber.yaml original_subtotal: oneOf: - type: string title: original_subtotal - description: The cart's original subtotal. + description: The parent's original subtotal. - type: number title: original_subtotal - description: The cart's original subtotal. + description: The parent's original subtotal. - type: string title: original_subtotal - description: The cart's original subtotal. + description: The parent's original subtotal. - $ref: ./IBigNumber.yaml original_tax_total: oneOf: - type: string title: original_tax_total - description: The cart's original tax total. + description: The parent's original tax total. - type: number title: original_tax_total - description: The cart's original tax total. + description: The parent's original tax total. - type: string title: original_tax_total - description: The cart's original tax total. + description: The parent's original tax total. - $ref: ./IBigNumber.yaml total: oneOf: - type: string title: total - description: The cart's total. + description: The parent's total. - type: number title: total - description: The cart's total. + description: The parent's total. - type: string title: total - description: The cart's total. + description: The parent's total. - $ref: ./IBigNumber.yaml subtotal: oneOf: - type: string title: subtotal - description: The cart's subtotal. + description: The parent's subtotal. - type: number title: subtotal - description: The cart's subtotal. + description: The parent's subtotal. - type: string title: subtotal - description: The cart's subtotal. + description: The parent's subtotal. - $ref: ./IBigNumber.yaml tax_total: oneOf: - type: string title: tax_total - description: The cart's tax total. + description: The parent's tax total. - type: number title: tax_total - description: The cart's tax total. + description: The parent's tax total. - type: string title: tax_total - description: The cart's tax total. + description: The parent's tax total. - $ref: ./IBigNumber.yaml discount_total: oneOf: - type: string title: discount_total - description: The cart's discount total. + description: The parent's discount total. - type: number title: discount_total - description: The cart's discount total. + description: The parent's discount total. - type: string title: discount_total - description: The cart's discount total. + description: The parent's discount total. - $ref: ./IBigNumber.yaml discount_tax_total: oneOf: - type: string title: discount_tax_total - description: The cart's discount tax total. + description: The parent's discount tax total. - type: number title: discount_tax_total - description: The cart's discount tax total. + description: The parent's discount tax total. - type: string title: discount_tax_total - description: The cart's discount tax total. + description: The parent's discount tax total. - $ref: ./IBigNumber.yaml gift_card_total: oneOf: - type: string title: gift_card_total - description: The cart's gift card total. + description: The parent's gift card total. - type: number title: gift_card_total - description: The cart's gift card total. + description: The parent's gift card total. - type: string title: gift_card_total - description: The cart's gift card total. + description: The parent's gift card total. - $ref: ./IBigNumber.yaml gift_card_tax_total: oneOf: - type: string title: gift_card_tax_total - description: The cart's gift card tax total. + description: The parent's gift card tax total. - type: number title: gift_card_tax_total - description: The cart's gift card tax total. + description: The parent's gift card tax total. - type: string title: gift_card_tax_total - description: The cart's gift card tax total. + description: The parent's gift card tax total. - $ref: ./IBigNumber.yaml shipping_total: oneOf: - type: string title: shipping_total - description: The cart's shipping total. + description: The parent's shipping total. - type: number title: shipping_total - description: The cart's shipping total. + description: The parent's shipping total. - type: string title: shipping_total - description: The cart's shipping total. + description: The parent's shipping total. - $ref: ./IBigNumber.yaml shipping_subtotal: oneOf: - type: string title: shipping_subtotal - description: The cart's shipping subtotal. + description: The parent's shipping subtotal. - type: number title: shipping_subtotal - description: The cart's shipping subtotal. + description: The parent's shipping subtotal. - type: string title: shipping_subtotal - description: The cart's shipping subtotal. + description: The parent's shipping subtotal. - $ref: ./IBigNumber.yaml shipping_tax_total: oneOf: - type: string title: shipping_tax_total - description: The cart's shipping tax total. + description: The parent's shipping tax total. - type: number title: shipping_tax_total - description: The cart's shipping tax total. + description: The parent's shipping tax total. - type: string title: shipping_tax_total - description: The cart's shipping tax total. + description: The parent's shipping tax total. - $ref: ./IBigNumber.yaml original_shipping_total: oneOf: - type: string title: original_shipping_total - description: The cart's original shipping total. + description: The parent's original shipping total. - type: number title: original_shipping_total - description: The cart's original shipping total. + description: The parent's original shipping total. - type: string title: original_shipping_total - description: The cart's original shipping total. + description: The parent's original shipping total. - $ref: ./IBigNumber.yaml original_shipping_subtotal: oneOf: - type: string title: original_shipping_subtotal - description: The cart's original shipping subtotal. + description: The parent's original shipping subtotal. - type: number title: original_shipping_subtotal - description: The cart's original shipping subtotal. + description: The parent's original shipping subtotal. - type: string title: original_shipping_subtotal - description: The cart's original shipping subtotal. + description: The parent's original shipping subtotal. - $ref: ./IBigNumber.yaml original_shipping_tax_total: oneOf: - type: string title: original_shipping_tax_total - description: The cart's original shipping tax total. + description: The parent's original shipping tax total. - type: number title: original_shipping_tax_total - description: The cart's original shipping tax total. + description: The parent's original shipping tax total. - type: string title: original_shipping_tax_total - description: The cart's original shipping tax total. + description: The parent's original shipping tax total. - $ref: ./IBigNumber.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCreateCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCreateCustomer.yaml index 07e7bc885c..f8f116c0fa 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCreateCustomer.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCreateCustomer.yaml @@ -3,10 +3,6 @@ description: SUMMARY x-schemaName: StoreCreateCustomer required: - email - - company_name - - first_name - - last_name - - phone properties: email: type: string @@ -29,3 +25,6 @@ properties: type: string title: phone description: The customer's phone. + metadata: + type: object + description: The customer's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCreatePaymentCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCreatePaymentCollection.yaml new file mode 100644 index 0000000000..f0f56b1048 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCreatePaymentCollection.yaml @@ -0,0 +1,10 @@ +type: object +description: SUMMARY +required: + - cart_id +properties: + cart_id: + 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/StoreCreateReturn.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturn.yaml new file mode 100644 index 0000000000..60c6dc1fd5 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturn.yaml @@ -0,0 +1,31 @@ +type: object +description: SUMMARY +x-schemaName: StoreCreateReturn +required: + - order_id + - items + - return_shipping +properties: + order_id: + type: string + title: order_id + description: The return's order id. + items: + type: array + description: The return's items. + items: + $ref: ./StoreCreateReturnItem.yaml + return_shipping: + $ref: ./StoreCreateReturnShipping.yaml + note: + type: string + title: note + description: The return's note. + receive_now: + type: boolean + title: receive_now + description: The return's receive now. + location_id: + type: string + title: location_id + description: The return's location id. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnItem.yaml new file mode 100644 index 0000000000..839a17cf5c --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnItem.yaml @@ -0,0 +1,23 @@ +type: object +description: The item's items. +required: + - id + - quantity +properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + reason_id: + type: string + title: reason_id + description: The item's reason id. + note: + 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 new file mode 100644 index 0000000000..ad5ccf7fdc --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnShipping.yaml @@ -0,0 +1,14 @@ +type: object +description: The return's return shipping. +required: + - option_id +properties: + option_id: + type: string + title: option_id + description: The return shipping's option id. + price: + type: number + title: price + description: The return shipping's price. +x-schemaName: StoreCreateReturnShipping diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomer.yaml index bbb8caf8e9..c6626ecc9c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCustomer.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCustomer.yaml @@ -1,5 +1,5 @@ type: object -description: The customer's details. +description: The customer's parent. x-schemaName: StoreCustomer required: - id @@ -14,60 +14,60 @@ properties: id: type: string title: id - description: The customer's ID. + description: The parent's ID. email: type: string title: email - description: The customer's email. + description: The parent's email. format: email default_billing_address_id: type: string title: default_billing_address_id - description: The customer's default billing address id. + description: The parent's default billing address id. default_shipping_address_id: type: string title: default_shipping_address_id - description: The customer's default shipping address id. + description: The parent's default shipping address id. company_name: type: string title: company_name - description: The customer's company name. + description: The parent's company name. first_name: type: string title: first_name - description: The customer's first name. + description: The parent's first name. last_name: type: string title: last_name - description: The customer's last name. + description: The parent's last name. addresses: type: array - description: The customer's addresses. + description: The parent's addresses. items: $ref: ./BaseCustomerAddress.yaml phone: type: string title: phone - description: The customer's phone. + description: The parent's phone. metadata: type: object - description: The customer's metadata. + description: The parent's metadata. created_by: type: string title: created_by - description: The customer's created by. + description: The parent's created by. deleted_at: type: string format: date-time title: deleted_at - description: The customer's deleted at. + description: The parent's deleted at. created_at: type: string format: date-time title: created_at - description: The customer's created at. + description: The parent's created at. updated_at: type: string format: date-time title: updated_at - description: The customer's updated at. + description: The parent's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml index da0096fa7a..188ac9c5e5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml @@ -70,7 +70,7 @@ properties: title: currency_code description: The order's currency code. display_id: - type: string + type: number title: display_id description: The order's display id. shipping_address: diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostReturnsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostReturnsReqSchema.yaml deleted file mode 100644 index 3ab63409b6..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostReturnsReqSchema.yaml +++ /dev/null @@ -1,68 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: StorePostReturnsReqSchema -required: - - order_id - - items - - return_shipping - - note - - location_id -properties: - order_id: - type: string - title: order_id - description: The return's order id. - items: - type: array - description: The return's items. - items: - type: object - description: The item's items. - required: - - id - - quantity - - reason_id - - note - properties: - id: - type: string - title: id - description: The item's ID. - quantity: - type: number - title: quantity - description: The item's quantity. - reason_id: - type: string - title: reason_id - description: The item's reason id. - note: - type: string - title: note - description: The item's note. - return_shipping: - type: object - description: The return's return shipping. - required: - - option_id - properties: - option_id: - type: string - title: option_id - description: The return shipping's option id. - price: - type: number - title: price - description: The return shipping's price. - note: - type: string - title: note - description: The return's note. - receive_now: - type: boolean - title: receive_now - description: The return's receive now. - location_id: - type: string - title: location_id - description: The return's location id. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml index 42d6393938..7062d98f47 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml @@ -2,9 +2,9 @@ type: object description: The product's details. x-schemaName: StoreProduct required: + - length - title - status - - length - options - description - id @@ -36,6 +36,10 @@ properties: type: object type: type: object + length: + type: number + title: length + description: The product's length. title: type: string title: title @@ -48,10 +52,6 @@ properties: - proposed - published - rejected - length: - type: number - title: length - description: The product's length. options: type: array description: The product's options. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductVariantParams.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductVariantParams.yaml new file mode 100644 index 0000000000..295b3c1fdd --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductVariantParams.yaml @@ -0,0 +1,76 @@ +type: object +description: The product's variants. +x-schemaName: StoreProductVariantParams +properties: + q: + type: string + title: q + description: The variant's q. + id: + oneOf: + - type: string + title: id + description: The variant's ID. + - type: array + description: The variant's ID. + items: + type: string + title: id + description: The id's ID. + sku: + oneOf: + - type: string + title: sku + description: The variant's sku. + - type: array + description: The variant's sku. + items: + type: string + title: sku + description: The sku's details. + product_id: + oneOf: + - type: string + title: product_id + description: The variant's product id. + - type: array + description: The variant's product id. + items: + type: string + title: product_id + description: The product id's details. + options: + type: object + description: The variant's options. + limit: + type: number + title: limit + description: The variant's limit. + offset: + type: number + title: offset + description: The variant's offset. + order: + type: string + title: order + description: The variant's order. + fields: + type: string + title: fields + description: The variant'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. + 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 diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 4b03a6c1fa..7261625e58 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -10,7 +10,7 @@ servers: - url: https://api.medusajs.com tags: - name: Auth - description: > + description: | Auth API routes allow you to manage a customer's authentication. - name: Carts description: | @@ -991,28 +991,32 @@ paths: content: application/json: schema: - type: object + allOf: + - type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The cart's ID. + object: + type: string + title: object + description: The name of the deleted object. + deleted: + type: boolean + title: deleted + description: Whether the Cart was deleted. + - type: object + description: SUMMARY + properties: + parent: + $ref: '#/components/schemas/StoreCart' description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The cart's ID. - object: - type: string - title: object - description: The cart's object. - deleted: - type: boolean - title: deleted - description: The cart's deleted. - parent: - type: object - description: The cart's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -1443,6 +1447,755 @@ 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: deleted_at + in: query + description: The collection's deleted at. + required: false + schema: + type: object + description: The collection'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: title + in: query + required: false + schema: + oneOf: + - type: string + title: title + description: The collection's title. + - type: array + description: The collection's title. + items: + type: string + title: title + description: The title's details. + - name: created_at + in: query + description: The collection's created at. + required: false + schema: + type: object + description: The collection'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 collection's updated at. + required: false + schema: + type: object + description: The collection'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: handle + in: query + required: false + schema: + oneOf: + - type: string + title: handle + description: The collection's handle. + - type: array + description: The collection's handle. + items: + type: string + title: handle + description: The handle's details. + - name: q + in: query + description: The collection's q. + required: false + schema: + type: string + title: q + description: The collection's q. + - 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 x-codeSamples: - lang: Shell label: cURL @@ -1622,6 +2375,48 @@ 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: The currency's q. + required: false + schema: + type: string + title: q + description: The currency's q. + - name: code + in: query + required: false + schema: + oneOf: + - type: string + title: code + description: The currency's code. + - type: array + description: The currency's code. + items: + type: string + title: code + description: The code's details. + - 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 x-codeSamples: - lang: Shell label: cURL @@ -2658,28 +3453,32 @@ paths: content: application/json: schema: - type: object + allOf: + - type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The customer's ID. + object: + type: string + title: object + description: The name of the deleted object. + deleted: + type: boolean + title: deleted + description: Whether the Customer was deleted. + - type: object + description: SUMMARY + properties: + parent: + $ref: '#/components/schemas/StoreCustomer' description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The customer's ID. - object: - type: string - title: object - description: The customer's object. - deleted: - type: boolean - title: deleted - description: The customer's deleted. - parent: - type: object - description: The customer's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -3015,15 +3814,7 @@ paths: content: application/json: schema: - type: object - description: SUMMARY - required: - - cart_id - properties: - cart_id: - type: string - title: cart_id - description: The payment collection's cart id. + $ref: '#/components/schemas/StoreCreatePaymentCollection' x-codeSamples: - lang: Shell label: cURL @@ -3211,11 +4002,18 @@ paths: - name: region_id in: query description: The payment provider's region id. - required: true + required: false schema: - type: string - title: region_id - description: The payment provider's region id. + oneOf: + - type: string + title: region_id + description: The payment provider's region id. + - type: array + description: The payment provider's region id. + items: + type: string + title: region_id + description: The region id's details. - name: id in: query required: false @@ -3441,17 +4239,695 @@ paths: in: query description: The product category's created at. required: false - schema: {} + schema: + type: object + description: The product category'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 product category's updated at. required: false - schema: {} + schema: + type: object + description: The product category'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 product category's deleted at. required: false - schema: {} + schema: + type: object + description: The product category'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 @@ -3470,6 +4946,36 @@ paths: items: type: object title: $or + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The product category's name. + - type: array + description: The product category's name. + items: + type: string + title: name + description: The name's details. + - name: is_active + in: query + description: The product category's is active. + required: false + schema: + type: boolean + title: is_active + description: The product category's is active. + - name: is_internal + in: query + description: The product category's is internal. + required: false + schema: + type: boolean + title: is_internal + description: The product category's is internal. x-codeSamples: - lang: Shell label: cURL @@ -3656,29 +5162,6 @@ paths: type: object description: The $or's details. title: $or - - name: variants - in: query - description: The product's variants. - required: false - schema: - type: object - description: The product's variants. - properties: - options: - type: object - description: The variant's options. - required: - - value - - option_id - properties: - value: - type: string - title: value - description: The option's value. - option_id: - type: string - title: option_id - description: The option's option id. - name: q in: query description: The product's q. @@ -3754,16 +5237,16 @@ paths: description: The product's tags. required: false schema: - type: object - description: The product's tags. - properties: - id: - type: array - description: The tag's ID. + oneOf: + - type: string + title: tags + description: The product's tags. + - type: array + description: The product's tags. items: type: string - title: id - description: The id's ID. + title: tags + description: The tag's tags. - name: type_id in: query description: The product's type id. @@ -4831,6 +6314,58 @@ paths: type: boolean title: $exists description: The id's $exists. + - name: region_id + in: query + description: The product's region id. + required: false + schema: + type: string + title: region_id + description: The product's region id. + - name: currency_code + in: query + description: The product's currency code. + required: false + schema: + type: string + title: currency_code + description: The product's currency code. + - name: province + in: query + description: The product's province. + required: false + schema: + type: string + title: province + description: The product's province. + - name: sales_channel_id + in: query + required: false + schema: + oneOf: + - type: string + title: sales_channel_id + description: The product's sales channel id. + - type: array + description: The product's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + - name: category_id + in: query + required: false + schema: + oneOf: + - type: string + title: category_id + description: The product's category id. + - type: array + description: The product's category id. + items: + type: string + title: category_id + description: The category id's details. x-codeSamples: - lang: Shell label: cURL @@ -5042,6 +6577,947 @@ 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: The region's q. + required: false + schema: + type: string + title: q + description: The region's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The region's ID. + - type: array + description: The region's ID. + items: + type: string + title: id + description: The id's ID. + - type: object + description: The region'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 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: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The region's name. + - type: array + description: The region's name. + items: + type: string + title: name + description: The name's details. + - name: code + in: query + required: false + schema: + oneOf: + - type: string + title: code + description: The region's code. + - type: array + description: The region's code. + items: + type: string + title: code + description: The code's details. + - name: created_at + in: query + description: The region's created at. + required: false + schema: + type: object + description: The 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 region's updated at. + required: false + schema: + type: object + description: The 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: $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 x-codeSamples: - lang: Shell label: cURL @@ -5191,7 +7667,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StorePostReturnsReqSchema' + $ref: '#/components/schemas/StoreCreateReturn' x-codeSamples: - lang: Shell label: cURL @@ -5463,6 +7939,34 @@ 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: cart_id + in: query + description: The shipping option's cart id. + required: true + schema: + type: string + title: cart_id + description: The shipping option's cart id. + - 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 x-codeSamples: - lang: Shell label: cURL @@ -5884,7 +8388,7 @@ components: description: The claim's email. format: email display_id: - type: string + type: number title: display_id description: The claim's display id. shipping_address: @@ -6062,9 +8566,6 @@ components: type: boolean title: deleted description: Whether the Claim was deleted. - parent: - type: object - description: The claim's parent. AdminClaimListResponse: type: object description: SUMMARY @@ -6222,9 +8723,6 @@ components: type: boolean title: deleted description: Whether the Collection was deleted. - parent: - type: object - description: The collection's parent. AdminCollectionListResponse: type: object description: SUMMARY @@ -6279,6 +8777,117 @@ components: enum: - publishable - secret + AdminCreateApplicationMethod: + type: object + description: The promotion's application method. + x-schemaName: AdminCreateApplicationMethod + required: + - value + - type + - target_type + properties: + description: + type: string + title: description + description: The application method's description. + value: + type: number + title: value + description: The application method's value. + currency_code: + type: string + title: currency_code + description: The application method's currency code. + max_quantity: + type: number + title: max_quantity + description: The application method's max quantity. + type: + type: string + description: The application method's type. + enum: + - fixed + - percentage + target_type: + type: string + description: The application method's target type. + enum: + - items + - shipping_methods + - order + allocation: + type: string + description: The application method's allocation. + enum: + - each + - across + target_rules: + type: array + description: The application method's target rules. + items: + $ref: '#/components/schemas/AdminCreatePromotionRule' + buy_rules: + type: array + description: The application method's buy rules. + items: + $ref: '#/components/schemas/AdminCreatePromotionRule' + apply_to_quantity: + type: number + title: apply_to_quantity + description: The application method's apply to quantity. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The application method's buy rules min quantity. + AdminCreateCampaign: + type: object + description: The promotion's campaign. + x-schemaName: AdminCreateCampaign + properties: + name: + type: string + title: name + description: The campaign's name. + description: + type: string + title: description + description: The campaign's description. + currency: + type: string + title: currency + description: The campaign's currency. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + budget: + type: object + description: The campaign's budget. + properties: + type: + type: string + description: The budget's type. + enum: + - spend + - usage + currency_code: + type: string + title: currency_code + description: The budget's currency code. + limit: + type: number + title: limit + description: The budget's limit. AdminCreateCollection: type: object description: SUMMARY @@ -6498,6 +9107,66 @@ components: metadata: type: object description: The fulfillment's metadata. + AdminCreateInventoryItem: + type: object + description: SUMMARY + properties: + sku: + type: string + title: sku + description: The inventory item's sku. + hs_code: + type: string + title: hs_code + description: The inventory item's hs code. + weight: + type: number + title: weight + description: The inventory item's weight. + length: + type: number + title: length + description: The inventory item's length. + height: + type: number + title: height + description: The inventory item's height. + width: + type: number + title: width + description: The inventory item's width. + origin_country: + type: string + title: origin_country + description: The inventory item's origin country. + mid_code: + type: string + title: mid_code + description: The inventory item's mid code. + material: + type: string + title: material + description: The inventory item's material. + title: + type: string + title: title + description: The inventory item's title. + description: + type: string + title: description + description: The inventory item's description. + requires_shipping: + type: boolean + title: requires_shipping + description: The inventory item's requires shipping. + thumbnail: + type: string + title: thumbnail + description: The inventory item's thumbnail. + metadata: + type: object + description: The inventory item's metadata. + x-schemaName: AdminCreateInventoryItem AdminCreatePriceList: type: object description: SUMMARY @@ -6740,6 +9409,44 @@ components: metadata: type: object description: The create's metadata. + AdminCreateProductCategory: + type: object + description: SUMMARY + required: + - name + properties: + name: + type: string + title: name + description: The product category's name. + description: + type: string + title: description + description: The product category's description. + handle: + type: string + title: handle + description: The product category's handle. + is_internal: + type: boolean + title: is_internal + description: The product category's is internal. + is_active: + type: boolean + title: is_active + description: The product category's is active. + parent_category_id: + 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 AdminCreateProductOption: type: object description: SUMMARY @@ -6759,6 +9466,20 @@ components: type: string title: values description: The value's values. + AdminCreateProductTag: + type: object + description: SUMMARY + required: + - value + properties: + value: + type: string + title: value + description: The product tag's value. + metadata: + type: object + description: The product tag's metadata. + x-schemaName: AdminCreateProductTag AdminCreateProductVariant: type: object description: The create's details. @@ -6869,14 +9590,139 @@ components: rules: type: object description: The price's rules. + AdminCreatePromotionRule: + type: object + description: The rule's rules. + x-schemaName: AdminCreatePromotionRule + required: + - operator + - attribute + - values + properties: + operator: + type: string + description: The rule's operator. + enum: + - gt + - lt + - eq + - ne + - in + - lte + - gte + description: + type: string + title: description + description: The rule's description. + attribute: + type: string + title: attribute + description: The rule's attribute. + values: + oneOf: + - type: string + title: values + description: The rule's values. + - type: array + description: The rule's values. + items: + type: string + title: values + description: The value's values. + AdminCreateRefundReason: + type: object + description: SUMMARY + required: + - label + properties: + label: + type: string + title: label + description: The refund reason's label. + description: + type: string + title: description + description: The refund reason's description. + x-schemaName: AdminCreateRefundReason + AdminCreateRegion: + type: object + description: SUMMARY + required: + - name + - currency_code + properties: + name: + type: string + title: name + description: The region's name. + currency_code: + type: string + title: currency_code + description: The region's currency code. + countries: + type: array + description: The region's countries. + items: + type: string + title: countries + description: The country's countries. + automatic_taxes: + type: boolean + title: automatic_taxes + description: The region's automatic taxes. + payment_providers: + type: array + description: The region's payment providers. + items: + type: string + title: payment_providers + description: The payment provider's payment providers. + 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 + required: + - location_id + - inventory_item_id + - quantity + properties: + line_item_id: + type: string + title: line_item_id + description: The reservation's line item id. + location_id: + type: string + title: location_id + description: The reservation's location id. + inventory_item_id: + type: string + title: inventory_item_id + description: The reservation's inventory item id. + quantity: + type: number + title: quantity + description: The reservation's quantity. + description: + type: string + title: description + description: The reservation's description. + metadata: + type: object + description: The reservation's metadata. + x-schemaName: AdminCreateReservation AdminCreateSalesChannel: type: object description: SUMMARY x-schemaName: AdminCreateSalesChannel required: - name - - description - - metadata properties: name: type: string @@ -6923,68 +9769,135 @@ components: type: string title: label_url description: The label's label url. + AdminCreateShippingOption: + type: object + description: SUMMARY + required: + - name + - service_zone_id + - shipping_profile_id + - price_type + - provider_id + - type + - prices + properties: + name: + type: string + title: name + description: The shipping option's name. + service_zone_id: + type: string + title: service_zone_id + description: The shipping option's service zone id. + shipping_profile_id: + type: string + title: shipping_profile_id + description: The shipping option's shipping profile id. + data: + type: object + description: The shipping option's data. + price_type: + type: string + enum: + - calculated + - flat + provider_id: + type: string + title: provider_id + description: The shipping option's provider id. + type: + type: object + prices: + type: array + description: The shipping option's prices. + items: + oneOf: + - type: object + description: The price's prices. + required: + - currency_code + - amount + properties: + currency_code: + type: string + title: currency_code + description: The price's currency code. + amount: + type: number + title: amount + description: The price's amount. + - type: object + description: The price's prices. + required: + - region_id + - amount + properties: + region_id: + type: string + title: region_id + description: The price's region id. + amount: + type: number + title: amount + description: The price's amount. + rules: + type: array + description: The shipping option's rules. + items: + $ref: '#/components/schemas/AdminCreateShippingOptionRule' + x-schemaName: AdminCreateShippingOption + AdminCreateShippingOptionRule: + type: object + description: The rule's rules. + required: + - operator + - attribute + - value + properties: + operator: + type: string + enum: + - in + - eq + - ne + - gt + - gte + - lt + - lte + - nin + attribute: + type: string + title: attribute + description: The rule's attribute. + value: + oneOf: + - type: string + title: value + description: The rule's value. + - type: array + description: The rule's value. + items: + type: string + title: value + description: The value's details. + x-schemaName: AdminCreateShippingOptionRule AdminCreateStockLocation: type: object description: SUMMARY x-schemaName: AdminCreateStockLocation required: - name - - address_id - - metadata properties: name: type: string title: name description: The stock location's name. - address: - type: object - description: The stock location's address. - required: - - address_1 - - address_2 - - company - - city - - country_code - - phone - - postal_code - - province - properties: - address_1: - type: string - title: address_1 - description: The address's address 1. - address_2: - type: string - title: address_2 - description: The address's address 2. - company: - type: string - title: company - description: The address's company. - city: - type: string - title: city - description: The address's city. - country_code: - type: string - title: country_code - description: The address's country code. - phone: - type: string - title: phone - description: The address's phone. - postal_code: - type: string - title: postal_code - description: The address's postal code. - province: - type: string - title: province - description: The address's province. address_id: type: string title: address_id description: The stock location's address id. + address: + $ref: '#/components/schemas/AdminUpsertStockLocationAddress' metadata: type: object description: The stock location's metadata. @@ -6995,8 +9908,15 @@ components: required: - name - tax_region_id - - metadata properties: + name: + type: string + title: name + description: The tax rate's name. + tax_region_id: + type: string + title: tax_region_id + description: The tax rate's tax region id. rate: type: number title: rate @@ -7009,24 +9929,7 @@ components: type: array description: The tax rate's rules. items: - type: object - description: The rule's rules. - required: - - reference - - reference_id - properties: - reference: - type: string - title: reference - description: The rule's reference. - reference_id: - type: string - title: reference_id - description: The rule's reference id. - name: - type: string - title: name - description: The tax rate's name. + $ref: '#/components/schemas/AdminCreateTaxRateRule' is_default: type: boolean title: is_default @@ -7035,10 +9938,6 @@ components: type: boolean title: is_combinable description: The tax rate's is combinable. - tax_region_id: - type: string - title: tax_region_id - description: The tax rate's tax region id. metadata: type: object description: The tax rate's metadata. @@ -7064,9 +9963,6 @@ components: x-schemaName: AdminCreateTaxRegion required: - country_code - - province_code - - parent_id - - metadata properties: country_code: type: string @@ -7085,7 +9981,6 @@ components: description: The tax region's default tax rate. required: - name - - metadata properties: rate: type: number @@ -7201,7 +10096,7 @@ components: $ref: '#/components/schemas/AdminCurrency' AdminCustomer: type: object - description: The customer's details. + description: The order's customer. x-schemaName: AdminCustomer required: - has_account @@ -7393,40 +10288,6 @@ components: type: object description: The group's groups. x-schemaName: AdminCustomerGroup - required: - - id - - name - - customers - - metadata - - created_at - - updated_at - properties: - id: - type: string - title: id - description: The group's ID. - name: - type: string - title: name - description: The group's name. - customers: - type: array - description: The group's customers. - items: - $ref: '#/components/schemas/BaseCustomer' - metadata: - type: object - description: The group's metadata. - created_at: - type: string - format: date-time - title: created_at - description: The group's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The group's updated at. AdminCustomerGroupResponse: type: object description: SUMMARY @@ -7436,6 +10297,560 @@ components: properties: customer_group: $ref: '#/components/schemas/AdminCustomerGroup' + AdminCustomerInGroupFilters: + type: object + description: The customer group's customers. + x-schemaName: AdminCustomerInGroupFilters + properties: + 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. + 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: Join 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`). + default_billing_address_id: + oneOf: + - type: string + title: default_billing_address_id + description: The customer's default billing address id. + - type: array + description: The customer's default billing address id. + items: + type: string + title: default_billing_address_id + description: The default billing address id's details. + default_shipping_address_id: + oneOf: + - type: string + title: default_shipping_address_id + description: The customer's default shipping address id. + - type: array + description: The customer's default shipping address id. + items: + type: string + title: default_shipping_address_id + description: The default shipping address id's details. + 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. + 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. + 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. + 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. + created_at: + type: object + description: The customer'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. + - 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: Join 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`). + deleted_at: + type: object + description: The customer'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. + - 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`). AdminCustomerResponse: type: object description: SUMMARY @@ -7445,6 +10860,28 @@ components: properties: customer: $ref: '#/components/schemas/AdminCustomer' + AdminDeletePaymentCollectionResponse: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The payment collection's ID. + object: + type: string + title: object + description: The name of the deleted object. + default: payment-collection + deleted: + type: boolean + title: deleted + description: Whether the payment collection was deleted. + x-schemaName: AdminDeletePaymentCollectionResponse AdminDraftOrderResponse: type: object description: SUMMARY @@ -7552,7 +10989,7 @@ components: description: The exchange's email. format: email display_id: - type: string + type: number title: display_id description: The exchange's display id. shipping_address: @@ -7708,6 +11145,28 @@ components: type: number title: original_shipping_tax_total description: The exchange's original shipping tax total. + AdminExchangeDeleteResponse: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The exchange's ID. + object: + type: string + title: object + description: The name of the deleted object. + default: exchange + deleted: + type: boolean + title: deleted + description: Whether the exchange was deleted. + x-schemaName: AdminExchangeDeleteResponse AdminExchangeOrderResponse: type: object description: SUMMARY @@ -8153,8 +11612,42 @@ components: $ref: '#/components/schemas/AdminFulfillment' AdminFulfillmentSet: type: object - description: The fulfillment set's details. - x-schemaName: AdminFulfillmentSet + description: The fulfillment set that the service zone belongs to. + properties: + id: + type: string + title: id + description: The parent's ID. + name: + type: string + title: name + description: The parent's name. + type: + type: string + title: type + description: The parent's type. + location: + $ref: '#/components/schemas/AdminStockLocation' + service_zones: + type: array + description: The parent's service zones. + items: + $ref: '#/components/schemas/AdminServiceZone' + created_at: + type: string + format: date-time + title: created_at + description: The parent's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The parent's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The parent's deleted at. required: - id - name @@ -8164,41 +11657,7 @@ components: - created_at - updated_at - deleted_at - properties: - id: - type: string - title: id - description: The fulfillment set's ID. - name: - type: string - title: name - description: The fulfillment set's name. - type: - type: string - title: type - description: The fulfillment set's type. - location: - $ref: '#/components/schemas/AdminStockLocation' - service_zones: - type: array - description: The fulfillment set's service zones. - items: - $ref: '#/components/schemas/AdminServiceZone' - created_at: - type: string - format: date-time - title: created_at - description: The fulfillment set's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The fulfillment set's updated at. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The fulfillment set's deleted at. + x-schemaName: AdminFulfillmentSet AdminFulfillmentSetDeleteResponse: type: object description: SUMMARY @@ -8221,9 +11680,6 @@ components: type: boolean title: deleted description: Whether the Fulfillment Set was deleted. - parent: - type: object - description: The fulfillment set's parent. AdminFulfillmentSetResponse: type: object description: SUMMARY @@ -8237,15 +11693,6 @@ components: type: object description: The geo zone's geo zones. x-schemaName: AdminGeoZone - AdminGetUploadParams: - type: object - description: SUMMARY - x-schemaName: AdminGetUploadParams - properties: - fields: - type: string - title: fields - description: The upload's fields. AdminImportProductRequest: type: object description: SUMMARY @@ -8349,6 +11796,11 @@ components: metadata: type: object description: The inventory item's metadata. + location_levels: + type: array + description: The inventory item's location levels. + items: + $ref: '#/components/schemas/AdminInventoryLevel' AdminInventoryItemResponse: type: object description: SUMMARY @@ -8358,6 +11810,83 @@ components: properties: inventory_item: $ref: '#/components/schemas/AdminInventoryItem' + AdminInventoryLevel: + type: object + description: The location level's location levels. + x-schemaName: AdminInventoryLevel + required: + - id + - created_at + - updated_at + - deleted_at + - inventory_item_id + - location_id + - stocked_quantity + - raw_stocked_quantity + - reserved_quantity + - raw_reserved_quantity + - incoming_quantity + - raw_incoming_quantity + - metadata + - available_quantity + properties: + id: + type: string + title: id + description: The location level's ID. + created_at: + type: string + format: date-time + title: created_at + description: The location level's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The location level's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The location level's deleted at. + inventory_item_id: + type: string + title: inventory_item_id + description: The location level's inventory item id. + location_id: + type: string + title: location_id + description: The location level's location id. + stocked_quantity: + type: number + title: stocked_quantity + description: The location level's stocked quantity. + raw_stocked_quantity: + type: object + description: The location level's raw stocked quantity. + reserved_quantity: + type: number + title: reserved_quantity + description: The location level's reserved quantity. + raw_reserved_quantity: + type: object + description: The location level's raw reserved quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The location level's incoming quantity. + raw_incoming_quantity: + type: object + description: The location level's raw incoming quantity. + metadata: + type: object + description: The location level's metadata. + inventory_item: + type: object + available_quantity: + type: number + title: available_quantity + description: The location level's available quantity. AdminInvite: type: object description: The invite's details. @@ -8566,6 +12095,14 @@ components: description: The order's fulfillments. items: $ref: '#/components/schemas/BaseOrderFulfillment' + sales_channel: + $ref: '#/components/schemas/AdminSalesChannel' + customer: + $ref: '#/components/schemas/AdminCustomer' + shipping_address: + $ref: '#/components/schemas/AdminOrderAddress' + billing_address: + $ref: '#/components/schemas/AdminOrderAddress' id: type: string title: id @@ -8596,13 +12133,9 @@ components: title: currency_code description: The order's currency code. display_id: - type: string + type: number title: display_id description: The order's display id. - shipping_address: - $ref: '#/components/schemas/BaseOrderAddress' - billing_address: - $ref: '#/components/schemas/BaseOrderAddress' items: type: array description: The order's items. @@ -8747,6 +12280,79 @@ components: type: number title: original_shipping_tax_total description: The order's original shipping tax total. + AdminOrderAddress: + type: object + description: The order's billing address. + x-schemaName: AdminOrderAddress + required: + - id + - metadata + - created_at + - updated_at + properties: + country: + $ref: '#/components/schemas/AdminRegionCountry' + id: + type: string + title: id + description: The billing address's ID. + customer_id: + type: string + title: customer_id + description: The billing address's customer id. + first_name: + type: string + title: first_name + description: The billing address's first name. + last_name: + type: string + title: last_name + description: The billing address's last name. + phone: + type: string + title: phone + description: The billing address's phone. + company: + type: string + title: company + description: The billing address's company. + address_1: + type: string + title: address_1 + description: The billing address's address 1. + address_2: + type: string + title: address_2 + description: The billing address's address 2. + city: + type: string + title: city + description: The billing address's city. + country_code: + type: string + title: country_code + description: The billing address's country code. + province: + type: string + title: province + description: The billing address's province. + postal_code: + type: string + title: postal_code + description: The billing address's postal code. + metadata: + type: object + description: The billing address's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The billing address's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The billing address's updated at. AdminOrderChangesResponse: type: object description: SUMMARY @@ -9271,13 +12877,13 @@ components: description: The order preview's email. format: email display_id: - type: string + type: number title: display_id description: The order preview's display id. shipping_address: - $ref: '#/components/schemas/BaseOrderAddress' + $ref: '#/components/schemas/AdminOrderAddress' billing_address: - $ref: '#/components/schemas/BaseOrderAddress' + $ref: '#/components/schemas/AdminOrderAddress' payment_collections: type: array description: The order preview's payment collections. @@ -9422,6 +13028,10 @@ components: type: number title: original_shipping_tax_total description: The order preview's original shipping tax total. + customer: + $ref: '#/components/schemas/AdminCustomer' + sales_channel: + $ref: '#/components/schemas/AdminSalesChannel' AdminOrderPreviewResponse: type: object description: SUMMARY @@ -10657,9 +14267,6 @@ components: type: boolean title: deleted description: Whether the Price List was deleted. - parent: - type: object - description: The price list's parent. AdminPriceListListResponse: type: object description: SUMMARY @@ -10834,9 +14441,6 @@ components: type: boolean title: deleted description: Whether the Price Preference was deleted. - parent: - type: object - description: The price preference's parent. AdminPricePreferenceListResponse: type: object description: SUMMARY @@ -10879,9 +14483,9 @@ components: x-schemaName: AdminProduct required: - type + - length - title - status - - length - options - description - id @@ -10929,6 +14533,10 @@ components: description: The parent's tags. items: $ref: '#/components/schemas/AdminProductTag' + length: + type: number + title: length + description: The parent's length. title: type: string title: title @@ -10941,10 +14549,6 @@ components: - proposed - published - rejected - length: - type: number - title: length - description: The parent's length. options: type: array description: The parent's options. @@ -11144,9 +14748,6 @@ components: type: boolean title: deleted description: Whether the Product Category was deleted. - parent: - type: object - description: The product category's parent. AdminProductCategoryListResponse: type: object description: SUMMARY @@ -11205,9 +14806,6 @@ components: type: boolean title: deleted description: Whether the Product was deleted. - parent: - type: object - description: The product's parent. AdminProductOption: type: object description: The product's product option. @@ -11270,7 +14868,6 @@ components: type: string title: object description: The name of the deleted object. - default: product_option deleted: type: boolean title: deleted @@ -11353,9 +14950,6 @@ components: type: boolean title: deleted description: Whether the Product Tag was deleted. - parent: - type: object - description: The product tag's parent. AdminProductTagListResponse: type: object description: SUMMARY @@ -11450,9 +15044,6 @@ components: type: boolean title: deleted description: Whether the Product Type was deleted. - parent: - type: object - description: The product type's parent. AdminProductTypeListResponse: type: object description: SUMMARY @@ -11637,7 +15228,6 @@ components: type: string title: object description: The name of the deleted object. - default: variant deleted: type: boolean title: deleted @@ -11822,31 +15412,359 @@ components: type: string title: id description: The id's ID. - sku: - oneOf: - - type: string - title: sku - description: The variant's sku. - - type: array - description: The variant's sku. - items: - type: string - title: sku - description: The sku's details. - product_id: - oneOf: - - type: string - title: product_id - description: The variant's product id. - - type: array - description: The variant's product id. - items: - type: string - title: product_id - description: The product id's details. - options: + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + allow_backorder: + type: boolean + title: allow_backorder + description: The variant's allow backorder. + created_at: type: object - description: The variant's options. + description: The variant'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. + - 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 variant'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. + - 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 variant'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. + - 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 @@ -11865,13 +15783,13 @@ components: description: The variant's fields. $and: type: array - description: The variant'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 variant'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 @@ -12051,6 +15969,10 @@ components: format: date-time title: updated_at description: The region's updated at. + AdminRegionCountry: + type: object + description: The billing address's country. + x-schemaName: AdminRegionCountry AdminRegionResponse: type: object description: SUMMARY @@ -12087,7 +16009,7 @@ components: title: location_id description: The reservation's location id. quantity: - type: string + type: number title: quantity description: The reservation's quantity. external_id: @@ -12307,6 +16229,28 @@ components: format: date-time title: updated_at description: The return reason's updated at. + AdminReturnReasonDeleteResponse: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The return reason's ID. + object: + type: string + title: object + description: The name of the deleted object. + default: return_reason + deleted: + type: boolean + title: deleted + description: Whether the return reason was deleted. + x-schemaName: AdminReturnReasonDeleteResponse AdminReturnReasonListResponse: type: object description: SUMMARY @@ -12426,7 +16370,7 @@ components: description: The value's label. AdminSalesChannel: type: object - description: The sales channel's sales channels. + description: The order's sales channel. x-schemaName: AdminSalesChannel required: - id @@ -12494,9 +16438,6 @@ components: type: boolean title: deleted description: Whether the Sales Channel was deleted. - parent: - type: object - description: The sales channel's parent. AdminSalesChannelResponse: type: object description: SUMMARY @@ -12560,6 +16501,30 @@ components: format: date-time title: deleted_at description: The service zone's deleted at. + AdminServiceZoneDeleteResponse: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The service zone'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. + parent: + $ref: '#/components/schemas/AdminFulfillmentSet' + x-schemaName: AdminServiceZoneDeleteResponse AdminServiceZoneResponse: type: object description: SUMMARY @@ -12595,9 +16560,6 @@ components: type: boolean title: deleted description: Whether the Shipping Option was deleted. - parent: - type: object - description: The shipping option's parent. AdminShippingOptionResponse: type: object description: SUMMARY @@ -12689,9 +16651,6 @@ components: type: boolean title: deleted description: Whether the Shipping Profile was deleted. - parent: - type: object - description: The shipping profile's parent. AdminShippingProfileResponse: type: object description: SUMMARY @@ -12703,7 +16662,7 @@ components: $ref: '#/components/schemas/AdminShippingProfile' AdminStockLocation: type: object - description: The fulfillment set's location. + description: The parent's location. x-schemaName: AdminStockLocation required: - id @@ -12765,9 +16724,6 @@ components: type: boolean title: deleted description: Whether the Stock Location was deleted. - parent: - type: object - description: The stock location's parent. AdminStockLocationListResponse: type: object description: SUMMARY @@ -12942,7 +16898,7 @@ components: $ref: '#/components/schemas/AdminStore' AdminTaxRate: type: object - description: The tax rate's details. + description: The tax rate's parent. x-schemaName: AdminTaxRate required: - id @@ -12963,58 +16919,58 @@ components: id: type: string title: id - description: The tax rate's ID. + description: The parent's ID. rate: type: number title: rate - description: The tax rate's rate. + description: The parent's rate. code: type: string title: code - description: The tax rate's code. + description: The parent's code. name: type: string title: name - description: The tax rate's name. + description: The parent's name. metadata: type: object - description: The tax rate's metadata. + description: The parent's metadata. tax_region_id: type: string title: tax_region_id - description: The tax rate's tax region id. + description: The parent's tax region id. is_combinable: type: boolean title: is_combinable - description: The tax rate's is combinable. + description: The parent's is combinable. is_default: type: boolean title: is_default - description: The tax rate's is default. + description: The parent's is default. created_at: type: string format: date-time title: created_at - description: The tax rate's created at. + description: The parent's created at. updated_at: type: string format: date-time title: updated_at - description: The tax rate's updated at. + description: The parent's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The tax rate's deleted at. + description: The parent's deleted at. created_by: type: string title: created_by - description: The tax rate's created by. + description: The parent's created by. tax_region: $ref: '#/components/schemas/AdminTaxRegion' rules: type: array - description: The tax rate's rules. + description: The parent's rules. items: $ref: '#/components/schemas/AdminTaxRateRule' AdminTaxRateDeleteResponse: @@ -13039,9 +16995,6 @@ components: type: boolean title: deleted description: Whether the Tax Rate was deleted. - parent: - type: object - description: The tax rate's parent. AdminTaxRateResponse: type: object description: SUMMARY @@ -13069,7 +17022,7 @@ components: description: The rule's reference id. AdminTaxRegion: type: object - description: The tax rate's tax region. + description: The parent's tax region. x-schemaName: AdminTaxRegion required: - id @@ -13187,9 +17140,6 @@ components: type: boolean title: deleted description: Whether the Tax Region was deleted. - parent: - type: object - description: The tax region's parent. AdminTaxRegionResponse: type: object description: SUMMARY @@ -13920,6 +17870,46 @@ components: type: number title: required_quantity description: The product's required quantity. + AdminUpsertStockLocationAddress: + type: object + description: The stock location's address. + x-schemaName: AdminUpsertStockLocationAddress + required: + - address_1 + - country_code + properties: + address_1: + type: string + title: address_1 + description: The address's address 1. + address_2: + type: string + title: address_2 + description: The address's address 2. + company: + type: string + title: company + description: The address's company. + country_code: + type: string + title: country_code + description: The address's country code. + city: + type: string + title: city + description: The address's city. + phone: + type: string + title: phone + description: The address's phone. + postal_code: + type: string + title: postal_code + description: The address's postal code. + province: + type: string + title: province + description: The address's province. AdminUser: type: object description: The user's details. @@ -13996,9 +17986,6 @@ components: type: boolean title: deleted description: Whether the User was deleted. - parent: - type: object - description: The user's parent. AdminUserListResponse: type: object description: SUMMARY @@ -14331,7 +18318,7 @@ components: x-schemaName: BaseCart BaseCartAddress: type: object - description: The cart's billing address. + description: The parent's billing address. x-schemaName: BaseCartAddress required: - id @@ -14950,107 +18937,10 @@ components: type: object description: The product's collection. x-schemaName: BaseCollection - BaseCustomer: - type: object - description: The customer's customers. - x-schemaName: BaseCustomer BaseCustomerAddress: type: object description: The address's addresses. x-schemaName: BaseCustomerAddress - required: - - id - - address_name - - is_default_shipping - - is_default_billing - - customer_id - - company - - first_name - - last_name - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - phone - - metadata - - created_at - - updated_at - properties: - id: - type: string - title: id - description: The address's ID. - address_name: - type: string - title: address_name - description: The address's address name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: The address's is default shipping. - is_default_billing: - type: boolean - title: is_default_billing - description: The address's is default billing. - customer_id: - type: string - title: customer_id - description: The address's customer id. - company: - type: string - title: company - description: The address's company. - first_name: - type: string - title: first_name - description: The address's first name. - last_name: - type: string - title: last_name - description: The address's last name. - address_1: - type: string - title: address_1 - description: The address's address 1. - address_2: - type: string - title: address_2 - description: The address's address 2. - city: - type: string - title: city - description: The address's city. - country_code: - type: string - title: country_code - description: The address's country code. - province: - type: string - title: province - description: The address's province. - postal_code: - type: string - title: postal_code - description: The address's postal code. - phone: - type: string - title: phone - description: The address's phone. - metadata: - type: object - description: The address's metadata. - created_at: - type: string - format: date-time - title: created_at - description: The address's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The address's updated at. BaseExchangeItem: type: object description: The additional item's additional items. @@ -15127,7 +19017,7 @@ components: x-schemaName: BaseOrder BaseOrderAddress: type: object - description: The order's billing address. + description: The exchange's billing address. x-schemaName: BaseOrderAddress required: - id @@ -16370,7 +20260,7 @@ components: x-schemaName: BaseRefund BaseRegion: type: object - description: The cart's region. + description: The parent's region. x-schemaName: BaseRegion required: - id @@ -16812,6 +20702,384 @@ components: metadata: type: object description: The return reason's metadata. + CustomerGroupInCustomerFilters: + type: object + description: The customer's groups. + x-schemaName: CustomerGroupInCustomerFilters + required: + - id + - name + - created_at + - updated_at + - deleted_at + properties: + id: + oneOf: + - type: string + title: id + description: The group's ID. + - type: array + description: The group's ID. + items: + type: string + title: id + description: The id's ID. + name: + oneOf: + - type: string + title: name + description: The group's name. + - type: array + description: The group's name. + items: + type: string + title: name + description: The name's details. + created_at: + type: object + description: The group'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. + - 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 group'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. + - 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 group'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. + - 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`). Error: title: Response Error type: object @@ -16892,6 +21160,25 @@ components: text: type: object description: The file's text. + FileList: + type: object + description: SUMMARY + x-schemaName: FileList + required: + - length + - item + - __@iterator@258 + properties: + length: + type: number + title: length + description: The upload's length. + item: + type: object + description: The upload's item. + __@iterator@258: + type: object + description: The upload's @iterator@258. IBigNumber: type: object description: The shipping method's discount tax total. @@ -18904,7 +23191,7 @@ components: description: The cart's fields. StoreCart: type: object - description: The cart's details. + description: The cart's parent. x-schemaName: StoreCart required: - id @@ -18935,322 +23222,322 @@ components: id: type: string title: id - description: The cart's ID. + description: The parent's ID. region: $ref: '#/components/schemas/BaseRegion' region_id: type: string title: region_id - description: The cart's region id. + description: The parent's region id. customer_id: type: string title: customer_id - description: The cart's customer id. + description: The parent's customer id. sales_channel_id: type: string title: sales_channel_id - description: The cart's sales channel id. + description: The parent's sales channel id. email: type: string title: email - description: The cart's email. + description: The parent's email. format: email currency_code: type: string title: currency_code - description: The cart's currency code. + description: The parent's currency code. shipping_address: $ref: '#/components/schemas/BaseCartAddress' billing_address: $ref: '#/components/schemas/BaseCartAddress' items: type: array - description: The cart's items. + description: The parent's items. items: $ref: '#/components/schemas/BaseCartLineItem' shipping_methods: type: array - description: The cart's shipping methods. + description: The parent's shipping methods. items: $ref: '#/components/schemas/BaseCartShippingMethod' payment_collection: $ref: '#/components/schemas/BasePaymentCollection' metadata: type: object - description: The cart's metadata. + description: The parent's metadata. created_at: type: string format: date-time title: created_at - description: The cart's created at. + description: The parent's created at. updated_at: type: string format: date-time title: updated_at - description: The cart's updated at. + description: The parent's updated at. original_item_total: oneOf: - type: string title: original_item_total - description: The cart's original item total. + description: The parent's original item total. - type: number title: original_item_total - description: The cart's original item total. + description: The parent's original item total. - type: string title: original_item_total - description: The cart's original item total. + description: The parent's original item total. - $ref: '#/components/schemas/IBigNumber' original_item_subtotal: oneOf: - type: string title: original_item_subtotal - description: The cart's original item subtotal. + description: The parent's original item subtotal. - type: number title: original_item_subtotal - description: The cart's original item subtotal. + description: The parent's original item subtotal. - type: string title: original_item_subtotal - description: The cart's original item subtotal. + description: The parent's original item subtotal. - $ref: '#/components/schemas/IBigNumber' original_item_tax_total: oneOf: - type: string title: original_item_tax_total - description: The cart's original item tax total. + description: The parent's original item tax total. - type: number title: original_item_tax_total - description: The cart's original item tax total. + description: The parent's original item tax total. - type: string title: original_item_tax_total - description: The cart's original item tax total. + description: The parent's original item tax total. - $ref: '#/components/schemas/IBigNumber' item_total: oneOf: - type: string title: item_total - description: The cart's item total. + description: The parent's item total. - type: number title: item_total - description: The cart's item total. + description: The parent's item total. - type: string title: item_total - description: The cart's item total. + description: The parent's item total. - $ref: '#/components/schemas/IBigNumber' item_subtotal: oneOf: - type: string title: item_subtotal - description: The cart's item subtotal. + description: The parent's item subtotal. - type: number title: item_subtotal - description: The cart's item subtotal. + description: The parent's item subtotal. - type: string title: item_subtotal - description: The cart's item subtotal. + description: The parent's item subtotal. - $ref: '#/components/schemas/IBigNumber' item_tax_total: oneOf: - type: string title: item_tax_total - description: The cart's item tax total. + description: The parent's item tax total. - type: number title: item_tax_total - description: The cart's item tax total. + description: The parent's item tax total. - type: string title: item_tax_total - description: The cart's item tax total. + description: The parent's item tax total. - $ref: '#/components/schemas/IBigNumber' original_total: oneOf: - type: string title: original_total - description: The cart's original total. + description: The parent's original total. - type: number title: original_total - description: The cart's original total. + description: The parent's original total. - type: string title: original_total - description: The cart's original total. + description: The parent's original total. - $ref: '#/components/schemas/IBigNumber' original_subtotal: oneOf: - type: string title: original_subtotal - description: The cart's original subtotal. + description: The parent's original subtotal. - type: number title: original_subtotal - description: The cart's original subtotal. + description: The parent's original subtotal. - type: string title: original_subtotal - description: The cart's original subtotal. + description: The parent's original subtotal. - $ref: '#/components/schemas/IBigNumber' original_tax_total: oneOf: - type: string title: original_tax_total - description: The cart's original tax total. + description: The parent's original tax total. - type: number title: original_tax_total - description: The cart's original tax total. + description: The parent's original tax total. - type: string title: original_tax_total - description: The cart's original tax total. + description: The parent's original tax total. - $ref: '#/components/schemas/IBigNumber' total: oneOf: - type: string title: total - description: The cart's total. + description: The parent's total. - type: number title: total - description: The cart's total. + description: The parent's total. - type: string title: total - description: The cart's total. + description: The parent's total. - $ref: '#/components/schemas/IBigNumber' subtotal: oneOf: - type: string title: subtotal - description: The cart's subtotal. + description: The parent's subtotal. - type: number title: subtotal - description: The cart's subtotal. + description: The parent's subtotal. - type: string title: subtotal - description: The cart's subtotal. + description: The parent's subtotal. - $ref: '#/components/schemas/IBigNumber' tax_total: oneOf: - type: string title: tax_total - description: The cart's tax total. + description: The parent's tax total. - type: number title: tax_total - description: The cart's tax total. + description: The parent's tax total. - type: string title: tax_total - description: The cart's tax total. + description: The parent's tax total. - $ref: '#/components/schemas/IBigNumber' discount_total: oneOf: - type: string title: discount_total - description: The cart's discount total. + description: The parent's discount total. - type: number title: discount_total - description: The cart's discount total. + description: The parent's discount total. - type: string title: discount_total - description: The cart's discount total. + description: The parent's discount total. - $ref: '#/components/schemas/IBigNumber' discount_tax_total: oneOf: - type: string title: discount_tax_total - description: The cart's discount tax total. + description: The parent's discount tax total. - type: number title: discount_tax_total - description: The cart's discount tax total. + description: The parent's discount tax total. - type: string title: discount_tax_total - description: The cart's discount tax total. + description: The parent's discount tax total. - $ref: '#/components/schemas/IBigNumber' gift_card_total: oneOf: - type: string title: gift_card_total - description: The cart's gift card total. + description: The parent's gift card total. - type: number title: gift_card_total - description: The cart's gift card total. + description: The parent's gift card total. - type: string title: gift_card_total - description: The cart's gift card total. + description: The parent's gift card total. - $ref: '#/components/schemas/IBigNumber' gift_card_tax_total: oneOf: - type: string title: gift_card_tax_total - description: The cart's gift card tax total. + description: The parent's gift card tax total. - type: number title: gift_card_tax_total - description: The cart's gift card tax total. + description: The parent's gift card tax total. - type: string title: gift_card_tax_total - description: The cart's gift card tax total. + description: The parent's gift card tax total. - $ref: '#/components/schemas/IBigNumber' shipping_total: oneOf: - type: string title: shipping_total - description: The cart's shipping total. + description: The parent's shipping total. - type: number title: shipping_total - description: The cart's shipping total. + description: The parent's shipping total. - type: string title: shipping_total - description: The cart's shipping total. + description: The parent's shipping total. - $ref: '#/components/schemas/IBigNumber' shipping_subtotal: oneOf: - type: string title: shipping_subtotal - description: The cart's shipping subtotal. + description: The parent's shipping subtotal. - type: number title: shipping_subtotal - description: The cart's shipping subtotal. + description: The parent's shipping subtotal. - type: string title: shipping_subtotal - description: The cart's shipping subtotal. + description: The parent's shipping subtotal. - $ref: '#/components/schemas/IBigNumber' shipping_tax_total: oneOf: - type: string title: shipping_tax_total - description: The cart's shipping tax total. + description: The parent's shipping tax total. - type: number title: shipping_tax_total - description: The cart's shipping tax total. + description: The parent's shipping tax total. - type: string title: shipping_tax_total - description: The cart's shipping tax total. + description: The parent's shipping tax total. - $ref: '#/components/schemas/IBigNumber' original_shipping_total: oneOf: - type: string title: original_shipping_total - description: The cart's original shipping total. + description: The parent's original shipping total. - type: number title: original_shipping_total - description: The cart's original shipping total. + description: The parent's original shipping total. - type: string title: original_shipping_total - description: The cart's original shipping total. + description: The parent's original shipping total. - $ref: '#/components/schemas/IBigNumber' original_shipping_subtotal: oneOf: - type: string title: original_shipping_subtotal - description: The cart's original shipping subtotal. + description: The parent's original shipping subtotal. - type: number title: original_shipping_subtotal - description: The cart's original shipping subtotal. + description: The parent's original shipping subtotal. - type: string title: original_shipping_subtotal - description: The cart's original shipping subtotal. + description: The parent's original shipping subtotal. - $ref: '#/components/schemas/IBigNumber' original_shipping_tax_total: oneOf: - type: string title: original_shipping_tax_total - description: The cart's original shipping tax total. + description: The parent's original shipping tax total. - type: number title: original_shipping_tax_total - description: The cart's original shipping tax total. + description: The parent's original shipping tax total. - type: string title: original_shipping_tax_total - description: The cart's original shipping tax total. + description: The parent's original shipping tax total. - $ref: '#/components/schemas/IBigNumber' StoreCartAddress: type: object @@ -19709,10 +23996,6 @@ components: x-schemaName: StoreCreateCustomer required: - email - - company_name - - first_name - - last_name - - phone properties: email: type: string @@ -19735,6 +24018,91 @@ components: type: string title: phone description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + StoreCreatePaymentCollection: + type: object + description: SUMMARY + required: + - cart_id + properties: + cart_id: + type: string + title: cart_id + description: The payment collection's cart id. + x-schemaName: StoreCreatePaymentCollection + StoreCreateReturn: + type: object + description: SUMMARY + x-schemaName: StoreCreateReturn + required: + - order_id + - items + - return_shipping + properties: + order_id: + type: string + title: order_id + description: The return's order id. + items: + type: array + description: The return's items. + items: + $ref: '#/components/schemas/StoreCreateReturnItem' + return_shipping: + $ref: '#/components/schemas/StoreCreateReturnShipping' + note: + type: string + title: note + description: The return's note. + receive_now: + type: boolean + title: receive_now + description: The return's receive now. + location_id: + type: string + title: location_id + description: The return's location id. + StoreCreateReturnItem: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + reason_id: + type: string + title: reason_id + description: The item's reason id. + note: + type: string + title: note + description: The item's note. + x-schemaName: StoreCreateReturnItem + StoreCreateReturnShipping: + type: object + description: The return's return shipping. + required: + - option_id + properties: + option_id: + type: string + title: option_id + description: The return shipping's option id. + price: + type: number + title: price + description: The return shipping's price. + x-schemaName: StoreCreateReturnShipping StoreCurrency: type: object description: The currency's details. @@ -19843,7 +24211,7 @@ components: $ref: '#/components/schemas/StoreCurrency' StoreCustomer: type: object - description: The customer's details. + description: The customer's parent. x-schemaName: StoreCustomer required: - id @@ -19858,63 +24226,63 @@ components: id: type: string title: id - description: The customer's ID. + description: The parent's ID. email: type: string title: email - description: The customer's email. + description: The parent's email. format: email default_billing_address_id: type: string title: default_billing_address_id - description: The customer's default billing address id. + description: The parent's default billing address id. default_shipping_address_id: type: string title: default_shipping_address_id - description: The customer's default shipping address id. + description: The parent's default shipping address id. company_name: type: string title: company_name - description: The customer's company name. + description: The parent's company name. first_name: type: string title: first_name - description: The customer's first name. + description: The parent's first name. last_name: type: string title: last_name - description: The customer's last name. + description: The parent's last name. addresses: type: array - description: The customer's addresses. + description: The parent's addresses. items: $ref: '#/components/schemas/BaseCustomerAddress' phone: type: string title: phone - description: The customer's phone. + description: The parent's phone. metadata: type: object - description: The customer's metadata. + description: The parent's metadata. created_by: type: string title: created_by - description: The customer's created by. + description: The parent's created by. deleted_at: type: string format: date-time title: deleted_at - description: The customer's deleted at. + description: The parent's deleted at. created_at: type: string format: date-time title: created_at - description: The customer's created at. + description: The parent's created at. updated_at: type: string format: date-time title: updated_at - description: The customer's updated at. + description: The parent's updated at. StoreCustomerAddress: type: object description: The customer's address. @@ -20130,7 +24498,7 @@ components: title: currency_code description: The order's currency code. display_id: - type: string + type: number title: display_id description: The order's display id. shipping_address: @@ -20438,83 +24806,14 @@ components: type: string title: id description: The payment provider's ID. - StorePostReturnsReqSchema: - type: object - description: SUMMARY - x-schemaName: StorePostReturnsReqSchema - required: - - order_id - - items - - return_shipping - - note - - location_id - properties: - order_id: - type: string - title: order_id - description: The return's order id. - items: - type: array - description: The return's items. - items: - type: object - description: The item's items. - required: - - id - - quantity - - reason_id - - note - properties: - id: - type: string - title: id - description: The item's ID. - quantity: - type: number - title: quantity - description: The item's quantity. - reason_id: - type: string - title: reason_id - description: The item's reason id. - note: - type: string - title: note - description: The item's note. - return_shipping: - type: object - description: The return's return shipping. - required: - - option_id - properties: - option_id: - type: string - title: option_id - description: The return shipping's option id. - price: - type: number - title: price - description: The return shipping's price. - note: - type: string - title: note - description: The return's note. - receive_now: - type: boolean - title: receive_now - description: The return's receive now. - location_id: - type: string - title: location_id - description: The return's location id. StoreProduct: type: object description: The product's details. x-schemaName: StoreProduct required: + - length - title - status - - length - options - description - id @@ -20546,6 +24845,10 @@ components: type: object type: type: object + length: + type: number + title: length + description: The product's length. title: type: string title: title @@ -20558,10 +24861,6 @@ components: - proposed - published - rejected - length: - type: number - title: length - description: The product's length. options: type: array description: The product's options. @@ -20796,6 +25095,79 @@ components: properties: product: $ref: '#/components/schemas/StoreProduct' + StoreProductVariantParams: + type: object + description: The product's variants. + x-schemaName: StoreProductVariantParams + properties: + q: + type: string + title: q + description: The variant's q. + id: + oneOf: + - type: string + title: id + description: The variant's ID. + - type: array + description: The variant's ID. + items: + type: string + title: id + description: The id's ID. + sku: + oneOf: + - type: string + title: sku + description: The variant's sku. + - type: array + description: The variant's sku. + items: + type: string + title: sku + description: The sku's details. + product_id: + oneOf: + - type: string + title: product_id + description: The variant's product id. + - type: array + description: The variant's product id. + items: + type: string + title: product_id + description: The product id's details. + options: + type: object + description: The variant's options. + limit: + type: number + title: limit + description: The variant's limit. + offset: + type: number + title: offset + description: The variant's offset. + order: + type: string + title: order + description: The variant's order. + fields: + type: string + title: fields + description: The variant'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. + 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 StoreRegion: type: object description: The region's details. diff --git a/www/apps/api-reference/specs/store/openapi.yaml b/www/apps/api-reference/specs/store/openapi.yaml index 5d62613d74..1dcec38829 100644 --- a/www/apps/api-reference/specs/store/openapi.yaml +++ b/www/apps/api-reference/specs/store/openapi.yaml @@ -10,7 +10,7 @@ servers: - url: https://api.medusajs.com tags: - name: Auth - description: > + description: | Auth API routes allow you to manage a customer's authentication. - name: Carts description: > diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml index 4f91c8e757..efef7e35e1 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml @@ -191,28 +191,32 @@ delete: content: application/json: schema: - type: object + allOf: + - type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The cart's ID. + object: + type: string + title: object + description: The name of the deleted object. + deleted: + type: boolean + title: deleted + description: Whether the Cart was deleted. + - type: object + description: SUMMARY + properties: + parent: + $ref: ../components/schemas/StoreCart.yaml description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The cart's ID. - object: - type: string - title: object - description: The cart's object. - deleted: - type: boolean - title: deleted - description: The cart's deleted. - parent: - type: object - description: The cart's parent. '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_collections.yaml b/www/apps/api-reference/specs/store/paths/store_collections.yaml index cdf92976f2..eb7cc9d0fa 100644 --- a/www/apps/api-reference/specs/store/paths/store_collections.yaml +++ b/www/apps/api-reference/specs/store/paths/store_collections.yaml @@ -61,6 +61,919 @@ 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: deleted_at + in: query + description: The collection's deleted at. + required: false + schema: + type: object + description: The collection'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: title + in: query + required: false + schema: + oneOf: + - type: string + title: title + description: The collection's title. + - type: array + description: The collection's title. + items: + type: string + title: title + description: The title's details. + - name: created_at + in: query + description: The collection's created at. + required: false + schema: + type: object + description: The collection'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 collection's updated at. + required: false + schema: + type: object + description: The collection'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: handle + in: query + required: false + schema: + oneOf: + - type: string + title: handle + description: The collection's handle. + - type: array + description: The collection's handle. + items: + type: string + title: handle + description: The handle's details. + - name: q + in: query + description: The collection's q. + required: false + schema: + type: string + title: q + description: The collection's q. + - 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 x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/paths/store_currencies.yaml b/www/apps/api-reference/specs/store/paths/store_currencies.yaml index 3c38f49170..9e098b3167 100644 --- a/www/apps/api-reference/specs/store/paths/store_currencies.yaml +++ b/www/apps/api-reference/specs/store/paths/store_currencies.yaml @@ -61,6 +61,56 @@ 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: The currency's q. + required: false + schema: + type: string + title: q + description: The currency's q. + - name: code + in: query + required: false + schema: + oneOf: + - type: string + title: code + description: The currency's code. + - type: array + description: The currency's code. + items: + type: string + title: code + description: The code's details. + - 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 x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml index 607a58b7d2..c489d8e710 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml @@ -355,28 +355,32 @@ delete: content: application/json: schema: - type: object + allOf: + - type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The customer's ID. + object: + type: string + title: object + description: The name of the deleted object. + deleted: + type: boolean + title: deleted + description: Whether the Customer was deleted. + - type: object + description: SUMMARY + properties: + parent: + $ref: ../components/schemas/StoreCustomer.yaml description: SUMMARY - required: - - id - - object - - deleted - properties: - id: - type: string - title: id - description: The customer's ID. - object: - type: string - title: object - description: The customer's object. - deleted: - type: boolean - title: deleted - description: The customer's deleted. - parent: - type: object - description: The customer's parent. '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections.yaml index fa79d501b7..52d20716f2 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-collections.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-collections.yaml @@ -63,15 +63,7 @@ post: content: application/json: schema: - type: object - description: SUMMARY - required: - - cart_id - properties: - cart_id: - type: string - title: cart_id - description: The payment collection's cart id. + $ref: ../components/schemas/StoreCreatePaymentCollection.yaml x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/paths/store_payment-providers.yaml b/www/apps/api-reference/specs/store/paths/store_payment-providers.yaml index 9b636d127f..90325a58d8 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-providers.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-providers.yaml @@ -65,11 +65,18 @@ get: - name: region_id in: query description: The payment provider's region id. - required: true + required: false schema: - type: string - title: region_id - description: The payment provider's region id. + oneOf: + - type: string + title: region_id + description: The payment provider's region id. + - type: array + description: The payment provider's region id. + items: + type: string + title: region_id + description: The region id's details. - name: id in: query required: false diff --git a/www/apps/api-reference/specs/store/paths/store_product-categories.yaml b/www/apps/api-reference/specs/store/paths/store_product-categories.yaml index c9133bddc5..ac4b1ac8a6 100644 --- a/www/apps/api-reference/specs/store/paths/store_product-categories.yaml +++ b/www/apps/api-reference/specs/store/paths/store_product-categories.yaml @@ -146,17 +146,851 @@ get: in: query description: The product category's created at. required: false - schema: {} + schema: + type: object + description: The product category'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 product category's updated at. required: false - schema: {} + schema: + type: object + description: The product category'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 product category's deleted at. required: false - schema: {} + schema: + type: object + description: The product category'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 @@ -175,6 +1009,36 @@ get: items: type: object title: $or + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The product category's name. + - type: array + description: The product category's name. + items: + type: string + title: name + description: The name's details. + - name: is_active + in: query + description: The product category's is active. + required: false + schema: + type: boolean + title: is_active + description: The product category's is active. + - name: is_internal + in: query + description: The product category's is internal. + required: false + schema: + type: boolean + title: is_internal + description: The product category's is internal. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/paths/store_products.yaml b/www/apps/api-reference/specs/store/paths/store_products.yaml index c7ab02dcb2..30e6a15c1e 100644 --- a/www/apps/api-reference/specs/store/paths/store_products.yaml +++ b/www/apps/api-reference/specs/store/paths/store_products.yaml @@ -81,29 +81,6 @@ get: type: object description: The $or's details. title: $or - - name: variants - in: query - description: The product's variants. - required: false - schema: - type: object - description: The product's variants. - properties: - options: - type: object - description: The variant's options. - required: - - value - - option_id - properties: - value: - type: string - title: value - description: The option's value. - option_id: - type: string - title: option_id - description: The option's option id. - name: q in: query description: The product's q. @@ -179,16 +156,16 @@ get: description: The product's tags. required: false schema: - type: object - description: The product's tags. - properties: - id: - type: array - description: The tag's ID. + oneOf: + - type: string + title: tags + description: The product's tags. + - type: array + description: The product's tags. items: type: string - title: id - description: The id's ID. + title: tags + description: The tag's tags. - name: type_id in: query description: The product's type id. @@ -1364,6 +1341,58 @@ get: type: boolean title: $exists description: The id's $exists. + - name: region_id + in: query + description: The product's region id. + required: false + schema: + type: string + title: region_id + description: The product's region id. + - name: currency_code + in: query + description: The product's currency code. + required: false + schema: + type: string + title: currency_code + description: The product's currency code. + - name: province + in: query + description: The product's province. + required: false + schema: + type: string + title: province + description: The product's province. + - name: sales_channel_id + in: query + required: false + schema: + oneOf: + - type: string + title: sales_channel_id + description: The product's sales channel id. + - type: array + description: The product's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + - name: category_id + in: query + required: false + schema: + oneOf: + - type: string + title: category_id + description: The product's category id. + - type: array + description: The product's category id. + items: + type: string + title: category_id + description: The category id's details. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/paths/store_regions.yaml b/www/apps/api-reference/specs/store/paths/store_regions.yaml index 03bcb0d5f6..bc243a0743 100644 --- a/www/apps/api-reference/specs/store/paths/store_regions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_regions.yaml @@ -61,6 +61,1189 @@ 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: The region's q. + required: false + schema: + type: string + title: q + description: The region's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The region's ID. + - type: array + description: The region's ID. + items: + type: string + title: id + description: The id's ID. + - type: object + description: The region'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 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: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The region's name. + - type: array + description: The region's name. + items: + type: string + title: name + description: The name's details. + - name: code + in: query + required: false + schema: + oneOf: + - type: string + title: code + description: The region's code. + - type: array + description: The region's code. + items: + type: string + title: code + description: The code's details. + - name: created_at + in: query + description: The region's created at. + required: false + schema: + type: object + description: The 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 region's updated at. + required: false + schema: + type: object + description: The 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: $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 x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/paths/store_return.yaml b/www/apps/api-reference/specs/store/paths/store_return.yaml index dbe3617283..1dd093e554 100644 --- a/www/apps/api-reference/specs/store/paths/store_return.yaml +++ b/www/apps/api-reference/specs/store/paths/store_return.yaml @@ -8,7 +8,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/StorePostReturnsReqSchema.yaml + $ref: ../components/schemas/StoreCreateReturn.yaml x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml b/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml index 4444203886..f5807cf7cf 100644 --- a/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml +++ b/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml @@ -61,6 +61,42 @@ 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: cart_id + in: query + description: The shipping option's cart id. + required: true + schema: + type: string + title: cart_id + description: The shipping option's cart id. + - 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 x-codeSamples: - lang: Shell label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts index 44405aebc8..b74414ae65 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts @@ -50,9 +50,6 @@ * type: boolean * title: deleted * description: Whether the API key was deleted. - * parent: - * type: object - * description: The API key's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts index a039478fec..756b42da27 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts @@ -50,9 +50,6 @@ * type: boolean * title: deleted * description: Whether the campaign was deleted. - * parent: - * type: object - * description: The campaign's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts index cefe91930f..a823af40cc 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts @@ -49,9 +49,6 @@ * type: boolean * title: deleted * description: The customer group's deleted. - * parent: - * type: object - * description: The customer group's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts index a447d37d90..30c712a55d 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts @@ -48,9 +48,6 @@ * type: boolean * title: deleted * description: The customer's deleted. - * parent: - * type: object - * description: The customer's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts index 0aea4a23b3..af971ede3a 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts @@ -75,28 +75,32 @@ * content: * application/json: * schema: - * type: object + * allOf: + * - type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The customer's ID. + * object: + * type: string + * title: object + * description: The name of the deleted object. + * deleted: + * type: boolean + * title: deleted + * description: Whether the Customer was deleted. + * - type: object + * description: SUMMARY + * properties: + * parent: + * $ref: "#/components/schemas/AdminCustomer" * description: SUMMARY - * required: - * - id - * - object - * - deleted - * properties: - * id: - * type: string - * title: id - * description: The customer's ID. - * object: - * type: string - * title: object - * description: The customer's object. - * deleted: - * type: boolean - * title: deleted - * description: The customer's deleted. - * parent: - * type: object - * description: The customer's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts index 33d23645b7..90557e32e8 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts @@ -29,29 +29,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - id - * - object - * - deleted - * properties: - * id: - * type: string - * title: id - * description: The exchange's ID. - * object: - * type: string - * title: object - * description: The name of the deleted object. - * default: exchange - * deleted: - * type: boolean - * title: deleted - * description: Whether the exchange was deleted. - * parent: - * type: object - * description: The exchange's parent. + * $ref: "#/components/schemas/AdminExchangeDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts index 4215f2f721..a5cb7a2853 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts @@ -34,29 +34,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - id - * - object - * - deleted - * properties: - * id: - * type: string - * title: id - * description: The service zone'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. - * parent: - * type: object - * description: The fulfillment set that the service zone belongs to. + * $ref: "#/components/schemas/AdminServiceZoneDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts index 23d1aff694..3f4e2ee52f 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts @@ -49,9 +49,6 @@ * type: boolean * title: deleted * description: Whether the inventory item was deleted. - * parent: - * type: object - * description: The inventory item's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts index 80a41014ce..8dac87a804 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts @@ -79,29 +79,32 @@ * content: * application/json: * schema: - * type: object + * allOf: + * - type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The inventory item's ID. + * object: + * type: string + * title: object + * description: The name of the deleted object. + * deleted: + * type: boolean + * title: deleted + * description: Whether the Inventory Item was deleted. + * - type: object + * description: SUMMARY + * properties: + * parent: + * $ref: "#/components/schemas/AdminInventoryItem" * description: SUMMARY - * required: - * - id - * - object - * - deleted - * properties: - * id: - * type: string - * title: id - * description: The inventory level's ID. - * object: - * type: string - * title: object - * description: The name of the deleted object. - * default: inventory-level - * deleted: - * type: boolean - * title: deleted - * description: Whether the inventory level was deleted. - * parent: - * type: object - * description: The inventory item of the level. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts index 861b88b397..4ccf7150f8 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts @@ -43,9 +43,6 @@ * type: boolean * title: deleted * description: Whether the invite was deleted. - * parent: - * type: object - * description: The invite's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts index 62c995eda7..093ea77f42 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts @@ -49,9 +49,6 @@ * type: boolean * title: deleted * description: Whether the order edit was deleted. - * parent: - * type: object - * description: The order edit's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_payment-collections_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_payment-collections_[id].ts index e4bccb653b..387badc0a2 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_payment-collections_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_payment-collections_[id].ts @@ -29,29 +29,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - id - * - object - * - deleted - * properties: - * id: - * type: string - * title: id - * description: The payment collection's ID. - * object: - * type: string - * title: object - * description: The name of the deleted object. - * default: payment-collection - * deleted: - * type: boolean - * title: deleted - * description: Whether the payment collection was deleted. - * parent: - * type: object - * description: The payment collection's parent. + * $ref: "#/components/schemas/AdminDeletePaymentCollectionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts index 2542fc43d1..9246fa59c5 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts @@ -49,9 +49,6 @@ * type: boolean * title: deleted * description: Whether the promotion was deleted. - * parent: - * type: object - * description: The promotion's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts index 9658ebacd0..82d3120324 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts @@ -49,9 +49,6 @@ * type: boolean * title: deleted * description: Whether the refund reason was deleted. - * parent: - * type: object - * description: The refund reason's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts index 865220e2f0..0467660bff 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts @@ -49,9 +49,6 @@ * type: boolean * title: deleted * description: Whether the region was deleted. - * parent: - * type: object - * description: The region's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts index c581c89158..8fecb06623 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts @@ -49,9 +49,6 @@ * type: boolean * title: deleted * description: Whether the reservation was deleted. - * parent: - * type: object - * description: The reservation's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts index bdcb12e4f6..03bb6b88f7 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts @@ -29,29 +29,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - id - * - object - * - deleted - * properties: - * id: - * type: string - * title: id - * description: The return reason's ID. - * object: - * type: string - * title: object - * description: The name of the deleted object. - * default: return_reason - * deleted: - * type: boolean - * title: deleted - * description: Whether the return reason was deleted. - * parent: - * type: object - * description: The return reason's parent. + * $ref: "#/components/schemas/AdminReturnReasonDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts index accc5ae1cf..89e782e6c7 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts @@ -49,9 +49,6 @@ * type: boolean * title: deleted * description: Whether the return was deleted. - * parent: - * type: object - * description: The return's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts index 7ddaf7362b..502512ca1d 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts @@ -49,9 +49,6 @@ * type: boolean * title: deleted * description: Whether the return was deleted. - * parent: - * type: object - * description: The return's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts index f6357b31dc..1064dfd07e 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts @@ -3,12 +3,10 @@ * operationId: DeleteReturnsIdShippingMethodAction_id * summary: Remove Shipping Method from Return * x-sidebar-summary: Remove Shipping Method - * description: > + * description: | * Remove a shipping method of the return by the ID of the item's `SHIPPING_ADD` action. * - * - * Every item has an `actions` property, whose value is an array of actions. You can check the action's - * name using its `action` property, and use the value of the `id` property. + * Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts index afc813cb9e..05516861ab 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts @@ -78,29 +78,32 @@ * content: * application/json: * schema: - * type: object + * allOf: + * - type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The tax rate's ID. + * object: + * type: string + * title: object + * description: The name of the deleted object. + * deleted: + * type: boolean + * title: deleted + * description: Whether the Tax Rate was deleted. + * - type: object + * description: SUMMARY + * properties: + * parent: + * $ref: "#/components/schemas/AdminTaxRate" * description: SUMMARY - * required: - * - id - * - object - * - deleted - * properties: - * id: - * type: string - * title: id - * description: The tax rate's ID. - * object: - * type: string - * title: object - * description: The name of the deleted object. - * default: "tax_rate_rule" - * deleted: - * type: boolean - * title: deleted - * description: Whether the tax rate rule was deleted. - * parent: - * type: object - * description: The parent tax rate. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts index 64c69788fd..7e6ad7cf3d 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts @@ -49,9 +49,6 @@ * type: boolean * title: deleted * description: Whether the file was deleted. - * parent: - * type: object - * description: The upload's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts index 7e03c95bf8..69309bd2e5 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/api-keys * operationId: GetApiKeys * summary: List API Keys - * description: Retrieve a list of API keys. The API keys can be filtered by fields - * such as `id`. The API keys can also be sorted or paginated. + * description: Retrieve a list of API keys. The API keys can be filtered by fields such as `id`. The API keys can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts index 4ef10c734d..aa1ea82d0c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/api-keys/{id} * operationId: GetApiKeysId * summary: Get API Key - * description: Retrieve an API key by its ID. You can expand the API key's - * relations or select the fields that should be returned using the query parameters. + * description: Retrieve an API key by its ID. You can expand the API key'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_campaigns.ts b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts index b796c47bff..24609001c7 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts @@ -47,54 +47,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: q - * in: query - * description: Search term to filter the campaign's searchable properties. - * required: false - * schema: - * type: string - * title: q - * description: Search term to filter the campaign's searchable properties. - * - name: campaign_identifier - * in: query - * description: Filter the campaign by its identifier. - * required: false - * schema: - * type: string - * title: campaign_identifier - * description: Filter the campaign by its identifier. - * - name: budget - * in: query - * description: Filter the campaign by its budget. - * required: false - * schema: - * type: object - * description: Filter the campaign by its budget. - * properties: - * currency_code: - * type: string - * title: currency_code - * description: Filter the campaign by its budget's currency 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. - * 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/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts index a21d698fb7..53c585da69 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/campaigns/{id} * operationId: GetCampaignsId * summary: Get a Campaign - * description: Retrieve a campaign by its ID. You can expand the campaign's - * relations or select the fields that should be returned using the query parameters. + * description: Retrieve a campaign by its ID. You can expand the campaign'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_claims.ts b/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts index 4712376d39..39f0e4ba55 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts @@ -47,6 +47,769 @@ * 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: deleted_at + * in: query + * description: The claim's deleted at. + * required: false + * schema: + * type: object + * description: The claim'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: q + * in: query + * description: The claim's q. + * required: false + * schema: + * type: string + * title: q + * description: The claim's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The claim's ID. + * - type: array + * description: The claim's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: order_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: order_id + * description: The claim's order id. + * - type: array + * description: The claim's order id. + * items: + * type: string + * title: order_id + * description: The order id's details. + * - name: status + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: status + * description: The claim's status. + * - type: array + * description: The claim's status. + * items: + * type: string + * title: status + * description: The status's details. + * - name: created_at + * in: query + * description: The claim's created at. + * required: false + * schema: + * type: object + * description: The claim'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 claim's updated at. + * required: false + * schema: + * type: object + * description: The claim'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: $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/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts index 7c98748102..38969843f9 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/claims/{id} * operationId: GetClaimsId * summary: Get a Claim - * description: Retrieve a claim by its ID. You can expand the claim's relations or - * select the fields that should be returned using the query parameters. + * description: Retrieve a claim by its ID. You can expand the claim'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_collections_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_collections_[id].ts index 0c4cbc9705..17d736dd22 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_collections_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/collections/{id} * operationId: GetCollectionsId * summary: Get a Collection - * description: Retrieve a collection by its ID. You can expand the collection's - * relations or select the fields that should be returned using the query parameters. + * description: Retrieve a collection by its ID. You can expand the collection'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_currencies_[code].ts b/www/utils/generated/oas-output/operations/admin/get_admin_currencies_[code].ts index e79e460c60..77505f2557 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_currencies_[code].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_currencies_[code].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/currencies/{code} * operationId: GetCurrenciesCode * summary: Get a Currency - * description: Retrieve a currency by its code. You can expand the currency's - * relations or select the fields that should be returned using the query parameters. + * description: Retrieve a currency by its code. You can expand the currency's relations or select the fields that should be returned using the query parameters. * x-authenticated: true * parameters: * - name: code 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 fe29ffcd16..a8356000d4 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 @@ -28,16 +28,16 @@ * in: query * description: |- * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields * description: |- * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. 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 49890b5645..a2b16b38a3 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 @@ -518,6 +518,20 @@ * items: * type: object * title: $or + * - name: name + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: name + * description: The product category's name. + * - type: array + * description: The product category's name. + * items: + * type: string + * title: name + * description: The name's details. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts index 0832ff009e..16337b57e8 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts @@ -55,99 +55,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - sku - * - hs_code - * - weight - * - length - * - height - * - width - * - origin_country - * - mid_code - * - material - * - title - * - description - * - thumbnail - * - metadata - * properties: - * sku: - * type: string - * title: sku - * description: The inventory item's sku. - * hs_code: - * type: string - * title: hs_code - * description: The inventory item's hs code. - * weight: - * type: number - * title: weight - * description: The inventory item's weight. - * length: - * type: number - * title: length - * description: The inventory item's length. - * height: - * type: number - * title: height - * description: The inventory item's height. - * width: - * type: number - * title: width - * description: The inventory item's width. - * origin_country: - * type: string - * title: origin_country - * description: The inventory item's origin country. - * mid_code: - * type: string - * title: mid_code - * description: The inventory item's mid code. - * material: - * type: string - * title: material - * description: The inventory item's material. - * title: - * type: string - * title: title - * description: The inventory item's title. - * description: - * type: string - * title: description - * description: The inventory item's description. - * requires_shipping: - * type: boolean - * title: requires_shipping - * description: The inventory item's requires shipping. - * thumbnail: - * type: string - * title: thumbnail - * description: The inventory item's thumbnail. - * metadata: - * type: object - * description: The inventory item's metadata. - * location_levels: - * type: array - * description: The inventory item's location levels. - * items: - * type: object - * description: The location level's location levels. - * required: - * - location_id - * properties: - * location_id: - * type: string - * title: location_id - * description: The location level's location id. - * stocked_quantity: - * type: number - * title: stocked_quantity - * description: The location level's stocked quantity. - * incoming_quantity: - * type: number - * title: incoming_quantity - * description: The location level's incoming quantity. + * $ref: "#/components/schemas/AdminCreateInventoryItem" * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts b/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts index e7c1cbb5e5..5274841f8d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts @@ -61,6 +61,9 @@ * title: email * description: The invite's email. * format: email + * metadata: + * type: object + * description: The invite's metadata. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts index 86adaa8ae0..0c10f8ca35 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts @@ -55,44 +55,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - name - * - parent_category_id - * - metadata - * properties: - * name: - * type: string - * title: name - * description: The product category's name. - * description: - * type: string - * title: description - * description: The product category's description. - * handle: - * type: string - * title: handle - * description: The product category's handle. - * is_internal: - * type: boolean - * title: is_internal - * description: The product category's is internal. - * is_active: - * type: boolean - * title: is_active - * description: The product category's is active. - * parent_category_id: - * 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. + * $ref: "#/components/schemas/AdminCreateProductCategory" * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts index d6931b3634..030ae0405d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts @@ -55,19 +55,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - value - * - metadata - * properties: - * value: - * type: string - * title: value - * description: The product tag's value. - * metadata: - * type: object - * description: The product tag's metadata. + * $ref: "#/components/schemas/AdminCreateProductTag" * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-types.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-types.ts index edad228db8..51bd665df3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-types.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-types.ts @@ -55,19 +55,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - value - * - metadata - * properties: - * value: - * type: string - * title: value - * description: The product type's value. - * metadata: - * type: object - * description: The product type's metadata. + * $ref: "#/components/schemas/AdminCreateProduct" * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts index 9b2fecba0c..cff3a2557d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts @@ -55,20 +55,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - label - * - description - * properties: - * label: - * type: string - * title: label - * description: The refund reason's label. - * description: - * type: string - * title: description - * description: The refund reason's description. + * $ref: "#/components/schemas/AdminCreateRefundReason" * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts index 86907d9ab0..60dc521681 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts @@ -55,46 +55,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - name - * - currency_code - * - metadata - * properties: - * name: - * type: string - * title: name - * description: The region's name. - * currency_code: - * type: string - * title: currency_code - * description: The region's currency code. - * countries: - * type: array - * description: The region's countries. - * items: - * type: string - * title: countries - * description: The country's countries. - * automatic_taxes: - * type: boolean - * title: automatic_taxes - * description: The region's automatic taxes. - * payment_providers: - * type: array - * description: The region's payment providers. - * items: - * type: string - * title: payment_providers - * description: The payment provider's payment providers. - * metadata: - * type: object - * description: The region's metadata. - * is_tax_inclusive: - * type: boolean - * title: is_tax_inclusive - * description: The region's is tax inclusive. + * $ref: "#/components/schemas/AdminCreateRegion" * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts b/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts index 50220ba218..7f005761b7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts @@ -55,39 +55,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - line_item_id - * - location_id - * - inventory_item_id - * - quantity - * - description - * - metadata - * properties: - * line_item_id: - * type: string - * title: line_item_id - * description: The reservation's line item id. - * location_id: - * type: string - * title: location_id - * description: The reservation's location id. - * inventory_item_id: - * type: string - * title: inventory_item_id - * description: The reservation's inventory item id. - * quantity: - * type: number - * title: quantity - * description: The reservation's quantity. - * description: - * type: string - * title: description - * description: The reservation's description. - * metadata: - * type: object - * description: The reservation's metadata. + * $ref: "#/components/schemas/AdminCreateReservation" * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts index dce3a80d0d..d1a5f25129 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts @@ -55,131 +55,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - name - * - service_zone_id - * - shipping_profile_id - * - price_type - * - provider_id - * - type - * - prices - * properties: - * name: - * type: string - * title: name - * description: The shipping option's name. - * service_zone_id: - * type: string - * title: service_zone_id - * description: The shipping option's service zone id. - * shipping_profile_id: - * type: string - * title: shipping_profile_id - * description: The shipping option's shipping profile id. - * data: - * type: object - * description: The shipping option's data. - * price_type: - * type: string - * enum: - * - calculated - * - flat - * provider_id: - * type: string - * title: provider_id - * description: The shipping option's provider id. - * type: - * type: object - * description: The shipping option's type. - * required: - * - label - * - description - * - code - * properties: - * label: - * type: string - * title: label - * description: The type's label. - * description: - * type: string - * title: description - * description: The type's description. - * code: - * type: string - * title: code - * description: The type's code. - * prices: - * type: array - * description: The shipping option's prices. - * items: - * oneOf: - * - type: object - * description: The price's prices. - * required: - * - currency_code - * - amount - * properties: - * currency_code: - * type: string - * title: currency_code - * description: The price's currency code. - * amount: - * type: number - * title: amount - * description: The price's amount. - * - type: object - * description: The price's prices. - * required: - * - region_id - * - amount - * properties: - * region_id: - * type: string - * title: region_id - * description: The price's region id. - * amount: - * type: number - * title: amount - * description: The price's amount. - * rules: - * type: array - * description: The shipping option's rules. - * items: - * type: object - * description: The rule's rules. - * required: - * - operator - * - attribute - * - value - * properties: - * operator: - * type: string - * enum: - * - in - * - eq - * - ne - * - gt - * - gte - * - lt - * - lte - * - nin - * attribute: - * type: string - * title: attribute - * description: The rule's attribute. - * value: - * oneOf: - * - type: string - * title: value - * description: The rule's value. - * - type: array - * description: The rule's value. - * items: - * type: string - * title: value - * description: The value's details. + * $ref: "#/components/schemas/AdminCreateShippingOption" * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts b/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts index ccc3fc4e24..7ff6adaba5 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts @@ -13,7 +13,34 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminGetUploadParams" + * oneOf: + * - type: object + * description: SUMMARY + * required: + * - files + * properties: + * files: + * type: array + * description: The upload's files. + * items: + * oneOf: + * - type: object + * description: The file's files. + * required: + * - name + * - content + * properties: + * name: + * type: string + * title: name + * description: The file's name. + * content: + * type: string + * title: content + * description: The file's content. + * - $ref: "#/components/schemas/File" + * - $ref: "#/components/schemas/FileList" + * description: SUMMARY * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_register.ts b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_register.ts index a61767ca37..c69a949492 100644 --- a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_register.ts +++ b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_register.ts @@ -24,8 +24,6 @@ * tags: * - "[actor_type]" * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -38,6 +36,10 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * requestBody: + * content: + * application/json: + * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts index 43a2175cb4..77d7a64620 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts @@ -71,28 +71,32 @@ * content: * application/json: * schema: - * type: object + * allOf: + * - type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The cart's ID. + * object: + * type: string + * title: object + * description: The name of the deleted object. + * deleted: + * type: boolean + * title: deleted + * description: Whether the Cart was deleted. + * - type: object + * description: SUMMARY + * properties: + * parent: + * $ref: "#/components/schemas/StoreCart" * description: SUMMARY - * required: - * - id - * - object - * - deleted - * properties: - * id: - * type: string - * title: id - * description: The cart's ID. - * object: - * type: string - * title: object - * description: The cart's object. - * deleted: - * type: boolean - * title: deleted - * description: The cart's deleted. - * parent: - * type: object - * description: The cart's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts index e05bc2157a..5bac80f7e3 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts @@ -70,28 +70,32 @@ * content: * application/json: * schema: - * type: object + * allOf: + * - type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The customer's ID. + * object: + * type: string + * title: object + * description: The name of the deleted object. + * deleted: + * type: boolean + * title: deleted + * description: Whether the Customer was deleted. + * - type: object + * description: SUMMARY + * properties: + * parent: + * $ref: "#/components/schemas/StoreCustomer" * description: SUMMARY - * required: - * - id - * - object - * - deleted - * properties: - * id: - * type: string - * title: id - * description: The customer's ID. - * object: - * type: string - * title: object - * description: The customer's object. - * deleted: - * type: boolean - * title: deleted - * description: The customer's deleted. - * parent: - * type: object - * description: The customer's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/get_store_collections.ts b/www/utils/generated/oas-output/operations/store/get_store_collections.ts index 80739e9b79..d57ef1af27 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_collections.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_collections.ts @@ -47,6 +47,755 @@ * 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: deleted_at + * in: query + * description: The collection's deleted at. + * required: false + * schema: + * type: object + * description: The collection'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: title + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: title + * description: The collection's title. + * - type: array + * description: The collection's title. + * items: + * type: string + * title: title + * description: The title's details. + * - name: created_at + * in: query + * description: The collection's created at. + * required: false + * schema: + * type: object + * description: The collection'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 collection's updated at. + * required: false + * schema: + * type: object + * description: The collection'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: handle + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: handle + * description: The collection's handle. + * - type: array + * description: The collection's handle. + * items: + * type: string + * title: handle + * description: The handle's details. + * - name: q + * in: query + * description: The collection's q. + * required: false + * schema: + * type: string + * title: q + * description: The collection's q. + * - 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 * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_currencies.ts b/www/utils/generated/oas-output/operations/store/get_store_currencies.ts index 11f202cc29..4c632b864e 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_currencies.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_currencies.ts @@ -47,6 +47,48 @@ * 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: The currency's q. + * required: false + * schema: + * type: string + * title: q + * description: The currency's q. + * - name: code + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: code + * description: The currency's code. + * - type: array + * description: The currency's code. + * items: + * type: string + * title: code + * description: The code's details. + * - 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 * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts b/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts index 876c1a487c..a543d9496f 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts @@ -50,11 +50,18 @@ * - name: region_id * in: query * description: The payment provider's region id. - * required: true + * required: false * schema: - * type: string - * title: region_id - * description: The payment provider's region id. + * oneOf: + * - type: string + * title: region_id + * description: The payment provider's region id. + * - type: array + * description: The payment provider's region id. + * items: + * type: string + * title: region_id + * description: The region id's details. * - name: id * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts b/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts index 8c8b75883a..3f52db4c5e 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts @@ -131,17 +131,695 @@ * in: query * description: The product category's created at. * required: false - * schema: {} + * schema: + * type: object + * description: The product category'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 product category's updated at. * required: false - * schema: {} + * schema: + * type: object + * description: The product category'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 product category's deleted at. * required: false - * schema: {} + * schema: + * type: object + * description: The product category'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 @@ -160,6 +838,36 @@ * items: * type: object * title: $or + * - name: name + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: name + * description: The product category's name. + * - type: array + * description: The product category's name. + * items: + * type: string + * title: name + * description: The name's details. + * - name: is_active + * in: query + * description: The product category's is active. + * required: false + * schema: + * type: boolean + * title: is_active + * description: The product category's is active. + * - name: is_internal + * in: query + * description: The product category's is internal. + * required: false + * schema: + * type: boolean + * title: is_internal + * description: The product category's is internal. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_products.ts b/www/utils/generated/oas-output/operations/store/get_store_products.ts index 5fc4541d99..85cb79d8b2 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_products.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_products.ts @@ -67,29 +67,6 @@ * type: object * description: The $or's details. * title: $or - * - name: variants - * in: query - * description: The product's variants. - * required: false - * schema: - * type: object - * description: The product's variants. - * properties: - * options: - * type: object - * description: The variant's options. - * required: - * - value - * - option_id - * properties: - * value: - * type: string - * title: value - * description: The option's value. - * option_id: - * type: string - * title: option_id - * description: The option's option id. * - name: q * in: query * description: The product's q. @@ -165,16 +142,16 @@ * description: The product's tags. * required: false * schema: - * type: object - * description: The product's tags. - * properties: - * id: - * type: array - * description: The tag's ID. + * oneOf: + * - type: string + * title: tags + * description: The product's tags. + * - type: array + * description: The product's tags. * items: * type: string - * title: id - * description: The id's ID. + * title: tags + * description: The tag's tags. * - name: type_id * in: query * description: The product's type id. @@ -1238,6 +1215,58 @@ * type: boolean * title: $exists * description: The id's $exists. + * - name: region_id + * in: query + * description: The product's region id. + * required: false + * schema: + * type: string + * title: region_id + * description: The product's region id. + * - name: currency_code + * in: query + * description: The product's currency code. + * required: false + * schema: + * type: string + * title: currency_code + * description: The product's currency code. + * - name: province + * in: query + * description: The product's province. + * required: false + * schema: + * type: string + * title: province + * description: The product's province. + * - name: sales_channel_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: sales_channel_id + * description: The product's sales channel id. + * - type: array + * description: The product's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * - name: category_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: category_id + * description: The product's category id. + * - type: array + * description: The product's category id. + * items: + * type: string + * title: category_id + * description: The category id's details. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_regions.ts b/www/utils/generated/oas-output/operations/store/get_store_regions.ts index 03ddaa5f73..0b5c79fda8 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_regions.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_regions.ts @@ -47,6 +47,947 @@ * 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: The region's q. + * required: false + * schema: + * type: string + * title: q + * description: The region's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The region's ID. + * - type: array + * description: The region's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - type: object + * description: The region'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 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: name + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: name + * description: The region's name. + * - type: array + * description: The region's name. + * items: + * type: string + * title: name + * description: The name's details. + * - name: code + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: code + * description: The region's code. + * - type: array + * description: The region's code. + * items: + * type: string + * title: code + * description: The code's details. + * - name: created_at + * in: query + * description: The region's created at. + * required: false + * schema: + * type: object + * description: The 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 region's updated at. + * required: false + * schema: + * type: object + * description: The 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: $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 * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts b/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts index 08810f8a9c..fd601abc5f 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts @@ -47,6 +47,34 @@ * 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: cart_id + * in: query + * description: The shipping option's cart id. + * required: true + * schema: + * type: string + * title: cart_id + * description: The shipping option's cart id. + * - 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 * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts b/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts index c51d2f3661..f54c9d69cc 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts @@ -51,15 +51,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - cart_id - * properties: - * cart_id: - * type: string - * title: cart_id - * description: The payment collection's cart id. + * $ref: "#/components/schemas/StoreCreatePaymentCollection" * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/post_store_return.ts b/www/utils/generated/oas-output/operations/store/post_store_return.ts index 6ffce3be6e..2ce0bbf2b9 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_return.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_return.ts @@ -9,7 +9,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/StorePostReturnsReqSchema" + * $ref: "#/components/schemas/StoreCreateReturn" * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/schemas/AdminClaim.ts b/www/utils/generated/oas-output/schemas/AdminClaim.ts index d378b58fce..75422a8d31 100644 --- a/www/utils/generated/oas-output/schemas/AdminClaim.ts +++ b/www/utils/generated/oas-output/schemas/AdminClaim.ts @@ -96,7 +96,7 @@ * description: The claim's email. * format: email * display_id: - * type: string + * type: number * title: display_id * description: The claim's display id. * shipping_address: diff --git a/www/utils/generated/oas-output/schemas/AdminClaimDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminClaimDeleteResponse.ts index 15a914ec17..d08ee0fd08 100644 --- a/www/utils/generated/oas-output/schemas/AdminClaimDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminClaimDeleteResponse.ts @@ -21,9 +21,6 @@ * type: boolean * title: deleted * description: Whether the Claim was deleted. - * parent: - * type: object - * description: The claim's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCollectionDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminCollectionDeleteResponse.ts index 37762c2e15..a996f28d58 100644 --- a/www/utils/generated/oas-output/schemas/AdminCollectionDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminCollectionDeleteResponse.ts @@ -21,9 +21,6 @@ * type: boolean * title: deleted * description: Whether the Collection was deleted. - * parent: - * type: object - * description: The collection's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateApplicationMethod.ts b/www/utils/generated/oas-output/schemas/AdminCreateApplicationMethod.ts new file mode 100644 index 0000000000..8537daf683 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateApplicationMethod.ts @@ -0,0 +1,66 @@ +/** + * @schema AdminCreateApplicationMethod + * type: object + * description: The promotion's application method. + * x-schemaName: AdminCreateApplicationMethod + * required: + * - value + * - type + * - target_type + * properties: + * description: + * type: string + * title: description + * description: The application method's description. + * value: + * type: number + * title: value + * description: The application method's value. + * currency_code: + * type: string + * title: currency_code + * description: The application method's currency code. + * max_quantity: + * type: number + * title: max_quantity + * description: The application method's max quantity. + * type: + * type: string + * description: The application method's type. + * enum: + * - fixed + * - percentage + * target_type: + * type: string + * description: The application method's target type. + * enum: + * - items + * - shipping_methods + * - order + * allocation: + * type: string + * description: The application method's allocation. + * enum: + * - each + * - across + * target_rules: + * type: array + * description: The application method's target rules. + * items: + * $ref: "#/components/schemas/AdminCreatePromotionRule" + * buy_rules: + * type: array + * description: The application method's buy rules. + * items: + * $ref: "#/components/schemas/AdminCreatePromotionRule" + * apply_to_quantity: + * type: number + * title: apply_to_quantity + * description: The application method's apply to quantity. + * buy_rules_min_quantity: + * type: number + * title: buy_rules_min_quantity + * description: The application method's buy rules min quantity. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateCampaign.ts b/www/utils/generated/oas-output/schemas/AdminCreateCampaign.ts new file mode 100644 index 0000000000..750e60218a --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateCampaign.ts @@ -0,0 +1,53 @@ +/** + * @schema AdminCreateCampaign + * type: object + * description: The promotion's campaign. + * x-schemaName: AdminCreateCampaign + * properties: + * name: + * type: string + * title: name + * description: The campaign's name. + * description: + * type: string + * title: description + * description: The campaign's description. + * currency: + * type: string + * title: currency + * description: The campaign's currency. + * campaign_identifier: + * type: string + * title: campaign_identifier + * description: The campaign's campaign identifier. + * starts_at: + * type: string + * title: starts_at + * description: The campaign's starts at. + * format: date-time + * ends_at: + * type: string + * title: ends_at + * description: The campaign's ends at. + * format: date-time + * budget: + * type: object + * description: The campaign's budget. + * properties: + * type: + * type: string + * description: The budget's type. + * enum: + * - spend + * - usage + * currency_code: + * type: string + * title: currency_code + * description: The budget's currency code. + * limit: + * type: number + * title: limit + * description: The budget's limit. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateInventoryItem.ts b/www/utils/generated/oas-output/schemas/AdminCreateInventoryItem.ts new file mode 100644 index 0000000000..f96c602801 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateInventoryItem.ts @@ -0,0 +1,64 @@ +/** + * @schema AdminCreateInventoryItem + * type: object + * description: SUMMARY + * properties: + * sku: + * type: string + * title: sku + * description: The inventory item's sku. + * hs_code: + * type: string + * title: hs_code + * description: The inventory item's hs code. + * weight: + * type: number + * title: weight + * description: The inventory item's weight. + * length: + * type: number + * title: length + * description: The inventory item's length. + * height: + * type: number + * title: height + * description: The inventory item's height. + * width: + * type: number + * title: width + * description: The inventory item's width. + * origin_country: + * type: string + * title: origin_country + * description: The inventory item's origin country. + * mid_code: + * type: string + * title: mid_code + * description: The inventory item's mid code. + * material: + * type: string + * title: material + * description: The inventory item's material. + * title: + * type: string + * title: title + * description: The inventory item's title. + * description: + * type: string + * title: description + * description: The inventory item's description. + * requires_shipping: + * type: boolean + * title: requires_shipping + * description: The inventory item's requires shipping. + * thumbnail: + * type: string + * title: thumbnail + * description: The inventory item's thumbnail. + * 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 new file mode 100644 index 0000000000..2008979b54 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateProductCategory.ts @@ -0,0 +1,42 @@ +/** + * @schema AdminCreateProductCategory + * type: object + * description: SUMMARY + * required: + * - name + * properties: + * name: + * type: string + * title: name + * description: The product category's name. + * description: + * type: string + * title: description + * description: The product category's description. + * handle: + * type: string + * title: handle + * description: The product category's handle. + * is_internal: + * type: boolean + * title: is_internal + * description: The product category's is internal. + * is_active: + * type: boolean + * title: is_active + * description: The product category's is active. + * parent_category_id: + * 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 + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateProductTag.ts b/www/utils/generated/oas-output/schemas/AdminCreateProductTag.ts new file mode 100644 index 0000000000..b6db4905c4 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateProductTag.ts @@ -0,0 +1,18 @@ +/** + * @schema AdminCreateProductTag + * type: object + * description: SUMMARY + * required: + * - value + * properties: + * value: + * type: string + * title: value + * description: The product tag's value. + * metadata: + * type: object + * description: The product tag's metadata. + * x-schemaName: AdminCreateProductTag + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreatePromotionRule.ts b/www/utils/generated/oas-output/schemas/AdminCreatePromotionRule.ts new file mode 100644 index 0000000000..c30b7fa4c1 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreatePromotionRule.ts @@ -0,0 +1,43 @@ +/** + * @schema AdminCreatePromotionRule + * type: object + * description: The rule's rules. + * x-schemaName: AdminCreatePromotionRule + * required: + * - operator + * - attribute + * - values + * properties: + * operator: + * type: string + * description: The rule's operator. + * enum: + * - gt + * - lt + * - eq + * - ne + * - in + * - lte + * - gte + * description: + * type: string + * title: description + * description: The rule's description. + * attribute: + * type: string + * title: attribute + * description: The rule's attribute. + * values: + * oneOf: + * - type: string + * title: values + * description: The rule's values. + * - type: array + * description: The rule's values. + * items: + * type: string + * title: values + * description: The value's values. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateRegion.ts b/www/utils/generated/oas-output/schemas/AdminCreateRegion.ts new file mode 100644 index 0000000000..1b23e04c65 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateRegion.ts @@ -0,0 +1,45 @@ +/** + * @schema AdminCreateRegion + * type: object + * description: SUMMARY + * required: + * - name + * - currency_code + * properties: + * name: + * type: string + * title: name + * description: The region's name. + * currency_code: + * type: string + * title: currency_code + * description: The region's currency code. + * countries: + * type: array + * description: The region's countries. + * items: + * type: string + * title: countries + * description: The country's countries. + * automatic_taxes: + * type: boolean + * title: automatic_taxes + * description: The region's automatic taxes. + * payment_providers: + * type: array + * description: The region's payment providers. + * items: + * type: string + * title: payment_providers + * description: The payment provider's payment providers. + * 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 new file mode 100644 index 0000000000..40c688f9ce --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateReservation.ts @@ -0,0 +1,36 @@ +/** + * @schema AdminCreateReservation + * type: object + * description: SUMMARY + * required: + * - location_id + * - inventory_item_id + * - quantity + * properties: + * line_item_id: + * type: string + * title: line_item_id + * description: The reservation's line item id. + * location_id: + * type: string + * title: location_id + * description: The reservation's location id. + * inventory_item_id: + * type: string + * title: inventory_item_id + * description: The reservation's inventory item id. + * quantity: + * type: number + * title: quantity + * description: The reservation's quantity. + * description: + * type: string + * title: description + * description: The reservation's description. + * metadata: + * type: object + * description: The reservation's metadata. + * x-schemaName: AdminCreateReservation + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateSalesChannel.ts b/www/utils/generated/oas-output/schemas/AdminCreateSalesChannel.ts index e22828d90d..1f584a6409 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateSalesChannel.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateSalesChannel.ts @@ -5,8 +5,6 @@ * x-schemaName: AdminCreateSalesChannel * required: * - name - * - description - * - metadata * properties: * name: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts b/www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts new file mode 100644 index 0000000000..2f910e7f67 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts @@ -0,0 +1,81 @@ +/** + * @schema AdminCreateShippingOption + * type: object + * description: SUMMARY + * required: + * - name + * - service_zone_id + * - shipping_profile_id + * - price_type + * - provider_id + * - type + * - prices + * properties: + * name: + * type: string + * title: name + * description: The shipping option's name. + * service_zone_id: + * type: string + * title: service_zone_id + * description: The shipping option's service zone id. + * shipping_profile_id: + * type: string + * title: shipping_profile_id + * description: The shipping option's shipping profile id. + * data: + * type: object + * description: The shipping option's data. + * price_type: + * type: string + * enum: + * - calculated + * - flat + * provider_id: + * type: string + * title: provider_id + * description: The shipping option's provider id. + * type: + * $ref: "#/components/schemas/AdminCreateShippingOption" + * prices: + * type: array + * description: The shipping option's prices. + * items: + * oneOf: + * - type: object + * description: The price's prices. + * required: + * - currency_code + * - amount + * properties: + * currency_code: + * type: string + * title: currency_code + * description: The price's currency code. + * amount: + * type: number + * title: amount + * description: The price's amount. + * - type: object + * description: The price's prices. + * required: + * - region_id + * - amount + * properties: + * region_id: + * type: string + * title: region_id + * description: The price's region id. + * amount: + * type: number + * title: amount + * description: The price's amount. + * rules: + * type: array + * 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 new file mode 100644 index 0000000000..25e7712f65 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateShippingOptionRule.ts @@ -0,0 +1,39 @@ +/** + * @schema AdminCreateShippingOptionRule + * type: object + * description: The rule's rules. + * required: + * - operator + * - attribute + * - value + * properties: + * operator: + * type: string + * enum: + * - in + * - eq + * - ne + * - gt + * - gte + * - lt + * - lte + * - nin + * attribute: + * type: string + * title: attribute + * description: The rule's attribute. + * value: + * oneOf: + * - type: string + * title: value + * description: The rule's value. + * - type: array + * description: The rule's value. + * items: + * type: string + * title: value + * description: The value's details. + * x-schemaName: AdminCreateShippingOptionRule + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateStockLocation.ts b/www/utils/generated/oas-output/schemas/AdminCreateStockLocation.ts index 4fe5f863e5..73c345ecd9 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateStockLocation.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateStockLocation.ts @@ -5,62 +5,17 @@ * x-schemaName: AdminCreateStockLocation * required: * - name - * - address_id - * - metadata * properties: * name: * type: string * title: name * description: The stock location's name. - * address: - * type: object - * description: The stock location's address. - * required: - * - address_1 - * - address_2 - * - company - * - city - * - country_code - * - phone - * - postal_code - * - province - * properties: - * address_1: - * type: string - * title: address_1 - * description: The address's address 1. - * address_2: - * type: string - * title: address_2 - * description: The address's address 2. - * company: - * type: string - * title: company - * description: The address's company. - * city: - * type: string - * title: city - * description: The address's city. - * country_code: - * type: string - * title: country_code - * description: The address's country code. - * phone: - * type: string - * title: phone - * description: The address's phone. - * postal_code: - * type: string - * title: postal_code - * description: The address's postal code. - * province: - * type: string - * title: province - * description: The address's province. * address_id: * type: string * title: address_id * description: The stock location's address id. + * address: + * $ref: "#/components/schemas/AdminUpsertStockLocationAddress" * metadata: * type: object * description: The stock location's metadata. diff --git a/www/utils/generated/oas-output/schemas/AdminCreateTaxRate.ts b/www/utils/generated/oas-output/schemas/AdminCreateTaxRate.ts index 9b70339d88..8ca4bd9ce3 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateTaxRate.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateTaxRate.ts @@ -6,8 +6,15 @@ * required: * - name * - tax_region_id - * - metadata * properties: + * name: + * type: string + * title: name + * description: The tax rate's name. + * tax_region_id: + * type: string + * title: tax_region_id + * description: The tax rate's tax region id. * rate: * type: number * title: rate @@ -20,24 +27,7 @@ * type: array * description: The tax rate's rules. * items: - * type: object - * description: The rule's rules. - * required: - * - reference - * - reference_id - * properties: - * reference: - * type: string - * title: reference - * description: The rule's reference. - * reference_id: - * type: string - * title: reference_id - * description: The rule's reference id. - * name: - * type: string - * title: name - * description: The tax rate's name. + * $ref: "#/components/schemas/AdminCreateTaxRateRule" * is_default: * type: boolean * title: is_default @@ -46,10 +36,6 @@ * type: boolean * title: is_combinable * description: The tax rate's is combinable. - * tax_region_id: - * type: string - * title: tax_region_id - * description: The tax rate's tax region id. * metadata: * type: object * description: The tax rate's metadata. diff --git a/www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts b/www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts index 91cd28498c..d9a6c8449c 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts @@ -5,9 +5,6 @@ * x-schemaName: AdminCreateTaxRegion * required: * - country_code - * - province_code - * - parent_id - * - metadata * properties: * country_code: * type: string @@ -26,7 +23,6 @@ * description: The tax region's default tax rate. * required: * - name - * - metadata * properties: * rate: * type: number diff --git a/www/utils/generated/oas-output/schemas/AdminCurrency.ts b/www/utils/generated/oas-output/schemas/AdminCurrency.ts index 6bc6788622..8fcfe47e7a 100644 --- a/www/utils/generated/oas-output/schemas/AdminCurrency.ts +++ b/www/utils/generated/oas-output/schemas/AdminCurrency.ts @@ -1,74 +1,8 @@ /** * @schema AdminCurrency * type: object - * description: The currency's currencies. + * description: The supported currency's currency. * x-schemaName: AdminCurrency - * required: - * - code - * - symbol - * - symbol_native - * - name - * - decimal_digits - * - rounding - * - raw_rounding - * - created_at - * - updated_at - * - deleted_at - * properties: - * code: - * type: string - * title: code - * description: The currency's code. - * symbol: - * type: string - * title: symbol - * description: The currency's symbol. - * symbol_native: - * type: string - * title: symbol_native - * description: The currency's symbol native. - * name: - * type: string - * title: name - * description: The currency's name. - * decimal_digits: - * type: number - * title: decimal_digits - * description: The currency's decimal digits. - * rounding: - * type: number - * title: rounding - * description: The currency's rounding. - * raw_rounding: - * type: object - * description: The currency's raw rounding. - * required: - * - value - * - precision - * properties: - * value: - * type: string - * title: value - * description: The raw rounding's value. - * precision: - * type: number - * title: precision - * description: The raw rounding's precision. - * created_at: - * type: string - * format: date-time - * title: created_at - * description: The currency's created at. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The currency's updated at. - * deleted_at: - * type: string - * format: date-time - * title: deleted_at - * description: The currency's deleted at. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCurrencyListParams.ts b/www/utils/generated/oas-output/schemas/AdminCurrencyListParams.ts deleted file mode 100644 index 3ae44b5198..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminCurrencyListParams.ts +++ /dev/null @@ -1,52 +0,0 @@ -/** - * @schema AdminCurrencyListParams - * type: object - * description: SUMMARY - * x-schemaName: AdminCurrencyListParams - * properties: - * q: - * type: string - * title: q - * description: The currency's q. - * code: - * oneOf: - * - type: string - * title: code - * description: The currency's code. - * - type: array - * description: The currency's code. - * items: - * type: string - * title: code - * description: The code's details. - * limit: - * type: number - * title: limit - * description: The currency's limit. - * offset: - * type: number - * title: offset - * description: The currency's offset. - * order: - * type: string - * title: order - * description: The currency's order. - * fields: - * type: string - * title: fields - * description: The currency's fields. - * $and: - * type: array - * description: The currency's $and. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: The currency's $or. - * items: - * type: object - * title: $or - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminCurrencyParams.ts b/www/utils/generated/oas-output/schemas/AdminCurrencyParams.ts deleted file mode 100644 index 50b9f9944f..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminCurrencyParams.ts +++ /dev/null @@ -1,13 +0,0 @@ -/** - * @schema AdminCurrencyParams - * type: object - * description: SUMMARY - * x-schemaName: AdminCurrencyParams - * properties: - * fields: - * type: string - * title: fields - * description: The currency's fields. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminCustomer.ts b/www/utils/generated/oas-output/schemas/AdminCustomer.ts index 3f0e5dfa2d..57a1d300ac 100644 --- a/www/utils/generated/oas-output/schemas/AdminCustomer.ts +++ b/www/utils/generated/oas-output/schemas/AdminCustomer.ts @@ -1,7 +1,7 @@ /** * @schema AdminCustomer * type: object - * description: The customer's details. + * description: The order's customer. * x-schemaName: AdminCustomer * required: * - has_account diff --git a/www/utils/generated/oas-output/schemas/AdminCustomerGroup.ts b/www/utils/generated/oas-output/schemas/AdminCustomerGroup.ts index b6d6fea046..21f0558b5f 100644 --- a/www/utils/generated/oas-output/schemas/AdminCustomerGroup.ts +++ b/www/utils/generated/oas-output/schemas/AdminCustomerGroup.ts @@ -3,40 +3,6 @@ * type: object * description: The group's groups. * x-schemaName: AdminCustomerGroup - * required: - * - id - * - name - * - customers - * - metadata - * - created_at - * - updated_at - * properties: - * id: - * type: string - * title: id - * description: The group's ID. - * name: - * type: string - * title: name - * description: The group's name. - * customers: - * type: array - * description: The group's customers. - * items: - * $ref: "#/components/schemas/BaseCustomer" - * metadata: - * type: object - * description: The group's metadata. - * created_at: - * type: string - * format: date-time - * title: created_at - * description: The group's created at. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The group's updated at. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminDeletePaymentCollectionResponse.ts b/www/utils/generated/oas-output/schemas/AdminDeletePaymentCollectionResponse.ts new file mode 100644 index 0000000000..783f717e13 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminDeletePaymentCollectionResponse.ts @@ -0,0 +1,26 @@ +/** + * @schema AdminDeletePaymentCollectionResponse + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The payment collection's ID. + * object: + * type: string + * title: object + * description: The name of the deleted object. + * default: payment-collection + * deleted: + * type: boolean + * title: deleted + * description: Whether the payment collection was deleted. + * x-schemaName: AdminDeletePaymentCollectionResponse + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminExchange.ts b/www/utils/generated/oas-output/schemas/AdminExchange.ts index af248b4eeb..d9a5d819b9 100644 --- a/www/utils/generated/oas-output/schemas/AdminExchange.ts +++ b/www/utils/generated/oas-output/schemas/AdminExchange.ts @@ -97,7 +97,7 @@ * description: The exchange's email. * format: email * display_id: - * type: string + * type: number * title: display_id * description: The exchange's display id. * shipping_address: diff --git a/www/utils/generated/oas-output/schemas/AdminExchangeDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminExchangeDeleteResponse.ts new file mode 100644 index 0000000000..58055997dc --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminExchangeDeleteResponse.ts @@ -0,0 +1,26 @@ +/** + * @schema AdminExchangeDeleteResponse + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The exchange's ID. + * object: + * type: string + * title: object + * description: The name of the deleted object. + * default: exchange + * deleted: + * type: boolean + * title: deleted + * description: Whether the exchange was deleted. + * x-schemaName: AdminExchangeDeleteResponse + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentSet.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentSet.ts index c960988eca..78a02e7e59 100644 --- a/www/utils/generated/oas-output/schemas/AdminFulfillmentSet.ts +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentSet.ts @@ -1,8 +1,42 @@ /** * @schema AdminFulfillmentSet * type: object - * description: The fulfillment set's details. - * x-schemaName: AdminFulfillmentSet + * description: The fulfillment set that the service zone belongs to. + * properties: + * id: + * type: string + * title: id + * description: The parent's ID. + * name: + * type: string + * title: name + * description: The parent's name. + * type: + * type: string + * title: type + * description: The parent's type. + * location: + * $ref: "#/components/schemas/AdminStockLocation" + * service_zones: + * type: array + * description: The parent's service zones. + * items: + * $ref: "#/components/schemas/AdminServiceZone" + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The parent's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The parent's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The parent's deleted at. * required: * - id * - name @@ -12,41 +46,7 @@ * - created_at * - updated_at * - deleted_at - * properties: - * id: - * type: string - * title: id - * description: The fulfillment set's ID. - * name: - * type: string - * title: name - * description: The fulfillment set's name. - * type: - * type: string - * title: type - * description: The fulfillment set's type. - * location: - * $ref: "#/components/schemas/AdminStockLocation" - * service_zones: - * type: array - * description: The fulfillment set's service zones. - * items: - * $ref: "#/components/schemas/AdminServiceZone" - * created_at: - * type: string - * format: date-time - * title: created_at - * description: The fulfillment set's created at. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The fulfillment set's updated at. - * deleted_at: - * type: string - * format: date-time - * title: deleted_at - * description: The fulfillment set's deleted at. + * x-schemaName: AdminFulfillmentSet * */ diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentSetDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentSetDeleteResponse.ts index e8bc527e13..5d9ab0b829 100644 --- a/www/utils/generated/oas-output/schemas/AdminFulfillmentSetDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentSetDeleteResponse.ts @@ -21,9 +21,6 @@ * type: boolean * title: deleted * description: Whether the Fulfillment Set was deleted. - * parent: - * type: object - * description: The fulfillment set's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminGetUploadParams.ts b/www/utils/generated/oas-output/schemas/AdminGetUploadParams.ts deleted file mode 100644 index 58057e508a..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminGetUploadParams.ts +++ /dev/null @@ -1,13 +0,0 @@ -/** - * @schema AdminGetUploadParams - * type: object - * description: SUMMARY - * x-schemaName: AdminGetUploadParams - * properties: - * fields: - * type: string - * title: fields - * description: The upload's fields. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminInventoryItem.ts b/www/utils/generated/oas-output/schemas/AdminInventoryItem.ts index 2b698103de..a61bce0c7a 100644 --- a/www/utils/generated/oas-output/schemas/AdminInventoryItem.ts +++ b/www/utils/generated/oas-output/schemas/AdminInventoryItem.ts @@ -66,6 +66,11 @@ * metadata: * type: object * description: The inventory item's metadata. + * location_levels: + * type: array + * description: The inventory item's location levels. + * items: + * $ref: "#/components/schemas/AdminInventoryLevel" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminInventoryLevel.ts b/www/utils/generated/oas-output/schemas/AdminInventoryLevel.ts new file mode 100644 index 0000000000..05da3ae4ac --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminInventoryLevel.ts @@ -0,0 +1,81 @@ +/** + * @schema AdminInventoryLevel + * type: object + * description: The location level's location levels. + * x-schemaName: AdminInventoryLevel + * required: + * - id + * - created_at + * - updated_at + * - deleted_at + * - inventory_item_id + * - location_id + * - stocked_quantity + * - raw_stocked_quantity + * - reserved_quantity + * - raw_reserved_quantity + * - incoming_quantity + * - raw_incoming_quantity + * - metadata + * - available_quantity + * properties: + * id: + * type: string + * title: id + * description: The location level's ID. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The location level's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The location level's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The location level's deleted at. + * inventory_item_id: + * type: string + * title: inventory_item_id + * description: The location level's inventory item id. + * location_id: + * type: string + * title: location_id + * description: The location level's location id. + * stocked_quantity: + * type: number + * title: stocked_quantity + * description: The location level's stocked quantity. + * raw_stocked_quantity: + * type: object + * description: The location level's raw stocked quantity. + * reserved_quantity: + * type: number + * title: reserved_quantity + * description: The location level's reserved quantity. + * raw_reserved_quantity: + * type: object + * description: The location level's raw reserved quantity. + * incoming_quantity: + * type: number + * title: incoming_quantity + * description: The location level's incoming quantity. + * raw_incoming_quantity: + * type: object + * description: The location level's raw incoming quantity. + * metadata: + * type: object + * description: The location level's metadata. + * inventory_item: + * $ref: "#/components/schemas/AdminInventoryItem" + * available_quantity: + * type: number + * title: available_quantity + * description: The location level's available quantity. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminOrder.ts b/www/utils/generated/oas-output/schemas/AdminOrder.ts index 52f34d4294..1a5024fcc2 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrder.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrder.ts @@ -53,6 +53,14 @@ * description: The order's fulfillments. * items: * $ref: "#/components/schemas/BaseOrderFulfillment" + * sales_channel: + * $ref: "#/components/schemas/AdminSalesChannel" + * customer: + * $ref: "#/components/schemas/AdminCustomer" + * shipping_address: + * $ref: "#/components/schemas/AdminOrderAddress" + * billing_address: + * $ref: "#/components/schemas/AdminOrderAddress" * id: * type: string * title: id @@ -83,13 +91,9 @@ * title: currency_code * description: The order's currency code. * display_id: - * type: string + * type: number * title: display_id * description: The order's display id. - * shipping_address: - * $ref: "#/components/schemas/BaseOrderAddress" - * billing_address: - * $ref: "#/components/schemas/BaseOrderAddress" * items: * type: array * description: The order's items. diff --git a/www/utils/generated/oas-output/schemas/AdminOrderAddress.ts b/www/utils/generated/oas-output/schemas/AdminOrderAddress.ts new file mode 100644 index 0000000000..6b17577f6d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminOrderAddress.ts @@ -0,0 +1,77 @@ +/** + * @schema AdminOrderAddress + * type: object + * description: The order's billing address. + * x-schemaName: AdminOrderAddress + * required: + * - id + * - metadata + * - created_at + * - updated_at + * properties: + * country: + * $ref: "#/components/schemas/AdminRegionCountry" + * id: + * type: string + * title: id + * description: The billing address's ID. + * customer_id: + * type: string + * title: customer_id + * description: The billing address's customer id. + * first_name: + * type: string + * title: first_name + * description: The billing address's first name. + * last_name: + * type: string + * title: last_name + * description: The billing address's last name. + * phone: + * type: string + * title: phone + * description: The billing address's phone. + * company: + * type: string + * title: company + * description: The billing address's company. + * address_1: + * type: string + * title: address_1 + * description: The billing address's address 1. + * address_2: + * type: string + * title: address_2 + * description: The billing address's address 2. + * city: + * type: string + * title: city + * description: The billing address's city. + * country_code: + * type: string + * title: country_code + * description: The billing address's country code. + * province: + * type: string + * title: province + * description: The billing address's province. + * postal_code: + * type: string + * title: postal_code + * description: The billing address's postal code. + * metadata: + * type: object + * description: The billing address's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The billing address's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The billing address's updated at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts index 2818d91362..b5714ed429 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts @@ -493,13 +493,13 @@ * description: The order preview's email. * format: email * display_id: - * type: string + * type: number * title: display_id * description: The order preview's display id. * shipping_address: - * $ref: "#/components/schemas/BaseOrderAddress" + * $ref: "#/components/schemas/AdminOrderAddress" * billing_address: - * $ref: "#/components/schemas/BaseOrderAddress" + * $ref: "#/components/schemas/AdminOrderAddress" * payment_collections: * type: array * description: The order preview's payment collections. @@ -644,6 +644,10 @@ * type: number * title: original_shipping_tax_total * description: The order preview's original shipping tax total. + * customer: + * $ref: "#/components/schemas/AdminCustomer" + * sales_channel: + * $ref: "#/components/schemas/AdminSalesChannel" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPriceListDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminPriceListDeleteResponse.ts index f964ec8b00..9f3150fdf2 100644 --- a/www/utils/generated/oas-output/schemas/AdminPriceListDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminPriceListDeleteResponse.ts @@ -21,9 +21,6 @@ * type: boolean * title: deleted * description: Whether the Price List was deleted. - * parent: - * type: object - * description: The price list's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPricePreferenceDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminPricePreferenceDeleteResponse.ts index d8468b2790..b381e26d09 100644 --- a/www/utils/generated/oas-output/schemas/AdminPricePreferenceDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminPricePreferenceDeleteResponse.ts @@ -21,9 +21,6 @@ * type: boolean * title: deleted * description: Whether the Price Preference was deleted. - * parent: - * type: object - * description: The price preference's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProduct.ts b/www/utils/generated/oas-output/schemas/AdminProduct.ts index 63eb8a91fa..dcf165aa79 100644 --- a/www/utils/generated/oas-output/schemas/AdminProduct.ts +++ b/www/utils/generated/oas-output/schemas/AdminProduct.ts @@ -5,9 +5,9 @@ * x-schemaName: AdminProduct * required: * - type + * - length * - title * - status - * - length * - options * - description * - id @@ -55,6 +55,10 @@ * description: The parent's tags. * items: * $ref: "#/components/schemas/AdminProductTag" + * length: + * type: number + * title: length + * description: The parent's length. * title: * type: string * title: title @@ -67,10 +71,6 @@ * - proposed * - published * - rejected - * length: - * type: number - * title: length - * description: The parent's length. * options: * type: array * description: The parent's options. diff --git a/www/utils/generated/oas-output/schemas/AdminProductCategoryDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductCategoryDeleteResponse.ts index 30f442f47c..d14e2ce6eb 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductCategoryDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductCategoryDeleteResponse.ts @@ -21,9 +21,6 @@ * type: boolean * title: deleted * description: Whether the Product Category was deleted. - * parent: - * type: object - * description: The product category's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProductDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductDeleteResponse.ts index 047cba8a74..c51fd0c13c 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductDeleteResponse.ts @@ -21,9 +21,6 @@ * type: boolean * title: deleted * description: Whether the Product was deleted. - * parent: - * type: object - * description: The product's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProductOptionDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductOptionDeleteResponse.ts index 601762d788..a4b291f1c2 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductOptionDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductOptionDeleteResponse.ts @@ -16,7 +16,6 @@ * type: string * title: object * description: The name of the deleted object. - * default: product_option * deleted: * type: boolean * title: deleted diff --git a/www/utils/generated/oas-output/schemas/AdminProductTagDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductTagDeleteResponse.ts index 28de610682..8aa2b620e1 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductTagDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductTagDeleteResponse.ts @@ -21,9 +21,6 @@ * type: boolean * title: deleted * description: Whether the Product Tag was deleted. - * parent: - * type: object - * description: The product tag's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProductTypeDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductTypeDeleteResponse.ts index 25bc201c10..9b11684116 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductTypeDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductTypeDeleteResponse.ts @@ -21,9 +21,6 @@ * type: boolean * title: deleted * description: Whether the Product Type was deleted. - * parent: - * type: object - * description: The product type's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariantDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductVariantDeleteResponse.ts index 31160a047f..c2d4331ef5 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductVariantDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductVariantDeleteResponse.ts @@ -16,7 +16,6 @@ * type: string * title: object * description: The name of the deleted object. - * default: variant * deleted: * type: boolean * title: deleted diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts b/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts index fac8d344fa..3775971bbb 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts @@ -19,31 +19,359 @@ * type: string * title: id * description: The id's ID. - * sku: - * oneOf: - * - type: string - * title: sku - * description: The variant's sku. - * - type: array - * description: The variant's sku. - * items: - * type: string - * title: sku - * description: The sku's details. - * product_id: - * oneOf: - * - type: string - * title: product_id - * description: The variant's product id. - * - type: array - * description: The variant's product id. - * items: - * type: string - * title: product_id - * description: The product id's details. - * options: + * manage_inventory: + * type: boolean + * title: manage_inventory + * description: The variant's manage inventory. + * allow_backorder: + * type: boolean + * title: allow_backorder + * description: The variant's allow backorder. + * created_at: * type: object - * description: The variant's options. + * description: The variant'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. + * - 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 variant'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. + * - 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 variant'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. + * - 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 @@ -62,13 +390,13 @@ * description: The variant's fields. * $and: * type: array - * description: The variant'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 variant'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/AdminRegionCountry.ts b/www/utils/generated/oas-output/schemas/AdminRegionCountry.ts new file mode 100644 index 0000000000..e722d35718 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminRegionCountry.ts @@ -0,0 +1,8 @@ +/** + * @schema AdminRegionCountry + * type: object + * description: The billing address's country. + * x-schemaName: AdminRegionCountry + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminReservation.ts b/www/utils/generated/oas-output/schemas/AdminReservation.ts index 6af38056bf..84e52568c6 100644 --- a/www/utils/generated/oas-output/schemas/AdminReservation.ts +++ b/www/utils/generated/oas-output/schemas/AdminReservation.ts @@ -26,7 +26,7 @@ * title: location_id * description: The reservation's location id. * quantity: - * type: string + * type: number * title: quantity * description: The reservation's quantity. * external_id: diff --git a/www/utils/generated/oas-output/schemas/AdminReturnReasonDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminReturnReasonDeleteResponse.ts new file mode 100644 index 0000000000..a4a2a4c1fc --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminReturnReasonDeleteResponse.ts @@ -0,0 +1,26 @@ +/** + * @schema AdminReturnReasonDeleteResponse + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The return reason's ID. + * object: + * type: string + * title: object + * description: The name of the deleted object. + * default: return_reason + * deleted: + * type: boolean + * title: deleted + * description: Whether the return reason was deleted. + * x-schemaName: AdminReturnReasonDeleteResponse + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminSalesChannel.ts b/www/utils/generated/oas-output/schemas/AdminSalesChannel.ts index ddae7a3a2c..009aa1299f 100644 --- a/www/utils/generated/oas-output/schemas/AdminSalesChannel.ts +++ b/www/utils/generated/oas-output/schemas/AdminSalesChannel.ts @@ -1,7 +1,7 @@ /** * @schema AdminSalesChannel * type: object - * description: The sales channel's sales channels. + * description: The order's sales channel. * x-schemaName: AdminSalesChannel * required: * - id diff --git a/www/utils/generated/oas-output/schemas/AdminSalesChannelDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminSalesChannelDeleteResponse.ts index feaaa675ea..49e39846ad 100644 --- a/www/utils/generated/oas-output/schemas/AdminSalesChannelDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminSalesChannelDeleteResponse.ts @@ -21,9 +21,6 @@ * type: boolean * title: deleted * description: Whether the Sales Channel was deleted. - * parent: - * type: object - * description: The sales channel's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminServiceZoneDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminServiceZoneDeleteResponse.ts new file mode 100644 index 0000000000..3d47af985d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminServiceZoneDeleteResponse.ts @@ -0,0 +1,28 @@ +/** + * @schema AdminServiceZoneDeleteResponse + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The service zone'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. + * parent: + * $ref: "#/components/schemas/AdminFulfillmentSet" + * x-schemaName: AdminServiceZoneDeleteResponse + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminShippingOptionDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminShippingOptionDeleteResponse.ts index 6e423860cc..45471665c2 100644 --- a/www/utils/generated/oas-output/schemas/AdminShippingOptionDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminShippingOptionDeleteResponse.ts @@ -21,9 +21,6 @@ * type: boolean * title: deleted * description: Whether the Shipping Option was deleted. - * parent: - * type: object - * description: The shipping option's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminShippingProfileDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminShippingProfileDeleteResponse.ts index 570fc3e1a4..eab4f24896 100644 --- a/www/utils/generated/oas-output/schemas/AdminShippingProfileDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminShippingProfileDeleteResponse.ts @@ -21,9 +21,6 @@ * type: boolean * title: deleted * description: Whether the Shipping Profile was deleted. - * parent: - * type: object - * description: The shipping profile's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminStockLocation.ts b/www/utils/generated/oas-output/schemas/AdminStockLocation.ts index 416b6e1fb0..06956ca356 100644 --- a/www/utils/generated/oas-output/schemas/AdminStockLocation.ts +++ b/www/utils/generated/oas-output/schemas/AdminStockLocation.ts @@ -1,7 +1,7 @@ /** * @schema AdminStockLocation * type: object - * description: The fulfillment set's location. + * description: The parent's location. * x-schemaName: AdminStockLocation * required: * - id diff --git a/www/utils/generated/oas-output/schemas/AdminStockLocationDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminStockLocationDeleteResponse.ts index 66aee30ea5..53ab03d2b8 100644 --- a/www/utils/generated/oas-output/schemas/AdminStockLocationDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminStockLocationDeleteResponse.ts @@ -21,9 +21,6 @@ * type: boolean * title: deleted * description: Whether the Stock Location was deleted. - * parent: - * type: object - * description: The stock location's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminTaxRate.ts b/www/utils/generated/oas-output/schemas/AdminTaxRate.ts index f600bcf4f4..fddfe277cb 100644 --- a/www/utils/generated/oas-output/schemas/AdminTaxRate.ts +++ b/www/utils/generated/oas-output/schemas/AdminTaxRate.ts @@ -1,7 +1,7 @@ /** * @schema AdminTaxRate * type: object - * description: The tax rate's details. + * description: The tax rate's parent. * x-schemaName: AdminTaxRate * required: * - id @@ -22,58 +22,58 @@ * id: * type: string * title: id - * description: The tax rate's ID. + * description: The parent's ID. * rate: * type: number * title: rate - * description: The tax rate's rate. + * description: The parent's rate. * code: * type: string * title: code - * description: The tax rate's code. + * description: The parent's code. * name: * type: string * title: name - * description: The tax rate's name. + * description: The parent's name. * metadata: * type: object - * description: The tax rate's metadata. + * description: The parent's metadata. * tax_region_id: * type: string * title: tax_region_id - * description: The tax rate's tax region id. + * description: The parent's tax region id. * is_combinable: * type: boolean * title: is_combinable - * description: The tax rate's is combinable. + * description: The parent's is combinable. * is_default: * type: boolean * title: is_default - * description: The tax rate's is default. + * description: The parent's is default. * created_at: * type: string * format: date-time * title: created_at - * description: The tax rate's created at. + * description: The parent's created at. * updated_at: * type: string * format: date-time * title: updated_at - * description: The tax rate's updated at. + * description: The parent's updated at. * deleted_at: * type: string * format: date-time * title: deleted_at - * description: The tax rate's deleted at. + * description: The parent's deleted at. * created_by: * type: string * title: created_by - * description: The tax rate's created by. + * description: The parent's created by. * tax_region: * $ref: "#/components/schemas/AdminTaxRegion" * rules: * type: array - * description: The tax rate's rules. + * description: The parent's rules. * items: * $ref: "#/components/schemas/AdminTaxRateRule" * diff --git a/www/utils/generated/oas-output/schemas/AdminTaxRateDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminTaxRateDeleteResponse.ts index 2e82eddd96..d616a2b6e7 100644 --- a/www/utils/generated/oas-output/schemas/AdminTaxRateDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminTaxRateDeleteResponse.ts @@ -21,9 +21,6 @@ * type: boolean * title: deleted * description: Whether the Tax Rate was deleted. - * parent: - * type: object - * description: The tax rate's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminTaxRegion.ts b/www/utils/generated/oas-output/schemas/AdminTaxRegion.ts index 604a353638..6c39aeee90 100644 --- a/www/utils/generated/oas-output/schemas/AdminTaxRegion.ts +++ b/www/utils/generated/oas-output/schemas/AdminTaxRegion.ts @@ -1,7 +1,7 @@ /** * @schema AdminTaxRegion * type: object - * description: The tax rate's tax region. + * description: The parent's tax region. * x-schemaName: AdminTaxRegion * required: * - id diff --git a/www/utils/generated/oas-output/schemas/AdminTaxRegionDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminTaxRegionDeleteResponse.ts index 31c4ec4736..9636a80cf7 100644 --- a/www/utils/generated/oas-output/schemas/AdminTaxRegionDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminTaxRegionDeleteResponse.ts @@ -21,9 +21,6 @@ * type: boolean * title: deleted * description: Whether the Tax Region was deleted. - * parent: - * type: object - * description: The tax region's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpsertStockLocationAddress.ts b/www/utils/generated/oas-output/schemas/AdminUpsertStockLocationAddress.ts new file mode 100644 index 0000000000..3471858e00 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpsertStockLocationAddress.ts @@ -0,0 +1,44 @@ +/** + * @schema AdminUpsertStockLocationAddress + * type: object + * description: The stock location's address. + * x-schemaName: AdminUpsertStockLocationAddress + * required: + * - address_1 + * - country_code + * properties: + * address_1: + * type: string + * title: address_1 + * description: The address's address 1. + * address_2: + * type: string + * title: address_2 + * description: The address's address 2. + * company: + * type: string + * title: company + * description: The address's company. + * country_code: + * type: string + * title: country_code + * description: The address's country code. + * city: + * type: string + * title: city + * description: The address's city. + * phone: + * type: string + * title: phone + * description: The address's phone. + * postal_code: + * type: string + * title: postal_code + * description: The address's postal code. + * province: + * type: string + * title: province + * description: The address's province. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUserDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminUserDeleteResponse.ts index ae11ddfbb9..e06ed5ce9a 100644 --- a/www/utils/generated/oas-output/schemas/AdminUserDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminUserDeleteResponse.ts @@ -21,9 +21,6 @@ * type: boolean * title: deleted * description: Whether the User was deleted. - * parent: - * type: object - * description: The user's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/BaseCartAddress.ts b/www/utils/generated/oas-output/schemas/BaseCartAddress.ts index 4fff43dbda..4df85ce410 100644 --- a/www/utils/generated/oas-output/schemas/BaseCartAddress.ts +++ b/www/utils/generated/oas-output/schemas/BaseCartAddress.ts @@ -1,7 +1,7 @@ /** * @schema BaseCartAddress * type: object - * description: The cart's billing address. + * description: The parent's billing address. * x-schemaName: BaseCartAddress * required: * - id diff --git a/www/utils/generated/oas-output/schemas/BaseCustomer.ts b/www/utils/generated/oas-output/schemas/BaseCustomer.ts deleted file mode 100644 index 6e4892a837..0000000000 --- a/www/utils/generated/oas-output/schemas/BaseCustomer.ts +++ /dev/null @@ -1,8 +0,0 @@ -/** - * @schema BaseCustomer - * type: object - * description: The customer's customers. - * x-schemaName: BaseCustomer - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/BaseCustomerAddress.ts b/www/utils/generated/oas-output/schemas/BaseCustomerAddress.ts index be689289cf..3a1ff4e83e 100644 --- a/www/utils/generated/oas-output/schemas/BaseCustomerAddress.ts +++ b/www/utils/generated/oas-output/schemas/BaseCustomerAddress.ts @@ -3,99 +3,6 @@ * type: object * description: The address's addresses. * x-schemaName: BaseCustomerAddress - * required: - * - id - * - address_name - * - is_default_shipping - * - is_default_billing - * - customer_id - * - company - * - first_name - * - last_name - * - address_1 - * - address_2 - * - city - * - country_code - * - province - * - postal_code - * - phone - * - metadata - * - created_at - * - updated_at - * properties: - * id: - * type: string - * title: id - * description: The address's ID. - * address_name: - * type: string - * title: address_name - * description: The address's address name. - * is_default_shipping: - * type: boolean - * title: is_default_shipping - * description: The address's is default shipping. - * is_default_billing: - * type: boolean - * title: is_default_billing - * description: The address's is default billing. - * customer_id: - * type: string - * title: customer_id - * description: The address's customer id. - * company: - * type: string - * title: company - * description: The address's company. - * first_name: - * type: string - * title: first_name - * description: The address's first name. - * last_name: - * type: string - * title: last_name - * description: The address's last name. - * address_1: - * type: string - * title: address_1 - * description: The address's address 1. - * address_2: - * type: string - * title: address_2 - * description: The address's address 2. - * city: - * type: string - * title: city - * description: The address's city. - * country_code: - * type: string - * title: country_code - * description: The address's country code. - * province: - * type: string - * title: province - * description: The address's province. - * postal_code: - * type: string - * title: postal_code - * description: The address's postal code. - * phone: - * type: string - * title: phone - * description: The address's phone. - * metadata: - * type: object - * description: The address's metadata. - * created_at: - * type: string - * format: date-time - * title: created_at - * description: The address's created at. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The address's updated at. * */ diff --git a/www/utils/generated/oas-output/schemas/BaseOrderAddress.ts b/www/utils/generated/oas-output/schemas/BaseOrderAddress.ts index 43884cde72..bd04252f47 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrderAddress.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrderAddress.ts @@ -1,7 +1,7 @@ /** * @schema BaseOrderAddress * type: object - * description: The order's billing address. + * description: The exchange's billing address. * x-schemaName: BaseOrderAddress * required: * - id diff --git a/www/utils/generated/oas-output/schemas/BaseRegion.ts b/www/utils/generated/oas-output/schemas/BaseRegion.ts index 8f3b04a722..de59008442 100644 --- a/www/utils/generated/oas-output/schemas/BaseRegion.ts +++ b/www/utils/generated/oas-output/schemas/BaseRegion.ts @@ -1,7 +1,7 @@ /** * @schema BaseRegion * type: object - * description: The cart's region. + * description: The parent's region. * x-schemaName: BaseRegion * required: * - id diff --git a/www/utils/generated/oas-output/schemas/FileList.ts b/www/utils/generated/oas-output/schemas/FileList.ts new file mode 100644 index 0000000000..882cf8fd41 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/FileList.ts @@ -0,0 +1,23 @@ +/** + * @schema FileList + * type: object + * description: SUMMARY + * x-schemaName: FileList + * required: + * - length + * - item + * - __@iterator@258 + * properties: + * length: + * type: number + * title: length + * description: The upload's length. + * item: + * type: object + * description: The upload's item. + * __@iterator@258: + * type: object + * description: The upload's @iterator@258. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCart.ts b/www/utils/generated/oas-output/schemas/StoreCart.ts index 205ce9fc88..c2a5b92590 100644 --- a/www/utils/generated/oas-output/schemas/StoreCart.ts +++ b/www/utils/generated/oas-output/schemas/StoreCart.ts @@ -1,7 +1,7 @@ /** * @schema StoreCart * type: object - * description: The cart's details. + * description: The cart's parent. * x-schemaName: StoreCart * required: * - id @@ -32,322 +32,322 @@ * id: * type: string * title: id - * description: The cart's ID. + * description: The parent's ID. * region: * $ref: "#/components/schemas/BaseRegion" * region_id: * type: string * title: region_id - * description: The cart's region id. + * description: The parent's region id. * customer_id: * type: string * title: customer_id - * description: The cart's customer id. + * description: The parent's customer id. * sales_channel_id: * type: string * title: sales_channel_id - * description: The cart's sales channel id. + * description: The parent's sales channel id. * email: * type: string * title: email - * description: The cart's email. + * description: The parent's email. * format: email * currency_code: * type: string * title: currency_code - * description: The cart's currency code. + * description: The parent's currency code. * shipping_address: * $ref: "#/components/schemas/BaseCartAddress" * billing_address: * $ref: "#/components/schemas/BaseCartAddress" * items: * type: array - * description: The cart's items. + * description: The parent's items. * items: * $ref: "#/components/schemas/BaseCartLineItem" * shipping_methods: * type: array - * description: The cart's shipping methods. + * description: The parent's shipping methods. * items: * $ref: "#/components/schemas/BaseCartShippingMethod" * payment_collection: * $ref: "#/components/schemas/BasePaymentCollection" * metadata: * type: object - * description: The cart's metadata. + * description: The parent's metadata. * created_at: * type: string * format: date-time * title: created_at - * description: The cart's created at. + * description: The parent's created at. * updated_at: * type: string * format: date-time * title: updated_at - * description: The cart's updated at. + * description: The parent's updated at. * original_item_total: * oneOf: * - type: string * title: original_item_total - * description: The cart's original item total. + * description: The parent's original item total. * - type: number * title: original_item_total - * description: The cart's original item total. + * description: The parent's original item total. * - type: string * title: original_item_total - * description: The cart's original item total. + * description: The parent's original item total. * - $ref: "#/components/schemas/IBigNumber" * original_item_subtotal: * oneOf: * - type: string * title: original_item_subtotal - * description: The cart's original item subtotal. + * description: The parent's original item subtotal. * - type: number * title: original_item_subtotal - * description: The cart's original item subtotal. + * description: The parent's original item subtotal. * - type: string * title: original_item_subtotal - * description: The cart's original item subtotal. + * description: The parent's original item subtotal. * - $ref: "#/components/schemas/IBigNumber" * original_item_tax_total: * oneOf: * - type: string * title: original_item_tax_total - * description: The cart's original item tax total. + * description: The parent's original item tax total. * - type: number * title: original_item_tax_total - * description: The cart's original item tax total. + * description: The parent's original item tax total. * - type: string * title: original_item_tax_total - * description: The cart's original item tax total. + * description: The parent's original item tax total. * - $ref: "#/components/schemas/IBigNumber" * item_total: * oneOf: * - type: string * title: item_total - * description: The cart's item total. + * description: The parent's item total. * - type: number * title: item_total - * description: The cart's item total. + * description: The parent's item total. * - type: string * title: item_total - * description: The cart's item total. + * description: The parent's item total. * - $ref: "#/components/schemas/IBigNumber" * item_subtotal: * oneOf: * - type: string * title: item_subtotal - * description: The cart's item subtotal. + * description: The parent's item subtotal. * - type: number * title: item_subtotal - * description: The cart's item subtotal. + * description: The parent's item subtotal. * - type: string * title: item_subtotal - * description: The cart's item subtotal. + * description: The parent's item subtotal. * - $ref: "#/components/schemas/IBigNumber" * item_tax_total: * oneOf: * - type: string * title: item_tax_total - * description: The cart's item tax total. + * description: The parent's item tax total. * - type: number * title: item_tax_total - * description: The cart's item tax total. + * description: The parent's item tax total. * - type: string * title: item_tax_total - * description: The cart's item tax total. + * description: The parent's item tax total. * - $ref: "#/components/schemas/IBigNumber" * original_total: * oneOf: * - type: string * title: original_total - * description: The cart's original total. + * description: The parent's original total. * - type: number * title: original_total - * description: The cart's original total. + * description: The parent's original total. * - type: string * title: original_total - * description: The cart's original total. + * description: The parent's original total. * - $ref: "#/components/schemas/IBigNumber" * original_subtotal: * oneOf: * - type: string * title: original_subtotal - * description: The cart's original subtotal. + * description: The parent's original subtotal. * - type: number * title: original_subtotal - * description: The cart's original subtotal. + * description: The parent's original subtotal. * - type: string * title: original_subtotal - * description: The cart's original subtotal. + * description: The parent's original subtotal. * - $ref: "#/components/schemas/IBigNumber" * original_tax_total: * oneOf: * - type: string * title: original_tax_total - * description: The cart's original tax total. + * description: The parent's original tax total. * - type: number * title: original_tax_total - * description: The cart's original tax total. + * description: The parent's original tax total. * - type: string * title: original_tax_total - * description: The cart's original tax total. + * description: The parent's original tax total. * - $ref: "#/components/schemas/IBigNumber" * total: * oneOf: * - type: string * title: total - * description: The cart's total. + * description: The parent's total. * - type: number * title: total - * description: The cart's total. + * description: The parent's total. * - type: string * title: total - * description: The cart's total. + * description: The parent's total. * - $ref: "#/components/schemas/IBigNumber" * subtotal: * oneOf: * - type: string * title: subtotal - * description: The cart's subtotal. + * description: The parent's subtotal. * - type: number * title: subtotal - * description: The cart's subtotal. + * description: The parent's subtotal. * - type: string * title: subtotal - * description: The cart's subtotal. + * description: The parent's subtotal. * - $ref: "#/components/schemas/IBigNumber" * tax_total: * oneOf: * - type: string * title: tax_total - * description: The cart's tax total. + * description: The parent's tax total. * - type: number * title: tax_total - * description: The cart's tax total. + * description: The parent's tax total. * - type: string * title: tax_total - * description: The cart's tax total. + * description: The parent's tax total. * - $ref: "#/components/schemas/IBigNumber" * discount_total: * oneOf: * - type: string * title: discount_total - * description: The cart's discount total. + * description: The parent's discount total. * - type: number * title: discount_total - * description: The cart's discount total. + * description: The parent's discount total. * - type: string * title: discount_total - * description: The cart's discount total. + * description: The parent's discount total. * - $ref: "#/components/schemas/IBigNumber" * discount_tax_total: * oneOf: * - type: string * title: discount_tax_total - * description: The cart's discount tax total. + * description: The parent's discount tax total. * - type: number * title: discount_tax_total - * description: The cart's discount tax total. + * description: The parent's discount tax total. * - type: string * title: discount_tax_total - * description: The cart's discount tax total. + * description: The parent's discount tax total. * - $ref: "#/components/schemas/IBigNumber" * gift_card_total: * oneOf: * - type: string * title: gift_card_total - * description: The cart's gift card total. + * description: The parent's gift card total. * - type: number * title: gift_card_total - * description: The cart's gift card total. + * description: The parent's gift card total. * - type: string * title: gift_card_total - * description: The cart's gift card total. + * description: The parent's gift card total. * - $ref: "#/components/schemas/IBigNumber" * gift_card_tax_total: * oneOf: * - type: string * title: gift_card_tax_total - * description: The cart's gift card tax total. + * description: The parent's gift card tax total. * - type: number * title: gift_card_tax_total - * description: The cart's gift card tax total. + * description: The parent's gift card tax total. * - type: string * title: gift_card_tax_total - * description: The cart's gift card tax total. + * description: The parent's gift card tax total. * - $ref: "#/components/schemas/IBigNumber" * shipping_total: * oneOf: * - type: string * title: shipping_total - * description: The cart's shipping total. + * description: The parent's shipping total. * - type: number * title: shipping_total - * description: The cart's shipping total. + * description: The parent's shipping total. * - type: string * title: shipping_total - * description: The cart's shipping total. + * description: The parent's shipping total. * - $ref: "#/components/schemas/IBigNumber" * shipping_subtotal: * oneOf: * - type: string * title: shipping_subtotal - * description: The cart's shipping subtotal. + * description: The parent's shipping subtotal. * - type: number * title: shipping_subtotal - * description: The cart's shipping subtotal. + * description: The parent's shipping subtotal. * - type: string * title: shipping_subtotal - * description: The cart's shipping subtotal. + * description: The parent's shipping subtotal. * - $ref: "#/components/schemas/IBigNumber" * shipping_tax_total: * oneOf: * - type: string * title: shipping_tax_total - * description: The cart's shipping tax total. + * description: The parent's shipping tax total. * - type: number * title: shipping_tax_total - * description: The cart's shipping tax total. + * description: The parent's shipping tax total. * - type: string * title: shipping_tax_total - * description: The cart's shipping tax total. + * description: The parent's shipping tax total. * - $ref: "#/components/schemas/IBigNumber" * original_shipping_total: * oneOf: * - type: string * title: original_shipping_total - * description: The cart's original shipping total. + * description: The parent's original shipping total. * - type: number * title: original_shipping_total - * description: The cart's original shipping total. + * description: The parent's original shipping total. * - type: string * title: original_shipping_total - * description: The cart's original shipping total. + * description: The parent's original shipping total. * - $ref: "#/components/schemas/IBigNumber" * original_shipping_subtotal: * oneOf: * - type: string * title: original_shipping_subtotal - * description: The cart's original shipping subtotal. + * description: The parent's original shipping subtotal. * - type: number * title: original_shipping_subtotal - * description: The cart's original shipping subtotal. + * description: The parent's original shipping subtotal. * - type: string * title: original_shipping_subtotal - * description: The cart's original shipping subtotal. + * description: The parent's original shipping subtotal. * - $ref: "#/components/schemas/IBigNumber" * original_shipping_tax_total: * oneOf: * - type: string * title: original_shipping_tax_total - * description: The cart's original shipping tax total. + * description: The parent's original shipping tax total. * - type: number * title: original_shipping_tax_total - * description: The cart's original shipping tax total. + * description: The parent's original shipping tax total. * - type: string * title: original_shipping_tax_total - * description: The cart's original shipping tax total. + * description: The parent's original shipping tax total. * - $ref: "#/components/schemas/IBigNumber" * */ diff --git a/www/utils/generated/oas-output/schemas/StoreCreateCustomer.ts b/www/utils/generated/oas-output/schemas/StoreCreateCustomer.ts index ed029e9288..582aa428de 100644 --- a/www/utils/generated/oas-output/schemas/StoreCreateCustomer.ts +++ b/www/utils/generated/oas-output/schemas/StoreCreateCustomer.ts @@ -5,10 +5,6 @@ * x-schemaName: StoreCreateCustomer * required: * - email - * - company_name - * - first_name - * - last_name - * - phone * properties: * email: * type: string @@ -31,6 +27,9 @@ * type: string * title: phone * description: The customer's phone. + * metadata: + * type: object + * description: The customer's metadata. * */ diff --git a/www/utils/generated/oas-output/schemas/StoreCreatePaymentCollection.ts b/www/utils/generated/oas-output/schemas/StoreCreatePaymentCollection.ts new file mode 100644 index 0000000000..ab5f682b86 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCreatePaymentCollection.ts @@ -0,0 +1,15 @@ +/** + * @schema StoreCreatePaymentCollection + * type: object + * description: SUMMARY + * required: + * - cart_id + * properties: + * cart_id: + * type: string + * title: cart_id + * description: The payment collection's cart id. + * x-schemaName: StoreCreatePaymentCollection + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCreateReturn.ts b/www/utils/generated/oas-output/schemas/StoreCreateReturn.ts new file mode 100644 index 0000000000..765095fa71 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCreateReturn.ts @@ -0,0 +1,36 @@ +/** + * @schema StoreCreateReturn + * type: object + * description: SUMMARY + * x-schemaName: StoreCreateReturn + * required: + * - order_id + * - items + * - return_shipping + * properties: + * order_id: + * type: string + * title: order_id + * description: The return's order id. + * items: + * type: array + * description: The return's items. + * items: + * $ref: "#/components/schemas/StoreCreateReturnItem" + * return_shipping: + * $ref: "#/components/schemas/StoreCreateReturnShipping" + * note: + * type: string + * title: note + * description: The return's note. + * receive_now: + * type: boolean + * title: receive_now + * description: The return's receive now. + * location_id: + * type: string + * title: location_id + * description: The return's location id. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCreateReturnItem.ts b/www/utils/generated/oas-output/schemas/StoreCreateReturnItem.ts new file mode 100644 index 0000000000..ee4419204d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCreateReturnItem.ts @@ -0,0 +1,28 @@ +/** + * @schema StoreCreateReturnItem + * type: object + * description: The item's items. + * required: + * - id + * - quantity + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * reason_id: + * type: string + * title: reason_id + * description: The item's reason id. + * note: + * 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 new file mode 100644 index 0000000000..bddc09fe3f --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCreateReturnShipping.ts @@ -0,0 +1,19 @@ +/** + * @schema StoreCreateReturnShipping + * type: object + * description: The return's return shipping. + * required: + * - option_id + * properties: + * option_id: + * type: string + * title: option_id + * description: The return shipping's option id. + * price: + * type: number + * title: price + * description: The return shipping's price. + * x-schemaName: StoreCreateReturnShipping + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCustomer.ts b/www/utils/generated/oas-output/schemas/StoreCustomer.ts index 1e56d68407..11cdb9bcdd 100644 --- a/www/utils/generated/oas-output/schemas/StoreCustomer.ts +++ b/www/utils/generated/oas-output/schemas/StoreCustomer.ts @@ -1,7 +1,7 @@ /** * @schema StoreCustomer * type: object - * description: The customer's details. + * description: The customer's parent. * x-schemaName: StoreCustomer * required: * - id @@ -16,63 +16,63 @@ * id: * type: string * title: id - * description: The customer's ID. + * description: The parent's ID. * email: * type: string * title: email - * description: The customer's email. + * description: The parent's email. * format: email * default_billing_address_id: * type: string * title: default_billing_address_id - * description: The customer's default billing address id. + * description: The parent's default billing address id. * default_shipping_address_id: * type: string * title: default_shipping_address_id - * description: The customer's default shipping address id. + * description: The parent's default shipping address id. * company_name: * type: string * title: company_name - * description: The customer's company name. + * description: The parent's company name. * first_name: * type: string * title: first_name - * description: The customer's first name. + * description: The parent's first name. * last_name: * type: string * title: last_name - * description: The customer's last name. + * description: The parent's last name. * addresses: * type: array - * description: The customer's addresses. + * description: The parent's addresses. * items: * $ref: "#/components/schemas/BaseCustomerAddress" * phone: * type: string * title: phone - * description: The customer's phone. + * description: The parent's phone. * metadata: * type: object - * description: The customer's metadata. + * description: The parent's metadata. * created_by: * type: string * title: created_by - * description: The customer's created by. + * description: The parent's created by. * deleted_at: * type: string * format: date-time * title: deleted_at - * description: The customer's deleted at. + * description: The parent's deleted at. * created_at: * type: string * format: date-time * title: created_at - * description: The customer's created at. + * description: The parent's created at. * updated_at: * type: string * format: date-time * title: updated_at - * description: The customer's updated at. + * description: The parent's updated at. * */ diff --git a/www/utils/generated/oas-output/schemas/StoreOrder.ts b/www/utils/generated/oas-output/schemas/StoreOrder.ts index 6527bcd730..37832ff736 100644 --- a/www/utils/generated/oas-output/schemas/StoreOrder.ts +++ b/www/utils/generated/oas-output/schemas/StoreOrder.ts @@ -72,7 +72,7 @@ * title: currency_code * description: The order's currency code. * display_id: - * type: string + * type: number * title: display_id * description: The order's display id. * shipping_address: diff --git a/www/utils/generated/oas-output/schemas/StorePostReturnsReqSchema.ts b/www/utils/generated/oas-output/schemas/StorePostReturnsReqSchema.ts deleted file mode 100644 index 086ec2e0c9..0000000000 --- a/www/utils/generated/oas-output/schemas/StorePostReturnsReqSchema.ts +++ /dev/null @@ -1,73 +0,0 @@ -/** - * @schema StorePostReturnsReqSchema - * type: object - * description: SUMMARY - * x-schemaName: StorePostReturnsReqSchema - * required: - * - order_id - * - items - * - return_shipping - * - note - * - location_id - * properties: - * order_id: - * type: string - * title: order_id - * description: The return's order id. - * items: - * type: array - * description: The return's items. - * items: - * type: object - * description: The item's items. - * required: - * - id - * - quantity - * - reason_id - * - note - * properties: - * id: - * type: string - * title: id - * description: The item's ID. - * quantity: - * type: number - * title: quantity - * description: The item's quantity. - * reason_id: - * type: string - * title: reason_id - * description: The item's reason id. - * note: - * type: string - * title: note - * description: The item's note. - * return_shipping: - * type: object - * description: The return's return shipping. - * required: - * - option_id - * properties: - * option_id: - * type: string - * title: option_id - * description: The return shipping's option id. - * price: - * type: number - * title: price - * description: The return shipping's price. - * note: - * type: string - * title: note - * description: The return's note. - * receive_now: - * type: boolean - * title: receive_now - * description: The return's receive now. - * location_id: - * type: string - * title: location_id - * description: The return's location id. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/StoreProduct.ts b/www/utils/generated/oas-output/schemas/StoreProduct.ts index 5776be5150..9b36486d6d 100644 --- a/www/utils/generated/oas-output/schemas/StoreProduct.ts +++ b/www/utils/generated/oas-output/schemas/StoreProduct.ts @@ -4,9 +4,9 @@ * description: The product's details. * x-schemaName: StoreProduct * required: + * - length * - title * - status - * - length * - options * - description * - id @@ -38,6 +38,10 @@ * $ref: "#/components/schemas/StoreProductCategory" * type: * $ref: "#/components/schemas/StoreProduct" + * length: + * type: number + * title: length + * description: The product's length. * title: * type: string * title: title @@ -50,10 +54,6 @@ * - proposed * - published * - rejected - * length: - * type: number - * title: length - * description: The product's length. * options: * type: array * description: The product's options. diff --git a/www/utils/generated/oas-output/schemas/StoreProductVariantParams.ts b/www/utils/generated/oas-output/schemas/StoreProductVariantParams.ts new file mode 100644 index 0000000000..77759b1275 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreProductVariantParams.ts @@ -0,0 +1,77 @@ +/** + * @schema StoreProductVariantParams + * type: object + * description: The product's variants. + * x-schemaName: StoreProductVariantParams + * properties: + * q: + * type: string + * title: q + * description: The variant's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The variant's ID. + * - type: array + * description: The variant's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * sku: + * oneOf: + * - type: string + * title: sku + * description: The variant's sku. + * - type: array + * description: The variant's sku. + * items: + * type: string + * title: sku + * description: The sku's details. + * product_id: + * oneOf: + * - type: string + * title: product_id + * description: The variant's product id. + * - type: array + * description: The variant's product id. + * items: + * type: string + * title: product_id + * description: The product id's details. + * options: + * type: object + * description: The variant's options. + * limit: + * type: number + * title: limit + * description: The variant's limit. + * offset: + * type: number + * title: offset + * description: The variant's offset. + * order: + * type: string + * title: order + * description: The variant's order. + * fields: + * type: string + * title: fields + * description: The variant'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. + * 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 + * +*/ +