From b23ddcdde88fb727d376028a91784757dd77cfe3 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 15 Aug 2024 14:31:35 +0000 Subject: [PATCH] chore(docs): Updated API Reference (v2) (#8609) Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com> --- .../Shell/admin_claims_{id}/get.sh | 2 + .../code_samples/Shell/admin_exchanges/get.sh | 2 + .../Shell/admin_exchanges/post.sh | 7 + .../Shell/admin_exchanges_{id}_cancel/post.sh | 2 + .../post.sh | 2 + .../delete.sh | 2 + .../post.sh | 2 + .../post.sh | 6 + .../delete.sh | 2 + .../post.sh | 2 + .../post.sh | 2 + .../delete.sh | 2 + .../post.sh | 2 + .../post.sh | 6 + .../delete.sh | 2 + .../post.sh | 2 + .../admin_exchanges_{id}_request/delete.sh | 2 + .../admin_exchanges_{id}_request/post.sh | 2 + .../Shell/admin_product-variants/get.sh | 2 + .../Shell/admin_refund-reasons/get.sh | 2 + .../Shell/admin_refund-reasons/post.sh | 7 + .../Shell/admin_refund-reasons_{id}/delete.sh | 2 + .../Shell/admin_refund-reasons_{id}/get.sh | 2 + .../Shell/admin_refund-reasons_{id}/post.sh | 6 + .../schemas/AdminApiKeyResponse.yaml | 8 + .../schemas/AdminCampaignResponse.yaml | 8 + .../admin/components/schemas/AdminClaim.yaml | 250 + .../schemas/AdminClaimDeleteResponse.yaml | 24 + .../schemas/AdminClaimListResponse.yaml | 26 + .../schemas/AdminClaimOrderResponse.yaml | 11 + .../schemas/AdminClaimPreviewResponse.yaml | 11 + .../schemas/AdminClaimRequestResponse.yaml | 14 + .../schemas/AdminClaimResponse.yaml | 8 + .../AdminClaimReturnPreviewResponse.yaml | 11 + .../AdminCollectionDeleteResponse.yaml | 24 + .../schemas/AdminCollectionListResponse.yaml | 26 + .../schemas/AdminCollectionResponse.yaml | 8 + .../schemas/AdminCompleteOrder.yaml | 10 - .../schemas/AdminCreateCustomer.yaml | 35 - .../schemas/AdminCreateCustomerAddress.yaml | 72 - .../schemas/AdminCreateProduct.yaml | 6 +- .../components/schemas/AdminCurrency.yaml | 3 + .../schemas/AdminCurrencyListResponse.yaml | 26 + .../schemas/AdminCurrencyResponse.yaml | 8 + .../schemas/AdminCustomerAddress.yaml | 96 + .../schemas/AdminCustomerAddressResponse.yaml | 8 + .../schemas/AdminCustomerGroupResponse.yaml | 8 + .../schemas/AdminCustomerResponse.yaml | 8 + .../schemas/AdminDraftOrderResponse.yaml | 8 + .../components/schemas/AdminExchange.yaml | 251 + .../schemas/AdminExchangeOrderResponse.yaml | 11 + .../schemas/AdminExchangePreviewResponse.yaml | 11 + .../schemas/AdminExchangeRequestResponse.yaml | 14 + .../schemas/AdminExchangeResponse.yaml | 8 + .../schemas/AdminExchangeReturnResponse.yaml | 11 + .../admin/components/schemas/AdminFile.yaml | 15 + .../schemas/AdminFileListResponse.yaml | 11 + .../components/schemas/AdminFileResponse.yaml | 8 + .../components/schemas/AdminFulfillment.yaml | 89 + .../schemas/AdminFulfillmentAddress.yaml | 87 + .../schemas/AdminFulfillmentItem.yaml | 63 + .../schemas/AdminFulfillmentLabel.yaml | 48 + .../schemas/AdminFulfillmentProvider.yaml | 2 +- .../AdminFulfillmentProviderListResponse.yaml | 26 + .../schemas/AdminFulfillmentResponse.yaml | 8 + .../schemas/AdminFulfillmentSet.yaml | 3 + .../schemas/AdminInventoryItem.yaml | 66 + .../schemas/AdminInventoryItemResponse.yaml | 8 + .../admin/components/schemas/AdminInvite.yaml | 44 + .../schemas/AdminInviteResponse.yaml | 8 + .../components/schemas/AdminNotification.yaml | 63 + .../AdminNotificationListResponse.yaml | 26 + .../schemas/AdminNotificationResponse.yaml | 8 + .../admin/components/schemas/AdminOrder.yaml | 232 + .../schemas/AdminOrderCreateFulfillment.yaml | 37 - .../schemas/AdminOrderCreateShipment.yaml | 55 - .../components/schemas/AdminOrderPreview.yaml | 642 + .../schemas/AdminOrderPreviewResponse.yaml | 8 + .../schemas/AdminOrderResponse.yaml | 8 + .../schemas/AdminOrderReturnResponse.yaml | 11 + .../components/schemas/AdminPayment.yaml | 130 + .../schemas/AdminPaymentCollection.yaml | 116 + .../schemas/AdminPaymentProvider.yaml | 3 + .../schemas/AdminPaymentResponse.yaml | 8 + .../AdminPostCancelExchangeReqSchema.yaml} | 4 +- .../AdminPostClaimsItemsActionReqSchema.yaml | 11 +- .../AdminPostExchangesAddItemsReqSchema.yaml | 37 + ...ngesRequestItemsReturnActionReqSchema.yaml | 19 + ...tExchangesReturnRequestItemsReqSchema.yaml | 37 + ...nPostExchangesShippingActionReqSchema.yaml | 15 + .../AdminPostExchangesShippingReqSchema.yaml | 25 + ...AdminPostExhangesItemsActionReqSchema.yaml | 12 + .../AdminPostOrderClaimsReqSchema.yaml | 5 + .../AdminPostOrderExchangesReqSchema.yaml | 22 + .../AdminPostReturnsShippingReqSchema.yaml | 10 +- .../components/schemas/AdminPriceList.yaml | 70 + .../schemas/AdminPriceListBatchResponse.yaml | 41 + .../schemas/AdminPriceListDeleteResponse.yaml | 24 + .../schemas/AdminPriceListListResponse.yaml | 26 + .../schemas/AdminPriceListPrice.yaml | 71 + .../schemas/AdminPriceListResponse.yaml | 8 + .../schemas/AdminPricePreference.yaml | 43 + .../AdminPricePreferenceDeleteResponse.yaml | 24 + .../AdminPricePreferenceListResponse.yaml | 26 + .../schemas/AdminPricePreferenceResponse.yaml | 8 + .../components/schemas/AdminProduct.yaml | 100 +- .../schemas/AdminProductCategory.yaml | 30 +- .../AdminProductCategoryDeleteResponse.yaml | 24 + .../AdminProductTagDeleteResponse.yaml | 24 + .../schemas/AdminProductTagListResponse.yaml | 26 + .../schemas/AdminProductTagResponse.yaml | 8 + .../AdminProductTypeDeleteResponse.yaml | 24 + .../schemas/AdminProductTypeListResponse.yaml | 26 + .../schemas/AdminProductTypeResponse.yaml | 8 + .../schemas/AdminProductVariant.yaml | 50 +- ...nProductVariantInventoryBatchResponse.yaml | 107 + .../AdminProductVariantInventoryLink.yaml | 27 + ...uctVariantInventoryLinkDeleteResponse.yaml | 21 + .../schemas/AdminProductVariantParams.yaml | 218 +- .../components/schemas/AdminPromotion.yaml | 36 + .../schemas/AdminPromotionResponse.yaml | 8 + .../schemas/AdminPromotionRule.yaml | 34 + .../components/schemas/AdminRefundReason.yaml | 35 + .../admin/components/schemas/AdminRegion.yaml | 47 + .../schemas/AdminRegionResponse.yaml | 8 + .../schemas/AdminReservationResponse.yaml | 8 + .../admin/components/schemas/AdminReturn.yaml | 66 + .../components/schemas/AdminReturnItem.yaml | 41 + .../schemas/AdminReturnPreviewResponse.yaml | 11 + .../components/schemas/AdminReturnReason.yaml | 39 + .../AdminReturnReasonListResponse.yaml | 26 + .../schemas/AdminReturnReasonResponse.yaml | 8 + .../schemas/AdminReturnResponse.yaml | 8 + .../schemas/AdminRuleAttributeOption.yaml | 41 + .../schemas/AdminRuleValueOption.yaml | 20 + .../AdminSalesChannelDeleteResponse.yaml | 24 + .../schemas/AdminSalesChannelResponse.yaml | 8 + .../components/schemas/AdminServiceZone.yaml | 3 + .../schemas/AdminShippingOptionRule.yaml | 55 + .../schemas/AdminStockLocation.yaml | 37 + .../schemas/AdminStockLocationAddress.yaml | 3 + .../AdminStockLocationDeleteResponse.yaml | 24 + .../AdminStockLocationListResponse.yaml | 26 + .../schemas/AdminStockLocationResponse.yaml | 8 + .../admin/components/schemas/AdminStore.yaml | 52 + .../schemas/AdminStoreCurrency.yaml | 46 + .../schemas/AdminStoreListResponse.yaml | 26 + .../schemas/AdminStoreResponse.yaml | 8 + .../components/schemas/AdminTaxRate.yaml | 76 + .../schemas/AdminTaxRateDeleteResponse.yaml | 24 + .../schemas/AdminTaxRateResponse.yaml | 8 + .../components/schemas/AdminTaxRateRule.yaml | 15 + .../components/schemas/AdminTaxRegion.yaml | 97 + .../schemas/AdminTaxRegionDeleteResponse.yaml | 24 + .../schemas/AdminTaxRegionResponse.yaml | 8 + .../schemas/AdminUpdateCustomer.yaml | 35 - .../schemas/AdminUpdateProduct.yaml | 169 +- .../admin/components/schemas/AdminUser.yaml | 53 + .../schemas/AdminUserDeleteResponse.yaml | 24 + .../schemas/AdminUserListResponse.yaml | 26 + .../components/schemas/AdminUserResponse.yaml | 8 + .../schemas/AdminWorkflowExecution.yaml | 50 + .../AdminWorkflowExecutionResponse.yaml | 8 + .../components/schemas/ApiKeyResponse.yaml | 59 + .../schemas/BaseApplicationMethod.yaml | 58 + .../schemas/BaseCalculatedPriceSet.yaml | 2 +- .../admin/components/schemas/BaseCapture.yaml | 3 + .../admin/components/schemas/BaseCart.yaml | 3 + .../components/schemas/BaseCartAddress.yaml | 69 + .../components/schemas/BaseCartLineItem.yaml | 306 + .../schemas/BaseCartShippingMethod.yaml | 178 + .../admin/components/schemas/BaseClaim.yaml | 3 + .../components/schemas/BaseClaimItem.yaml | 55 + .../components/schemas/BaseExchangeItem.yaml | 45 + .../schemas/BaseFulfillmentProvider.yaml | 15 + .../schemas/BaseLineItemAdjustment.yaml | 3 + .../schemas/BaseLineItemTaxLine.yaml | 3 + .../admin/components/schemas/BaseOrder.yaml | 3 + .../components/schemas/BaseOrderAddress.yaml | 70 + .../components/schemas/BaseOrderChange.yaml | 144 + .../schemas/BaseOrderChangeAction.yaml | 3 + .../schemas/BaseOrderFulfillment.yaml | 69 + .../schemas/BaseOrderItemDetail.yaml | 3 + .../components/schemas/BaseOrderLineItem.yaml | 211 + .../schemas/BaseOrderLineItemAdjustment.yaml | 3 + .../schemas/BaseOrderLineItemTaxLine.yaml | 3 + .../schemas/BaseOrderShippingMethod.yaml | 173 + .../BaseOrderShippingMethodAdjustment.yaml | 3 + .../BaseOrderShippingMethodTaxLine.yaml | 3 + .../components/schemas/BaseOrderSummary.yaml | 80 + .../schemas/BaseOrderTransaction.yaml | 51 + .../admin/components/schemas/BasePayment.yaml | 3 + .../schemas/BasePaymentCollection.yaml | 116 + .../schemas/BasePaymentProvider.yaml | 3 + .../schemas/BasePaymentSession.yaml | 3 + .../admin/components/schemas/BaseProduct.yaml | 2 +- .../components/schemas/BasePromotion.yaml | 3 + .../components/schemas/BasePromotionRule.yaml | 34 + .../schemas/BasePromotionRuleValue.yaml | 14 + .../admin/components/schemas/BaseRefund.yaml | 3 + .../admin/components/schemas/BaseRegion.yaml | 47 + .../components/schemas/BaseRegionCountry.yaml | 3 + .../components/schemas/BaseReturnItem.yaml | 3 + .../schemas/BaseRuleOperatorOptions.yaml | 20 + .../schemas/BaseShippingMethodAdjustment.yaml | 3 + .../schemas/BaseShippingMethodTaxLine.yaml | 3 + .../components/schemas/CampaignResponse.yaml} | 81 +- .../schemas/CreateCartWorkflowInput.yaml | 60 - .../admin/components/schemas/IBigNumber.yaml | 3 + .../components/schemas/InventoryLevel.yaml | 43 + .../specs/admin/components/schemas/Order.yaml | 936 + .../components/schemas/OrderAddress.yaml | 69 + .../admin/components/schemas/OrderChange.yaml | 146 + .../components/schemas/OrderChangeAction.yaml | 3 + .../admin/components/schemas/OrderClaim.yaml | 3 + .../components/schemas/OrderExchange.yaml | 3 + .../admin/components/schemas/OrderItem.yaml | 3 + .../components/schemas/OrderLineItem.yaml | 359 + .../schemas/OrderLineItemAdjustment.yaml | 3 + .../schemas/OrderLineItemTaxLine.yaml | 3 + .../schemas/OrderShippingMethod.yaml | 214 + .../OrderShippingMethodAdjustment.yaml | 3 + .../schemas/OrderShippingMethodTaxLine.yaml | 3 + .../components/schemas/OrderTransaction.yaml | 66 + .../schemas/RefundReasonResponse.yaml | 8 + .../schemas/ReservationResponse.yaml | 66 + .../admin/components/schemas/Return.yaml | 3 + .../admin/components/schemas/StoreCart.yaml | 349 + .../components/schemas/StoreCartResponse.yaml | 8 + .../components/schemas/StoreCollection.yaml | 47 + .../schemas/StoreCollectionResponse.yaml | 8 + .../components/schemas/StoreCurrency.yaml | 69 + .../schemas/StoreCurrencyListResponse.yaml | 26 + .../schemas/StoreCurrencyResponse.yaml | 8 + .../components/schemas/StoreCustomer.yaml | 73 + .../schemas/StoreCustomerAddress.yaml | 96 + .../StoreCustomerAddressListResponse.yaml | 26 + .../schemas/StoreCustomerAddressResponse.yaml | 8 + .../schemas/StoreCustomerResponse.yaml | 8 + .../admin/components/schemas/StoreOrder.yaml | 231 + .../schemas/StoreOrderResponse.yaml | 8 + .../schemas/StorePaymentCollection.yaml | 116 + .../StorePaymentCollectionResponse.yaml | 8 + .../schemas/StorePaymentProvider.yaml | 10 + .../components/schemas/StoreProduct.yaml | 104 +- .../schemas/StoreProductCategory.yaml | 28 +- .../schemas/StoreProductResponse.yaml | 8 + .../admin/components/schemas/StoreRegion.yaml | 47 + .../admin/components/schemas/StoreReturn.yaml | 66 + .../components/schemas/StoreReturnReason.yaml | 39 + .../schemas/StoreReturnReasonResponse.yaml | 8 + .../schemas/StoreReturnResponse.yaml | 8 + .../schemas/StoreShippingOption.yaml | 65 + .../StoreShippingOptionListResponse.yaml | 11 + .../components/schemas/UpdateCartData.yaml | 44 - .../specs/admin/openapi.full.yaml | 17632 ++++++++++++++- .../api-reference/specs/admin/openapi.yaml | 77 + .../specs/admin/paths/admin_api-keys.yaml | 42 + .../admin/paths/admin_api-keys_{id}.yaml | 39 + .../paths/admin_api-keys_{id}_revoke.yaml | 6 + .../admin_api-keys_{id}_sales-channels.yaml | 6 + .../specs/admin/paths/admin_campaigns.yaml | 49 +- .../admin/paths/admin_campaigns_{id}.yaml | 87 +- .../admin_campaigns_{id}_promotions.yaml | 6 + .../specs/admin/paths/admin_claims.yaml | 12 + .../specs/admin/paths/admin_claims_{id}.yaml | 97 + .../admin/paths/admin_claims_{id}_cancel.yaml | 6 + .../paths/admin_claims_{id}_claim-items.yaml | 7 + ...n_claims_{id}_claim-items_{action_id}.yaml | 14 + .../admin_claims_{id}_inbound_items.yaml | 7 + ...claims_{id}_inbound_items_{action_id}.yaml | 14 + ...n_claims_{id}_inbound_shipping-method.yaml | 7 + ...}_inbound_shipping-method_{action_id}.yaml | 14 + .../admin_claims_{id}_outbound_items.yaml | 7 + ...laims_{id}_outbound_items_{action_id}.yaml | 14 + ..._claims_{id}_outbound_shipping-method.yaml | 7 + ..._outbound_shipping-method_{action_id}.yaml | 14 + .../paths/admin_claims_{id}_request.yaml | 13 + .../specs/admin/paths/admin_collections.yaml | 13 + .../admin/paths/admin_collections_{id}.yaml | 18 + .../admin_collections_{id}_products.yaml | 6 + .../specs/admin/paths/admin_currencies.yaml | 6 + .../admin/paths/admin_currencies_{code}.yaml | 6 + .../admin/paths/admin_customer-groups.yaml | 41 + .../paths/admin_customer-groups_{id}.yaml | 39 + .../admin_customer-groups_{id}_customers.yaml | 6 + .../specs/admin/paths/admin_customers.yaml | 35 +- .../admin/paths/admin_customers_{id}.yaml | 70 +- .../paths/admin_customers_{id}_addresses.yaml | 99 +- ...customers_{id}_addresses_{address_id}.yaml | 97 +- .../specs/admin/paths/admin_draft-orders.yaml | 48 +- .../admin/paths/admin_draft-orders_{id}.yaml | 6 + .../specs/admin/paths/admin_exchanges.yaml | 211 + .../paths/admin_exchanges_{id}_cancel.yaml | 100 + .../admin_exchanges_{id}_inbound_items.yaml | 102 + ...hanges_{id}_inbound_items_{action_id}.yaml | 214 + ...xchanges_{id}_inbound_shipping-method.yaml | 102 + ...}_inbound_shipping-method_{action_id}.yaml | 214 + .../admin_exchanges_{id}_outbound_items.yaml | 101 + ...anges_{id}_outbound_items_{action_id}.yaml | 213 + ...changes_{id}_outbound_shipping-method.yaml | 102 + ..._outbound_shipping-method_{action_id}.yaml | 214 + .../paths/admin_exchanges_{id}_request.yaml | 214 + .../paths/admin_fulfillment-providers.yaml | 6 + ...n_fulfillment-sets_{id}_service-zones.yaml | 6 + ...ent-sets_{id}_service-zones_{zone_id}.yaml | 27 + .../specs/admin/paths/admin_fulfillments.yaml | 7 + .../paths/admin_fulfillments_{id}_cancel.yaml | 6 + .../admin_fulfillments_{id}_shipment.yaml | 6 + .../admin/paths/admin_inventory-items.yaml | 56 +- .../paths/admin_inventory-items_{id}.yaml | 39 + ..._inventory-items_{id}_location-levels.yaml | 55 +- ...tory-items_{id}_location-levels_batch.yaml | 13 + ...ms_{id}_location-levels_{location_id}.yaml | 33 + .../specs/admin/paths/admin_invites.yaml | 55 +- .../admin/paths/admin_invites_accept.yaml | 22 + .../specs/admin/paths/admin_invites_{id}.yaml | 33 + .../paths/admin_invites_{id}_resend.yaml | 6 + .../admin/paths/admin_notifications.yaml | 20 +- .../admin/paths/admin_notifications_{id}.yaml | 6 + .../specs/admin/paths/admin_orders.yaml | 35 + .../specs/admin/paths/admin_orders_{id}.yaml | 12 + .../paths/admin_orders_{id}_archive.yaml | 6 + .../admin/paths/admin_orders_{id}_cancel.yaml | 6 + .../paths/admin_orders_{id}_complete.yaml | 13 +- .../paths/admin_orders_{id}_fulfillments.yaml | 38 +- ..._fulfillments_{fulfillment_id}_cancel.yaml | 13 +- ...lfillments_{fulfillment_id}_shipments.yaml | 57 +- .../paths/admin_orders_{id}_preview.yaml | 6 + .../specs/admin/paths/admin_payments.yaml | 49 +- .../admin_payments_payment-providers.yaml | 49 +- .../admin/paths/admin_payments_{id}.yaml | 6 + .../paths/admin_payments_{id}_capture.yaml | 6 + .../paths/admin_payments_{id}_refund.yaml | 14 + .../specs/admin/paths/admin_price-lists.yaml | 12 + .../admin/paths/admin_price-lists_{id}.yaml | 18 + .../admin_price-lists_{id}_prices_batch.yaml | 6 + .../admin_price-lists_{id}_products.yaml | 6 + .../admin/paths/admin_price-preferences.yaml | 12 + .../paths/admin_price-preferences_{id}.yaml | 18 + .../admin/paths/admin_product-categories.yaml | 15 +- .../paths/admin_product-categories_{id}.yaml | 6 + .../specs/admin/paths/admin_product-tags.yaml | 27 +- .../admin/paths/admin_product-tags_{id}.yaml | 19 + .../admin/paths/admin_product-types.yaml | 27 +- .../admin/paths/admin_product-types_{id}.yaml | 19 + .../admin/paths/admin_product-variants.yaml | 120 + .../specs/admin/paths/admin_products.yaml | 150 +- .../admin/paths/admin_products_batch.yaml | 1 + .../admin/paths/admin_products_export.yaml | 1 + .../admin/paths/admin_products_import.yaml | 1 + .../admin/paths/admin_products_{id}.yaml | 146 +- .../paths/admin_products_{id}_options.yaml | 20 +- ...min_products_{id}_options_{option_id}.yaml | 14 +- .../paths/admin_products_{id}_variants.yaml | 78 +- .../admin_products_{id}_variants_batch.yaml | 1 + ...s_{id}_variants_inventory-items_batch.yaml | 8 + ...n_products_{id}_variants_{variant_id}.yaml | 78 +- ...variants_{variant_id}_inventory-items.yaml | 6 + ...}_inventory-items_{inventory_item_id}.yaml | 14 + .../specs/admin/paths/admin_promotions.yaml | 61 +- ...ns_rule-attribute-options_{rule_type}.yaml | 15 + ...tions_{rule_type}_{rule_attribute_id}.yaml | 15 + .../admin/paths/admin_promotions_{id}.yaml | 42 +- ...admin_promotions_{id}_buy-rules_batch.yaml | 46 + .../admin_promotions_{id}_rules_batch.yaml | 46 + ...in_promotions_{id}_target-rules_batch.yaml | 46 + .../admin_promotions_{id}_{rule_type}.yaml | 15 + .../admin/paths/admin_refund-reasons.yaml | 228 + .../paths/admin_refund-reasons_{id}.yaml | 325 + .../specs/admin/paths/admin_regions.yaml | 56 +- .../specs/admin/paths/admin_regions_{id}.yaml | 40 + .../specs/admin/paths/admin_reservations.yaml | 42 + .../admin/paths/admin_reservations_{id}.yaml | 39 + .../admin/paths/admin_return-reasons.yaml | 137 + .../paths/admin_return-reasons_{id}.yaml | 39 + .../specs/admin/paths/admin_returns.yaml | 41 + .../specs/admin/paths/admin_returns_{id}.yaml | 13 + .../paths/admin_returns_{id}_cancel.yaml | 6 + .../admin_returns_{id}_dismiss-items.yaml | 7 + ...eturns_{id}_dismiss-items_{action_id}.yaml | 14 + .../admin_returns_{id}_receive-items.yaml | 7 + ...eturns_{id}_receive-items_{action_id}.yaml | 14 + .../paths/admin_returns_{id}_receive.yaml | 33 + .../admin_returns_{id}_receive_confirm.yaml | 7 + .../admin_returns_{id}_request-items.yaml | 7 + ...eturns_{id}_request-items_{action_id}.yaml | 14 + .../paths/admin_returns_{id}_request.yaml | 34 + .../admin_returns_{id}_shipping-method.yaml | 7 + ...urns_{id}_shipping-method_{action_id}.yaml | 14 + .../admin/paths/admin_sales-channels.yaml | 56 +- .../paths/admin_sales-channels_{id}.yaml | 18 + .../admin_sales-channels_{id}_products.yaml | 6 + .../admin/paths/admin_shipping-options.yaml | 14 + ...min_shipping-options_{id}_rules_batch.yaml | 46 + .../admin/paths/admin_shipping-profiles.yaml | 15 +- .../admin/paths/admin_stock-locations.yaml | 27 +- .../paths/admin_stock-locations_{id}.yaml | 18 + ...-locations_{id}_fulfillment-providers.yaml | 6 + ...stock-locations_{id}_fulfillment-sets.yaml | 6 + ...n_stock-locations_{id}_sales-channels.yaml | 6 + .../specs/admin/paths/admin_stores.yaml | 20 +- .../specs/admin/paths/admin_stores_{id}.yaml | 13 + .../specs/admin/paths/admin_tax-rates.yaml | 56 +- .../admin/paths/admin_tax-rates_{id}.yaml | 18 + .../paths/admin_tax-rates_{id}_rules.yaml | 6 + .../admin_tax-rates_{id}_rules_{rule_id}.yaml | 27 + .../specs/admin/paths/admin_tax-regions.yaml | 56 +- .../admin/paths/admin_tax-regions_{id}.yaml | 12 + .../specs/admin/paths/admin_uploads.yaml | 7 + .../specs/admin/paths/admin_uploads_{id}.yaml | 33 + .../specs/admin/paths/admin_users.yaml | 13 + .../specs/admin/paths/admin_users_me.yaml | 6 + .../specs/admin/paths/admin_users_{id}.yaml | 18 + .../paths/admin_workflows-executions.yaml | 35 + .../admin_workflows-executions_{id}.yaml | 6 + ...orkflows-executions_{workflow_id}_run.yaml | 11 + ...xecutions_{workflow_id}_steps_failure.yaml | 14 + ...xecutions_{workflow_id}_steps_success.yaml | 14 + ...utions_{workflow_id}_{transaction_id}.yaml | 6 + .../schemas/AdminApiKeyResponse.yaml | 8 + .../schemas/AdminCampaignResponse.yaml | 8 + .../store/components/schemas/AdminClaim.yaml | 250 + .../schemas/AdminClaimDeleteResponse.yaml | 24 + .../schemas/AdminClaimListResponse.yaml | 26 + .../schemas/AdminClaimOrderResponse.yaml | 11 + .../schemas/AdminClaimPreviewResponse.yaml | 11 + .../schemas/AdminClaimRequestResponse.yaml | 14 + .../schemas/AdminClaimResponse.yaml | 8 + .../AdminClaimReturnPreviewResponse.yaml | 11 + .../AdminCollectionDeleteResponse.yaml | 24 + .../schemas/AdminCollectionListResponse.yaml | 26 + .../schemas/AdminCollectionResponse.yaml | 8 + .../schemas/AdminCompleteOrder.yaml | 10 - .../schemas/AdminCreateCustomer.yaml | 35 - .../schemas/AdminCreateCustomerAddress.yaml | 72 - .../schemas/AdminCreateProduct.yaml | 6 +- .../components/schemas/AdminCurrency.yaml | 3 + .../schemas/AdminCurrencyListResponse.yaml | 26 + .../schemas/AdminCurrencyResponse.yaml | 8 + .../schemas/AdminCustomerAddress.yaml | 96 + .../schemas/AdminCustomerAddressResponse.yaml | 8 + .../schemas/AdminCustomerGroupResponse.yaml | 8 + .../schemas/AdminCustomerResponse.yaml | 8 + .../schemas/AdminDraftOrderResponse.yaml | 8 + .../components/schemas/AdminExchange.yaml | 251 + .../schemas/AdminExchangeOrderResponse.yaml | 11 + .../schemas/AdminExchangePreviewResponse.yaml | 11 + .../schemas/AdminExchangeRequestResponse.yaml | 14 + .../schemas/AdminExchangeResponse.yaml | 8 + .../schemas/AdminExchangeReturnResponse.yaml | 11 + .../store/components/schemas/AdminFile.yaml | 15 + .../schemas/AdminFileListResponse.yaml | 11 + .../components/schemas/AdminFileResponse.yaml | 8 + .../components/schemas/AdminFulfillment.yaml | 89 + .../schemas/AdminFulfillmentAddress.yaml | 87 + .../schemas/AdminFulfillmentItem.yaml | 63 + .../schemas/AdminFulfillmentLabel.yaml | 48 + .../schemas/AdminFulfillmentProvider.yaml | 2 +- .../AdminFulfillmentProviderListResponse.yaml | 26 + .../schemas/AdminFulfillmentResponse.yaml | 8 + .../schemas/AdminFulfillmentSet.yaml | 3 + .../schemas/AdminInventoryItem.yaml | 66 + .../schemas/AdminInventoryItemResponse.yaml | 8 + .../store/components/schemas/AdminInvite.yaml | 44 + .../schemas/AdminInviteResponse.yaml | 8 + .../components/schemas/AdminNotification.yaml | 63 + .../AdminNotificationListResponse.yaml | 26 + .../schemas/AdminNotificationResponse.yaml | 8 + .../store/components/schemas/AdminOrder.yaml | 232 + .../schemas/AdminOrderCreateFulfillment.yaml | 37 - .../schemas/AdminOrderCreateShipment.yaml | 55 - .../components/schemas/AdminOrderPreview.yaml | 642 + .../schemas/AdminOrderPreviewResponse.yaml | 8 + .../schemas/AdminOrderResponse.yaml | 8 + .../schemas/AdminOrderReturnResponse.yaml | 11 + .../components/schemas/AdminPayment.yaml | 130 + .../schemas/AdminPaymentCollection.yaml | 116 + .../schemas/AdminPaymentProvider.yaml | 3 + .../schemas/AdminPaymentResponse.yaml | 8 + .../AdminPostCancelExchangeReqSchema.yaml} | 4 +- .../AdminPostClaimsItemsActionReqSchema.yaml | 11 +- .../AdminPostExchangesAddItemsReqSchema.yaml | 37 + ...ngesRequestItemsReturnActionReqSchema.yaml | 19 + ...tExchangesReturnRequestItemsReqSchema.yaml | 37 + ...nPostExchangesShippingActionReqSchema.yaml | 15 + .../AdminPostExchangesShippingReqSchema.yaml | 25 + ...AdminPostExhangesItemsActionReqSchema.yaml | 12 + .../AdminPostOrderClaimsReqSchema.yaml | 5 + .../AdminPostOrderExchangesReqSchema.yaml | 22 + .../AdminPostReturnsShippingReqSchema.yaml | 10 +- .../components/schemas/AdminPriceList.yaml | 70 + .../schemas/AdminPriceListBatchResponse.yaml | 41 + .../schemas/AdminPriceListDeleteResponse.yaml | 24 + .../schemas/AdminPriceListListResponse.yaml | 26 + .../schemas/AdminPriceListPrice.yaml | 71 + .../schemas/AdminPriceListResponse.yaml | 8 + .../schemas/AdminPricePreference.yaml | 43 + .../AdminPricePreferenceDeleteResponse.yaml | 24 + .../AdminPricePreferenceListResponse.yaml | 26 + .../schemas/AdminPricePreferenceResponse.yaml | 8 + .../components/schemas/AdminProduct.yaml | 100 +- .../schemas/AdminProductCategory.yaml | 30 +- .../AdminProductCategoryDeleteResponse.yaml | 24 + .../AdminProductTagDeleteResponse.yaml | 24 + .../schemas/AdminProductTagListResponse.yaml | 26 + .../schemas/AdminProductTagResponse.yaml | 8 + .../AdminProductTypeDeleteResponse.yaml | 24 + .../schemas/AdminProductTypeListResponse.yaml | 26 + .../schemas/AdminProductTypeResponse.yaml | 8 + .../schemas/AdminProductVariant.yaml | 50 +- ...nProductVariantInventoryBatchResponse.yaml | 107 + .../AdminProductVariantInventoryLink.yaml | 27 + ...uctVariantInventoryLinkDeleteResponse.yaml | 21 + .../schemas/AdminProductVariantParams.yaml | 218 +- .../components/schemas/AdminPromotion.yaml | 36 + .../schemas/AdminPromotionResponse.yaml | 8 + .../schemas/AdminPromotionRule.yaml | 34 + .../components/schemas/AdminRefundReason.yaml | 35 + .../store/components/schemas/AdminRegion.yaml | 47 + .../schemas/AdminRegionResponse.yaml | 8 + .../schemas/AdminReservationResponse.yaml | 8 + .../store/components/schemas/AdminReturn.yaml | 66 + .../components/schemas/AdminReturnItem.yaml | 41 + .../schemas/AdminReturnPreviewResponse.yaml | 11 + .../components/schemas/AdminReturnReason.yaml | 39 + .../AdminReturnReasonListResponse.yaml | 26 + .../schemas/AdminReturnReasonResponse.yaml | 8 + .../schemas/AdminReturnResponse.yaml | 8 + .../schemas/AdminRuleAttributeOption.yaml | 41 + .../schemas/AdminRuleValueOption.yaml | 20 + .../AdminSalesChannelDeleteResponse.yaml | 24 + .../schemas/AdminSalesChannelResponse.yaml | 8 + .../components/schemas/AdminServiceZone.yaml | 3 + .../schemas/AdminShippingOptionRule.yaml | 55 + .../schemas/AdminStockLocation.yaml | 37 + .../schemas/AdminStockLocationAddress.yaml | 3 + .../AdminStockLocationDeleteResponse.yaml | 24 + .../AdminStockLocationListResponse.yaml | 26 + .../schemas/AdminStockLocationResponse.yaml | 8 + .../store/components/schemas/AdminStore.yaml | 52 + .../schemas/AdminStoreCurrency.yaml | 46 + .../schemas/AdminStoreListResponse.yaml | 26 + .../schemas/AdminStoreResponse.yaml | 8 + .../components/schemas/AdminTaxRate.yaml | 76 + .../schemas/AdminTaxRateDeleteResponse.yaml | 24 + .../schemas/AdminTaxRateResponse.yaml | 8 + .../components/schemas/AdminTaxRateRule.yaml | 15 + .../components/schemas/AdminTaxRegion.yaml | 97 + .../schemas/AdminTaxRegionDeleteResponse.yaml | 24 + .../schemas/AdminTaxRegionResponse.yaml | 8 + .../schemas/AdminUpdateCustomer.yaml | 35 - .../schemas/AdminUpdateProduct.yaml | 169 +- .../store/components/schemas/AdminUser.yaml | 53 + .../schemas/AdminUserDeleteResponse.yaml | 24 + .../schemas/AdminUserListResponse.yaml | 26 + .../components/schemas/AdminUserResponse.yaml | 8 + .../schemas/AdminWorkflowExecution.yaml | 50 + .../AdminWorkflowExecutionResponse.yaml | 8 + .../components/schemas/ApiKeyResponse.yaml | 59 + .../schemas/BaseApplicationMethod.yaml | 58 + .../schemas/BaseCalculatedPriceSet.yaml | 2 +- .../store/components/schemas/BaseCapture.yaml | 3 + .../store/components/schemas/BaseCart.yaml | 3 + .../components/schemas/BaseCartAddress.yaml | 69 + .../components/schemas/BaseCartLineItem.yaml | 306 + .../schemas/BaseCartShippingMethod.yaml | 178 + .../store/components/schemas/BaseClaim.yaml | 3 + .../components/schemas/BaseClaimItem.yaml | 55 + .../components/schemas/BaseExchangeItem.yaml | 45 + .../schemas/BaseFulfillmentProvider.yaml | 15 + .../schemas/BaseLineItemAdjustment.yaml | 3 + .../schemas/BaseLineItemTaxLine.yaml | 3 + .../store/components/schemas/BaseOrder.yaml | 3 + .../components/schemas/BaseOrderAddress.yaml | 70 + .../components/schemas/BaseOrderChange.yaml | 144 + .../schemas/BaseOrderChangeAction.yaml | 3 + .../schemas/BaseOrderFulfillment.yaml | 69 + .../schemas/BaseOrderItemDetail.yaml | 3 + .../components/schemas/BaseOrderLineItem.yaml | 211 + .../schemas/BaseOrderLineItemAdjustment.yaml | 3 + .../schemas/BaseOrderLineItemTaxLine.yaml | 3 + .../schemas/BaseOrderShippingMethod.yaml | 173 + .../BaseOrderShippingMethodAdjustment.yaml | 3 + .../BaseOrderShippingMethodTaxLine.yaml | 3 + .../components/schemas/BaseOrderSummary.yaml | 80 + .../schemas/BaseOrderTransaction.yaml | 51 + .../store/components/schemas/BasePayment.yaml | 3 + .../schemas/BasePaymentCollection.yaml | 116 + .../schemas/BasePaymentProvider.yaml | 3 + .../schemas/BasePaymentSession.yaml | 3 + .../store/components/schemas/BaseProduct.yaml | 2 +- .../components/schemas/BasePromotion.yaml | 3 + .../components/schemas/BasePromotionRule.yaml | 34 + .../schemas/BasePromotionRuleValue.yaml | 14 + .../store/components/schemas/BaseRefund.yaml | 3 + .../store/components/schemas/BaseRegion.yaml | 47 + .../components/schemas/BaseRegionCountry.yaml | 3 + .../components/schemas/BaseReturnItem.yaml | 3 + .../schemas/BaseRuleOperatorOptions.yaml | 20 + .../schemas/BaseShippingMethodAdjustment.yaml | 3 + .../schemas/BaseShippingMethodTaxLine.yaml | 3 + .../components/schemas/CampaignResponse.yaml} | 81 +- .../schemas/CreateCartWorkflowInput.yaml | 60 - .../store/components/schemas/IBigNumber.yaml | 3 + .../components/schemas/InventoryLevel.yaml | 43 + .../specs/store/components/schemas/Order.yaml | 936 + .../components/schemas/OrderAddress.yaml | 69 + .../store/components/schemas/OrderChange.yaml | 146 + .../components/schemas/OrderChangeAction.yaml | 3 + .../store/components/schemas/OrderClaim.yaml | 3 + .../components/schemas/OrderExchange.yaml | 3 + .../store/components/schemas/OrderItem.yaml | 3 + .../components/schemas/OrderLineItem.yaml | 359 + .../schemas/OrderLineItemAdjustment.yaml | 3 + .../schemas/OrderLineItemTaxLine.yaml | 3 + .../schemas/OrderShippingMethod.yaml | 214 + .../OrderShippingMethodAdjustment.yaml | 3 + .../schemas/OrderShippingMethodTaxLine.yaml | 3 + .../components/schemas/OrderTransaction.yaml | 66 + .../schemas/RefundReasonResponse.yaml | 8 + .../schemas/ReservationResponse.yaml | 66 + .../store/components/schemas/Return.yaml | 3 + .../store/components/schemas/StoreCart.yaml | 349 + .../components/schemas/StoreCartResponse.yaml | 8 + .../components/schemas/StoreCollection.yaml | 47 + .../schemas/StoreCollectionResponse.yaml | 8 + .../components/schemas/StoreCurrency.yaml | 69 + .../schemas/StoreCurrencyListResponse.yaml | 26 + .../schemas/StoreCurrencyResponse.yaml | 8 + .../components/schemas/StoreCustomer.yaml | 73 + .../schemas/StoreCustomerAddress.yaml | 96 + .../StoreCustomerAddressListResponse.yaml | 26 + .../schemas/StoreCustomerAddressResponse.yaml | 8 + .../schemas/StoreCustomerResponse.yaml | 8 + .../store/components/schemas/StoreOrder.yaml | 231 + .../schemas/StoreOrderResponse.yaml | 8 + .../schemas/StorePaymentCollection.yaml | 116 + .../StorePaymentCollectionResponse.yaml | 8 + .../schemas/StorePaymentProvider.yaml | 10 + .../components/schemas/StoreProduct.yaml | 104 +- .../schemas/StoreProductCategory.yaml | 28 +- .../schemas/StoreProductResponse.yaml | 8 + .../store/components/schemas/StoreRegion.yaml | 47 + .../store/components/schemas/StoreReturn.yaml | 66 + .../components/schemas/StoreReturnReason.yaml | 39 + .../schemas/StoreReturnReasonResponse.yaml | 8 + .../schemas/StoreReturnResponse.yaml | 8 + .../schemas/StoreShippingOption.yaml | 65 + .../StoreShippingOptionListResponse.yaml | 11 + .../components/schemas/UpdateCartData.yaml | 44 - .../specs/store/openapi.full.yaml | 18587 +++++++++++++++- .../api-reference/specs/store/openapi.yaml | 22 + .../specs/store/paths/store_carts.yaml | 66 +- .../specs/store/paths/store_carts_{id}.yaml | 61 +- .../paths/store_carts_{id}_complete.yaml | 52 + .../paths/store_carts_{id}_line-items.yaml | 6 + ...store_carts_{id}_line-items_{line_id}.yaml | 6 + .../paths/store_carts_{id}_promotions.yaml | 18 + .../store_carts_{id}_shipping-methods.yaml | 6 + .../store/paths/store_carts_{id}_taxes.yaml | 6 + .../specs/store/paths/store_collections.yaml | 35 + .../store/paths/store_collections_{id}.yaml | 6 + .../specs/store/paths/store_currencies.yaml | 6 + .../store/paths/store_currencies_{code}.yaml | 6 + .../specs/store/paths/store_customers.yaml | 6 + .../specs/store/paths/store_customers_me.yaml | 12 + .../paths/store_customers_me_addresses.yaml | 12 + ...e_customers_me_addresses_{address_id}.yaml | 39 + .../specs/store/paths/store_orders.yaml | 49 +- .../specs/store/paths/store_orders_{id}.yaml | 20 +- .../paths/store_payment-collections.yaml | 21 +- ...ent-collections_{id}_payment-sessions.yaml | 6 + .../store/paths/store_payment-providers.yaml | 49 +- .../store/paths/store_product-categories.yaml | 14 +- .../specs/store/paths/store_products.yaml | 6443 +++++- .../store/paths/store_products_{id}.yaml | 6 + .../specs/store/paths/store_regions.yaml | 35 + .../specs/store/paths/store_regions_{id}.yaml | 12 + .../store/paths/store_return-reasons.yaml | 35 + .../paths/store_return-reasons_{id}.yaml | 6 + .../specs/store/paths/store_return.yaml | 6 + .../store/paths/store_shipping-options.yaml | 7 + .../oas-output/base/admin.oas.base.yaml | 75 +- .../oas-output/base/store.oas.base.yaml | 48 +- .../admin/delete_admin_api-keys_[id].ts | 27 + .../admin/delete_admin_campaigns_[id].ts | 27 + ...min_claims_[id]_claim-items_[action_id].ts | 7 + ...n_claims_[id]_inbound_items_[action_id].ts | 7 + ...id]_inbound_shipping-method_[action_id].ts | 7 + ..._claims_[id]_outbound_items_[action_id].ts | 7 + ...d]_outbound_shipping-method_[action_id].ts | 7 + .../admin/delete_admin_claims_[id]_request.ts | 6 + .../admin/delete_admin_collections_[id].ts | 6 + .../delete_admin_customer-groups_[id].ts | 27 + .../admin/delete_admin_customers_[id].ts | 27 + ...n_customers_[id]_addresses_[address_id].ts | 27 + ...xchanges_[id]_inbound_items_[action_id].ts | 107 + ...id]_inbound_shipping-method_[action_id].ts | 108 + ...changes_[id]_outbound_items_[action_id].ts | 107 + ...d]_outbound_shipping-method_[action_id].ts | 109 + .../delete_admin_exchanges_[id]_request.ts | 119 + ...lment-sets_[id]_service-zones_[zone_id].ts | 27 + .../delete_admin_inventory-items_[id].ts | 27 + ...tems_[id]_location-levels_[location_id].ts | 27 + .../admin/delete_admin_invites_[id].ts | 27 + .../admin/delete_admin_price-lists_[id].ts | 6 + .../delete_admin_price-preferences_[id].ts | 6 + .../delete_admin_product-categories_[id].ts | 6 + .../admin/delete_admin_product-tags_[id].ts | 6 + .../admin/delete_admin_product-types_[id].ts | 6 + ...id]_inventory-items_[inventory_item_id].ts | 7 + .../admin/delete_admin_promotions_[id].ts | 27 + .../admin/delete_admin_refund-reasons_[id].ts | 118 + .../admin/delete_admin_regions_[id].ts | 27 + .../admin/delete_admin_reservations_[id].ts | 27 + .../admin/delete_admin_return-reasons_[id].ts | 27 + ..._returns_[id]_dismiss-items_[action_id].ts | 7 + ..._returns_[id]_receive-items_[action_id].ts | 7 + .../delete_admin_returns_[id]_receive.ts | 27 + ..._returns_[id]_request-items_[action_id].ts | 7 + .../delete_admin_returns_[id]_request.ts | 27 + ...eturns_[id]_shipping-method_[action_id].ts | 7 + .../admin/delete_admin_sales-channels_[id].ts | 6 + .../delete_admin_stock-locations_[id].ts | 6 + .../admin/delete_admin_tax-rates_[id].ts | 6 + ...te_admin_tax-rates_[id]_rules_[rule_id].ts | 27 + .../admin/delete_admin_tax-regions_[id].ts | 6 + .../admin/delete_admin_uploads_[id].ts | 27 + .../admin/delete_admin_users_[id].ts | 6 + .../operations/admin/get_admin_api-keys.ts | 35 + .../admin/get_admin_api-keys_[id].ts | 6 + .../operations/admin/get_admin_campaigns.ts | 35 + .../admin/get_admin_campaigns_[id].ts | 6 + .../operations/admin/get_admin_claims.ts | 6 + .../operations/admin/get_admin_claims_[id].ts | 98 + .../operations/admin/get_admin_collections.ts | 6 + .../admin/get_admin_collections_[id].ts | 6 + .../operations/admin/get_admin_currencies.ts | 6 + .../admin/get_admin_currencies_[code].ts | 6 + .../admin/get_admin_customer-groups.ts | 35 + .../admin/get_admin_customer-groups_[id].ts | 6 + .../admin/get_admin_customers_[id].ts | 8 +- .../get_admin_customers_[id]_addresses.ts | 35 + ...n_customers_[id]_addresses_[address_id].ts | 6 + .../admin/get_admin_draft-orders.ts | 32 + .../admin/get_admin_draft-orders_[id].ts | 6 + .../operations/admin/get_admin_exchanges.ts | 118 + .../admin/get_admin_fulfillment-providers.ts | 6 + .../admin/get_admin_inventory-items.ts | 49 +- .../admin/get_admin_inventory-items_[id].ts | 6 + ...in_inventory-items_[id]_location-levels.ts | 49 +- .../operations/admin/get_admin_invites.ts | 49 +- .../admin/get_admin_invites_[id].ts | 6 + .../admin/get_admin_notifications.ts | 20 +- .../admin/get_admin_notifications_[id].ts | 6 + .../operations/admin/get_admin_orders.ts | 35 + .../operations/admin/get_admin_orders_[id].ts | 6 + .../admin/get_admin_orders_[id]_preview.ts | 6 + .../operations/admin/get_admin_payments.ts | 49 +- .../admin/get_admin_payments_[id].ts | 6 + .../get_admin_payments_payment-providers.ts | 49 +- .../operations/admin/get_admin_price-lists.ts | 6 + .../admin/get_admin_price-lists_[id].ts | 6 + .../admin/get_admin_price-preferences.ts | 6 + .../admin/get_admin_price-preferences_[id].ts | 6 + .../admin/get_admin_product-categories.ts | 14 +- .../admin/get_admin_product-tags.ts | 20 +- .../admin/get_admin_product-tags_[id].ts | 6 + .../admin/get_admin_product-types.ts | 20 +- .../admin/get_admin_product-types_[id].ts | 6 + .../admin/get_admin_product-variants.ts | 122 + .../operations/admin/get_admin_products.ts | 6 + .../admin/get_admin_products_[id]_options.ts | 6 + .../operations/admin/get_admin_promotions.ts | 49 +- .../admin/get_admin_promotions_[id].ts | 6 + .../get_admin_promotions_[id]_[rule_type].ts | 15 + ...ions_rule-attribute-options_[rule_type].ts | 15 + ...options_[rule_type]_[rule_attribute_id].ts | 15 + .../admin/get_admin_refund-reasons.ts | 122 + .../admin/get_admin_refund-reasons_[id].ts | 98 + .../operations/admin/get_admin_regions.ts | 49 +- .../admin/get_admin_regions_[id].ts | 6 + .../admin/get_admin_reservations.ts | 35 + .../admin/get_admin_reservations_[id].ts | 6 + .../admin/get_admin_return-reasons.ts | 131 + .../admin/get_admin_return-reasons_[id].ts | 6 + .../operations/admin/get_admin_returns.ts | 35 + .../admin/get_admin_returns_[id].ts | 6 + .../admin/get_admin_sales-channels.ts | 49 +- .../admin/get_admin_sales-channels_[id].ts | 6 + .../admin/get_admin_shipping-options.ts | 14 + .../admin/get_admin_shipping-profiles.ts | 14 +- .../admin/get_admin_stock-locations.ts | 20 +- .../admin/get_admin_stock-locations_[id].ts | 6 + .../operations/admin/get_admin_stores.ts | 20 +- .../operations/admin/get_admin_stores_[id].ts | 6 + .../operations/admin/get_admin_tax-rates.ts | 49 +- .../admin/get_admin_tax-rates_[id].ts | 6 + .../operations/admin/get_admin_tax-regions.ts | 49 +- .../admin/get_admin_tax-regions_[id].ts | 6 + .../admin/get_admin_uploads_[id].ts | 6 + .../operations/admin/get_admin_users.ts | 6 + .../operations/admin/get_admin_users_[id].ts | 6 + .../operations/admin/get_admin_users_me.ts | 6 + .../admin/get_admin_workflows-executions.ts | 35 + .../get_admin_workflows-executions_[id].ts | 6 + ...ecutions_[workflow_id]_[transaction_id].ts | 6 + .../operations/admin/post_admin_api-keys.ts | 7 + .../admin/post_admin_api-keys_[id].ts | 6 + .../admin/post_admin_api-keys_[id]_revoke.ts | 6 + ...post_admin_api-keys_[id]_sales-channels.ts | 6 + .../operations/admin/post_admin_campaigns.ts | 14 +- .../admin/post_admin_campaigns_[id].ts | 54 +- .../post_admin_campaigns_[id]_promotions.ts | 6 + .../operations/admin/post_admin_claims.ts | 6 + .../admin/post_admin_claims_[id]_cancel.ts | 6 + .../post_admin_claims_[id]_claim-items.ts | 7 + ...min_claims_[id]_claim-items_[action_id].ts | 7 + .../post_admin_claims_[id]_inbound_items.ts | 7 + ...n_claims_[id]_inbound_items_[action_id].ts | 7 + ...min_claims_[id]_inbound_shipping-method.ts | 7 + ...id]_inbound_shipping-method_[action_id].ts | 7 + .../post_admin_claims_[id]_outbound_items.ts | 7 + ..._claims_[id]_outbound_items_[action_id].ts | 7 + ...in_claims_[id]_outbound_shipping-method.ts | 7 + ...d]_outbound_shipping-method_[action_id].ts | 7 + .../admin/post_admin_claims_[id]_request.ts | 7 + .../admin/post_admin_collections.ts | 7 + .../admin/post_admin_collections_[id].ts | 6 + .../post_admin_collections_[id]_products.ts | 6 + .../admin/post_admin_customer-groups.ts | 6 + .../admin/post_admin_customer-groups_[id].ts | 6 + ...st_admin_customer-groups_[id]_customers.ts | 6 + .../operations/admin/post_admin_customers.ts | 35 +- .../admin/post_admin_customers_[id].ts | 35 +- .../post_admin_customers_[id]_addresses.ts | 64 +- ...n_customers_[id]_addresses_[address_id].ts | 64 +- .../admin/post_admin_draft-orders.ts | 16 +- .../operations/admin/post_admin_exchanges.ts | 101 + .../admin/post_admin_exchanges_[id]_cancel.ts | 102 + ...post_admin_exchanges_[id]_inbound_items.ts | 103 + ...xchanges_[id]_inbound_items_[action_id].ts | 111 + ..._exchanges_[id]_inbound_shipping-method.ts | 111 + ...id]_inbound_shipping-method_[action_id].ts | 111 + ...ost_admin_exchanges_[id]_outbound_items.ts | 103 + ...changes_[id]_outbound_items_[action_id].ts | 111 + ...exchanges_[id]_outbound_shipping-method.ts | 111 + ...d]_outbound_shipping-method_[action_id].ts | 112 + .../post_admin_exchanges_[id]_request.ts | 98 + ...min_fulfillment-sets_[id]_service-zones.ts | 6 + .../admin/post_admin_fulfillments.ts | 7 + .../post_admin_fulfillments_[id]_cancel.ts | 6 + .../post_admin_fulfillments_[id]_shipment.ts | 6 + .../admin/post_admin_inventory-items.ts | 7 + .../admin/post_admin_inventory-items_[id].ts | 6 + ...in_inventory-items_[id]_location-levels.ts | 6 + ...tems_[id]_location-levels_[location_id].ts | 6 + ...entory-items_[id]_location-levels_batch.ts | 13 + .../operations/admin/post_admin_invites.ts | 6 + .../admin/post_admin_invites_[id]_resend.ts | 6 + .../admin/post_admin_invites_accept.ts | 22 + .../admin/post_admin_orders_[id].ts | 6 + .../admin/post_admin_orders_[id]_archive.ts | 6 + .../admin/post_admin_orders_[id]_cancel.ts | 6 + .../admin/post_admin_orders_[id]_complete.ts | 13 +- .../post_admin_orders_[id]_fulfillments.ts | 38 +- ...d]_fulfillments_[fulfillment_id]_cancel.ts | 13 +- ...fulfillments_[fulfillment_id]_shipments.ts | 57 +- .../admin/post_admin_payments_[id]_capture.ts | 6 + .../admin/post_admin_payments_[id]_refund.ts | 14 + .../admin/post_admin_price-lists.ts | 6 + .../admin/post_admin_price-lists_[id].ts | 6 + ...ost_admin_price-lists_[id]_prices_batch.ts | 6 + .../post_admin_price-lists_[id]_products.ts | 6 + .../admin/post_admin_price-preferences.ts | 6 + .../post_admin_price-preferences_[id].ts | 6 + .../admin/post_admin_product-categories.ts | 1 + .../admin/post_admin_product-tags.ts | 7 + .../admin/post_admin_product-tags_[id].ts | 7 + .../admin/post_admin_product-types.ts | 7 + .../admin/post_admin_product-types_[id].ts | 7 + .../operations/admin/post_admin_products.ts | 144 +- .../admin/post_admin_products_[id].ts | 146 +- .../admin/post_admin_products_[id]_options.ts | 14 +- ...admin_products_[id]_options_[option_id].ts | 14 +- .../post_admin_products_[id]_variants.ts | 78 +- ...min_products_[id]_variants_[variant_id].ts | 78 +- ...]_variants_[variant_id]_inventory-items.ts | 6 + ...id]_inventory-items_[inventory_item_id].ts | 6 + ...post_admin_products_[id]_variants_batch.ts | 1 + ...cts_[id]_variants_inventory-items_batch.ts | 7 + .../admin/post_admin_products_batch.ts | 1 + .../admin/post_admin_products_export.ts | 1 + .../admin/post_admin_products_import.ts | 1 + .../operations/admin/post_admin_promotions.ts | 12 +- .../admin/post_admin_promotions_[id].ts | 9 +- ...t_admin_promotions_[id]_buy-rules_batch.ts | 46 + .../post_admin_promotions_[id]_rules_batch.ts | 46 + ...dmin_promotions_[id]_target-rules_batch.ts | 46 + .../admin/post_admin_refund-reasons.ts | 115 + .../admin/post_admin_refund-reasons_[id].ts | 118 + .../operations/admin/post_admin_regions.ts | 7 + .../admin/post_admin_regions_[id].ts | 7 + .../admin/post_admin_reservations.ts | 7 + .../admin/post_admin_reservations_[id].ts | 6 + .../admin/post_admin_return-reasons.ts | 6 + .../admin/post_admin_return-reasons_[id].ts | 6 + .../operations/admin/post_admin_returns.ts | 6 + .../admin/post_admin_returns_[id].ts | 7 + .../admin/post_admin_returns_[id]_cancel.ts | 6 + .../post_admin_returns_[id]_dismiss-items.ts | 7 + ..._returns_[id]_dismiss-items_[action_id].ts | 7 + .../post_admin_returns_[id]_receive-items.ts | 7 + ..._returns_[id]_receive-items_[action_id].ts | 7 + .../admin/post_admin_returns_[id]_receive.ts | 6 + ...post_admin_returns_[id]_receive_confirm.ts | 7 + .../post_admin_returns_[id]_request-items.ts | 7 + ..._returns_[id]_request-items_[action_id].ts | 7 + .../admin/post_admin_returns_[id]_request.ts | 7 + ...post_admin_returns_[id]_shipping-method.ts | 7 + ...eturns_[id]_shipping-method_[action_id].ts | 7 + .../admin/post_admin_sales-channels.ts | 7 + .../admin/post_admin_sales-channels_[id].ts | 6 + ...post_admin_sales-channels_[id]_products.ts | 6 + ...admin_shipping-options_[id]_rules_batch.ts | 46 + .../admin/post_admin_shipping-profiles.ts | 1 + .../admin/post_admin_stock-locations.ts | 7 + .../admin/post_admin_stock-locations_[id].ts | 6 + ...ck-locations_[id]_fulfillment-providers.ts | 6 + ...n_stock-locations_[id]_fulfillment-sets.ts | 6 + ...min_stock-locations_[id]_sales-channels.ts | 6 + .../admin/post_admin_stores_[id].ts | 7 + .../operations/admin/post_admin_tax-rates.ts | 7 + .../admin/post_admin_tax-rates_[id].ts | 6 + .../admin/post_admin_tax-rates_[id]_rules.ts | 6 + .../admin/post_admin_tax-regions.ts | 7 + .../operations/admin/post_admin_uploads.ts | 7 + .../operations/admin/post_admin_users.ts | 7 + .../operations/admin/post_admin_users_[id].ts | 6 + ..._workflows-executions_[workflow_id]_run.ts | 11 + ...-executions_[workflow_id]_steps_failure.ts | 14 + ...-executions_[workflow_id]_steps_success.ts | 14 + .../delete_store_carts_[id]_promotions.ts | 12 + ...ore_customers_me_addresses_[address_id].ts | 27 + .../operations/store/get_store_carts_[id].ts | 6 + .../operations/store/get_store_collections.ts | 35 + .../store/get_store_collections_[id].ts | 6 + .../operations/store/get_store_currencies.ts | 6 + .../store/get_store_currencies_[code].ts | 6 + .../store/get_store_customers_me.ts | 6 + .../store/get_store_customers_me_addresses.ts | 6 + ...ore_customers_me_addresses_[address_id].ts | 6 + .../operations/store/get_store_orders.ts | 49 +- .../operations/store/get_store_orders_[id].ts | 20 +- .../store/get_store_payment-providers.ts | 49 +- .../store/get_store_product-categories.ts | 14 +- .../operations/store/get_store_products.ts | 6389 +++++- .../store/get_store_products_[id].ts | 6 + .../operations/store/get_store_regions.ts | 35 + .../store/get_store_regions_[id].ts | 12 + .../store/get_store_return-reasons.ts | 35 + .../store/get_store_return-reasons_[id].ts | 6 + .../store/get_store_shipping-options.ts | 7 + .../operations/store/post_store_carts.ts | 66 +- .../operations/store/post_store_carts_[id].ts | 55 +- .../store/post_store_carts_[id]_complete.ts | 52 + .../store/post_store_carts_[id]_line-items.ts | 6 + ...t_store_carts_[id]_line-items_[line_id].ts | 6 + .../store/post_store_carts_[id]_promotions.ts | 6 + .../post_store_carts_[id]_shipping-methods.ts | 6 + .../store/post_store_carts_[id]_taxes.ts | 6 + .../operations/store/post_store_customers.ts | 6 + .../store/post_store_customers_me.ts | 6 + .../post_store_customers_me_addresses.ts | 6 + ...ore_customers_me_addresses_[address_id].ts | 6 + .../store/post_store_payment-collections.ts | 21 +- ...yment-collections_[id]_payment-sessions.ts | 6 + .../operations/store/post_store_return.ts | 6 + .../oas-output/schemas/AdminApiKeyResponse.ts | 13 + .../schemas/AdminCampaignResponse.ts | 13 + .../oas-output/schemas/AdminClaim.ts | 255 + .../schemas/AdminClaimDeleteResponse.ts | 29 + .../schemas/AdminClaimListResponse.ts | 31 + .../schemas/AdminClaimOrderResponse.ts | 16 + .../schemas/AdminClaimPreviewResponse.ts | 16 + .../schemas/AdminClaimRequestResponse.ts | 19 + .../oas-output/schemas/AdminClaimResponse.ts | 13 + .../AdminClaimReturnPreviewResponse.ts | 16 + .../schemas/AdminCollectionDeleteResponse.ts | 29 + .../schemas/AdminCollectionListResponse.ts | 31 + .../schemas/AdminCollectionResponse.ts | 13 + .../oas-output/schemas/AdminCompleteOrder.ts | 15 - .../oas-output/schemas/AdminCreateCustomer.ts | 40 - .../schemas/AdminCreateCustomerAddress.ts | 77 - .../oas-output/schemas/AdminCreateProduct.ts | 6 +- .../oas-output/schemas/AdminCurrency.ts | 8 + .../schemas/AdminCurrencyListResponse.ts | 31 + .../schemas/AdminCurrencyResponse.ts | 13 + .../schemas/AdminCustomerAddress.ts | 101 + .../schemas/AdminCustomerAddressResponse.ts | 13 + .../schemas/AdminCustomerGroupResponse.ts | 13 + .../schemas/AdminCustomerResponse.ts | 13 + .../schemas/AdminDraftOrderResponse.ts | 13 + .../oas-output/schemas/AdminExchange.ts | 256 + .../schemas/AdminExchangeOrderResponse.ts | 16 + .../schemas/AdminExchangePreviewResponse.ts | 16 + .../schemas/AdminExchangeRequestResponse.ts | 19 + .../schemas/AdminExchangeResponse.ts | 13 + .../schemas/AdminExchangeReturnResponse.ts | 16 + .../generated/oas-output/schemas/AdminFile.ts | 20 + .../schemas/AdminFileListResponse.ts | 16 + .../oas-output/schemas/AdminFileResponse.ts | 13 + .../oas-output/schemas/AdminFulfillment.ts | 94 + .../schemas/AdminFulfillmentAddress.ts | 92 + .../schemas/AdminFulfillmentItem.ts | 68 + .../schemas/AdminFulfillmentLabel.ts | 53 + .../schemas/AdminFulfillmentProvider.ts | 2 +- .../AdminFulfillmentProviderListResponse.ts | 31 + .../schemas/AdminFulfillmentResponse.ts | 13 + .../oas-output/schemas/AdminFulfillmentSet.ts | 3 + .../oas-output/schemas/AdminInventoryItem.ts | 71 + .../schemas/AdminInventoryItemResponse.ts | 13 + .../oas-output/schemas/AdminInvite.ts | 49 + .../oas-output/schemas/AdminInviteResponse.ts | 13 + .../oas-output/schemas/AdminNotification.ts | 68 + .../schemas/AdminNotificationListResponse.ts | 31 + .../schemas/AdminNotificationResponse.ts | 13 + .../oas-output/schemas/AdminOrder.ts | 237 + .../schemas/AdminOrderCancelFulfillment.ts | 13 - .../schemas/AdminOrderCreateFulfillment.ts | 42 - .../schemas/AdminOrderCreateShipment.ts | 60 - .../oas-output/schemas/AdminOrderPreview.ts | 647 + .../schemas/AdminOrderPreviewResponse.ts | 13 + .../oas-output/schemas/AdminOrderResponse.ts | 13 + .../schemas/AdminOrderReturnResponse.ts | 16 + .../oas-output/schemas/AdminPayment.ts | 135 + .../schemas/AdminPaymentCollection.ts | 121 + .../schemas/AdminPaymentProvider.ts | 8 + .../schemas/AdminPaymentResponse.ts | 13 + .../AdminPostCancelExchangeReqSchema.ts | 13 + .../AdminPostClaimsItemsActionReqSchema.ts | 11 +- .../AdminPostExchangesAddItemsReqSchema.ts | 42 + ...hangesRequestItemsReturnActionReqSchema.ts | 24 + ...ostExchangesReturnRequestItemsReqSchema.ts | 42 + ...minPostExchangesShippingActionReqSchema.ts | 20 + .../AdminPostExchangesShippingReqSchema.ts | 30 + .../AdminPostExhangesItemsActionReqSchema.ts | 17 + .../schemas/AdminPostOrderClaimsReqSchema.ts | 5 + .../AdminPostOrderExchangesReqSchema.ts | 27 + .../AdminPostReturnsShippingReqSchema.ts | 10 +- .../oas-output/schemas/AdminPriceList.ts | 75 + .../schemas/AdminPriceListBatchResponse.ts | 46 + .../schemas/AdminPriceListDeleteResponse.ts | 29 + .../schemas/AdminPriceListListResponse.ts | 31 + .../oas-output/schemas/AdminPriceListPrice.ts | 76 + .../schemas/AdminPriceListResponse.ts | 13 + .../schemas/AdminPricePreference.ts | 48 + .../AdminPricePreferenceDeleteResponse.ts | 29 + .../AdminPricePreferenceListResponse.ts | 31 + .../schemas/AdminPricePreferenceResponse.ts | 13 + .../oas-output/schemas/AdminProduct.ts | 100 +- .../schemas/AdminProductCategory.ts | 30 +- .../AdminProductCategoryDeleteResponse.ts | 29 + .../schemas/AdminProductTagDeleteResponse.ts | 29 + .../schemas/AdminProductTagListResponse.ts | 31 + .../schemas/AdminProductTagResponse.ts | 13 + .../schemas/AdminProductTypeDeleteResponse.ts | 29 + .../schemas/AdminProductTypeListResponse.ts | 31 + .../schemas/AdminProductTypeResponse.ts | 13 + .../oas-output/schemas/AdminProductVariant.ts | 50 +- ...minProductVariantInventoryBatchResponse.ts | 112 + .../AdminProductVariantInventoryLink.ts | 32 + ...oductVariantInventoryLinkDeleteResponse.ts | 26 + .../schemas/AdminProductVariantParams.ts | 218 +- .../oas-output/schemas/AdminPromotion.ts | 41 + .../schemas/AdminPromotionResponse.ts | 13 + .../oas-output/schemas/AdminPromotionRule.ts | 39 + .../oas-output/schemas/AdminRefundReason.ts | 40 + .../oas-output/schemas/AdminRegion.ts | 52 + .../oas-output/schemas/AdminRegionResponse.ts | 13 + .../schemas/AdminReservationResponse.ts | 13 + .../oas-output/schemas/AdminReturn.ts | 71 + .../oas-output/schemas/AdminReturnItem.ts | 46 + .../schemas/AdminReturnPreviewResponse.ts | 16 + .../oas-output/schemas/AdminReturnReason.ts | 44 + .../schemas/AdminReturnReasonListResponse.ts | 31 + .../schemas/AdminReturnReasonResponse.ts | 13 + .../oas-output/schemas/AdminReturnResponse.ts | 13 + .../schemas/AdminRuleAttributeOption.ts | 46 + .../schemas/AdminRuleValueOption.ts | 25 + .../AdminSalesChannelDeleteResponse.ts | 29 + .../schemas/AdminSalesChannelResponse.ts | 13 + .../oas-output/schemas/AdminServiceZone.ts | 3 + .../schemas/AdminShippingOptionRule.ts | 60 + .../oas-output/schemas/AdminStockLocation.ts | 42 + .../schemas/AdminStockLocationAddress.ts | 8 + .../AdminStockLocationDeleteResponse.ts | 29 + .../schemas/AdminStockLocationListResponse.ts | 31 + .../schemas/AdminStockLocationResponse.ts | 13 + .../oas-output/schemas/AdminStore.ts | 57 + .../oas-output/schemas/AdminStoreCurrency.ts | 51 + .../schemas/AdminStoreListResponse.ts | 31 + .../oas-output/schemas/AdminStoreResponse.ts | 13 + .../oas-output/schemas/AdminTaxRate.ts | 81 + .../schemas/AdminTaxRateDeleteResponse.ts | 29 + .../schemas/AdminTaxRateResponse.ts | 13 + .../oas-output/schemas/AdminTaxRateRule.ts | 20 + .../oas-output/schemas/AdminTaxRegion.ts | 102 + .../schemas/AdminTaxRegionDeleteResponse.ts | 29 + .../schemas/AdminTaxRegionResponse.ts | 13 + .../oas-output/schemas/AdminUpdateCustomer.ts | 40 - .../oas-output/schemas/AdminUpdateProduct.ts | 169 +- .../generated/oas-output/schemas/AdminUser.ts | 58 + .../schemas/AdminUserDeleteResponse.ts | 29 + .../schemas/AdminUserListResponse.ts | 31 + .../oas-output/schemas/AdminUserResponse.ts | 13 + .../schemas/AdminWorkflowExecution.ts | 55 + .../schemas/AdminWorkflowExecutionResponse.ts | 13 + .../oas-output/schemas/ApiKeyResponse.ts | 64 + .../schemas/BaseApplicationMethod.ts | 63 + .../schemas/BaseCalculatedPriceSet.ts | 2 +- .../oas-output/schemas/BaseCapture.ts | 8 + .../generated/oas-output/schemas/BaseCart.ts | 8 + .../oas-output/schemas/BaseCartAddress.ts | 74 + .../oas-output/schemas/BaseCartLineItem.ts | 311 + .../schemas/BaseCartShippingMethod.ts | 183 + .../generated/oas-output/schemas/BaseClaim.ts | 8 + .../oas-output/schemas/BaseClaimItem.ts | 60 + .../oas-output/schemas/BaseExchangeItem.ts | 50 + .../schemas/BaseFulfillmentProvider.ts | 20 + .../schemas/BaseLineItemAdjustment.ts | 8 + .../oas-output/schemas/BaseLineItemTaxLine.ts | 8 + .../generated/oas-output/schemas/BaseOrder.ts | 8 + .../oas-output/schemas/BaseOrderAddress.ts | 75 + .../oas-output/schemas/BaseOrderChange.ts | 149 + .../schemas/BaseOrderChangeAction.ts | 8 + .../schemas/BaseOrderFulfillment.ts | 74 + .../oas-output/schemas/BaseOrderItemDetail.ts | 8 + .../oas-output/schemas/BaseOrderLineItem.ts | 216 + .../schemas/BaseOrderLineItemAdjustment.ts | 8 + .../schemas/BaseOrderLineItemTaxLine.ts | 8 + .../schemas/BaseOrderShippingMethod.ts | 178 + .../BaseOrderShippingMethodAdjustment.ts | 8 + .../schemas/BaseOrderShippingMethodTaxLine.ts | 8 + .../oas-output/schemas/BaseOrderSummary.ts | 85 + .../schemas/BaseOrderTransaction.ts | 56 + .../oas-output/schemas/BasePayment.ts | 8 + .../schemas/BasePaymentCollection.ts | 121 + .../oas-output/schemas/BasePaymentProvider.ts | 8 + .../oas-output/schemas/BasePaymentSession.ts | 8 + .../oas-output/schemas/BaseProduct.ts | 2 +- .../oas-output/schemas/BasePromotion.ts | 8 + .../oas-output/schemas/BasePromotionRule.ts | 39 + .../schemas/BasePromotionRuleValue.ts | 19 + .../oas-output/schemas/BaseRefund.ts | 8 + .../oas-output/schemas/BaseRegion.ts | 52 + .../oas-output/schemas/BaseRegionCountry.ts | 8 + .../oas-output/schemas/BaseReturnItem.ts | 8 + .../schemas/BaseRuleOperatorOptions.ts | 25 + .../schemas/BaseShippingMethodAdjustment.ts | 8 + .../schemas/BaseShippingMethodTaxLine.ts | 8 + ...nUpdateCampaign.ts => CampaignResponse.ts} | 83 +- .../schemas/CreateCartWorkflowInput.ts | 65 - .../oas-output/schemas/IBigNumber.ts | 8 + .../oas-output/schemas/InventoryLevel.ts | 48 + .../generated/oas-output/schemas/Order.ts | 941 + .../oas-output/schemas/OrderAddress.ts | 74 + .../oas-output/schemas/OrderChange.ts | 151 + .../oas-output/schemas/OrderChangeAction.ts | 8 + .../oas-output/schemas/OrderClaim.ts | 8 + .../oas-output/schemas/OrderExchange.ts | 8 + .../generated/oas-output/schemas/OrderItem.ts | 8 + .../oas-output/schemas/OrderLineItem.ts | 364 + .../schemas/OrderLineItemAdjustment.ts | 8 + .../schemas/OrderLineItemTaxLine.ts | 8 + .../oas-output/schemas/OrderShippingMethod.ts | 219 + .../schemas/OrderShippingMethodAdjustment.ts | 8 + .../schemas/OrderShippingMethodTaxLine.ts | 8 + .../oas-output/schemas/OrderTransaction.ts | 71 + .../schemas/RefundReasonResponse.ts | 13 + .../oas-output/schemas/ReservationResponse.ts | 71 + .../generated/oas-output/schemas/Return.ts | 8 + .../generated/oas-output/schemas/StoreCart.ts | 354 + .../oas-output/schemas/StoreCartResponse.ts | 13 + .../oas-output/schemas/StoreCollection.ts | 52 + .../schemas/StoreCollectionResponse.ts | 13 + .../oas-output/schemas/StoreCurrency.ts | 74 + .../schemas/StoreCurrencyListResponse.ts | 31 + .../schemas/StoreCurrencyResponse.ts | 13 + .../oas-output/schemas/StoreCustomer.ts | 78 + .../schemas/StoreCustomerAddress.ts | 101 + .../StoreCustomerAddressListResponse.ts | 31 + .../schemas/StoreCustomerAddressResponse.ts | 13 + .../schemas/StoreCustomerResponse.ts | 13 + .../oas-output/schemas/StoreOrder.ts | 236 + .../oas-output/schemas/StoreOrderResponse.ts | 13 + .../schemas/StorePaymentCollection.ts | 121 + .../schemas/StorePaymentCollectionResponse.ts | 13 + .../schemas/StorePaymentProvider.ts | 15 + .../oas-output/schemas/StoreProduct.ts | 104 +- .../schemas/StoreProductCategory.ts | 28 +- .../schemas/StoreProductResponse.ts | 13 + .../oas-output/schemas/StoreRegion.ts | 52 + .../oas-output/schemas/StoreReturn.ts | 71 + .../oas-output/schemas/StoreReturnReason.ts | 44 + .../schemas/StoreReturnReasonResponse.ts | 13 + .../oas-output/schemas/StoreReturnResponse.ts | 13 + .../oas-output/schemas/StoreShippingOption.ts | 70 + .../StoreShippingOptionListResponse.ts | 16 + .../oas-output/schemas/UpdateCartData.ts | 49 - 1211 files changed, 92070 insertions(+), 5062 deletions(-) create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}/get.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges/get.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_cancel/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/delete.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/delete.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/delete.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/delete.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_request/delete.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_request/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-variants/get.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons/get.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/delete.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/get.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/post.sh create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminApiKeyResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCampaignResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminClaimDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminClaimListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminClaimOrderResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminClaimPreviewResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminClaimRequestResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminClaimResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminClaimReturnPreviewResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCollectionDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCollectionListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCollectionResponse.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCompleteOrder.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomer.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerAddress.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCurrency.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCurrencyListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCurrencyResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCustomerAddress.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCustomerAddressResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCustomerResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminExchangeOrderResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminExchangePreviewResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminExchangeRequestResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminExchangeResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminExchangeReturnResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminFile.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminFileListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminFileResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminFulfillment.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentAddress.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentItem.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentLabel.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProviderListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItem.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminInvite.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminInviteResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminNotification.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminNotificationListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminNotificationResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminOrderCreateFulfillment.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminOrderCreateShipment.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreviewResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminOrderResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminOrderReturnResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPayment.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPaymentProvider.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPaymentResponse.yaml rename www/apps/api-reference/specs/{store/components/schemas/AdminOrderCancelFulfillment.yaml => admin/components/schemas/AdminPostCancelExchangeReqSchema.yaml} (53%) create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPostExhangesItemsActionReqSchema.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPriceList.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPriceListBatchResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPriceListListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPriceListPrice.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPriceListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPricePreference.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminProductTagDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminProductTagListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminProductTagResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryBatchResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLink.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPromotionResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPromotionRule.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminRefundReason.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminRegion.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminRegionResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminReservationResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminReturn.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminReturnItem.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminReturnPreviewResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminReturnReason.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminReturnResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminRuleAttributeOption.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminRuleValueOption.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionRule.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminStockLocation.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationAddress.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminStore.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminStoreCurrency.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminStoreListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminStoreResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminTaxRate.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateRule.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionResponse.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomer.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminUser.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminUserDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminUserListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminUserResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecution.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/ApiKeyResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseApplicationMethod.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseCapture.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseCart.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseCartAddress.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseCartLineItem.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseCartShippingMethod.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseClaim.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseClaimItem.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseExchangeItem.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseFulfillmentProvider.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseLineItemAdjustment.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseLineItemTaxLine.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseOrderChange.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseOrderChangeAction.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseOrderItemDetail.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItemAdjustment.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItemTaxLine.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethod.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethodAdjustment.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethodTaxLine.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseOrderSummary.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseOrderTransaction.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BasePayment.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BasePaymentProvider.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BasePaymentSession.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BasePromotion.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BasePromotionRule.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BasePromotionRuleValue.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseRefund.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseRegion.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseRegionCountry.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseReturnItem.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseRuleOperatorOptions.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseShippingMethodAdjustment.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseShippingMethodTaxLine.yaml rename www/apps/api-reference/specs/{store/components/schemas/AdminUpdateCampaign.yaml => admin/components/schemas/CampaignResponse.yaml} (51%) delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/CreateCartWorkflowInput.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/IBigNumber.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/InventoryLevel.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/Order.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/OrderChangeAction.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/OrderClaim.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/OrderItem.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/OrderLineItemAdjustment.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/OrderLineItemTaxLine.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethod.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodAdjustment.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodTaxLine.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/OrderTransaction.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/RefundReasonResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/ReservationResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/Return.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCartResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCollection.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCollectionResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCurrency.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCurrencyListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCurrencyResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCustomer.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddressListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddressResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCustomerResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreOrderResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollectionResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StorePaymentProvider.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreProductResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreRegion.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreReturnReason.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreReturnReasonResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreReturnResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreShippingOption.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreShippingOptionListResponse.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_claims_{id}.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminApiKeyResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCampaignResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminClaimDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminClaimListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminClaimOrderResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminClaimPreviewResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminClaimRequestResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminClaimResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminClaimReturnPreviewResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCollectionDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCollectionListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCollectionResponse.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCompleteOrder.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomer.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomerAddress.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCurrency.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCurrencyListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCurrencyResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCustomerAddress.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCustomerAddressResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroupResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCustomerResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminExchangeOrderResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminExchangePreviewResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminExchangeRequestResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminExchangeResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminExchangeReturnResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminFile.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminFileListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminFileResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminFulfillment.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentAddress.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentItem.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentLabel.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProviderListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminInventoryItem.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminInventoryItemResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminInvite.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminInviteResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminNotification.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminNotificationListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminNotificationResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminOrderCreateFulfillment.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminOrderCreateShipment.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminOrderPreviewResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminOrderResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminOrderReturnResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPayment.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPaymentProvider.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPaymentResponse.yaml rename www/apps/api-reference/specs/{admin/components/schemas/AdminOrderCancelFulfillment.yaml => store/components/schemas/AdminPostCancelExchangeReqSchema.yaml} (53%) create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPostExhangesItemsActionReqSchema.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPriceList.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPriceListBatchResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPriceListDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPriceListListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPriceListPrice.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPriceListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPricePreference.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminProductTagDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminProductTagListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminProductTagResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminProductTypeDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminProductTypeListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminProductTypeResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryBatchResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLink.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPromotionResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPromotionRule.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminRefundReason.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminRegion.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminRegionResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminReservationResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminReturn.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminReturnItem.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminReturnPreviewResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminReturnReason.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminReturnResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminRuleAttributeOption.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminRuleValueOption.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionRule.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminStockLocation.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminStockLocationAddress.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminStockLocationDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminStockLocationListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminStockLocationResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminStore.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminStoreCurrency.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminStoreListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminStoreResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminTaxRate.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminTaxRateDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminTaxRateResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminTaxRateRule.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionResponse.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomer.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminUser.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminUserDeleteResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminUserListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminUserResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecution.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/ApiKeyResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseApplicationMethod.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseCapture.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseCart.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseCartAddress.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseCartLineItem.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseCartShippingMethod.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseClaim.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseClaimItem.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseExchangeItem.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseFulfillmentProvider.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseLineItemAdjustment.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseLineItemTaxLine.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseOrderChange.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseOrderChangeAction.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseOrderItemDetail.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItemAdjustment.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItemTaxLine.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethod.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethodAdjustment.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethodTaxLine.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseOrderSummary.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseOrderTransaction.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BasePayment.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BasePaymentCollection.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BasePaymentProvider.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BasePaymentSession.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BasePromotion.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BasePromotionRule.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BasePromotionRuleValue.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseRefund.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseRegion.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseRegionCountry.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseReturnItem.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseRuleOperatorOptions.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseShippingMethodAdjustment.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseShippingMethodTaxLine.yaml rename www/apps/api-reference/specs/{admin/components/schemas/AdminUpdateCampaign.yaml => store/components/schemas/CampaignResponse.yaml} (51%) delete mode 100644 www/apps/api-reference/specs/store/components/schemas/CreateCartWorkflowInput.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/IBigNumber.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/InventoryLevel.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/Order.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/OrderAddress.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/OrderChangeAction.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/OrderClaim.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/OrderItem.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/OrderLineItemAdjustment.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/OrderLineItemTaxLine.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/OrderShippingMethod.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodAdjustment.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodTaxLine.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/OrderTransaction.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/RefundReasonResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/ReservationResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/Return.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCartResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCollection.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCollectionResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCurrency.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCurrencyListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCurrencyResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCustomer.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddress.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddressListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddressResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCustomerResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreOrderResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StorePaymentCollection.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StorePaymentProvider.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreProductResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreRegion.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreReturn.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreReturnReason.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreReturnResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreShippingOption.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionListResponse.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml create mode 100644 www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts create mode 100644 www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts create mode 100644 www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts create mode 100644 www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts create mode 100644 www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons_[id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts create mode 100644 www/utils/generated/oas-output/schemas/AdminApiKeyResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCampaignResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminClaim.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminClaimDeleteResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminClaimListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminClaimOrderResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminClaimPreviewResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminClaimRequestResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminClaimResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminClaimReturnPreviewResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCollectionDeleteResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCollectionListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCollectionResponse.ts delete mode 100644 www/utils/generated/oas-output/schemas/AdminCompleteOrder.ts delete mode 100644 www/utils/generated/oas-output/schemas/AdminCreateCustomer.ts delete mode 100644 www/utils/generated/oas-output/schemas/AdminCreateCustomerAddress.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCurrency.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCurrencyListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCurrencyResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCustomerAddress.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCustomerAddressResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCustomerGroupResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCustomerResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminDraftOrderResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminExchange.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminExchangeOrderResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminExchangePreviewResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminExchangeRequestResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminExchangeResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminExchangeReturnResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminFile.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminFileListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminFileResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminFulfillment.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminFulfillmentAddress.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminFulfillmentItem.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminFulfillmentLabel.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminFulfillmentProviderListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminFulfillmentResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminInventoryItem.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminInventoryItemResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminInvite.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminInviteResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminNotification.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminNotificationListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminNotificationResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminOrder.ts delete mode 100644 www/utils/generated/oas-output/schemas/AdminOrderCancelFulfillment.ts delete mode 100644 www/utils/generated/oas-output/schemas/AdminOrderCreateFulfillment.ts delete mode 100644 www/utils/generated/oas-output/schemas/AdminOrderCreateShipment.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminOrderPreview.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminOrderPreviewResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminOrderResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminOrderReturnResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPayment.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPaymentProvider.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPaymentResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPostCancelExchangeReqSchema.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPostExchangesAddItemsReqSchema.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPostExchangesReturnRequestItemsReqSchema.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPostExchangesShippingActionReqSchema.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPostExchangesShippingReqSchema.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPostExhangesItemsActionReqSchema.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPostOrderExchangesReqSchema.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPriceList.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPriceListBatchResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPriceListDeleteResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPriceListListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPriceListPrice.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPriceListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPricePreference.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPricePreferenceDeleteResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPricePreferenceListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPricePreferenceResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminProductCategoryDeleteResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminProductTagDeleteResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminProductTagListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminProductTagResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminProductTypeDeleteResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminProductTypeListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminProductTypeResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminProductVariantInventoryBatchResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLink.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLinkDeleteResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPromotion.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPromotionResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminPromotionRule.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminRefundReason.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminRegion.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminRegionResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminReservationResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminReturn.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminReturnItem.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminReturnPreviewResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminReturnReason.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminReturnReasonListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminReturnReasonResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminReturnResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminRuleAttributeOption.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminRuleValueOption.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminSalesChannelDeleteResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminSalesChannelResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminShippingOptionRule.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminStockLocation.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminStockLocationAddress.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminStockLocationDeleteResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminStockLocationListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminStockLocationResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminStore.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminStoreCurrency.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminStoreListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminStoreResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminTaxRate.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminTaxRateDeleteResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminTaxRateResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminTaxRateRule.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminTaxRegion.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminTaxRegionDeleteResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminTaxRegionResponse.ts delete mode 100644 www/utils/generated/oas-output/schemas/AdminUpdateCustomer.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminUser.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminUserDeleteResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminUserListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminUserResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminWorkflowExecution.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminWorkflowExecutionResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/ApiKeyResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseApplicationMethod.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseCapture.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseCart.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseCartAddress.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseCartLineItem.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseCartShippingMethod.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseClaim.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseClaimItem.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseExchangeItem.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseFulfillmentProvider.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseLineItemAdjustment.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseLineItemTaxLine.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseOrder.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseOrderAddress.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseOrderChange.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseOrderChangeAction.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseOrderItemDetail.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseOrderLineItemAdjustment.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseOrderLineItemTaxLine.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseOrderShippingMethod.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseOrderShippingMethodAdjustment.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseOrderShippingMethodTaxLine.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseOrderSummary.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseOrderTransaction.ts create mode 100644 www/utils/generated/oas-output/schemas/BasePayment.ts create mode 100644 www/utils/generated/oas-output/schemas/BasePaymentCollection.ts create mode 100644 www/utils/generated/oas-output/schemas/BasePaymentProvider.ts create mode 100644 www/utils/generated/oas-output/schemas/BasePaymentSession.ts create mode 100644 www/utils/generated/oas-output/schemas/BasePromotion.ts create mode 100644 www/utils/generated/oas-output/schemas/BasePromotionRule.ts create mode 100644 www/utils/generated/oas-output/schemas/BasePromotionRuleValue.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseRefund.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseRegion.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseRegionCountry.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseReturnItem.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseRuleOperatorOptions.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseShippingMethodAdjustment.ts create mode 100644 www/utils/generated/oas-output/schemas/BaseShippingMethodTaxLine.ts rename www/utils/generated/oas-output/schemas/{AdminUpdateCampaign.ts => CampaignResponse.ts} (50%) delete mode 100644 www/utils/generated/oas-output/schemas/CreateCartWorkflowInput.ts create mode 100644 www/utils/generated/oas-output/schemas/IBigNumber.ts create mode 100644 www/utils/generated/oas-output/schemas/InventoryLevel.ts create mode 100644 www/utils/generated/oas-output/schemas/Order.ts create mode 100644 www/utils/generated/oas-output/schemas/OrderAddress.ts create mode 100644 www/utils/generated/oas-output/schemas/OrderChange.ts create mode 100644 www/utils/generated/oas-output/schemas/OrderChangeAction.ts create mode 100644 www/utils/generated/oas-output/schemas/OrderClaim.ts create mode 100644 www/utils/generated/oas-output/schemas/OrderExchange.ts create mode 100644 www/utils/generated/oas-output/schemas/OrderItem.ts create mode 100644 www/utils/generated/oas-output/schemas/OrderLineItem.ts create mode 100644 www/utils/generated/oas-output/schemas/OrderLineItemAdjustment.ts create mode 100644 www/utils/generated/oas-output/schemas/OrderLineItemTaxLine.ts create mode 100644 www/utils/generated/oas-output/schemas/OrderShippingMethod.ts create mode 100644 www/utils/generated/oas-output/schemas/OrderShippingMethodAdjustment.ts create mode 100644 www/utils/generated/oas-output/schemas/OrderShippingMethodTaxLine.ts create mode 100644 www/utils/generated/oas-output/schemas/OrderTransaction.ts create mode 100644 www/utils/generated/oas-output/schemas/RefundReasonResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/ReservationResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/Return.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreCart.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreCartResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreCollection.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreCollectionResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreCurrency.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreCurrencyListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreCurrencyResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreCustomer.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreCustomerAddress.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreCustomerAddressListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreCustomerAddressResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreCustomerResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreOrder.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreOrderResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/StorePaymentCollection.ts create mode 100644 www/utils/generated/oas-output/schemas/StorePaymentCollectionResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/StorePaymentProvider.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreProductResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreRegion.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreReturn.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreReturnReason.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreReturnReasonResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreReturnResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreShippingOption.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreShippingOptionListResponse.ts delete mode 100644 www/utils/generated/oas-output/schemas/UpdateCartData.ts diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}/get.sh new file mode 100644 index 0000000000..1c3dd7f2c6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/claims/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges/get.sh new file mode 100644 index 0000000000..801c8a9893 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/exchanges' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges/post.sh new file mode 100644 index 0000000000..14651ebe9b --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges/post.sh @@ -0,0 +1,7 @@ +curl -X POST '{backend_url}/admin/exchanges' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "order_id": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_cancel/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_cancel/post.sh new file mode 100644 index 0000000000..3297293f06 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_cancel/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/exchanges/{id}/cancel' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items/post.sh new file mode 100644 index 0000000000..2fede41df1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/items' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/delete.sh new file mode 100644 index 0000000000..6bcbee03da --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/post.sh new file mode 100644 index 0000000000..63f7ef8236 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method/post.sh new file mode 100644 index 0000000000..9d948d33d0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method/post.sh @@ -0,0 +1,6 @@ +curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/shipping-method' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "shipping_option_id": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/delete.sh new file mode 100644 index 0000000000..e84f1220f4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/post.sh new file mode 100644 index 0000000000..1a05d7a98a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items/post.sh new file mode 100644 index 0000000000..f96acaa8e4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/items' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/delete.sh new file mode 100644 index 0000000000..8e718f5e4f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/post.sh new file mode 100644 index 0000000000..404fa4651a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method/post.sh new file mode 100644 index 0000000000..401d4df26f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method/post.sh @@ -0,0 +1,6 @@ +curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/shipping-method' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "shipping_option_id": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/delete.sh new file mode 100644 index 0000000000..183e0bbdb4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/post.sh new file mode 100644 index 0000000000..2f416713ef --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_request/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_request/delete.sh new file mode 100644 index 0000000000..ee18c94a42 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_request/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/exchanges/{id}/request' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_request/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_request/post.sh new file mode 100644 index 0000000000..1f917cbada --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_request/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/exchanges/{id}/request' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-variants/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-variants/get.sh new file mode 100644 index 0000000000..885315611f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-variants/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/product-variants' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons/get.sh new file mode 100644 index 0000000000..085a0267ec --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/refund-reasons' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons/post.sh new file mode 100644 index 0000000000..7c561f9022 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons/post.sh @@ -0,0 +1,7 @@ +curl -X POST '{backend_url}/admin/refund-reasons' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "label": "{value}", + "description": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/delete.sh new file mode 100644 index 0000000000..740e330caa --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/refund-reasons/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/get.sh new file mode 100644 index 0000000000..9bbf91892a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/refund-reasons/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/post.sh new file mode 100644 index 0000000000..463943c99a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons_{id}/post.sh @@ -0,0 +1,6 @@ +curl -X POST '{backend_url}/admin/refund-reasons/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "description": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminApiKeyResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminApiKeyResponse.yaml new file mode 100644 index 0000000000..7d07ea15a7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminApiKeyResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminApiKeyResponse +required: + - api_key +properties: + api_key: + $ref: ./ApiKeyResponse.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCampaignResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCampaignResponse.yaml new file mode 100644 index 0000000000..a7019974cb --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCampaignResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminCampaignResponse +required: + - campaign +properties: + campaign: + $ref: ./CampaignResponse.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml new file mode 100644 index 0000000000..9eecf34368 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml @@ -0,0 +1,250 @@ +type: object +description: The claim's details. +x-schemaName: AdminClaim +required: + - order_id + - claim_items + - additional_items + - currency_code + - id + - region_id + - customer_id + - sales_channel_id + - email + - shipping_methods + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total +properties: + order_id: + type: string + title: order_id + description: The claim's order id. + claim_items: + type: array + description: The claim's claim items. + items: + $ref: ./BaseClaimItem.yaml + additional_items: + type: array + description: The claim's additional items. + items: {} + return: + $ref: ./Return.yaml + return_id: + type: string + title: return_id + description: The claim's return id. + no_notification: + type: boolean + title: no_notification + description: The claim's no notification. + refund_amount: + type: number + title: refund_amount + description: The claim's refund amount. + currency_code: + type: string + title: currency_code + description: The claim's currency code. + id: + type: string + title: id + description: The claim's ID. + region_id: + type: string + title: region_id + description: The claim's region id. + customer_id: + type: string + title: customer_id + description: The claim's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The claim's sales channel id. + email: + type: string + title: email + description: The claim's email. + format: email + display_id: + type: string + title: display_id + description: The claim's display id. + shipping_address: + $ref: ./BaseOrderAddress.yaml + billing_address: + $ref: ./BaseOrderAddress.yaml + shipping_methods: + type: array + description: The claim's shipping methods. + items: + $ref: ./BaseOrderShippingMethod.yaml + payment_collections: + type: array + description: The claim's payment collections. + items: + $ref: ./BasePaymentCollection.yaml + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The claim's fulfillments. + items: + $ref: ./BaseOrderFulfillment.yaml + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The claim's transactions. + items: + $ref: ./BaseOrderTransaction.yaml + summary: + $ref: ./BaseOrderSummary.yaml + metadata: + type: object + description: The claim's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The claim's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The claim's updated at. + original_item_total: + type: number + title: original_item_total + description: The claim's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The claim's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The claim's original item tax total. + item_total: + type: number + title: item_total + description: The claim's item total. + item_subtotal: + type: number + title: item_subtotal + description: The claim's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The claim's item tax total. + original_total: + type: number + title: original_total + description: The claim's original total. + original_subtotal: + type: number + title: original_subtotal + description: The claim's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The claim's original tax total. + total: + type: number + title: total + description: The claim's total. + subtotal: + type: number + title: subtotal + description: The claim's subtotal. + tax_total: + type: number + title: tax_total + description: The claim's tax total. + discount_total: + type: number + title: discount_total + description: The claim's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The claim's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The claim's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The claim's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The claim's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The claim's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The claim's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The claim's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The claim's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The claim's original shipping tax total. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimDeleteResponse.yaml new file mode 100644 index 0000000000..3ef16374d2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminClaimDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The claim's ID. + object: + type: string + title: object + description: The claim's object. + default: claim + deleted: + type: boolean + title: deleted + description: The claim's deleted. + parent: + type: object + description: The claim's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimListResponse.yaml new file mode 100644 index 0000000000..71a3c2b604 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminClaimListResponse +required: + - limit + - offset + - count + - claims +properties: + limit: + type: number + title: limit + description: The claim's limit. + offset: + type: number + title: offset + description: The claim's offset. + count: + type: number + title: count + description: The claim's count. + claims: + type: array + description: The claim's claims. + items: + $ref: ./AdminClaim.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimOrderResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimOrderResponse.yaml new file mode 100644 index 0000000000..f656466d44 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimOrderResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminClaimOrderResponse +required: + - order + - claim +properties: + order: + $ref: ./Order.yaml + claim: + $ref: ./AdminClaim.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimPreviewResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimPreviewResponse.yaml new file mode 100644 index 0000000000..f463a9ee83 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimPreviewResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminClaimPreviewResponse +required: + - order_preview + - claim +properties: + order_preview: + $ref: ./Order.yaml + claim: + $ref: ./AdminClaim.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimRequestResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimRequestResponse.yaml new file mode 100644 index 0000000000..74bbc37b56 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimRequestResponse.yaml @@ -0,0 +1,14 @@ +type: object +description: SUMMARY +x-schemaName: AdminClaimRequestResponse +required: + - return + - order_preview + - claim +properties: + return: + $ref: ./AdminReturn.yaml + order_preview: + $ref: ./Order.yaml + claim: + $ref: ./AdminClaim.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimResponse.yaml new file mode 100644 index 0000000000..f827238354 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminClaimResponse +required: + - claim +properties: + claim: + $ref: ./AdminClaim.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimReturnPreviewResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimReturnPreviewResponse.yaml new file mode 100644 index 0000000000..ff9659b347 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimReturnPreviewResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminClaimReturnPreviewResponse +required: + - order_preview + - return +properties: + order_preview: + $ref: ./Order.yaml + return: + $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionDeleteResponse.yaml new file mode 100644 index 0000000000..7c95f2e8a3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminCollectionDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The collection's ID. + object: + type: string + title: object + description: The collection's object. + default: collection + deleted: + type: boolean + title: deleted + description: The collection's deleted. + parent: + type: object + description: The collection's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionListResponse.yaml new file mode 100644 index 0000000000..e97fa1ee12 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminCollectionListResponse +required: + - limit + - offset + - count + - collections +properties: + limit: + type: number + title: limit + description: The collection's limit. + offset: + type: number + title: offset + description: The collection's offset. + count: + type: number + title: count + description: The collection's count. + collections: + type: array + description: The collection's collections. + items: + $ref: ./AdminCollection.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionResponse.yaml new file mode 100644 index 0000000000..d48e815089 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminCollectionResponse +required: + - collection +properties: + collection: + $ref: ./AdminCollection.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCompleteOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCompleteOrder.yaml deleted file mode 100644 index c9efe9e5a2..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCompleteOrder.yaml +++ /dev/null @@ -1,10 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminCompleteOrder -required: - - order_id -properties: - order_id: - type: string - title: order_id - description: The order's order id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomer.yaml deleted file mode 100644 index 9b448177ad..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomer.yaml +++ /dev/null @@ -1,35 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminCreateCustomer -required: - - email - - company_name - - first_name - - last_name - - phone - - metadata -properties: - email: - type: string - title: email - description: The customer's email. - format: email - company_name: - type: string - title: company_name - description: The customer's company name. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - phone: - 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/AdminCreateCustomerAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerAddress.yaml deleted file mode 100644 index 744dd0a854..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerAddress.yaml +++ /dev/null @@ -1,72 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminCreateCustomerAddress -required: - - address_name - - company - - first_name - - last_name - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - phone - - metadata -properties: - address_name: - type: string - title: address_name - description: The customer's address name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: The customer's is default shipping. - is_default_billing: - type: boolean - title: is_default_billing - description: The customer's is default billing. - company: - type: string - title: company - description: The customer's company. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - address_1: - type: string - title: address_1 - description: The customer's address 1. - address_2: - type: string - title: address_2 - description: The customer's address 2. - city: - type: string - title: city - description: The customer's city. - country_code: - type: string - title: country_code - description: The customer's country code. - province: - type: string - title: province - description: The customer's province. - postal_code: - type: string - title: postal_code - description: The customer's postal code. - phone: - 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/AdminCreateProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml index a582cab145..849d38df54 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml @@ -79,15 +79,13 @@ properties: items: type: object description: The tag's tags. + required: + - id properties: id: type: string title: id description: The tag's ID. - value: - type: string - title: value - description: The tag's value. options: type: array description: The create's options. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCurrency.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCurrency.yaml new file mode 100644 index 0000000000..4b310956ab --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCurrency.yaml @@ -0,0 +1,3 @@ +type: object +description: The supported currency's currency. +x-schemaName: AdminCurrency diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCurrencyListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCurrencyListResponse.yaml new file mode 100644 index 0000000000..ad2343c380 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCurrencyListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminCurrencyListResponse +required: + - limit + - offset + - count + - currencies +properties: + limit: + type: number + title: limit + description: The currency's limit. + offset: + type: number + title: offset + description: The currency's offset. + count: + type: number + title: count + description: The currency's count. + currencies: + type: array + description: The currency's currencies. + items: + $ref: ./AdminCurrency.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCurrencyResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCurrencyResponse.yaml new file mode 100644 index 0000000000..da9a68b4d3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCurrencyResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminCurrencyResponse +required: + - currency +properties: + currency: + $ref: ./AdminCurrency.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerAddress.yaml new file mode 100644 index 0000000000..6b2d655e7a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerAddress.yaml @@ -0,0 +1,96 @@ +type: object +description: The customer's address. +x-schemaName: AdminCustomerAddress +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/AdminCustomerAddressResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerAddressResponse.yaml new file mode 100644 index 0000000000..e84a4d16dd --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerAddressResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminCustomerAddressResponse +required: + - address +properties: + address: + $ref: ./AdminCustomerAddress.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupResponse.yaml new file mode 100644 index 0000000000..4ddc2deae1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminCustomerGroupResponse +required: + - customer_group +properties: + customer_group: + $ref: ./AdminCustomerGroup.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerResponse.yaml new file mode 100644 index 0000000000..06cde895cd --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminCustomerResponse +required: + - customer +properties: + customer: + $ref: ./AdminCustomer.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderResponse.yaml new file mode 100644 index 0000000000..d2fd16520c --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrderResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminDraftOrderResponse +required: + - draft_order +properties: + draft_order: + $ref: ./AdminOrder.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml new file mode 100644 index 0000000000..109a755674 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml @@ -0,0 +1,251 @@ +type: object +description: The exchange's details. +x-schemaName: AdminExchange +required: + - order_id + - return_items + - additional_items + - currency_code + - id + - region_id + - customer_id + - sales_channel_id + - email + - shipping_methods + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total +properties: + order_id: + type: string + title: order_id + description: The exchange's order id. + return_items: + type: array + description: The exchange's return items. + items: + $ref: ./AdminReturnItem.yaml + additional_items: + type: array + description: The exchange's additional items. + items: + $ref: ./BaseExchangeItem.yaml + no_notification: + type: boolean + title: no_notification + description: The exchange's no notification. + difference_due: + type: number + title: difference_due + description: The exchange's difference due. + return: + $ref: ./AdminReturn.yaml + return_id: + type: string + title: return_id + description: The exchange's return id. + currency_code: + type: string + title: currency_code + description: The exchange's currency code. + id: + type: string + title: id + description: The exchange's ID. + region_id: + type: string + title: region_id + description: The exchange's region id. + customer_id: + type: string + title: customer_id + description: The exchange's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The exchange's sales channel id. + email: + type: string + title: email + description: The exchange's email. + format: email + display_id: + type: string + title: display_id + description: The exchange's display id. + shipping_address: + $ref: ./BaseOrderAddress.yaml + billing_address: + $ref: ./BaseOrderAddress.yaml + shipping_methods: + type: array + description: The exchange's shipping methods. + items: + $ref: ./BaseOrderShippingMethod.yaml + payment_collections: + type: array + description: The exchange's payment collections. + items: + $ref: ./BasePaymentCollection.yaml + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The exchange's fulfillments. + items: + $ref: ./BaseOrderFulfillment.yaml + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The exchange's transactions. + items: + $ref: ./BaseOrderTransaction.yaml + summary: + $ref: ./BaseOrderSummary.yaml + metadata: + type: object + description: The exchange's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The exchange's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The exchange's updated at. + original_item_total: + type: number + title: original_item_total + description: The exchange's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The exchange's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The exchange's original item tax total. + item_total: + type: number + title: item_total + description: The exchange's item total. + item_subtotal: + type: number + title: item_subtotal + description: The exchange's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The exchange's item tax total. + original_total: + type: number + title: original_total + description: The exchange's original total. + original_subtotal: + type: number + title: original_subtotal + description: The exchange's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The exchange's original tax total. + total: + type: number + title: total + description: The exchange's total. + subtotal: + type: number + title: subtotal + description: The exchange's subtotal. + tax_total: + type: number + title: tax_total + description: The exchange's tax total. + discount_total: + type: number + title: discount_total + description: The exchange's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The exchange's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The exchange's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The exchange's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The exchange's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The exchange's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The exchange's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The exchange's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The exchange's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The exchange's original shipping tax total. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeOrderResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeOrderResponse.yaml new file mode 100644 index 0000000000..356c9e7e54 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeOrderResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminExchangeOrderResponse +required: + - order + - exchange +properties: + order: + $ref: ./Order.yaml + exchange: + $ref: ./AdminExchange.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangePreviewResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangePreviewResponse.yaml new file mode 100644 index 0000000000..6776dd01d0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangePreviewResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminExchangePreviewResponse +required: + - order_preview + - exchange +properties: + order_preview: + $ref: ./Order.yaml + exchange: + $ref: ./AdminExchange.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeRequestResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeRequestResponse.yaml new file mode 100644 index 0000000000..400aec0e26 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeRequestResponse.yaml @@ -0,0 +1,14 @@ +type: object +description: SUMMARY +x-schemaName: AdminExchangeRequestResponse +required: + - return + - order_preview + - exchange +properties: + return: + $ref: ./AdminReturn.yaml + order_preview: + $ref: ./Order.yaml + exchange: + $ref: ./AdminExchange.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeResponse.yaml new file mode 100644 index 0000000000..663eadccee --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminExchangeResponse +required: + - exchange +properties: + exchange: + $ref: ./AdminExchange.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeReturnResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeReturnResponse.yaml new file mode 100644 index 0000000000..f0db225699 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeReturnResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminExchangeReturnResponse +required: + - order_preview + - return +properties: + order_preview: + $ref: ./Order.yaml + return: + $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFile.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFile.yaml new file mode 100644 index 0000000000..2cd7dd88eb --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFile.yaml @@ -0,0 +1,15 @@ +type: object +description: The upload's file. +x-schemaName: AdminFile +required: + - id + - url +properties: + id: + type: string + title: id + description: The file's ID. + url: + type: string + title: url + description: The file's url. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFileListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFileListResponse.yaml new file mode 100644 index 0000000000..37160b8ed1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFileListResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminFileListResponse +required: + - files +properties: + files: + type: array + description: The upload's files. + items: + $ref: ./AdminFile.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFileResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFileResponse.yaml new file mode 100644 index 0000000000..c0850cabdc --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFileResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminFileResponse +required: + - file +properties: + file: + $ref: ./AdminFile.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillment.yaml new file mode 100644 index 0000000000..797d72ca7b --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillment.yaml @@ -0,0 +1,89 @@ +type: object +description: The fulfillment's details. +x-schemaName: AdminFulfillment +required: + - id + - location_id + - provider_id + - shipping_option_id + - provider + - delivery_address + - items + - labels + - packed_at + - shipped_at + - delivered_at + - canceled_at + - data + - metadata + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The fulfillment's ID. + location_id: + type: string + title: location_id + description: The fulfillment's location id. + provider_id: + type: string + title: provider_id + description: The fulfillment's provider id. + shipping_option_id: + type: string + title: shipping_option_id + description: The fulfillment's shipping option id. + provider: + $ref: ./AdminFulfillmentProvider.yaml + delivery_address: + $ref: ./AdminFulfillmentAddress.yaml + items: + type: array + description: The fulfillment's items. + items: + $ref: ./AdminFulfillmentItem.yaml + labels: + type: array + description: The fulfillment's labels. + items: + $ref: ./AdminFulfillmentLabel.yaml + packed_at: + type: string + title: packed_at + description: The fulfillment's packed at. + shipped_at: + type: string + title: shipped_at + description: The fulfillment's shipped at. + delivered_at: + type: string + title: delivered_at + description: The fulfillment's delivered at. + canceled_at: + type: string + title: canceled_at + description: The fulfillment's canceled at. + data: + type: object + description: The fulfillment's data. + metadata: + type: object + description: The fulfillment's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The fulfillment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The fulfillment's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The fulfillment's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentAddress.yaml new file mode 100644 index 0000000000..4f26290089 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentAddress.yaml @@ -0,0 +1,87 @@ +type: object +description: The fulfillment's delivery address. +x-schemaName: AdminFulfillmentAddress +required: + - id + - fulfillment_id + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The delivery address's ID. + fulfillment_id: + type: string + title: fulfillment_id + description: The delivery address's fulfillment id. + company: + type: string + title: company + description: The delivery address's company. + first_name: + type: string + title: first_name + description: The delivery address's first name. + last_name: + type: string + title: last_name + description: The delivery address's last name. + address_1: + type: string + title: address_1 + description: The delivery address's address 1. + address_2: + type: string + title: address_2 + description: The delivery address's address 2. + city: + type: string + title: city + description: The delivery address's city. + country_code: + type: string + title: country_code + description: The delivery address's country code. + province: + type: string + title: province + description: The delivery address's province. + postal_code: + type: string + title: postal_code + description: The delivery address's postal code. + phone: + type: string + title: phone + description: The delivery address's phone. + metadata: + type: object + description: The delivery address's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The delivery address's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The delivery address's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The delivery address's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentItem.yaml new file mode 100644 index 0000000000..618af8761d --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentItem.yaml @@ -0,0 +1,63 @@ +type: object +description: The item's items. +x-schemaName: AdminFulfillmentItem +required: + - id + - title + - quantity + - sku + - barcode + - line_item_id + - inventory_item_id + - fulfillment_id + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + quantity: + type: number + title: quantity + description: The item's quantity. + sku: + type: string + title: sku + description: The item's sku. + barcode: + type: string + title: barcode + description: The item's barcode. + line_item_id: + type: string + title: line_item_id + description: The item's line item id. + inventory_item_id: + type: string + title: inventory_item_id + description: The item's inventory item id. + fulfillment_id: + type: string + title: fulfillment_id + description: The item's fulfillment id. + created_at: + type: string + format: date-time + title: created_at + description: The item's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The item's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The item's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentLabel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentLabel.yaml new file mode 100644 index 0000000000..6304d99832 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentLabel.yaml @@ -0,0 +1,48 @@ +type: object +description: The label's labels. +x-schemaName: AdminFulfillmentLabel +required: + - id + - tracking_number + - tracking_url + - label_url + - fulfillment_id + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The label's ID. + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + fulfillment_id: + type: string + title: fulfillment_id + description: The label's fulfillment id. + created_at: + type: string + format: date-time + title: created_at + description: The label's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The label's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The label's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProvider.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProvider.yaml index 9d7d2c4f6a..0fbdf6fd21 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProvider.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProvider.yaml @@ -1,3 +1,3 @@ type: object -description: The shipping option's provider. +description: The fulfillment provider's fulfillment providers. x-schemaName: AdminFulfillmentProvider diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProviderListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProviderListResponse.yaml new file mode 100644 index 0000000000..23fefdf665 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProviderListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminFulfillmentProviderListResponse +required: + - limit + - offset + - count + - fulfillment_providers +properties: + limit: + type: number + title: limit + description: The fulfillment provider's limit. + offset: + type: number + title: offset + description: The fulfillment provider's offset. + count: + type: number + title: count + description: The fulfillment provider's count. + fulfillment_providers: + type: array + description: The fulfillment provider's fulfillment providers. + items: + $ref: ./AdminFulfillmentProvider.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentResponse.yaml new file mode 100644 index 0000000000..8870aa903b --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminFulfillmentResponse +required: + - fulfillment +properties: + fulfillment: + $ref: ./AdminFulfillment.yaml 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 bff56cf421..01f7f452c6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSet.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSet.yaml @@ -5,6 +5,7 @@ required: - id - name - type + - location - service_zones - created_at - updated_at @@ -22,6 +23,8 @@ properties: 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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItem.yaml new file mode 100644 index 0000000000..58e6de4897 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItem.yaml @@ -0,0 +1,66 @@ +type: object +description: The inventory item's details. +x-schemaName: AdminInventoryItem +required: + - id + - requires_shipping +properties: + id: + type: string + title: id + description: The inventory item's ID. + sku: + type: string + title: sku + description: The inventory item's sku. + origin_country: + type: string + title: origin_country + description: The inventory item's origin country. + hs_code: + type: string + title: hs_code + description: The inventory item's hs code. + requires_shipping: + type: boolean + title: requires_shipping + description: The inventory item's requires shipping. + 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. + 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. + title: + type: string + title: title + description: The inventory item's title. + description: + type: string + title: description + description: The inventory item's description. + thumbnail: + type: string + title: thumbnail + description: The inventory item's thumbnail. + metadata: + type: object + description: The inventory item's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemResponse.yaml new file mode 100644 index 0000000000..9512367b8d --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminInventoryItemResponse +required: + - inventory_item +properties: + inventory_item: + $ref: ./AdminInventoryItem.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInvite.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInvite.yaml new file mode 100644 index 0000000000..5b81a094fc --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminInvite.yaml @@ -0,0 +1,44 @@ +type: object +description: The invite's details. +x-schemaName: AdminInvite +required: + - id + - email + - accepted + - token +properties: + id: + type: string + title: id + description: The invite's ID. + email: + type: string + title: email + description: The invite's email. + format: email + accepted: + type: boolean + title: accepted + description: The invite's accepted. + token: + type: string + title: token + description: The invite's token. + expires_at: + type: string + title: expires_at + description: The invite's expires at. + format: date-time + metadata: + type: object + description: The invite's metadata. + created_at: + type: string + title: created_at + description: The invite's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The invite's updated at. + format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInviteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInviteResponse.yaml new file mode 100644 index 0000000000..d2649d5348 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminInviteResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminInviteResponse +required: + - invite +properties: + invite: + $ref: ./AdminInvite.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminNotification.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminNotification.yaml new file mode 100644 index 0000000000..4b4d98663c --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminNotification.yaml @@ -0,0 +1,63 @@ +type: object +description: The notification's details. +x-schemaName: AdminNotification +required: + - id + - to + - channel + - template + - provider_id + - created_at +properties: + id: + type: string + title: id + description: The notification's ID. + to: + type: string + title: to + description: The notification's to. + channel: + type: string + title: channel + description: The notification's channel. + template: + type: string + title: template + description: The notification's template. + data: + type: object + description: The notification's data. + trigger_type: + type: string + title: trigger_type + description: The notification's trigger type. + resource_id: + type: string + title: resource_id + description: The notification's resource id. + resource_type: + type: string + title: resource_type + description: The notification's resource type. + receiver_id: + type: string + title: receiver_id + description: The notification's receiver id. + original_notification_id: + type: string + title: original_notification_id + description: The notification's original notification id. + external_id: + type: string + title: external_id + description: The notification's external id. + provider_id: + type: string + title: provider_id + description: The notification's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The notification's created at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminNotificationListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminNotificationListResponse.yaml new file mode 100644 index 0000000000..aa51a6a023 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminNotificationListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminNotificationListResponse +required: + - limit + - offset + - count + - notifications +properties: + limit: + type: number + title: limit + description: The notification's limit. + offset: + type: number + title: offset + description: The notification's offset. + count: + type: number + title: count + description: The notification's count. + notifications: + type: array + description: The notification's notifications. + items: + $ref: ./AdminNotification.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminNotificationResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminNotificationResponse.yaml new file mode 100644 index 0000000000..b6e0ab7c90 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminNotificationResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminNotificationResponse +required: + - notification +properties: + notification: + $ref: ./AdminNotification.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml new file mode 100644 index 0000000000..347756583d --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml @@ -0,0 +1,232 @@ +type: object +description: The order's details. +x-schemaName: AdminOrder +required: + - payment_collections + - id + - version + - region_id + - customer_id + - sales_channel_id + - email + - currency_code + - items + - shipping_methods + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total +properties: + payment_collections: + type: array + description: The order's payment collections. + items: + $ref: ./AdminPaymentCollection.yaml + id: + type: string + title: id + description: The order's ID. + version: + type: number + title: version + description: The order's version. + region_id: + type: string + title: region_id + description: The order's region id. + customer_id: + type: string + title: customer_id + description: The order's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order's sales channel id. + email: + type: string + title: email + description: The order's email. + format: email + currency_code: + type: string + title: currency_code + description: The order's currency code. + display_id: + type: string + 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. + items: + $ref: ./BaseOrderLineItem.yaml + shipping_methods: + type: array + description: The order's shipping methods. + items: + $ref: ./BaseOrderShippingMethod.yaml + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The order's fulfillments. + items: + $ref: ./BaseOrderFulfillment.yaml + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The order's transactions. + items: + $ref: ./BaseOrderTransaction.yaml + summary: + $ref: ./BaseOrderSummary.yaml + metadata: + type: object + description: The order's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The order's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order's updated at. + original_item_total: + type: number + title: original_item_total + description: The order's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The order's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The order's original item tax total. + item_total: + type: number + title: item_total + description: The order's item total. + item_subtotal: + type: number + title: item_subtotal + description: The order's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The order's item tax total. + original_total: + type: number + title: original_total + description: The order's original total. + original_subtotal: + type: number + title: original_subtotal + description: The order's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The order's original tax total. + total: + type: number + title: total + description: The order's total. + subtotal: + type: number + title: subtotal + description: The order's subtotal. + tax_total: + type: number + title: tax_total + description: The order's tax total. + discount_total: + type: number + title: discount_total + description: The order's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The order's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The order's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The order's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The order's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The order's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The order's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The order's original shipping tax total. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderCreateFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderCreateFulfillment.yaml deleted file mode 100644 index 59a7bc492a..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderCreateFulfillment.yaml +++ /dev/null @@ -1,37 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminOrderCreateFulfillment -required: - - items - - location_id - - metadata -properties: - items: - type: array - description: The order's items. - items: - 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. - location_id: - type: string - title: location_id - description: The order's location id. - no_notification: - type: boolean - title: no_notification - description: The order's no notification. - metadata: - type: object - description: The order's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderCreateShipment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderCreateShipment.yaml deleted file mode 100644 index 75ce832164..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderCreateShipment.yaml +++ /dev/null @@ -1,55 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminOrderCreateShipment -required: - - items - - metadata -properties: - items: - type: array - description: The order's items. - items: - 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. - labels: - type: array - description: The order's labels. - items: - type: object - description: The label's labels. - required: - - tracking_number - - tracking_url - - label_url - properties: - tracking_number: - type: string - title: tracking_number - description: The label's tracking number. - tracking_url: - type: string - title: tracking_url - description: The label's tracking url. - label_url: - type: string - title: label_url - description: The label's label url. - no_notification: - type: boolean - title: no_notification - description: The order's no notification. - metadata: - type: object - description: The order's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml new file mode 100644 index 0000000000..4b3f9af0d3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml @@ -0,0 +1,642 @@ +type: object +description: The return's order preview. +x-schemaName: AdminOrderPreview +required: + - return_requested_total + - order_change + - currency_code + - id + - version + - region_id + - customer_id + - sales_channel_id + - email + - payment_collections + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total +properties: + return_requested_total: + type: number + title: return_requested_total + description: The order preview's return requested total. + order_change: + $ref: ./BaseOrderChange.yaml + items: + type: array + description: The order preview's items. + items: + allOf: + - type: object + description: The item's items. + x-schemaName: BaseOrderLineItem + required: + - id + - title + - subtitle + - thumbnail + - variant_id + - product_id + - product_title + - product_description + - product_subtitle + - product_type + - product_collection + - product_handle + - variant_sku + - variant_barcode + - variant_title + - variant_option_values + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - detail + - created_at + - updated_at + - metadata + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant: + $ref: ./BaseProductVariant.yaml + variant_id: + type: string + title: variant_id + description: The item's variant id. + product: + $ref: ./BaseProduct.yaml + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: ./BaseOrderLineItemTaxLine.yaml + adjustments: + type: array + description: The item's adjustments. + items: + $ref: ./BaseOrderLineItemAdjustment.yaml + detail: + $ref: ./BaseOrderItemDetail.yaml + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + metadata: + type: object + description: The item's metadata. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: object + description: The item's items. + properties: + actions: + type: array + description: The item's actions. + items: + type: object + description: The action's actions. + x-schemaName: BaseOrderChangeAction + shipping_methods: + type: array + description: The order preview's shipping methods. + items: + allOf: + - type: object + description: The shipping method's shipping methods. + x-schemaName: BaseOrderShippingMethod + required: + - id + - order_id + - name + - amount + - is_tax_inclusive + - shipping_option_id + - data + - metadata + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: ./BaseOrderShippingMethodTaxLine.yaml + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: ./BaseOrderShippingMethodAdjustment.yaml + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: discount_tax_total + description: The shipping method's discount tax total. + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - $ref: ./IBigNumber.yaml + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + - type: object + description: The shipping method's shipping methods. + properties: + actions: + type: array + description: The shipping method's actions. + items: + type: object + description: The action's actions. + x-schemaName: BaseOrderChangeAction + currency_code: + type: string + title: currency_code + description: The order preview's currency code. + id: + type: string + title: id + description: The order preview's ID. + version: + type: number + title: version + description: The order preview's version. + region_id: + type: string + title: region_id + description: The order preview's region id. + customer_id: + type: string + title: customer_id + description: The order preview's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order preview's sales channel id. + email: + type: string + title: email + description: The order preview's email. + format: email + display_id: + type: string + title: display_id + description: The order preview's display id. + shipping_address: + $ref: ./BaseOrderAddress.yaml + billing_address: + $ref: ./BaseOrderAddress.yaml + payment_collections: + type: array + description: The order preview's payment collections. + items: + $ref: ./AdminPaymentCollection.yaml + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The order preview's fulfillments. + items: + $ref: ./BaseOrderFulfillment.yaml + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The order preview's transactions. + items: + $ref: ./BaseOrderTransaction.yaml + summary: + $ref: ./BaseOrderSummary.yaml + metadata: + type: object + description: The order preview's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The order preview's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order preview's updated at. + original_item_total: + type: number + title: original_item_total + description: The order preview's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The order preview's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The order preview's original item tax total. + item_total: + type: number + title: item_total + description: The order preview's item total. + item_subtotal: + type: number + title: item_subtotal + description: The order preview's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The order preview's item tax total. + original_total: + type: number + title: original_total + description: The order preview's original total. + original_subtotal: + type: number + title: original_subtotal + description: The order preview's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The order preview's original tax total. + total: + type: number + title: total + description: The order preview's total. + subtotal: + type: number + title: subtotal + description: The order preview's subtotal. + tax_total: + type: number + title: tax_total + description: The order preview's tax total. + discount_total: + type: number + title: discount_total + description: The order preview's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The order preview's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The order preview's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The order preview's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The order preview's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order preview's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The order preview's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The order preview's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The order preview's original shipping tax total. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreviewResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreviewResponse.yaml new file mode 100644 index 0000000000..d0f0e88f40 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreviewResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminOrderPreviewResponse +required: + - order +properties: + order: + $ref: ./AdminOrderPreview.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderResponse.yaml new file mode 100644 index 0000000000..18e28bbc59 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminOrderResponse +required: + - order +properties: + order: + $ref: ./AdminOrder.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderReturnResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderReturnResponse.yaml new file mode 100644 index 0000000000..1fed4284d0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderReturnResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminOrderReturnResponse +required: + - order + - return +properties: + order: + $ref: ./Order.yaml + return: + $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPayment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPayment.yaml new file mode 100644 index 0000000000..2836394d2e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPayment.yaml @@ -0,0 +1,130 @@ +type: object +description: The payment's details. +x-schemaName: AdminPayment +required: + - id + - amount + - currency_code + - provider_id +properties: + id: + type: string + title: id + description: The payment's ID. + amount: + oneOf: + - type: string + title: amount + description: The payment's amount. + - type: number + title: amount + description: The payment's amount. + - type: string + title: amount + description: The payment's amount. + - $ref: ./IBigNumber.yaml + authorized_amount: + oneOf: + - type: string + title: authorized_amount + description: The payment's authorized amount. + - type: number + title: authorized_amount + description: The payment's authorized amount. + - type: string + title: authorized_amount + description: The payment's authorized amount. + - $ref: ./IBigNumber.yaml + currency_code: + type: string + title: currency_code + description: The payment's currency code. + provider_id: + type: string + title: provider_id + description: The payment's provider id. + cart_id: + type: string + title: cart_id + description: The payment's cart id. + order_id: + type: string + title: order_id + description: The payment's order id. + order_edit_id: + type: string + title: order_edit_id + description: The payment's order edit id. + customer_id: + type: string + title: customer_id + description: The payment's customer id. + data: + type: object + description: The payment's data. + created_at: + type: string + format: date-time + title: created_at + description: The payment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The payment's updated at. + captured_at: + oneOf: + - type: string + title: captured_at + description: The payment's captured at. + - type: string + title: captured_at + description: The payment's captured at. + format: date-time + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The payment's canceled at. + - type: string + title: canceled_at + description: The payment's canceled at. + format: date-time + captured_amount: + oneOf: + - type: string + title: captured_amount + description: The payment's captured amount. + - type: number + title: captured_amount + description: The payment's captured amount. + - type: string + title: captured_amount + description: The payment's captured amount. + - $ref: ./IBigNumber.yaml + refunded_amount: + oneOf: + - type: string + title: refunded_amount + description: The payment's refunded amount. + - type: number + title: refunded_amount + description: The payment's refunded amount. + - type: string + title: refunded_amount + description: The payment's refunded amount. + - $ref: ./IBigNumber.yaml + captures: + type: array + description: The payment's captures. + items: + $ref: ./BaseCapture.yaml + refunds: + type: array + description: The payment's refunds. + items: + $ref: ./BaseRefund.yaml + payment_collection: + $ref: ./BasePaymentCollection.yaml + payment_session: + $ref: ./BasePaymentSession.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml new file mode 100644 index 0000000000..e58397669a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml @@ -0,0 +1,116 @@ +type: object +description: The payment collection's payment collections. +x-schemaName: AdminPaymentCollection +required: + - id + - currency_code + - region_id + - amount + - status + - payment_providers +properties: + id: + type: string + title: id + description: The payment collection's ID. + currency_code: + type: string + title: currency_code + description: The payment collection's currency code. + region_id: + type: string + title: region_id + description: The payment collection's region id. + amount: + oneOf: + - type: string + title: amount + description: The payment collection's amount. + - type: number + title: amount + description: The payment collection's amount. + - type: string + title: amount + description: The payment collection's amount. + - $ref: ./IBigNumber.yaml + authorized_amount: + oneOf: + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - type: number + title: authorized_amount + description: The payment collection's authorized amount. + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - $ref: ./IBigNumber.yaml + captured_amount: + oneOf: + - type: string + title: captured_amount + description: The payment collection's captured amount. + - type: number + title: captured_amount + description: The payment collection's captured amount. + - type: string + title: captured_amount + description: The payment collection's captured amount. + - $ref: ./IBigNumber.yaml + refunded_amount: + oneOf: + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - type: number + title: refunded_amount + description: The payment collection's refunded amount. + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - $ref: ./IBigNumber.yaml + completed_at: + oneOf: + - type: string + title: completed_at + description: The payment collection's completed at. + - type: string + title: completed_at + description: The payment collection's completed at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The payment collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The payment collection's updated at. + metadata: + type: object + description: The payment collection's metadata. + status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + payment_providers: + type: array + description: The payment collection's payment providers. + items: + $ref: ./BasePaymentProvider.yaml + payment_sessions: + type: array + description: The payment collection's payment sessions. + items: + $ref: ./BasePaymentSession.yaml + payments: + type: array + description: The payment collection's payments. + items: + $ref: ./BasePayment.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentProvider.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentProvider.yaml new file mode 100644 index 0000000000..022e34057b --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentProvider.yaml @@ -0,0 +1,3 @@ +type: object +description: The payment provider's payment providers. +x-schemaName: AdminPaymentProvider diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentResponse.yaml new file mode 100644 index 0000000000..ede86ff43a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminPaymentResponse +required: + - payment +properties: + payment: + $ref: ./AdminPayment.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderCancelFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelExchangeReqSchema.yaml similarity index 53% rename from www/apps/api-reference/specs/store/components/schemas/AdminOrderCancelFulfillment.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelExchangeReqSchema.yaml index 849a186934..b73520094e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderCancelFulfillment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelExchangeReqSchema.yaml @@ -1,8 +1,8 @@ type: object description: SUMMARY -x-schemaName: AdminOrderCancelFulfillment +x-schemaName: AdminPostCancelExchangeReqSchema properties: no_notification: type: boolean title: no_notification - description: The order's no notification. + description: The exchange's no notification. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml index 2b74376fcd..b3b1589daa 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml @@ -1,18 +1,17 @@ type: object description: SUMMARY x-schemaName: AdminPostClaimsItemsActionReqSchema +required: + - reason_id properties: quantity: type: number title: quantity description: The claim's quantity. - reason: + reason_id: type: string - enum: - - missing_item - - wrong_item - - production_failure - - other + title: reason_id + description: The claim's reason id. internal_note: type: string title: internal_note diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml new file mode 100644 index 0000000000..6609955ffd --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml @@ -0,0 +1,37 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostExchangesAddItemsReqSchema +properties: + items: + type: array + description: The exchange's items. + items: + type: object + description: The item's items. + required: + - variant_id + - quantity + properties: + variant_id: + type: string + title: variant_id + description: The item's variant id. + quantity: + type: number + title: quantity + description: The item's quantity. + unit_price: + type: number + title: unit_price + description: The item's unit price. + internal_note: + type: string + title: internal_note + description: The item's internal note. + allow_backorder: + type: boolean + title: allow_backorder + description: The item's allow backorder. + metadata: + type: object + description: The item's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml new file mode 100644 index 0000000000..1d8aa2b4db --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml @@ -0,0 +1,19 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostExchangesRequestItemsReturnActionReqSchema +properties: + quantity: + type: number + title: quantity + description: The exchange's quantity. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. + reason_id: + type: string + title: reason_id + description: The exchange's reason id. + metadata: + type: object + description: The exchange's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml new file mode 100644 index 0000000000..3e2045fd89 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml @@ -0,0 +1,37 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema +properties: + items: + type: array + description: The exchange's items. + items: + 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. + description: + type: string + title: description + description: The item's description. + internal_note: + type: string + title: internal_note + description: The item's internal note. + reason_id: + type: string + title: reason_id + description: The item's reason id. + metadata: + type: object + description: The item's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml new file mode 100644 index 0000000000..c473ba6e3a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml @@ -0,0 +1,15 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostExchangesShippingActionReqSchema +properties: + custom_price: + type: number + title: custom_price + description: The exchange's custom price. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. + metadata: + type: object + description: The exchange's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml new file mode 100644 index 0000000000..6af8ce407a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml @@ -0,0 +1,25 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostExchangesShippingReqSchema +required: + - shipping_option_id +properties: + shipping_option_id: + type: string + title: shipping_option_id + description: The exchange's shipping option id. + custom_price: + type: number + title: custom_price + description: The exchange's custom price. + description: + type: string + title: description + description: The exchange's description. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. + metadata: + type: object + description: The exchange's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExhangesItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExhangesItemsActionReqSchema.yaml new file mode 100644 index 0000000000..d058255237 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExhangesItemsActionReqSchema.yaml @@ -0,0 +1,12 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostExhangesItemsActionReqSchema +properties: + quantity: + type: number + title: quantity + description: The exchange's quantity. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml index 4eaef32fa9..2dbe34cae5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml @@ -4,6 +4,7 @@ x-schemaName: AdminPostOrderClaimsReqSchema required: - type - order_id + - reason_id - metadata properties: type: @@ -23,6 +24,10 @@ properties: type: string title: internal_note description: The claim's internal note. + reason_id: + type: string + title: reason_id + description: The claim's reason id. metadata: type: object description: The claim's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml new file mode 100644 index 0000000000..60f49ba39f --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml @@ -0,0 +1,22 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostOrderExchangesReqSchema +required: + - order_id + - metadata +properties: + order_id: + type: string + title: order_id + description: The exchange's order id. + description: + type: string + title: description + description: The exchange's description. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. + metadata: + type: object + description: The exchange's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml index a7a445758d..48a850a29f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml @@ -7,19 +7,19 @@ properties: shipping_option_id: type: string title: shipping_option_id - description: The claim's shipping option id. + description: The exchange's shipping option id. custom_price: type: number title: custom_price - description: The claim's custom price. + description: The exchange's custom price. description: type: string title: description - description: The claim's description. + description: The exchange's description. internal_note: type: string title: internal_note - description: The claim's internal note. + description: The exchange's internal note. metadata: type: object - description: The claim's metadata. + description: The exchange's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceList.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceList.yaml new file mode 100644 index 0000000000..ff8ed0bc50 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceList.yaml @@ -0,0 +1,70 @@ +type: object +description: The price list's details. +x-schemaName: AdminPriceList +required: + - id + - title + - description + - rules + - starts_at + - ends_at + - status + - type + - prices + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The price list's ID. + title: + type: string + title: title + description: The price list's title. + description: + type: string + title: description + description: The price list's description. + rules: + type: object + description: The price list's rules. + starts_at: + type: string + title: starts_at + description: The price list's starts at. + ends_at: + type: string + title: ends_at + description: The price list's ends at. + status: + type: string + enum: + - draft + - active + type: + type: string + enum: + - sale + - override + prices: + type: array + description: The price list's prices. + items: + $ref: ./AdminPriceListPrice.yaml + created_at: + type: string + format: date-time + title: created_at + description: The price list's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The price list's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The price list's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListBatchResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListBatchResponse.yaml new file mode 100644 index 0000000000..f525939ed7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListBatchResponse.yaml @@ -0,0 +1,41 @@ +type: object +description: SUMMARY +x-schemaName: AdminPriceListBatchResponse +required: + - created + - updated + - deleted +properties: + created: + type: array + description: The price list's created. + items: + $ref: ./AdminPrice.yaml + updated: + type: array + description: The price list's updated. + items: + $ref: ./AdminPrice.yaml + deleted: + type: object + description: The price list's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml new file mode 100644 index 0000000000..9fc53869c3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminPriceListDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The price list's ID. + object: + type: string + title: object + description: The price list's object. + default: price_list + deleted: + type: boolean + title: deleted + description: The price list's deleted. + parent: + type: object + description: The price list's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListListResponse.yaml new file mode 100644 index 0000000000..0199ba1e0e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminPriceListListResponse +required: + - limit + - offset + - count + - price_lists +properties: + limit: + type: number + title: limit + description: The price list's limit. + offset: + type: number + title: offset + description: The price list's offset. + count: + type: number + title: count + description: The price list's count. + price_lists: + type: array + description: The price list's price lists. + items: + $ref: ./AdminPriceList.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListPrice.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListPrice.yaml new file mode 100644 index 0000000000..5e699d3feb --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListPrice.yaml @@ -0,0 +1,71 @@ +type: object +description: The price's prices. +x-schemaName: AdminPriceListPrice +required: + - variant_id + - rules + - id + - title + - currency_code + - amount + - raw_amount + - min_quantity + - max_quantity + - price_set_id + - created_at + - updated_at + - deleted_at +properties: + variant_id: + type: string + title: variant_id + description: The price's variant id. + rules: + type: object + description: The price's rules. + id: + type: string + title: id + description: The price's ID. + title: + type: string + title: title + description: The price's title. + currency_code: + type: string + title: currency_code + description: The price's currency code. + amount: + type: number + title: amount + description: The price's amount. + raw_amount: + type: object + description: The price's raw amount. + min_quantity: + type: number + title: min_quantity + description: The price's min quantity. + max_quantity: + type: number + title: max_quantity + description: The price's max quantity. + price_set_id: + type: string + title: price_set_id + description: The price's price set id. + created_at: + type: string + format: date-time + title: created_at + description: The price's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The price's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The price's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListResponse.yaml new file mode 100644 index 0000000000..b666517278 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminPriceListResponse +required: + - price_list +properties: + price_list: + $ref: ./AdminPriceList.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreference.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreference.yaml new file mode 100644 index 0000000000..01479f00c8 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreference.yaml @@ -0,0 +1,43 @@ +type: object +description: The price preference's details. +x-schemaName: AdminPricePreference +required: + - id + - attribute + - value + - is_tax_inclusive + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The price preference's ID. + attribute: + type: string + title: attribute + description: The price preference's attribute. + value: + type: string + title: value + description: The price preference's value. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The price preference's is tax inclusive. + created_at: + type: string + format: date-time + title: created_at + description: The price preference's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The price preference's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The price preference's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml new file mode 100644 index 0000000000..a34e982325 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminPricePreferenceDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The price preference's ID. + object: + type: string + title: object + description: The price preference's object. + default: price_preference + deleted: + type: boolean + title: deleted + description: The price preference's deleted. + parent: + type: object + description: The price preference's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceListResponse.yaml new file mode 100644 index 0000000000..1ee09e258e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminPricePreferenceListResponse +required: + - limit + - offset + - count + - price_preferences +properties: + limit: + type: number + title: limit + description: The price preference's limit. + offset: + type: number + title: offset + description: The price preference's offset. + count: + type: number + title: count + description: The price preference's count. + price_preferences: + type: array + description: The price preference's price preferences. + items: + $ref: ./AdminPricePreference.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceResponse.yaml new file mode 100644 index 0000000000..4fbab75262 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminPricePreferenceResponse +required: + - price_preference +properties: + price_preference: + $ref: ./AdminPricePreference.yaml 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 2db6ee1407..f31c9d51d9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml @@ -9,25 +9,25 @@ required: - options - description - id - - handle - - hs_code - - weight - - height - - width - - origin_country - - mid_code - - material - - thumbnail - created_at - updated_at - - deleted_at + - handle - subtitle - is_giftcard + - thumbnail + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material - collection_id - type_id - images - discountable - external_id + - deleted_at properties: collection: $ref: ./AdminCollection.yaml @@ -84,42 +84,6 @@ properties: metadata: type: object description: The parent's metadata. - handle: - type: string - title: handle - description: The parent's handle. - hs_code: - type: string - title: hs_code - description: The parent's hs code. - weight: - type: number - title: weight - description: The parent's weight. - height: - type: number - title: height - description: The parent's height. - width: - type: number - title: width - description: The parent's width. - origin_country: - type: string - title: origin_country - description: The parent's origin country. - mid_code: - type: string - title: mid_code - description: The parent's mid code. - material: - type: string - title: material - description: The parent's material. - thumbnail: - type: string - title: thumbnail - description: The parent's thumbnail. created_at: type: string format: date-time @@ -130,11 +94,10 @@ properties: format: date-time title: updated_at description: The parent's updated at. - deleted_at: + handle: type: string - format: date-time - title: deleted_at - description: The parent's deleted at. + title: handle + description: The parent's handle. subtitle: type: string title: subtitle @@ -143,6 +106,38 @@ properties: type: boolean title: is_giftcard description: The parent's is giftcard. + thumbnail: + type: string + title: thumbnail + description: The parent's thumbnail. + width: + type: number + title: width + description: The parent's width. + weight: + type: number + title: weight + description: The parent's weight. + height: + type: number + title: height + description: The parent's height. + origin_country: + type: string + title: origin_country + description: The parent's origin country. + hs_code: + type: string + title: hs_code + description: The parent's hs code. + mid_code: + type: string + title: mid_code + description: The parent's mid code. + material: + type: string + title: material + description: The parent's material. collection_id: type: string title: collection_id @@ -164,3 +159,8 @@ properties: type: string title: external_id description: The parent's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The parent's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml index 1de3721e0e..750ab66be6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml @@ -7,14 +7,14 @@ required: - name - description - id - - handle - created_at - updated_at + - handle - deleted_at - - parent_category_id - - is_internal - is_active + - is_internal - rank + - parent_category_id properties: category_children: type: array @@ -40,10 +40,6 @@ properties: type: string title: id description: The category's ID. - handle: - type: string - title: handle - description: The category's handle. created_at: type: string format: date-time @@ -54,24 +50,28 @@ properties: format: date-time title: updated_at description: The category's updated at. + handle: + type: string + title: handle + description: The category's handle. deleted_at: type: string format: date-time title: deleted_at description: The category's deleted at. - parent_category_id: - type: string - title: parent_category_id - description: The category's parent category id. - is_internal: - type: boolean - title: is_internal - description: The category's is internal. is_active: type: boolean title: is_active description: The category's is active. + is_internal: + type: boolean + title: is_internal + description: The category's is internal. rank: type: number title: rank description: The category's rank. + parent_category_id: + type: string + title: parent_category_id + description: The category's parent category id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml new file mode 100644 index 0000000000..38c8ca528b --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductCategoryDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The product category's ID. + object: + type: string + title: object + description: The product category's object. + default: product_category + deleted: + type: boolean + title: deleted + description: The product category's deleted. + parent: + type: object + description: The product category's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagDeleteResponse.yaml new file mode 100644 index 0000000000..d723c20219 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductTagDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The product tag's ID. + object: + type: string + title: object + description: The product tag's object. + default: product_tag + deleted: + type: boolean + title: deleted + description: The product tag's deleted. + parent: + type: object + description: The product tag's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagListResponse.yaml new file mode 100644 index 0000000000..40accb6692 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductTagListResponse +required: + - limit + - offset + - count + - product_tags +properties: + limit: + type: number + title: limit + description: The product tag's limit. + offset: + type: number + title: offset + description: The product tag's offset. + count: + type: number + title: count + description: The product tag's count. + product_tags: + type: array + description: The product tag's product tags. + items: + $ref: ./AdminProductTag.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagResponse.yaml new file mode 100644 index 0000000000..47fe1ad408 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductTagResponse +required: + - product_tag +properties: + product_tag: + $ref: ./AdminProductTag.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeDeleteResponse.yaml new file mode 100644 index 0000000000..dcd995552c --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductTypeDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The product type's ID. + object: + type: string + title: object + description: The product type's object. + default: product_type + deleted: + type: boolean + title: deleted + description: The product type's deleted. + parent: + type: object + description: The product type's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeListResponse.yaml new file mode 100644 index 0000000000..5e6dfa5a8f --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductTypeListResponse +required: + - limit + - offset + - count + - product_types +properties: + limit: + type: number + title: limit + description: The product type's limit. + offset: + type: number + title: offset + description: The product type's offset. + count: + type: number + title: count + description: The product type's count. + product_types: + type: array + description: The product type's product types. + items: + $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeResponse.yaml new file mode 100644 index 0000000000..3e74c8b2fb --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductTypeResponse +required: + - product_type +properties: + product_type: + $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml index 8404f7168a..73384be760 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml @@ -1,5 +1,5 @@ type: object -description: The updated's details. +description: The product's parent. x-schemaName: AdminProductVariant required: - prices @@ -26,80 +26,80 @@ required: properties: prices: type: array - description: The updated's prices. + description: The parent's prices. items: $ref: ./AdminPrice.yaml id: type: string title: id - description: The updated's ID. + description: The parent's ID. title: type: string title: title - description: The updated's title. + description: The parent's title. sku: type: string title: sku - description: The updated's sku. + description: The parent's sku. barcode: type: string title: barcode - description: The updated's barcode. + description: The parent's barcode. ean: type: string title: ean - description: The updated's ean. + description: The parent's ean. upc: type: string title: upc - description: The updated's upc. + description: The parent's upc. allow_backorder: type: boolean title: allow_backorder - description: The updated's allow backorder. + description: The parent's allow backorder. manage_inventory: type: boolean title: manage_inventory - description: The updated's manage inventory. + description: The parent's manage inventory. hs_code: type: string title: hs_code - description: The updated's hs code. + description: The parent's hs code. origin_country: type: string title: origin_country - description: The updated's origin country. + description: The parent's origin country. mid_code: type: string title: mid_code - description: The updated's mid code. + description: The parent's mid code. material: type: string title: material - description: The updated's material. + description: The parent's material. weight: type: number title: weight - description: The updated's weight. + description: The parent's weight. length: type: number title: length - description: The updated's length. + description: The parent's length. height: type: number title: height - description: The updated's height. + description: The parent's height. width: type: number title: width - description: The updated's width. + description: The parent's width. variant_rank: type: number title: variant_rank - description: The updated's variant rank. + description: The parent's variant rank. options: type: array - description: The updated's options. + description: The parent's options. items: $ref: ./BaseProductOptionValue.yaml product: @@ -107,24 +107,24 @@ properties: product_id: type: string title: product_id - description: The updated's product id. + description: The parent's product id. calculated_price: $ref: ./BaseCalculatedPriceSet.yaml created_at: type: string format: date-time title: created_at - description: The updated's created at. + description: The parent's created at. updated_at: type: string format: date-time title: updated_at - description: The updated's updated at. + description: The parent's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The updated's deleted at. + description: The parent's deleted at. metadata: type: object - description: The updated's metadata. + description: The parent's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryBatchResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryBatchResponse.yaml new file mode 100644 index 0000000000..3da518f03a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryBatchResponse.yaml @@ -0,0 +1,107 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductVariantInventoryBatchResponse +required: + - created + - updated + - deleted +properties: + created: + oneOf: + - $ref: ./AdminProductVariantInventoryLink.yaml + - type: array + description: The product's created. + items: + type: object + description: The created's details. + x-schemaName: AdminProductVariantInventoryLink + required: + - productService + - inventoryService + properties: + productService: + type: object + description: The created's productservice. + required: + - variant_id + properties: + variant_id: + type: string + title: variant_id + description: The productservice's variant id. + inventoryService: + type: object + description: The created's inventoryservice. + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventoryservice's inventory item id. + updated: + oneOf: + - $ref: ./AdminProductVariantInventoryLink.yaml + - type: array + description: The product's updated. + items: + type: object + description: The updated's details. + x-schemaName: AdminProductVariantInventoryLink + required: + - productService + - inventoryService + properties: + productService: + type: object + description: The updated's productservice. + required: + - variant_id + properties: + variant_id: + type: string + title: variant_id + description: The productservice's variant id. + inventoryService: + type: object + description: The updated's inventoryservice. + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventoryservice's inventory item id. + deleted: + oneOf: + - $ref: ./AdminProductVariantInventoryLink.yaml + - type: array + description: The product's deleted. + items: + type: object + description: The deleted's details. + x-schemaName: AdminProductVariantInventoryLink + required: + - productService + - inventoryService + properties: + productService: + type: object + description: The deleted's productservice. + required: + - variant_id + properties: + variant_id: + type: string + title: variant_id + description: The productservice's variant id. + inventoryService: + type: object + description: The deleted's inventoryservice. + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventoryservice's inventory item id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLink.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLink.yaml new file mode 100644 index 0000000000..e5938e984d --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLink.yaml @@ -0,0 +1,27 @@ +type: object +description: The product's ID. +x-schemaName: AdminProductVariantInventoryLink +required: + - productService + - inventoryService +properties: + productService: + type: object + description: The id's productservice. + required: + - variant_id + properties: + variant_id: + type: string + title: variant_id + description: The productservice's variant id. + inventoryService: + type: object + description: The id's inventoryservice. + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventoryservice's inventory item id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml new file mode 100644 index 0000000000..4e2fdc8918 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml @@ -0,0 +1,21 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductVariantInventoryLinkDeleteResponse +required: + - id + - object + - deleted + - parent +properties: + id: + $ref: ./AdminProductVariantInventoryLink.yaml + object: + type: string + title: object + description: The product's object. + deleted: + type: boolean + title: deleted + description: The product's deleted. + parent: + $ref: ./AdminProductVariant.yaml 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 a6a154c417..0b6f5fd615 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml @@ -62,215 +62,17 @@ properties: type: array description: The variant's $and. items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - sku: - oneOf: - - type: string - title: sku - description: The $and's sku. - - type: array - description: The $and's sku. - items: - type: string - title: sku - description: The sku's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $and's product id. - - type: array - description: The $and's product id. - items: - type: string - title: product_id - description: The product id's details. - options: - type: object - description: The $and's options. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $or's details. + type: array + description: The $and's details. + items: + type: object + title: $and $or: type: array description: The variant's $or. items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - sku: - oneOf: - - type: string - title: sku - description: The $or's sku. - - type: array - description: The $or's sku. - items: - type: string - title: sku - description: The sku's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $or's product id. - - type: array - description: The $or's product id. - items: - type: string - title: product_id - description: The product id's details. - options: - type: object - description: The $or's options. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $or's details. + type: array + description: The $or's details. + items: + type: object + title: $or diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml new file mode 100644 index 0000000000..a04db87818 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml @@ -0,0 +1,36 @@ +type: object +description: The promotion's details. +x-schemaName: AdminPromotion +required: + - id +properties: + id: + type: string + title: id + description: The promotion's ID. + code: + type: string + title: code + description: The promotion's code. + type: + type: string + enum: + - standard + - buyget + is_automatic: + type: boolean + title: is_automatic + description: The promotion's is automatic. + application_method: + $ref: ./BaseApplicationMethod.yaml + rules: + type: array + description: The promotion's rules. + items: + $ref: ./BasePromotionRule.yaml + campaign_id: + type: string + title: campaign_id + description: The promotion's campaign id. + campaign: + $ref: ./CampaignResponse.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotionResponse.yaml new file mode 100644 index 0000000000..3a4255fe94 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminPromotionResponse +required: + - promotion +properties: + promotion: + $ref: ./AdminPromotion.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotionRule.yaml new file mode 100644 index 0000000000..606b760d6f --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotionRule.yaml @@ -0,0 +1,34 @@ +type: object +description: The updated's details. +x-schemaName: AdminPromotionRule +required: + - id + - values +properties: + id: + type: string + title: id + description: The updated's ID. + description: + type: string + title: description + description: The updated's description. + attribute: + type: string + title: attribute + description: The updated's attribute. + operator: + type: string + enum: + - gt + - lt + - eq + - ne + - in + - lte + - gte + values: + type: array + description: The updated's values. + items: + $ref: ./BasePromotionRuleValue.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRefundReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRefundReason.yaml new file mode 100644 index 0000000000..3110520654 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRefundReason.yaml @@ -0,0 +1,35 @@ +type: object +description: The refund reason's details. +x-schemaName: AdminRefundReason +required: + - id + - label + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The refund reason's ID. + label: + type: string + title: label + description: The refund reason's label. + description: + type: string + title: description + description: The refund reason's description. + metadata: + type: object + description: The refund reason's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The refund reason's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The refund reason's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRegion.yaml new file mode 100644 index 0000000000..0ad92660d5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRegion.yaml @@ -0,0 +1,47 @@ +type: object +description: The region's details. +x-schemaName: AdminRegion +required: + - id + - name + - currency_code +properties: + id: + type: string + title: id + description: The region's ID. + name: + type: string + title: name + description: The region's name. + currency_code: + type: string + title: currency_code + description: The region's currency code. + automatic_taxes: + type: boolean + title: automatic_taxes + description: The region's automatic taxes. + countries: + type: array + description: The region's countries. + items: + $ref: ./BaseRegionCountry.yaml + payment_providers: + type: array + description: The region's payment providers. + items: + $ref: ./AdminPaymentProvider.yaml + metadata: + type: object + description: The region's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The region's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The region's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRegionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRegionResponse.yaml new file mode 100644 index 0000000000..fc2373ff77 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRegionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminRegionResponse +required: + - region +properties: + region: + $ref: ./AdminRegion.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReservationResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReservationResponse.yaml new file mode 100644 index 0000000000..6f13a6c0e5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReservationResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminReservationResponse +required: + - reservation +properties: + reservation: + $ref: ./ReservationResponse.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturn.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturn.yaml new file mode 100644 index 0000000000..f35a98e0a3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturn.yaml @@ -0,0 +1,66 @@ +type: object +description: The exchange's return. +x-schemaName: AdminReturn +required: + - id + - order_id + - order_version + - display_id + - items + - received_at + - created_at +properties: + id: + type: string + title: id + description: The return's ID. + order_id: + type: string + title: order_id + description: The return's order id. + status: + type: string + title: status + description: The return's status. + exchange_id: + type: string + title: exchange_id + description: The return's exchange id. + location_id: + type: string + title: location_id + description: The return's location id. + claim_id: + type: string + title: claim_id + description: The return's claim id. + order_version: + type: number + title: order_version + description: The return's order version. + display_id: + type: number + title: display_id + description: The return's display id. + no_notification: + type: boolean + title: no_notification + description: The return's no notification. + refund_amount: + type: number + title: refund_amount + description: The return's refund amount. + items: + type: array + description: The return's items. + items: + $ref: ./BaseReturnItem.yaml + received_at: + type: string + title: received_at + description: The return's received at. + created_at: + type: string + format: date-time + title: created_at + description: The return's created at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnItem.yaml new file mode 100644 index 0000000000..104e37834a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnItem.yaml @@ -0,0 +1,41 @@ +type: object +description: The return item's return items. +x-schemaName: AdminReturnItem +required: + - id + - quantity + - received_quantity + - item_id + - return_id +properties: + id: + type: string + title: id + description: The return item's ID. + quantity: + type: number + title: quantity + description: The return item's quantity. + received_quantity: + type: number + title: received_quantity + description: The return item's received quantity. + reason_id: + type: string + title: reason_id + description: The return item's reason id. + note: + type: string + title: note + description: The return item's note. + item_id: + type: string + title: item_id + description: The return item's item id. + return_id: + type: string + title: return_id + description: The return item's return id. + metadata: + type: object + description: The return item's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnPreviewResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnPreviewResponse.yaml new file mode 100644 index 0000000000..8b8734b2fe --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnPreviewResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminReturnPreviewResponse +required: + - order_preview + - return +properties: + order_preview: + $ref: ./AdminOrderPreview.yaml + return: + $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReason.yaml new file mode 100644 index 0000000000..3046e2a254 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReason.yaml @@ -0,0 +1,39 @@ +type: object +description: The return reason's details. +x-schemaName: AdminReturnReason +required: + - id + - value + - label + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The return reason's ID. + value: + type: string + title: value + description: The return reason's value. + label: + type: string + title: label + description: The return reason's label. + description: + type: string + title: description + description: The return reason's description. + metadata: + type: object + description: The return reason's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The return reason's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The return reason's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonListResponse.yaml new file mode 100644 index 0000000000..0fa69fc517 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminReturnReasonListResponse +required: + - limit + - offset + - count + - return_reasons +properties: + limit: + type: number + title: limit + description: The return reason's limit. + offset: + type: number + title: offset + description: The return reason's offset. + count: + type: number + title: count + description: The return reason's count. + return_reasons: + type: array + description: The return reason's return reasons. + items: + $ref: ./AdminReturnReason.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonResponse.yaml new file mode 100644 index 0000000000..9b3ad0f9a4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminReturnReasonResponse +required: + - return_reason +properties: + return_reason: + $ref: ./AdminReturnReason.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnResponse.yaml new file mode 100644 index 0000000000..8ce9535394 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminReturnResponse +required: + - return +properties: + return: + $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRuleAttributeOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRuleAttributeOption.yaml new file mode 100644 index 0000000000..8ca5eaabf3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRuleAttributeOption.yaml @@ -0,0 +1,41 @@ +type: object +description: The attribute's attributes. +x-schemaName: AdminRuleAttributeOption +required: + - id + - value + - label + - field_type + - required + - disguised + - operators +properties: + id: + type: string + title: id + description: The attribute's ID. + value: + type: string + title: value + description: The attribute's value. + label: + type: string + title: label + description: The attribute's label. + field_type: + type: string + title: field_type + description: The attribute's field type. + required: + type: boolean + title: required + description: The attribute's required. + disguised: + type: boolean + title: disguised + description: The attribute's disguised. + operators: + type: array + description: The attribute's operators. + items: + $ref: ./BaseRuleOperatorOptions.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRuleValueOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRuleValueOption.yaml new file mode 100644 index 0000000000..cb8776ea83 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRuleValueOption.yaml @@ -0,0 +1,20 @@ +type: object +description: The value's values. +x-schemaName: AdminRuleValueOption +required: + - id + - value + - label +properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value's details. + label: + type: string + title: label + description: The value's label. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelDeleteResponse.yaml new file mode 100644 index 0000000000..56dff1a392 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminSalesChannelDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The sales channel's ID. + object: + type: string + title: object + description: The sales channel's object. + default: sales-channel + deleted: + type: boolean + title: deleted + description: The sales channel's deleted. + parent: + type: object + description: The sales channel's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelResponse.yaml new file mode 100644 index 0000000000..baeb779f03 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminSalesChannelResponse +required: + - sales_channel +properties: + sales_channel: + $ref: ./AdminSalesChannel.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZone.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZone.yaml index d3a3547a06..d0dff34efc 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZone.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZone.yaml @@ -5,6 +5,7 @@ required: - id - name - fulfillment_set_id + - fulfillment_set - geo_zones - shipping_options - created_at @@ -23,6 +24,8 @@ properties: type: string title: fulfillment_set_id description: The service zone's fulfillment set id. + fulfillment_set: + type: object geo_zones: type: array description: The service zone's geo zones. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionRule.yaml new file mode 100644 index 0000000000..ed10fb27e4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionRule.yaml @@ -0,0 +1,55 @@ +type: object +description: The updated's details. +x-schemaName: AdminShippingOptionRule +required: + - id + - attribute + - operator + - value + - shipping_option_id + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The updated's ID. + attribute: + type: string + title: attribute + description: The updated's attribute. + operator: + type: string + title: operator + description: The updated's operator. + value: + oneOf: + - type: string + title: value + description: The updated's value. + - type: array + description: The updated's value. + items: + type: string + title: value + description: The value's details. + shipping_option_id: + type: string + title: shipping_option_id + description: The updated's shipping option id. + created_at: + type: string + format: date-time + title: created_at + description: The updated's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The updated's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The updated's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocation.yaml new file mode 100644 index 0000000000..e4f23a4318 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocation.yaml @@ -0,0 +1,37 @@ +type: object +description: The fulfillment set's location. +x-schemaName: AdminStockLocation +required: + - id + - name + - address_id +properties: + id: + type: string + title: id + description: The location's ID. + name: + type: string + title: name + description: The location's name. + address_id: + type: string + title: address_id + description: The location's address id. + address: + $ref: ./AdminStockLocationAddress.yaml + sales_channels: + type: array + description: The location's sales channels. + items: + $ref: ./AdminSalesChannel.yaml + fulfillment_providers: + type: array + description: The location's fulfillment providers. + items: + $ref: ./AdminFulfillmentProvider.yaml + fulfillment_sets: + type: array + description: The location's fulfillment sets. + items: + type: object diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationAddress.yaml new file mode 100644 index 0000000000..03be8aa3dd --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationAddress.yaml @@ -0,0 +1,3 @@ +type: object +description: The location's address. +x-schemaName: AdminStockLocationAddress diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationDeleteResponse.yaml new file mode 100644 index 0000000000..eded6905fb --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminStockLocationDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The stock location's ID. + object: + type: string + title: object + description: The stock location's object. + default: stock_location + deleted: + type: boolean + title: deleted + description: The stock location's deleted. + parent: + type: object + description: The stock location's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationListResponse.yaml new file mode 100644 index 0000000000..f8181758b1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminStockLocationListResponse +required: + - limit + - offset + - count + - stock_locations +properties: + limit: + type: number + title: limit + description: The stock location's limit. + offset: + type: number + title: offset + description: The stock location's offset. + count: + type: number + title: count + description: The stock location's count. + stock_locations: + type: array + description: The stock location's stock locations. + items: + $ref: ./AdminStockLocation.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationResponse.yaml new file mode 100644 index 0000000000..68d6a4db18 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminStockLocationResponse +required: + - stock_location +properties: + stock_location: + $ref: ./AdminStockLocation.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStore.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStore.yaml new file mode 100644 index 0000000000..a56500fc7b --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStore.yaml @@ -0,0 +1,52 @@ +type: object +description: The store's details. +x-schemaName: AdminStore +required: + - id + - name + - supported_currencies + - default_sales_channel_id + - default_region_id + - default_location_id + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The store's ID. + name: + type: string + title: name + description: The store's name. + supported_currencies: + type: array + description: The store's supported currencies. + items: + $ref: ./AdminStoreCurrency.yaml + default_sales_channel_id: + type: string + title: default_sales_channel_id + description: The store's default sales channel id. + default_region_id: + type: string + title: default_region_id + description: The store's default region id. + default_location_id: + type: string + title: default_location_id + description: The store's default location id. + metadata: + type: object + description: The store's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The store's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The store's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStoreCurrency.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStoreCurrency.yaml new file mode 100644 index 0000000000..5014c7b7bc --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStoreCurrency.yaml @@ -0,0 +1,46 @@ +type: object +description: The supported currency's supported currencies. +x-schemaName: AdminStoreCurrency +required: + - id + - currency_code + - store_id + - is_default + - currency + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The supported currency's ID. + currency_code: + type: string + title: currency_code + description: The supported currency's currency code. + store_id: + type: string + title: store_id + description: The supported currency's store id. + is_default: + type: boolean + title: is_default + description: The supported currency's is default. + currency: + $ref: ./AdminCurrency.yaml + created_at: + type: string + format: date-time + title: created_at + description: The supported currency's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The supported currency's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The supported currency's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStoreListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStoreListResponse.yaml new file mode 100644 index 0000000000..33099c28f1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStoreListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminStoreListResponse +required: + - limit + - offset + - count + - stores +properties: + limit: + type: number + title: limit + description: The store's limit. + offset: + type: number + title: offset + description: The store's offset. + count: + type: number + title: count + description: The store's count. + stores: + type: array + description: The store's stores. + items: + $ref: ./AdminStore.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStoreResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStoreResponse.yaml new file mode 100644 index 0000000000..c24cc35690 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStoreResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminStoreResponse +required: + - store +properties: + store: + $ref: ./AdminStore.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRate.yaml new file mode 100644 index 0000000000..35d3b37a92 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRate.yaml @@ -0,0 +1,76 @@ +type: object +description: The tax rate's details. +x-schemaName: AdminTaxRate +required: + - id + - rate + - code + - name + - metadata + - tax_region_id + - is_combinable + - is_default + - created_at + - updated_at + - deleted_at + - created_by + - tax_region + - rules +properties: + id: + type: string + title: id + description: The tax rate's ID. + rate: + type: number + title: rate + description: The tax rate's rate. + code: + type: string + title: code + description: The tax rate's code. + name: + type: string + title: name + description: The tax rate's name. + metadata: + type: object + description: The tax rate's metadata. + tax_region_id: + type: string + title: tax_region_id + description: The tax rate's tax region id. + is_combinable: + type: boolean + title: is_combinable + description: The tax rate's is combinable. + is_default: + type: boolean + title: is_default + description: The tax rate's is default. + created_at: + type: string + format: date-time + title: created_at + description: The tax rate's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax rate's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The tax rate's deleted at. + created_by: + type: string + title: created_by + description: The tax rate's created by. + tax_region: + $ref: ./AdminTaxRegion.yaml + rules: + type: array + description: The tax rate'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 new file mode 100644 index 0000000000..8d63342ef2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminTaxRateDeleteResponse +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. + default: tax_rate + deleted: + type: boolean + title: deleted + description: The tax rate's deleted. + parent: + type: object + description: The tax rate's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateResponse.yaml new file mode 100644 index 0000000000..2dd828e446 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminTaxRateResponse +required: + - tax_rate +properties: + tax_rate: + $ref: ./AdminTaxRate.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateRule.yaml new file mode 100644 index 0000000000..8e0ff14b5d --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateRule.yaml @@ -0,0 +1,15 @@ +type: object +description: The rule's rules. +x-schemaName: AdminTaxRateRule +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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml new file mode 100644 index 0000000000..a9597eba8a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml @@ -0,0 +1,97 @@ +type: object +description: The tax rate's tax region. +x-schemaName: AdminTaxRegion +required: + - id + - rate + - code + - country_code + - province_code + - name + - metadata + - tax_region_id + - is_combinable + - is_default + - parent_id + - created_at + - updated_at + - deleted_at + - created_by + - tax_rates + - parent + - children +properties: + id: + type: string + title: id + description: The tax region's ID. + rate: + type: number + title: rate + description: The tax region's rate. + code: + type: string + title: code + description: The tax region's code. + country_code: + type: string + title: country_code + description: The tax region's country code. + province_code: + type: string + title: province_code + description: The tax region's province code. + name: + type: string + title: name + description: The tax region's name. + metadata: + type: object + description: The tax region's metadata. + tax_region_id: + type: string + title: tax_region_id + description: The tax region's tax region id. + is_combinable: + type: boolean + title: is_combinable + description: The tax region's is combinable. + is_default: + type: boolean + title: is_default + description: The tax region's is default. + parent_id: + type: string + title: parent_id + description: The tax region's parent id. + created_at: + type: string + format: date-time + title: created_at + description: The tax region's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax region's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The tax region's deleted at. + created_by: + type: string + title: created_by + description: The tax region's created by. + tax_rates: + type: array + description: The tax region's tax rates. + items: + type: object + parent: + type: object + children: + type: array + description: The tax region's children. + items: + type: object diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionDeleteResponse.yaml new file mode 100644 index 0000000000..fcc06bd342 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminTaxRegionDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The tax region's ID. + object: + type: string + title: object + description: The tax region's object. + default: tax_region + deleted: + type: boolean + title: deleted + description: The tax region's deleted. + parent: + type: object + description: The tax region's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionResponse.yaml new file mode 100644 index 0000000000..0c200e26d0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminTaxRegionResponse +required: + - tax_region +properties: + tax_region: + $ref: ./AdminTaxRegion.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomer.yaml deleted file mode 100644 index 81d0b149a0..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomer.yaml +++ /dev/null @@ -1,35 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminUpdateCustomer -required: - - email - - company_name - - first_name - - last_name - - phone - - metadata -properties: - email: - type: string - title: email - description: The customer's email. - format: email - company_name: - type: string - title: company_name - description: The customer's company name. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - phone: - 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/AdminUpdateProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProduct.yaml index b95015d041..c5e1c3c7a9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProduct.yaml @@ -77,15 +77,13 @@ properties: items: type: object description: The tag's tags. + required: + - id properties: id: type: string title: id description: The tag's ID. - value: - type: string - title: value - description: The tag's value. options: type: array description: The update's options. @@ -95,7 +93,168 @@ properties: type: array description: The update's variants. items: - $ref: ./AdminCreateProductVariant.yaml + oneOf: + - type: object + description: The variant's variants. + x-schemaName: AdminCreateProductVariant + required: + - title + - prices + properties: + title: + type: string + title: title + description: The variant's title. + sku: + type: string + title: sku + description: The variant's sku. + ean: + type: string + title: ean + description: The variant's ean. + upc: + type: string + title: upc + description: The variant's upc. + barcode: + type: string + title: barcode + description: The variant's barcode. + hs_code: + type: string + title: hs_code + description: The variant's hs code. + mid_code: + type: string + title: mid_code + description: The variant's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + weight: + type: number + title: weight + description: The variant's weight. + length: + type: number + title: length + description: The variant's length. + height: + type: number + title: height + description: The variant's height. + width: + type: number + title: width + description: The variant's width. + origin_country: + type: string + title: origin_country + description: The variant's origin country. + material: + type: string + title: material + description: The variant's material. + metadata: + type: object + description: The variant's metadata. + prices: + type: array + description: The variant's prices. + items: + $ref: ./AdminCreateProductVariantPrice.yaml + options: + type: object + description: The variant's options. + - type: object + description: The variant's variants. + x-schemaName: AdminUpdateProductVariant + properties: + title: + type: string + title: title + description: The variant's title. + sku: + type: string + title: sku + description: The variant's sku. + ean: + type: string + title: ean + description: The variant's ean. + upc: + type: string + title: upc + description: The variant's upc. + barcode: + type: string + title: barcode + description: The variant's barcode. + hs_code: + type: string + title: hs_code + description: The variant's hs code. + mid_code: + type: string + title: mid_code + description: The variant's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + weight: + type: number + title: weight + description: The variant's weight. + length: + type: number + title: length + description: The variant's length. + height: + type: number + title: height + description: The variant's height. + width: + type: number + title: width + description: The variant's width. + origin_country: + type: string + title: origin_country + description: The variant's origin country. + material: + type: string + title: material + description: The variant's material. + metadata: + type: object + description: The variant's metadata. + prices: + type: array + description: The variant's prices. + items: + $ref: ./AdminCreateProductVariantPrice.yaml + options: + type: object + description: The variant's options. sales_channels: type: array description: The update's sales channels. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUser.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUser.yaml new file mode 100644 index 0000000000..6fb258123e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUser.yaml @@ -0,0 +1,53 @@ +type: object +description: The user's details. +x-schemaName: AdminUser +required: + - id + - email + - first_name + - last_name + - avatar_url + - metadata + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The user's ID. + email: + type: string + title: email + description: The user's email. + format: email + first_name: + type: string + title: first_name + description: The user's first name. + last_name: + type: string + title: last_name + description: The user's last name. + avatar_url: + type: string + title: avatar_url + description: The user's avatar url. + metadata: + type: object + description: The user's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The user's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The user's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The user's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUserDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUserDeleteResponse.yaml new file mode 100644 index 0000000000..5714e8f25d --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUserDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminUserDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The user's ID. + object: + type: string + title: object + description: The user's object. + default: user + deleted: + type: boolean + title: deleted + description: The user's deleted. + parent: + type: object + description: The user's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUserListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUserListResponse.yaml new file mode 100644 index 0000000000..7aac88724a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUserListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminUserListResponse +required: + - limit + - offset + - count + - users +properties: + limit: + type: number + title: limit + description: The user's limit. + offset: + type: number + title: offset + description: The user's offset. + count: + type: number + title: count + description: The user's count. + users: + type: array + description: The user's users. + items: + $ref: ./AdminUser.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUserResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUserResponse.yaml new file mode 100644 index 0000000000..dfc78e1bc9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUserResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminUserResponse +required: + - user +properties: + user: + $ref: ./AdminUser.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecution.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecution.yaml new file mode 100644 index 0000000000..8e71182f9e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecution.yaml @@ -0,0 +1,50 @@ +type: object +description: The workflows execution's workflow execution. +x-schemaName: AdminWorkflowExecution +required: + - id + - workflow_id + - transaction_id + - execution + - context + - state + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The workflow execution's ID. + workflow_id: + type: string + title: workflow_id + description: The workflow execution's workflow id. + transaction_id: + type: string + title: transaction_id + description: The workflow execution's transaction id. + execution: + type: string + title: execution + description: The workflow execution's execution. + context: + type: string + title: context + description: The workflow execution's context. + state: {} + created_at: + type: string + title: created_at + description: The workflow execution's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The workflow execution's updated at. + format: date-time + deleted_at: + type: string + title: deleted_at + description: The workflow execution's deleted at. + format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionResponse.yaml new file mode 100644 index 0000000000..2c21bd3e4e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminWorkflowExecutionResponse +required: + - workflow_execution +properties: + workflow_execution: + $ref: ./AdminWorkflowExecution.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/ApiKeyResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/ApiKeyResponse.yaml new file mode 100644 index 0000000000..df83ca78ff --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/ApiKeyResponse.yaml @@ -0,0 +1,59 @@ +type: object +description: The api key's details. +x-schemaName: ApiKeyResponse +required: + - id + - token + - redacted + - title + - type + - last_used_at + - created_by + - created_at + - revoked_by + - revoked_at +properties: + id: + type: string + title: id + description: The api key's ID. + token: + type: string + title: token + description: The api key's token. + redacted: + type: string + title: redacted + description: The api key's redacted. + title: + type: string + title: title + description: The api key's title. + type: + type: string + enum: + - secret + - publishable + last_used_at: + type: string + title: last_used_at + description: The api key's last used at. + format: date-time + created_by: + type: string + title: created_by + description: The api key's created by. + created_at: + type: string + title: created_at + description: The api key's created at. + format: date-time + revoked_by: + type: string + title: revoked_by + description: The api key's revoked by. + revoked_at: + type: string + title: revoked_at + description: The api key's revoked at. + format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseApplicationMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseApplicationMethod.yaml new file mode 100644 index 0000000000..b45304e208 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseApplicationMethod.yaml @@ -0,0 +1,58 @@ +type: object +description: The promotion's application method. +x-schemaName: BaseApplicationMethod +required: + - id +properties: + id: + type: string + title: id + description: The application method's ID. + type: + type: string + enum: + - fixed + - percentage + target_type: + type: string + enum: + - items + - shipping_methods + - order + allocation: + type: string + enum: + - each + - across + 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. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The application method's buy rules min quantity. + apply_to_quantity: + type: number + title: apply_to_quantity + description: The application method's apply to quantity. + promotion: + $ref: ./BasePromotion.yaml + target_rules: + type: array + description: The application method's target rules. + items: + $ref: ./BasePromotionRule.yaml + buy_rules: + type: array + description: The application method's buy rules. + items: + $ref: ./BasePromotionRule.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCalculatedPriceSet.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCalculatedPriceSet.yaml index dafb774a5f..70dd7bf660 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCalculatedPriceSet.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCalculatedPriceSet.yaml @@ -1,5 +1,5 @@ type: object -description: The updated's calculated price. +description: The parent's calculated price. x-schemaName: BaseCalculatedPriceSet required: - id diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCapture.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCapture.yaml new file mode 100644 index 0000000000..59baa7033c --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCapture.yaml @@ -0,0 +1,3 @@ +type: object +description: The capture's captures. +x-schemaName: BaseCapture diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCart.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCart.yaml new file mode 100644 index 0000000000..5cc50d1e73 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCart.yaml @@ -0,0 +1,3 @@ +type: object +description: The item's cart. +x-schemaName: BaseCart diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCartAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCartAddress.yaml new file mode 100644 index 0000000000..830384378e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCartAddress.yaml @@ -0,0 +1,69 @@ +type: object +description: The cart's billing address. +x-schemaName: BaseCartAddress +required: + - id + - created_at + - updated_at +properties: + 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/BaseCartLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCartLineItem.yaml new file mode 100644 index 0000000000..c1a1fc38f4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCartLineItem.yaml @@ -0,0 +1,306 @@ +type: object +description: The item's items. +x-schemaName: BaseCartLineItem +required: + - id + - title + - quantity + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - cart + - cart_id + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total +properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + quantity: + oneOf: + - type: string + title: quantity + description: The item's quantity. + - type: number + title: quantity + description: The item's quantity. + - type: string + title: quantity + description: The item's quantity. + - $ref: ./IBigNumber.yaml + product: + $ref: ./BaseProduct.yaml + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant: + $ref: ./BaseProductVariant.yaml + variant_id: + type: string + title: variant_id + description: The item's variant id. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + oneOf: + - type: string + title: compare_at_unit_price + description: The item's compare at unit price. + - type: number + title: compare_at_unit_price + description: The item's compare at unit price. + - type: string + title: compare_at_unit_price + description: The item's compare at unit price. + - $ref: ./IBigNumber.yaml + unit_price: + oneOf: + - type: string + title: unit_price + description: The item's unit price. + - type: number + title: unit_price + description: The item's unit price. + - type: string + title: unit_price + description: The item's unit price. + - $ref: ./IBigNumber.yaml + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: ./BaseLineItemTaxLine.yaml + adjustments: + type: array + description: The item's adjustments. + items: + $ref: ./BaseLineItemAdjustment.yaml + cart: + $ref: ./BaseCart.yaml + cart_id: + type: string + title: cart_id + description: The item's cart id. + metadata: + type: object + description: The item's metadata. + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + deleted_at: + type: string + title: deleted_at + description: The item's deleted at. + format: date-time + original_total: + oneOf: + - type: string + title: original_total + description: The item's original total. + - type: number + title: original_total + description: The item's original total. + - type: string + title: original_total + description: The item's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The item's original subtotal. + - type: number + title: original_subtotal + description: The item's original subtotal. + - type: string + title: original_subtotal + description: The item's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The item's original tax total. + - type: number + title: original_tax_total + description: The item's original tax total. + - type: string + title: original_tax_total + description: The item's original tax total. + - $ref: ./IBigNumber.yaml + item_total: + oneOf: + - type: string + title: item_total + description: The item's item total. + - type: number + title: item_total + description: The item's item total. + - type: string + title: item_total + description: The item's item total. + - $ref: ./IBigNumber.yaml + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The item's item subtotal. + - type: number + title: item_subtotal + description: The item's item subtotal. + - type: string + title: item_subtotal + description: The item's item subtotal. + - $ref: ./IBigNumber.yaml + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The item's item tax total. + - type: number + title: item_tax_total + description: The item's item tax total. + - type: string + title: item_tax_total + description: The item's item tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The item's total. + - type: number + title: total + description: The item's total. + - type: string + title: total + description: The item's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The item's subtotal. + - type: number + title: subtotal + description: The item's subtotal. + - type: string + title: subtotal + description: The item's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The item's tax total. + - type: number + title: tax_total + description: The item's tax total. + - type: string + title: tax_total + description: The item's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The item's discount total. + - type: number + title: discount_total + description: The item's discount total. + - type: string + title: discount_total + description: The item's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The item's discount tax total. + - type: number + title: discount_tax_total + description: The item's discount tax total. + - type: string + title: discount_tax_total + description: The item's discount tax total. + - $ref: ./IBigNumber.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCartShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCartShippingMethod.yaml new file mode 100644 index 0000000000..6f613ecf88 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCartShippingMethod.yaml @@ -0,0 +1,178 @@ +type: object +description: The shipping method's shipping methods. +x-schemaName: BaseCartShippingMethod +required: + - id + - cart_id + - name + - amount + - is_tax_inclusive + - created_at + - updated_at + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total +properties: + id: + type: string + title: id + description: The shipping method's ID. + cart_id: + type: string + title: cart_id + description: The shipping method's cart id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + oneOf: + - type: string + title: amount + description: The shipping method's amount. + - type: number + title: amount + description: The shipping method's amount. + - type: string + title: amount + description: The shipping method's amount. + - $ref: ./IBigNumber.yaml + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: ./BaseShippingMethodTaxLine.yaml + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: ./BaseShippingMethodAdjustment.yaml + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: discount_tax_total + description: The shipping method's discount tax total. + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - $ref: ./IBigNumber.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseClaim.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseClaim.yaml new file mode 100644 index 0000000000..85d6a02519 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseClaim.yaml @@ -0,0 +1,3 @@ +type: object +description: The order change's claim. +x-schemaName: BaseClaim diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseClaimItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseClaimItem.yaml new file mode 100644 index 0000000000..bff97378cc --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseClaimItem.yaml @@ -0,0 +1,55 @@ +type: object +description: The claim item's claim items. +x-schemaName: BaseClaimItem +required: + - id + - claim_id + - order_id + - item_id + - quantity + - reason + - raw_quantity +properties: + id: + type: string + title: id + description: The claim item's ID. + claim_id: + type: string + title: claim_id + description: The claim item's claim id. + order_id: + type: string + title: order_id + description: The claim item's order id. + item_id: + type: string + title: item_id + description: The claim item's item id. + quantity: + type: number + title: quantity + description: The claim item's quantity. + reason: + type: string + enum: + - missing_item + - wrong_item + - production_failure + - other + raw_quantity: + type: object + description: The claim item's raw quantity. + metadata: + type: object + description: The claim item's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The claim item's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The claim item's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseExchangeItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseExchangeItem.yaml new file mode 100644 index 0000000000..852b2e0a94 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseExchangeItem.yaml @@ -0,0 +1,45 @@ +type: object +description: The additional item's additional items. +x-schemaName: BaseExchangeItem +required: + - id + - exchange_id + - order_id + - item_id + - quantity + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The additional item's ID. + exchange_id: + type: string + title: exchange_id + description: The additional item's exchange id. + order_id: + type: string + title: order_id + description: The additional item's order id. + item_id: + type: string + title: item_id + description: The additional item's item id. + quantity: + type: number + title: quantity + description: The additional item's quantity. + metadata: + type: object + description: The additional item's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The additional item's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The additional item's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseFulfillmentProvider.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseFulfillmentProvider.yaml new file mode 100644 index 0000000000..5cddd56a89 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseFulfillmentProvider.yaml @@ -0,0 +1,15 @@ +type: object +description: The shipping option's provider. +x-schemaName: BaseFulfillmentProvider +required: + - id + - is_enabled +properties: + id: + type: string + title: id + description: The provider's ID. + is_enabled: + type: boolean + title: is_enabled + description: The provider's is enabled. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseLineItemAdjustment.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseLineItemAdjustment.yaml new file mode 100644 index 0000000000..5b5a104b31 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseLineItemAdjustment.yaml @@ -0,0 +1,3 @@ +type: object +description: The adjustment's adjustments. +x-schemaName: BaseLineItemAdjustment diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseLineItemTaxLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseLineItemTaxLine.yaml new file mode 100644 index 0000000000..1fdd8bf379 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseLineItemTaxLine.yaml @@ -0,0 +1,3 @@ +type: object +description: The tax line's tax lines. +x-schemaName: BaseLineItemTaxLine diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml new file mode 100644 index 0000000000..09579fa8dd --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml @@ -0,0 +1,3 @@ +type: object +description: The order change's order. +x-schemaName: BaseOrder diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml new file mode 100644 index 0000000000..4c549387e7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml @@ -0,0 +1,70 @@ +type: object +description: The order's billing address. +x-schemaName: BaseOrderAddress +required: + - id + - metadata + - created_at + - updated_at +properties: + 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/BaseOrderChange.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderChange.yaml new file mode 100644 index 0000000000..a50ab648b5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderChange.yaml @@ -0,0 +1,144 @@ +type: object +description: The order preview's order change. +x-schemaName: BaseOrderChange +required: + - id + - order_id + - actions + - status + - requested_by + - requested_at + - confirmed_by + - confirmed_at + - declined_by + - declined_reason + - metadata + - declined_at + - canceled_by + - canceled_at + - created_at + - updated_at + - version + - return_id + - exchange_id + - claim_id + - order + - return_order + - exchange + - claim +properties: + id: + type: string + title: id + description: The order change's ID. + order_id: + type: string + title: order_id + description: The order change's order id. + actions: + type: array + description: The order change's actions. + items: + $ref: ./BaseOrderChangeAction.yaml + status: + type: string + title: status + description: The order change's status. + requested_by: + type: string + title: requested_by + description: The order change's requested by. + requested_at: + oneOf: + - type: string + title: requested_at + description: The order change's requested at. + - type: string + title: requested_at + description: The order change's requested at. + format: date-time + confirmed_by: + type: string + title: confirmed_by + description: The order change's confirmed by. + confirmed_at: + oneOf: + - type: string + title: confirmed_at + description: The order change's confirmed at. + - type: string + title: confirmed_at + description: The order change's confirmed at. + format: date-time + declined_by: + type: string + title: declined_by + description: The order change's declined by. + declined_reason: + type: string + title: declined_reason + description: The order change's declined reason. + metadata: + type: object + description: The order change's metadata. + declined_at: + oneOf: + - type: string + title: declined_at + description: The order change's declined at. + - type: string + title: declined_at + description: The order change's declined at. + format: date-time + canceled_by: + type: string + title: canceled_by + description: The order change's canceled by. + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order change's canceled at. + - type: string + title: canceled_at + description: The order change's canceled at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The order change's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order change's updated at. + version: + type: number + title: version + description: The order change's version. + change_type: + type: string + enum: + - return + - exchange + - claim + - edit + return_id: + type: string + title: return_id + description: The order change's return id. + exchange_id: + type: string + title: exchange_id + description: The order change's exchange id. + claim_id: + type: string + title: claim_id + description: The order change's claim id. + order: + $ref: ./BaseOrder.yaml + return_order: {} + exchange: {} + claim: + $ref: ./BaseClaim.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderChangeAction.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderChangeAction.yaml new file mode 100644 index 0000000000..91725525be --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderChangeAction.yaml @@ -0,0 +1,3 @@ +type: object +description: The action's actions. +x-schemaName: BaseOrderChangeAction diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml new file mode 100644 index 0000000000..3e6cbb2a1a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml @@ -0,0 +1,69 @@ +type: object +description: The fulfillment's fulfillments. +x-schemaName: BaseOrderFulfillment +required: + - id + - location_id + - packed_at + - shipped_at + - delivered_at + - canceled_at + - data + - provider_id + - shipping_option_id + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The fulfillment's ID. + location_id: + type: string + title: location_id + description: The fulfillment's location id. + packed_at: + type: string + title: packed_at + description: The fulfillment's packed at. + format: date-time + shipped_at: + type: string + title: shipped_at + description: The fulfillment's shipped at. + format: date-time + delivered_at: + type: string + title: delivered_at + description: The fulfillment's delivered at. + format: date-time + canceled_at: + type: string + title: canceled_at + description: The fulfillment's canceled at. + format: date-time + data: + type: object + description: The fulfillment's data. + provider_id: + type: string + title: provider_id + description: The fulfillment's provider id. + shipping_option_id: + type: string + title: shipping_option_id + description: The fulfillment's shipping option id. + metadata: + type: object + description: The fulfillment's metadata. + created_at: + type: string + title: created_at + description: The fulfillment's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The fulfillment's updated at. + format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderItemDetail.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderItemDetail.yaml new file mode 100644 index 0000000000..0a1f9eb14d --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderItemDetail.yaml @@ -0,0 +1,3 @@ +type: object +description: The item's detail. +x-schemaName: BaseOrderItemDetail diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml new file mode 100644 index 0000000000..e3808ee206 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml @@ -0,0 +1,211 @@ +type: object +description: The item's items. +x-schemaName: BaseOrderLineItem +required: + - id + - title + - subtitle + - thumbnail + - variant_id + - product_id + - product_title + - product_description + - product_subtitle + - product_type + - product_collection + - product_handle + - variant_sku + - variant_barcode + - variant_title + - variant_option_values + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - detail + - created_at + - updated_at + - metadata + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit +properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant: + $ref: ./BaseProductVariant.yaml + variant_id: + type: string + title: variant_id + description: The item's variant id. + product: + $ref: ./BaseProduct.yaml + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: ./BaseOrderLineItemTaxLine.yaml + adjustments: + type: array + description: The item's adjustments. + items: + $ref: ./BaseOrderLineItemAdjustment.yaml + detail: + $ref: ./BaseOrderItemDetail.yaml + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + metadata: + type: object + description: The item's metadata. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItemAdjustment.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItemAdjustment.yaml new file mode 100644 index 0000000000..a4f81ce94f --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItemAdjustment.yaml @@ -0,0 +1,3 @@ +type: object +description: The adjustment's adjustments. +x-schemaName: BaseOrderLineItemAdjustment diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItemTaxLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItemTaxLine.yaml new file mode 100644 index 0000000000..213da9382d --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItemTaxLine.yaml @@ -0,0 +1,3 @@ +type: object +description: The tax line's tax lines. +x-schemaName: BaseOrderLineItemTaxLine diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethod.yaml new file mode 100644 index 0000000000..4357db37d7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethod.yaml @@ -0,0 +1,173 @@ +type: object +description: The shipping method's shipping methods. +x-schemaName: BaseOrderShippingMethod +required: + - id + - order_id + - name + - amount + - is_tax_inclusive + - shipping_option_id + - data + - metadata + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: ./BaseOrderShippingMethodTaxLine.yaml + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: ./BaseOrderShippingMethodAdjustment.yaml + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: discount_tax_total + description: The shipping method's discount tax total. + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - $ref: ./IBigNumber.yaml + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethodAdjustment.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethodAdjustment.yaml new file mode 100644 index 0000000000..0d458f73fa --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethodAdjustment.yaml @@ -0,0 +1,3 @@ +type: object +description: The adjustment's adjustments. +x-schemaName: BaseOrderShippingMethodAdjustment diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethodTaxLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethodTaxLine.yaml new file mode 100644 index 0000000000..3cce6d21b0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethodTaxLine.yaml @@ -0,0 +1,3 @@ +type: object +description: The tax line's tax lines. +x-schemaName: BaseOrderShippingMethodTaxLine diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderSummary.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderSummary.yaml new file mode 100644 index 0000000000..395346dc23 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderSummary.yaml @@ -0,0 +1,80 @@ +type: object +description: The order's summary. +x-schemaName: BaseOrderSummary +required: + - total + - subtotal + - total_tax + - ordered_total + - fulfilled_total + - returned_total + - return_request_total + - write_off_total + - projected_total + - net_total + - net_subtotal + - net_total_tax + - balance + - paid_total + - refunded_total +properties: + total: + type: number + title: total + description: The summary's total. + subtotal: + type: number + title: subtotal + description: The summary's subtotal. + total_tax: + type: number + title: total_tax + description: The summary's total tax. + ordered_total: + type: number + title: ordered_total + description: The summary's ordered total. + fulfilled_total: + type: number + title: fulfilled_total + description: The summary's fulfilled total. + returned_total: + type: number + title: returned_total + description: The summary's returned total. + return_request_total: + type: number + title: return_request_total + description: The summary's return request total. + write_off_total: + type: number + title: write_off_total + description: The summary's write off total. + projected_total: + type: number + title: projected_total + description: The summary's projected total. + net_total: + type: number + title: net_total + description: The summary's net total. + net_subtotal: + type: number + title: net_subtotal + description: The summary's net subtotal. + net_total_tax: + type: number + title: net_total_tax + description: The summary's net total tax. + balance: + type: number + title: balance + description: The summary's balance. + paid_total: + type: number + title: paid_total + description: The summary's paid total. + refunded_total: + type: number + title: refunded_total + description: The summary's refunded total. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderTransaction.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderTransaction.yaml new file mode 100644 index 0000000000..8abf8cfd58 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderTransaction.yaml @@ -0,0 +1,51 @@ +type: object +description: The transaction's transactions. +x-schemaName: BaseOrderTransaction +required: + - id + - order_id + - amount + - currency_code + - reference + - reference_id + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The transaction's ID. + order_id: + type: string + title: order_id + description: The transaction's order id. + amount: + type: number + title: amount + description: The transaction's amount. + currency_code: + type: string + title: currency_code + description: The transaction's currency code. + reference: + type: string + title: reference + description: The transaction's reference. + reference_id: + type: string + title: reference_id + description: The transaction's reference id. + metadata: + type: object + description: The transaction's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The transaction's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The transaction's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BasePayment.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePayment.yaml new file mode 100644 index 0000000000..6171436ba7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BasePayment.yaml @@ -0,0 +1,3 @@ +type: object +description: The payment's payments. +x-schemaName: BasePayment diff --git a/www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml new file mode 100644 index 0000000000..f60bcd7273 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml @@ -0,0 +1,116 @@ +type: object +description: The payment collection's payment collections. +x-schemaName: BasePaymentCollection +required: + - id + - currency_code + - region_id + - amount + - status + - payment_providers +properties: + id: + type: string + title: id + description: The payment collection's ID. + currency_code: + type: string + title: currency_code + description: The payment collection's currency code. + region_id: + type: string + title: region_id + description: The payment collection's region id. + amount: + oneOf: + - type: string + title: amount + description: The payment collection's amount. + - type: number + title: amount + description: The payment collection's amount. + - type: string + title: amount + description: The payment collection's amount. + - $ref: ./IBigNumber.yaml + authorized_amount: + oneOf: + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - type: number + title: authorized_amount + description: The payment collection's authorized amount. + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - $ref: ./IBigNumber.yaml + captured_amount: + oneOf: + - type: string + title: captured_amount + description: The payment collection's captured amount. + - type: number + title: captured_amount + description: The payment collection's captured amount. + - type: string + title: captured_amount + description: The payment collection's captured amount. + - $ref: ./IBigNumber.yaml + refunded_amount: + oneOf: + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - type: number + title: refunded_amount + description: The payment collection's refunded amount. + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - $ref: ./IBigNumber.yaml + completed_at: + oneOf: + - type: string + title: completed_at + description: The payment collection's completed at. + - type: string + title: completed_at + description: The payment collection's completed at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The payment collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The payment collection's updated at. + metadata: + type: object + description: The payment collection's metadata. + status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + payment_providers: + type: array + description: The payment collection's payment providers. + items: + $ref: ./BasePaymentProvider.yaml + payment_sessions: + type: array + description: The payment collection's payment sessions. + items: + $ref: ./BasePaymentSession.yaml + payments: + type: array + description: The payment collection's payments. + items: + $ref: ./BasePayment.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/BasePaymentProvider.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentProvider.yaml new file mode 100644 index 0000000000..2266f0a8ea --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentProvider.yaml @@ -0,0 +1,3 @@ +type: object +description: The payment provider's payment providers. +x-schemaName: BasePaymentProvider diff --git a/www/apps/api-reference/specs/admin/components/schemas/BasePaymentSession.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentSession.yaml new file mode 100644 index 0000000000..f0c1e2603a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentSession.yaml @@ -0,0 +1,3 @@ +type: object +description: The payment session's payment sessions. +x-schemaName: BasePaymentSession diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml index 9d8d9258cf..bb621de314 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml @@ -1,5 +1,5 @@ type: object -description: The updated's product. +description: The parent's product. x-schemaName: BaseProduct required: - id diff --git a/www/apps/api-reference/specs/admin/components/schemas/BasePromotion.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePromotion.yaml new file mode 100644 index 0000000000..9715373b34 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BasePromotion.yaml @@ -0,0 +1,3 @@ +type: object +description: The application method's promotion. +x-schemaName: BasePromotion diff --git a/www/apps/api-reference/specs/admin/components/schemas/BasePromotionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePromotionRule.yaml new file mode 100644 index 0000000000..29325b0a3b --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BasePromotionRule.yaml @@ -0,0 +1,34 @@ +type: object +description: The rule's rules. +x-schemaName: BasePromotionRule +required: + - id + - values +properties: + id: + type: string + title: id + description: The rule's ID. + description: + type: string + title: description + description: The rule's description. + attribute: + type: string + title: attribute + description: The rule's attribute. + operator: + type: string + enum: + - gt + - lt + - eq + - ne + - in + - lte + - gte + values: + type: array + description: The rule's values. + items: + $ref: ./BasePromotionRuleValue.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/BasePromotionRuleValue.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePromotionRuleValue.yaml new file mode 100644 index 0000000000..9cba351225 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BasePromotionRuleValue.yaml @@ -0,0 +1,14 @@ +type: object +description: The value's values. +x-schemaName: BasePromotionRuleValue +required: + - id +properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value's details. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseRefund.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseRefund.yaml new file mode 100644 index 0000000000..50d12fb0f9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseRefund.yaml @@ -0,0 +1,3 @@ +type: object +description: The refund's refunds. +x-schemaName: BaseRefund diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseRegion.yaml new file mode 100644 index 0000000000..c90e5373dc --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseRegion.yaml @@ -0,0 +1,47 @@ +type: object +description: The cart's region. +x-schemaName: BaseRegion +required: + - id + - name + - currency_code +properties: + id: + type: string + title: id + description: The region's ID. + name: + type: string + title: name + description: The region's name. + currency_code: + type: string + title: currency_code + description: The region's currency code. + automatic_taxes: + type: boolean + title: automatic_taxes + description: The region's automatic taxes. + countries: + type: array + description: The region's countries. + items: + $ref: ./BaseRegionCountry.yaml + payment_providers: + type: array + description: The region's payment providers. + items: + $ref: ./AdminPaymentProvider.yaml + metadata: + type: object + description: The region's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The region's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The region's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseRegionCountry.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseRegionCountry.yaml new file mode 100644 index 0000000000..ee76c5c787 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseRegionCountry.yaml @@ -0,0 +1,3 @@ +type: object +description: The country's countries. +x-schemaName: BaseRegionCountry diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseReturnItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseReturnItem.yaml new file mode 100644 index 0000000000..3f0906bd54 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseReturnItem.yaml @@ -0,0 +1,3 @@ +type: object +description: The item's items. +x-schemaName: BaseReturnItem diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseRuleOperatorOptions.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseRuleOperatorOptions.yaml new file mode 100644 index 0000000000..b5c88a34d8 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseRuleOperatorOptions.yaml @@ -0,0 +1,20 @@ +type: object +description: The operator's operators. +x-schemaName: BaseRuleOperatorOptions +required: + - id + - value + - label +properties: + id: + type: string + title: id + description: The operator's ID. + value: + type: string + title: value + description: The operator's value. + label: + type: string + title: label + description: The operator's label. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseShippingMethodAdjustment.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseShippingMethodAdjustment.yaml new file mode 100644 index 0000000000..e20885775e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseShippingMethodAdjustment.yaml @@ -0,0 +1,3 @@ +type: object +description: The adjustment's adjustments. +x-schemaName: BaseShippingMethodAdjustment diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseShippingMethodTaxLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseShippingMethodTaxLine.yaml new file mode 100644 index 0000000000..e7e494dae5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseShippingMethodTaxLine.yaml @@ -0,0 +1,3 @@ +type: object +description: The tax line's tax lines. +x-schemaName: BaseShippingMethodTaxLine diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCampaign.yaml b/www/apps/api-reference/specs/admin/components/schemas/CampaignResponse.yaml similarity index 51% rename from www/apps/api-reference/specs/store/components/schemas/AdminUpdateCampaign.yaml rename to www/apps/api-reference/specs/admin/components/schemas/CampaignResponse.yaml index d273d2bfbf..aa51404c15 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCampaign.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/CampaignResponse.yaml @@ -1,53 +1,72 @@ type: object -description: SUMMARY -x-schemaName: AdminUpdateCampaign +description: The campaign's details. +x-schemaName: CampaignResponse required: + - id + - name - description + - currency + - campaign_identifier - starts_at - ends_at + - budget properties: + id: + type: string + title: id + description: The campaign's ID. name: type: string title: name description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. description: type: string title: description description: The campaign's description. - budget: - type: object - description: The campaign's budget. - required: - - limit - properties: - limit: - type: number - title: limit - description: The budget's limit. + 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 - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. + budget: + type: object + description: The campaign's budget. + required: + - id + - type + - currency_code + - limit + - used + properties: + id: + type: string + title: id + description: The budget's ID. + type: + type: string + 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. + used: + type: number + title: used + description: The budget's used. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateCartWorkflowInput.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateCartWorkflowInput.yaml deleted file mode 100644 index 369ef9b3a1..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateCartWorkflowInput.yaml +++ /dev/null @@ -1,60 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreateCartWorkflowInput -properties: - region_id: - type: string - title: region_id - description: The cart's region id. - customer_id: - type: string - title: customer_id - description: The cart's customer id. - sales_channel_id: - type: string - title: sales_channel_id - description: The cart's sales channel id. - email: - type: string - title: email - description: The cart's email. - format: email - currency_code: - type: string - title: currency_code - description: The cart's currency code. - shipping_address_id: - type: string - title: shipping_address_id - description: The cart's shipping address id. - billing_address_id: - type: string - title: billing_address_id - description: The cart's billing address id. - shipping_address: - oneOf: - - type: string - title: shipping_address - description: The cart's shipping address. - - $ref: ./CreateCartAddress.yaml - billing_address: - oneOf: - - type: string - title: billing_address - description: The cart's billing address. - - $ref: ./CreateCartAddress.yaml - metadata: - type: object - description: The cart's metadata. - items: - type: array - description: The cart's items. - items: - $ref: ./CreateCartCreateLineItem.yaml - promo_codes: - type: array - description: The cart's promo codes. - items: - type: string - title: promo_codes - description: The promo code's promo codes. diff --git a/www/apps/api-reference/specs/admin/components/schemas/IBigNumber.yaml b/www/apps/api-reference/specs/admin/components/schemas/IBigNumber.yaml new file mode 100644 index 0000000000..50cf33abe6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/IBigNumber.yaml @@ -0,0 +1,3 @@ +type: object +description: The shipping method's discount tax total. +x-schemaName: IBigNumber diff --git a/www/apps/api-reference/specs/admin/components/schemas/InventoryLevel.yaml b/www/apps/api-reference/specs/admin/components/schemas/InventoryLevel.yaml new file mode 100644 index 0000000000..ff883a1a28 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/InventoryLevel.yaml @@ -0,0 +1,43 @@ +type: object +description: The inventory level's inventory levels. +x-schemaName: InventoryLevel +required: + - id + - inventory_item_id + - location_id + - stocked_quantity + - reserved_quantity + - available_quantity + - incoming_quantity +properties: + id: + type: string + title: id + description: The inventory level's ID. + inventory_item_id: + type: string + title: inventory_item_id + description: The inventory level's inventory item id. + location_id: + type: string + title: location_id + description: The inventory level's location id. + stocked_quantity: + type: number + title: stocked_quantity + description: The inventory level's stocked quantity. + reserved_quantity: + type: number + title: reserved_quantity + description: The inventory level's reserved quantity. + available_quantity: + type: number + title: available_quantity + description: The inventory level's available quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The inventory level's incoming quantity. + metadata: + type: object + description: The inventory level's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml new file mode 100644 index 0000000000..f138b6e974 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml @@ -0,0 +1,936 @@ +type: object +description: The exchange's order preview. +x-schemaName: Order +required: + - id + - version + - status + - currency_code + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total + - raw_original_item_total + - raw_original_item_subtotal + - raw_original_item_tax_total + - raw_item_total + - raw_item_subtotal + - raw_item_tax_total + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + - raw_gift_card_total + - raw_gift_card_tax_total + - raw_shipping_total + - raw_shipping_subtotal + - raw_shipping_tax_total + - raw_original_shipping_total + - raw_original_shipping_subtotal + - raw_original_shipping_tax_total +properties: + id: + type: string + title: id + description: The order preview's ID. + version: + type: number + title: version + description: The order preview's version. + order_change: + $ref: ./OrderChange.yaml + status: + type: string + enum: + - canceled + - requires_action + - pending + - completed + - draft + - archived + region_id: + type: string + title: region_id + description: The order preview's region id. + customer_id: + type: string + title: customer_id + description: The order preview's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order preview's sales channel id. + email: + type: string + title: email + description: The order preview's email. + format: email + currency_code: + type: string + title: currency_code + description: The order preview's currency code. + shipping_address: + $ref: ./OrderAddress.yaml + billing_address: + $ref: ./OrderAddress.yaml + items: + type: array + description: The order preview's items. + items: + $ref: ./OrderLineItem.yaml + shipping_methods: + type: array + description: The order preview's shipping methods. + items: + $ref: ./OrderShippingMethod.yaml + transactions: + type: array + description: The order preview's transactions. + items: + $ref: ./OrderTransaction.yaml + summary: + type: object + description: The order preview's summary. + required: + - total + - subtotal + - total_tax + - ordered_total + - fulfilled_total + - returned_total + - return_request_total + - write_off_total + - projected_total + - net_total + - net_subtotal + - net_total_tax + - balance + - paid_total + - refunded_total + properties: + total: + oneOf: + - type: string + title: total + description: The summary's total. + - type: number + title: total + description: The summary's total. + - type: string + title: total + description: The summary's total. + - type: object + description: The summary's total. + x-schemaName: IBigNumber + subtotal: + oneOf: + - type: string + title: subtotal + description: The summary's subtotal. + - type: number + title: subtotal + description: The summary's subtotal. + - type: string + title: subtotal + description: The summary's subtotal. + - type: object + description: The summary's subtotal. + x-schemaName: IBigNumber + total_tax: + oneOf: + - type: string + title: total_tax + description: The summary's total tax. + - type: number + title: total_tax + description: The summary's total tax. + - type: string + title: total_tax + description: The summary's total tax. + - type: object + description: The summary's total tax. + x-schemaName: IBigNumber + ordered_total: + oneOf: + - type: string + title: ordered_total + description: The summary's ordered total. + - type: number + title: ordered_total + description: The summary's ordered total. + - type: string + title: ordered_total + description: The summary's ordered total. + - type: object + description: The summary's ordered total. + x-schemaName: IBigNumber + fulfilled_total: + oneOf: + - type: string + title: fulfilled_total + description: The summary's fulfilled total. + - type: number + title: fulfilled_total + description: The summary's fulfilled total. + - type: string + title: fulfilled_total + description: The summary's fulfilled total. + - type: object + description: The summary's fulfilled total. + x-schemaName: IBigNumber + returned_total: + oneOf: + - type: string + title: returned_total + description: The summary's returned total. + - type: number + title: returned_total + description: The summary's returned total. + - type: string + title: returned_total + description: The summary's returned total. + - type: object + description: The summary's returned total. + x-schemaName: IBigNumber + return_request_total: + oneOf: + - type: string + title: return_request_total + description: The summary's return request total. + - type: number + title: return_request_total + description: The summary's return request total. + - type: string + title: return_request_total + description: The summary's return request total. + - type: object + description: The summary's return request total. + x-schemaName: IBigNumber + write_off_total: + oneOf: + - type: string + title: write_off_total + description: The summary's write off total. + - type: number + title: write_off_total + description: The summary's write off total. + - type: string + title: write_off_total + description: The summary's write off total. + - type: object + description: The summary's write off total. + x-schemaName: IBigNumber + projected_total: + oneOf: + - type: string + title: projected_total + description: The summary's projected total. + - type: number + title: projected_total + description: The summary's projected total. + - type: string + title: projected_total + description: The summary's projected total. + - type: object + description: The summary's projected total. + x-schemaName: IBigNumber + net_total: + oneOf: + - type: string + title: net_total + description: The summary's net total. + - type: number + title: net_total + description: The summary's net total. + - type: string + title: net_total + description: The summary's net total. + - type: object + description: The summary's net total. + x-schemaName: IBigNumber + net_subtotal: + oneOf: + - type: string + title: net_subtotal + description: The summary's net subtotal. + - type: number + title: net_subtotal + description: The summary's net subtotal. + - type: string + title: net_subtotal + description: The summary's net subtotal. + - type: object + description: The summary's net subtotal. + x-schemaName: IBigNumber + net_total_tax: + oneOf: + - type: string + title: net_total_tax + description: The summary's net total tax. + - type: number + title: net_total_tax + description: The summary's net total tax. + - type: string + title: net_total_tax + description: The summary's net total tax. + - type: object + description: The summary's net total tax. + x-schemaName: IBigNumber + balance: + oneOf: + - type: string + title: balance + description: The summary's balance. + - type: number + title: balance + description: The summary's balance. + - type: string + title: balance + description: The summary's balance. + - type: object + description: The summary's balance. + x-schemaName: IBigNumber + paid_total: + oneOf: + - type: string + title: paid_total + description: The summary's paid total. + - type: number + title: paid_total + description: The summary's paid total. + - type: string + title: paid_total + description: The summary's paid total. + - type: object + description: The summary's paid total. + x-schemaName: IBigNumber + refunded_total: + oneOf: + - type: string + title: refunded_total + description: The summary's refunded total. + - type: number + title: refunded_total + description: The summary's refunded total. + - type: string + title: refunded_total + description: The summary's refunded total. + - type: object + description: The summary's refunded total. + x-schemaName: IBigNumber + metadata: + type: object + description: The order preview's metadata. + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order preview's canceled at. + - type: string + title: canceled_at + description: The order preview's canceled at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The order preview's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order preview's updated at. + original_item_total: + oneOf: + - type: string + title: original_item_total + description: The order preview's original item total. + - type: number + title: original_item_total + description: The order preview's original item total. + - type: string + title: original_item_total + description: The order preview's original item total. + - $ref: ./IBigNumber.yaml + original_item_subtotal: + oneOf: + - type: string + title: original_item_subtotal + description: The order preview's original item subtotal. + - type: number + title: original_item_subtotal + description: The order preview's original item subtotal. + - type: string + title: original_item_subtotal + description: The order preview's original item subtotal. + - $ref: ./IBigNumber.yaml + original_item_tax_total: + oneOf: + - type: string + title: original_item_tax_total + description: The order preview's original item tax total. + - type: number + title: original_item_tax_total + description: The order preview's original item tax total. + - type: string + title: original_item_tax_total + description: The order preview's original item tax total. + - $ref: ./IBigNumber.yaml + item_total: + oneOf: + - type: string + title: item_total + description: The order preview's item total. + - type: number + title: item_total + description: The order preview's item total. + - type: string + title: item_total + description: The order preview's item total. + - $ref: ./IBigNumber.yaml + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The order preview's item subtotal. + - type: number + title: item_subtotal + description: The order preview's item subtotal. + - type: string + title: item_subtotal + description: The order preview's item subtotal. + - $ref: ./IBigNumber.yaml + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The order preview's item tax total. + - type: number + title: item_tax_total + description: The order preview's item tax total. + - type: string + title: item_tax_total + description: The order preview's item tax total. + - $ref: ./IBigNumber.yaml + original_total: + oneOf: + - type: string + title: original_total + description: The order preview's original total. + - type: number + title: original_total + description: The order preview's original total. + - type: string + title: original_total + description: The order preview's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The order preview's original subtotal. + - type: number + title: original_subtotal + description: The order preview's original subtotal. + - type: string + title: original_subtotal + description: The order preview's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The order preview's original tax total. + - type: number + title: original_tax_total + description: The order preview's original tax total. + - type: string + title: original_tax_total + description: The order preview's original tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The order preview's total. + - type: number + title: total + description: The order preview's total. + - type: string + title: total + description: The order preview's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The order preview's subtotal. + - type: number + title: subtotal + description: The order preview's subtotal. + - type: string + title: subtotal + description: The order preview's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The order preview's tax total. + - type: number + title: tax_total + description: The order preview's tax total. + - type: string + title: tax_total + description: The order preview's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The order preview's discount total. + - type: number + title: discount_total + description: The order preview's discount total. + - type: string + title: discount_total + description: The order preview's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The order preview's discount tax total. + - type: number + title: discount_tax_total + description: The order preview's discount tax total. + - type: string + title: discount_tax_total + description: The order preview's discount tax total. + - $ref: ./IBigNumber.yaml + gift_card_total: + oneOf: + - type: string + title: gift_card_total + description: The order preview's gift card total. + - type: number + title: gift_card_total + description: The order preview's gift card total. + - type: string + title: gift_card_total + description: The order preview's gift card total. + - $ref: ./IBigNumber.yaml + gift_card_tax_total: + oneOf: + - type: string + title: gift_card_tax_total + description: The order preview's gift card tax total. + - type: number + title: gift_card_tax_total + description: The order preview's gift card tax total. + - type: string + title: gift_card_tax_total + description: The order preview's gift card tax total. + - $ref: ./IBigNumber.yaml + shipping_total: + oneOf: + - type: string + title: shipping_total + description: The order preview's shipping total. + - type: number + title: shipping_total + description: The order preview's shipping total. + - type: string + title: shipping_total + description: The order preview's shipping total. + - $ref: ./IBigNumber.yaml + shipping_subtotal: + oneOf: + - type: string + title: shipping_subtotal + description: The order preview's shipping subtotal. + - type: number + title: shipping_subtotal + description: The order preview's shipping subtotal. + - type: string + title: shipping_subtotal + description: The order preview's shipping subtotal. + - $ref: ./IBigNumber.yaml + shipping_tax_total: + oneOf: + - type: string + title: shipping_tax_total + description: The order preview's shipping tax total. + - type: number + title: shipping_tax_total + description: The order preview's shipping tax total. + - type: string + title: shipping_tax_total + description: The order preview's shipping tax total. + - $ref: ./IBigNumber.yaml + original_shipping_total: + oneOf: + - type: string + title: original_shipping_total + description: The order preview's original shipping total. + - type: number + title: original_shipping_total + description: The order preview's original shipping total. + - type: string + title: original_shipping_total + description: The order preview's original shipping total. + - $ref: ./IBigNumber.yaml + original_shipping_subtotal: + oneOf: + - type: string + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - type: number + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - type: string + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - $ref: ./IBigNumber.yaml + original_shipping_tax_total: + oneOf: + - type: string + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - type: number + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - type: string + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - $ref: ./IBigNumber.yaml + raw_original_item_total: + type: object + description: The order preview's raw original item total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item total's value. + - type: number + title: value + description: The raw original item total's value. + raw_original_item_subtotal: + type: object + description: The order preview's raw original item subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item subtotal's value. + - type: number + title: value + description: The raw original item subtotal's value. + raw_original_item_tax_total: + type: object + description: The order preview's raw original item tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item tax total's value. + - type: number + title: value + description: The raw original item tax total's value. + raw_item_total: + type: object + description: The order preview's raw item total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item total's value. + - type: number + title: value + description: The raw item total's value. + raw_item_subtotal: + type: object + description: The order preview's raw item subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item subtotal's value. + - type: number + title: value + description: The raw item subtotal's value. + raw_item_tax_total: + type: object + description: The order preview's raw item tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item tax total's value. + - type: number + title: value + description: The raw item tax total's value. + raw_original_total: + type: object + description: The order preview's raw original total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original total's value. + - type: number + title: value + description: The raw original total's value. + raw_original_subtotal: + type: object + description: The order preview's raw original subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original subtotal's value. + - type: number + title: value + description: The raw original subtotal's value. + raw_original_tax_total: + type: object + description: The order preview's raw original tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original tax total's value. + - type: number + title: value + description: The raw original tax total's value. + raw_total: + type: object + description: The order preview's raw total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw total's value. + - type: number + title: value + description: The raw total's value. + raw_subtotal: + type: object + description: The order preview's raw subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw subtotal's value. + - type: number + title: value + description: The raw subtotal's value. + raw_tax_total: + type: object + description: The order preview's raw tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw tax total's value. + - type: number + title: value + description: The raw tax total's value. + raw_discount_total: + type: object + description: The order preview's raw discount total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw discount total's value. + - type: number + title: value + description: The raw discount total's value. + raw_discount_tax_total: + type: object + description: The order preview's raw discount tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw discount tax total's value. + - type: number + title: value + description: The raw discount tax total's value. + raw_gift_card_total: + type: object + description: The order preview's raw gift card total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw gift card total's value. + - type: number + title: value + description: The raw gift card total's value. + raw_gift_card_tax_total: + type: object + description: The order preview's raw gift card tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw gift card tax total's value. + - type: number + title: value + description: The raw gift card tax total's value. + raw_shipping_total: + type: object + description: The order preview's raw shipping total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping total's value. + - type: number + title: value + description: The raw shipping total's value. + raw_shipping_subtotal: + type: object + description: The order preview's raw shipping subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping subtotal's value. + - type: number + title: value + description: The raw shipping subtotal's value. + raw_shipping_tax_total: + type: object + description: The order preview's raw shipping tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping tax total's value. + - type: number + title: value + description: The raw shipping tax total's value. + raw_original_shipping_total: + type: object + description: The order preview's raw original shipping total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping total's value. + - type: number + title: value + description: The raw original shipping total's value. + raw_original_shipping_subtotal: + type: object + description: The order preview's raw original shipping subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping subtotal's value. + - type: number + title: value + description: The raw original shipping subtotal's value. + raw_original_shipping_tax_total: + type: object + description: The order preview's raw original shipping tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping tax total's value. + - type: number + title: value + description: The raw original shipping tax total's value. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml new file mode 100644 index 0000000000..2006536055 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml @@ -0,0 +1,69 @@ +type: object +description: The order preview's billing address. +x-schemaName: OrderAddress +required: + - id + - created_at + - updated_at +properties: + 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/OrderChange.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml new file mode 100644 index 0000000000..a414e29765 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml @@ -0,0 +1,146 @@ +type: object +description: The order preview's order change. +x-schemaName: OrderChange +required: + - id + - version + - order_id + - return_id + - exchange_id + - claim_id + - order + - return_order + - exchange + - claim + - actions + - status + - requested_by + - requested_at + - confirmed_by + - confirmed_at + - declined_by + - declined_reason + - metadata + - declined_at + - canceled_by + - canceled_at + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The order change's ID. + version: + type: number + title: version + description: The order change's version. + change_type: + type: string + enum: + - return + - exchange + - claim + - edit + order_id: + type: string + title: order_id + description: The order change's order id. + return_id: + type: string + title: return_id + description: The order change's return id. + exchange_id: + type: string + title: exchange_id + description: The order change's exchange id. + claim_id: + type: string + title: claim_id + description: The order change's claim id. + order: + type: object + return_order: + $ref: ./Return.yaml + exchange: + $ref: ./OrderExchange.yaml + claim: + $ref: ./OrderClaim.yaml + actions: + type: array + description: The order change's actions. + items: + $ref: ./OrderChangeAction.yaml + status: + type: string + title: status + description: The order change's status. + requested_by: + type: string + title: requested_by + description: The order change's requested by. + requested_at: + oneOf: + - type: string + title: requested_at + description: The order change's requested at. + - type: string + title: requested_at + description: The order change's requested at. + format: date-time + confirmed_by: + type: string + title: confirmed_by + description: The order change's confirmed by. + confirmed_at: + oneOf: + - type: string + title: confirmed_at + description: The order change's confirmed at. + - type: string + title: confirmed_at + description: The order change's confirmed at. + format: date-time + declined_by: + type: string + title: declined_by + description: The order change's declined by. + declined_reason: + type: string + title: declined_reason + description: The order change's declined reason. + metadata: + type: object + description: The order change's metadata. + declined_at: + oneOf: + - type: string + title: declined_at + description: The order change's declined at. + - type: string + title: declined_at + description: The order change's declined at. + format: date-time + canceled_by: + type: string + title: canceled_by + description: The order change's canceled by. + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order change's canceled at. + - type: string + title: canceled_at + description: The order change's canceled at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The order change's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order change's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderChangeAction.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderChangeAction.yaml new file mode 100644 index 0000000000..13a80ba767 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderChangeAction.yaml @@ -0,0 +1,3 @@ +type: object +description: The action's actions. +x-schemaName: OrderChangeAction diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderClaim.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderClaim.yaml new file mode 100644 index 0000000000..7d1a9d3366 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderClaim.yaml @@ -0,0 +1,3 @@ +type: object +description: The order change's claim. +x-schemaName: OrderClaim diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml new file mode 100644 index 0000000000..0c83b9bb1b --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml @@ -0,0 +1,3 @@ +type: object +description: The order change's exchange. +x-schemaName: OrderExchange diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderItem.yaml new file mode 100644 index 0000000000..d7584d2fbe --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderItem.yaml @@ -0,0 +1,3 @@ +type: object +description: The item's detail. +x-schemaName: OrderItem diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml new file mode 100644 index 0000000000..971b9caf80 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml @@ -0,0 +1,359 @@ +type: object +description: The item's items. +x-schemaName: OrderLineItem +required: + - id + - title + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - raw_unit_price + - quantity + - raw_quantity + - detail + - created_at + - updated_at + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_item_total + - raw_item_subtotal + - raw_item_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + - raw_refundable_total + - raw_refundable_total_per_unit +properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant_id: + type: string + title: variant_id + description: The item's variant id. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + raw_compare_at_unit_price: + type: object + description: The item's raw compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + raw_unit_price: + type: object + description: The item's raw unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + raw_quantity: + type: object + description: The item's raw quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: ./OrderLineItemTaxLine.yaml + adjustments: + type: array + description: The item's adjustments. + items: + $ref: ./OrderLineItemAdjustment.yaml + detail: + $ref: ./OrderItem.yaml + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + metadata: + type: object + description: The item's metadata. + original_total: + oneOf: + - type: string + title: original_total + description: The item's original total. + - type: number + title: original_total + description: The item's original total. + - type: string + title: original_total + description: The item's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The item's original subtotal. + - type: number + title: original_subtotal + description: The item's original subtotal. + - type: string + title: original_subtotal + description: The item's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The item's original tax total. + - type: number + title: original_tax_total + description: The item's original tax total. + - type: string + title: original_tax_total + description: The item's original tax total. + - $ref: ./IBigNumber.yaml + item_total: + oneOf: + - type: string + title: item_total + description: The item's item total. + - type: number + title: item_total + description: The item's item total. + - type: string + title: item_total + description: The item's item total. + - $ref: ./IBigNumber.yaml + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The item's item subtotal. + - type: number + title: item_subtotal + description: The item's item subtotal. + - type: string + title: item_subtotal + description: The item's item subtotal. + - $ref: ./IBigNumber.yaml + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The item's item tax total. + - type: number + title: item_tax_total + description: The item's item tax total. + - type: string + title: item_tax_total + description: The item's item tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The item's total. + - type: number + title: total + description: The item's total. + - type: string + title: total + description: The item's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The item's subtotal. + - type: number + title: subtotal + description: The item's subtotal. + - type: string + title: subtotal + description: The item's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The item's tax total. + - type: number + title: tax_total + description: The item's tax total. + - type: string + title: tax_total + description: The item's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The item's discount total. + - type: number + title: discount_total + description: The item's discount total. + - type: string + title: discount_total + description: The item's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The item's discount tax total. + - type: number + title: discount_tax_total + description: The item's discount tax total. + - type: string + title: discount_tax_total + description: The item's discount tax total. + - $ref: ./IBigNumber.yaml + refundable_total: + oneOf: + - type: string + title: refundable_total + description: The item's refundable total. + - type: number + title: refundable_total + description: The item's refundable total. + - type: string + title: refundable_total + description: The item's refundable total. + - $ref: ./IBigNumber.yaml + refundable_total_per_unit: + oneOf: + - type: string + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: string + title: refundable_total_per_unit + description: The item's refundable total per unit. + - $ref: ./IBigNumber.yaml + raw_original_total: + type: object + description: The item's raw original total. + raw_original_subtotal: + type: object + description: The item's raw original subtotal. + raw_original_tax_total: + type: object + description: The item's raw original tax total. + raw_item_total: + type: object + description: The item's raw item total. + raw_item_subtotal: + type: object + description: The item's raw item subtotal. + raw_item_tax_total: + type: object + description: The item's raw item tax total. + raw_total: + type: object + description: The item's raw total. + raw_subtotal: + type: object + description: The item's raw subtotal. + raw_tax_total: + type: object + description: The item's raw tax total. + raw_discount_total: + type: object + description: The item's raw discount total. + raw_discount_tax_total: + type: object + description: The item's raw discount tax total. + raw_refundable_total: + type: object + description: The item's raw refundable total. + raw_refundable_total_per_unit: + type: object + description: The item's raw refundable total per unit. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderLineItemAdjustment.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItemAdjustment.yaml new file mode 100644 index 0000000000..18f5e20824 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItemAdjustment.yaml @@ -0,0 +1,3 @@ +type: object +description: The adjustment's adjustments. +x-schemaName: OrderLineItemAdjustment diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderLineItemTaxLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItemTaxLine.yaml new file mode 100644 index 0000000000..0b002d0419 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItemTaxLine.yaml @@ -0,0 +1,3 @@ +type: object +description: The tax line's tax lines. +x-schemaName: OrderLineItemTaxLine diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethod.yaml new file mode 100644 index 0000000000..27f2932fb3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethod.yaml @@ -0,0 +1,214 @@ +type: object +description: The shipping method's shipping methods. +x-schemaName: OrderShippingMethod +required: + - id + - order_id + - name + - amount + - raw_amount + - is_tax_inclusive + - created_at + - updated_at + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total +properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + oneOf: + - type: string + title: amount + description: The shipping method's amount. + - type: number + title: amount + description: The shipping method's amount. + - type: string + title: amount + description: The shipping method's amount. + - $ref: ./IBigNumber.yaml + raw_amount: + type: object + description: The shipping method's raw amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: ./OrderShippingMethodTaxLine.yaml + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: ./OrderShippingMethodAdjustment.yaml + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: discount_tax_total + description: The shipping method's discount tax total. + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - $ref: ./IBigNumber.yaml + raw_original_total: + type: object + description: The shipping method's raw original total. + raw_original_subtotal: + type: object + description: The shipping method's raw original subtotal. + raw_original_tax_total: + type: object + description: The shipping method's raw original tax total. + raw_total: + type: object + description: The shipping method's raw total. + raw_subtotal: + type: object + description: The shipping method's raw subtotal. + raw_tax_total: + type: object + description: The shipping method's raw tax total. + raw_discount_total: + type: object + description: The shipping method's raw discount total. + raw_discount_tax_total: + type: object + description: The shipping method's raw discount tax total. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodAdjustment.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodAdjustment.yaml new file mode 100644 index 0000000000..a05be82f62 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodAdjustment.yaml @@ -0,0 +1,3 @@ +type: object +description: The adjustment's adjustments. +x-schemaName: OrderShippingMethodAdjustment diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodTaxLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodTaxLine.yaml new file mode 100644 index 0000000000..89976e41b4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodTaxLine.yaml @@ -0,0 +1,3 @@ +type: object +description: The tax line's tax lines. +x-schemaName: OrderShippingMethodTaxLine diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderTransaction.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderTransaction.yaml new file mode 100644 index 0000000000..fe6226719f --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderTransaction.yaml @@ -0,0 +1,66 @@ +type: object +description: The transaction's transactions. +x-schemaName: OrderTransaction +required: + - id + - order_id + - order + - amount + - raw_amount + - currency_code + - reference + - reference_id + - created_at + - updated_at + - metadata +properties: + id: + type: string + title: id + description: The transaction's ID. + order_id: + type: string + title: order_id + description: The transaction's order id. + order: + type: object + amount: + oneOf: + - type: string + title: amount + description: The transaction's amount. + - type: number + title: amount + description: The transaction's amount. + - type: string + title: amount + description: The transaction's amount. + - $ref: ./IBigNumber.yaml + raw_amount: + type: object + description: The transaction's raw amount. + currency_code: + type: string + title: currency_code + description: The transaction's currency code. + reference: + type: string + title: reference + description: The transaction's reference. + reference_id: + type: string + title: reference_id + description: The transaction's reference id. + created_at: + type: string + format: date-time + title: created_at + description: The transaction's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The transaction's updated at. + metadata: + type: object + description: The transaction's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/RefundReasonResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/RefundReasonResponse.yaml new file mode 100644 index 0000000000..2ccee98673 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/RefundReasonResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: RefundReasonResponse +required: + - refund_reason +properties: + refund_reason: + $ref: ./AdminRefundReason.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/ReservationResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/ReservationResponse.yaml new file mode 100644 index 0000000000..d66cc74750 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/ReservationResponse.yaml @@ -0,0 +1,66 @@ +type: object +description: The reservation's details. +x-schemaName: ReservationResponse +required: + - id + - line_item_id + - location_id + - quantity + - external_id + - description + - inventory_item_id + - inventory_item +properties: + id: + type: string + title: id + description: The reservation's ID. + 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. + quantity: + type: string + title: quantity + description: The reservation's quantity. + external_id: + type: string + title: external_id + description: The reservation's external id. + description: + type: string + title: description + description: The reservation's description. + inventory_item_id: + type: string + title: inventory_item_id + description: The reservation's inventory item id. + inventory_item: + type: object + description: The reservation's inventory item. + metadata: + type: object + description: The reservation's metadata. + created_by: + type: string + title: created_by + description: The reservation's created by. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The reservation's deleted at. + created_at: + type: string + format: date-time + title: created_at + description: The reservation's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The reservation's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/Return.yaml b/www/apps/api-reference/specs/admin/components/schemas/Return.yaml new file mode 100644 index 0000000000..529ada57ca --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/Return.yaml @@ -0,0 +1,3 @@ +type: object +description: The order change's return order. +x-schemaName: Return diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml new file mode 100644 index 0000000000..9974725fda --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml @@ -0,0 +1,349 @@ +type: object +description: The cart's details. +x-schemaName: StoreCart +required: + - id + - currency_code + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total +properties: + id: + type: string + title: id + description: The cart's ID. + region: + $ref: ./BaseRegion.yaml + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address: + $ref: ./BaseCartAddress.yaml + billing_address: + $ref: ./BaseCartAddress.yaml + items: + type: array + description: The cart's items. + items: + $ref: ./BaseCartLineItem.yaml + shipping_methods: + type: array + description: The cart's shipping methods. + items: + $ref: ./BaseCartShippingMethod.yaml + payment_collection: + $ref: ./BasePaymentCollection.yaml + metadata: + type: object + description: The cart's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The cart's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The cart's updated at. + original_item_total: + oneOf: + - type: string + title: original_item_total + description: The cart's original item total. + - type: number + title: original_item_total + description: The cart's original item total. + - type: string + title: original_item_total + description: The cart's original item total. + - $ref: ./IBigNumber.yaml + original_item_subtotal: + oneOf: + - type: string + title: original_item_subtotal + description: The cart's original item subtotal. + - type: number + title: original_item_subtotal + description: The cart's original item subtotal. + - type: string + title: original_item_subtotal + description: The cart'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. + - type: number + title: original_item_tax_total + description: The cart's original item tax total. + - type: string + title: original_item_tax_total + description: The cart's original item tax total. + - $ref: ./IBigNumber.yaml + item_total: + oneOf: + - type: string + title: item_total + description: The cart's item total. + - type: number + title: item_total + description: The cart's item total. + - type: string + title: item_total + description: The cart's item total. + - $ref: ./IBigNumber.yaml + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The cart's item subtotal. + - type: number + title: item_subtotal + description: The cart's item subtotal. + - type: string + title: item_subtotal + description: The cart's item subtotal. + - $ref: ./IBigNumber.yaml + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The cart's item tax total. + - type: number + title: item_tax_total + description: The cart's item tax total. + - type: string + title: item_tax_total + description: The cart's item tax total. + - $ref: ./IBigNumber.yaml + original_total: + oneOf: + - type: string + title: original_total + description: The cart's original total. + - type: number + title: original_total + description: The cart's original total. + - type: string + title: original_total + description: The cart's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The cart's original subtotal. + - type: number + title: original_subtotal + description: The cart's original subtotal. + - type: string + title: original_subtotal + description: The cart's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The cart's original tax total. + - type: number + title: original_tax_total + description: The cart's original tax total. + - type: string + title: original_tax_total + description: The cart's original tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The cart's total. + - type: number + title: total + description: The cart's total. + - type: string + title: total + description: The cart's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The cart's subtotal. + - type: number + title: subtotal + description: The cart's subtotal. + - type: string + title: subtotal + description: The cart's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The cart's tax total. + - type: number + title: tax_total + description: The cart's tax total. + - type: string + title: tax_total + description: The cart's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The cart's discount total. + - type: number + title: discount_total + description: The cart's discount total. + - type: string + title: discount_total + description: The cart's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The cart's discount tax total. + - type: number + title: discount_tax_total + description: The cart's discount tax total. + - type: string + title: discount_tax_total + description: The cart's discount tax total. + - $ref: ./IBigNumber.yaml + gift_card_total: + oneOf: + - type: string + title: gift_card_total + description: The cart's gift card total. + - type: number + title: gift_card_total + description: The cart's gift card total. + - type: string + title: gift_card_total + description: The cart'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. + - type: number + title: gift_card_tax_total + description: The cart's gift card tax total. + - type: string + title: gift_card_tax_total + description: The cart's gift card tax total. + - $ref: ./IBigNumber.yaml + shipping_total: + oneOf: + - type: string + title: shipping_total + description: The cart's shipping total. + - type: number + title: shipping_total + description: The cart's shipping total. + - type: string + title: shipping_total + description: The cart's shipping total. + - $ref: ./IBigNumber.yaml + shipping_subtotal: + oneOf: + - type: string + title: shipping_subtotal + description: The cart's shipping subtotal. + - type: number + title: shipping_subtotal + description: The cart's shipping subtotal. + - type: string + title: shipping_subtotal + description: The cart's shipping subtotal. + - $ref: ./IBigNumber.yaml + shipping_tax_total: + oneOf: + - type: string + title: shipping_tax_total + description: The cart's shipping tax total. + - type: number + title: shipping_tax_total + description: The cart's shipping tax total. + - type: string + title: shipping_tax_total + description: The cart's shipping tax total. + - $ref: ./IBigNumber.yaml + original_shipping_total: + oneOf: + - type: string + title: original_shipping_total + description: The cart's original shipping total. + - type: number + title: original_shipping_total + description: The cart's original shipping total. + - type: string + title: original_shipping_total + description: The cart's original shipping total. + - $ref: ./IBigNumber.yaml + original_shipping_subtotal: + oneOf: + - type: string + title: original_shipping_subtotal + description: The cart's original shipping subtotal. + - type: number + title: original_shipping_subtotal + description: The cart's original shipping subtotal. + - type: string + title: original_shipping_subtotal + description: The cart'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. + - type: number + title: original_shipping_tax_total + description: The cart's original shipping tax total. + - type: string + title: original_shipping_tax_total + description: The cart's original shipping tax total. + - $ref: ./IBigNumber.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCartResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCartResponse.yaml new file mode 100644 index 0000000000..2bfa43f956 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCartResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreCartResponse +required: + - cart +properties: + cart: + $ref: ./StoreCart.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCollection.yaml new file mode 100644 index 0000000000..a336103bb6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCollection.yaml @@ -0,0 +1,47 @@ +type: object +description: The collection's details. +x-schemaName: StoreCollection +required: + - id + - title + - handle + - created_at + - updated_at + - deleted_at + - metadata +properties: + id: + type: string + title: id + description: The collection's ID. + title: + type: string + title: title + description: The collection's title. + handle: + type: string + title: handle + description: The collection's handle. + created_at: + type: string + format: date-time + title: created_at + description: The collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The collection's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The collection's deleted at. + products: + type: array + description: The collection's products. + items: + $ref: ./AdminProduct.yaml + metadata: + type: object + description: The collection's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCollectionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCollectionResponse.yaml new file mode 100644 index 0000000000..ad095a583e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCollectionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreCollectionResponse +required: + - collection +properties: + collection: + $ref: ./StoreCollection.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCurrency.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCurrency.yaml new file mode 100644 index 0000000000..05eec9f84d --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCurrency.yaml @@ -0,0 +1,69 @@ +type: object +description: The currency's details. +x-schemaName: StoreCurrency +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/apps/api-reference/specs/admin/components/schemas/StoreCurrencyListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCurrencyListResponse.yaml new file mode 100644 index 0000000000..cb51836b4b --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCurrencyListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: StoreCurrencyListResponse +required: + - limit + - offset + - count + - currencies +properties: + limit: + type: number + title: limit + description: The currency's limit. + offset: + type: number + title: offset + description: The currency's offset. + count: + type: number + title: count + description: The currency's count. + currencies: + type: array + description: The currency's currencies. + items: + $ref: ./StoreCurrency.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCurrencyResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCurrencyResponse.yaml new file mode 100644 index 0000000000..18fffcdeeb --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCurrencyResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreCurrencyResponse +required: + - currency +properties: + currency: + $ref: ./StoreCurrency.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomer.yaml new file mode 100644 index 0000000000..bbb8caf8e9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomer.yaml @@ -0,0 +1,73 @@ +type: object +description: The customer's details. +x-schemaName: StoreCustomer +required: + - id + - email + - default_billing_address_id + - default_shipping_address_id + - company_name + - first_name + - last_name + - addresses +properties: + id: + type: string + title: id + description: The customer's ID. + email: + type: string + title: email + description: The customer's email. + format: email + default_billing_address_id: + type: string + title: default_billing_address_id + description: The customer's default billing address id. + default_shipping_address_id: + type: string + title: default_shipping_address_id + description: The customer's default shipping address id. + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + addresses: + type: array + description: The customer's addresses. + items: + $ref: ./BaseCustomerAddress.yaml + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + created_by: + type: string + title: created_by + description: The customer's created by. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The customer's deleted at. + created_at: + type: string + format: date-time + title: created_at + description: The customer's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The customer's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml new file mode 100644 index 0000000000..8bc8942adb --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml @@ -0,0 +1,96 @@ +type: object +description: The customer's address. +x-schemaName: StoreCustomerAddress +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/StoreCustomerAddressListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddressListResponse.yaml new file mode 100644 index 0000000000..ae6cf1559e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddressListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: StoreCustomerAddressListResponse +required: + - limit + - offset + - count + - addresses +properties: + limit: + type: number + title: limit + description: The customer's limit. + offset: + type: number + title: offset + description: The customer's offset. + count: + type: number + title: count + description: The customer's count. + addresses: + type: array + description: The customer's addresses. + items: + $ref: ./StoreCustomerAddress.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddressResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddressResponse.yaml new file mode 100644 index 0000000000..a665e19eb1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddressResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreCustomerAddressResponse +required: + - address +properties: + address: + $ref: ./StoreCustomerAddress.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerResponse.yaml new file mode 100644 index 0000000000..c121ca1d70 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreCustomerResponse +required: + - customer +properties: + customer: + $ref: ./StoreCustomer.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml new file mode 100644 index 0000000000..38c9d30978 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml @@ -0,0 +1,231 @@ +type: object +description: The cart's order. +x-schemaName: StoreOrder +required: + - id + - version + - region_id + - customer_id + - sales_channel_id + - email + - currency_code + - items + - shipping_methods + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total +properties: + id: + type: string + title: id + description: The order's ID. + version: + type: number + title: version + description: The order's version. + region_id: + type: string + title: region_id + description: The order's region id. + customer_id: + type: string + title: customer_id + description: The order's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order's sales channel id. + email: + type: string + title: email + description: The order's email. + format: email + currency_code: + type: string + title: currency_code + description: The order's currency code. + display_id: + type: string + 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. + items: + $ref: ./BaseOrderLineItem.yaml + shipping_methods: + type: array + description: The order's shipping methods. + items: + $ref: ./BaseOrderShippingMethod.yaml + payment_collections: + type: array + description: The order's payment collections. + items: + $ref: ./BasePaymentCollection.yaml + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The order's fulfillments. + items: + $ref: ./BaseOrderFulfillment.yaml + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The order's transactions. + items: + $ref: ./BaseOrderTransaction.yaml + summary: + $ref: ./BaseOrderSummary.yaml + metadata: + type: object + description: The order's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The order's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order's updated at. + original_item_total: + type: number + title: original_item_total + description: The order's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The order's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The order's original item tax total. + item_total: + type: number + title: item_total + description: The order's item total. + item_subtotal: + type: number + title: item_subtotal + description: The order's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The order's item tax total. + original_total: + type: number + title: original_total + description: The order's original total. + original_subtotal: + type: number + title: original_subtotal + description: The order's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The order's original tax total. + total: + type: number + title: total + description: The order's total. + subtotal: + type: number + title: subtotal + description: The order's subtotal. + tax_total: + type: number + title: tax_total + description: The order's tax total. + discount_total: + type: number + title: discount_total + description: The order's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The order's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The order's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The order's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The order's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The order's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The order's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The order's original shipping tax total. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderResponse.yaml new file mode 100644 index 0000000000..c0ce372244 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreOrderResponse +required: + - order +properties: + order: + $ref: ./StoreOrder.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml new file mode 100644 index 0000000000..d19be961a8 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml @@ -0,0 +1,116 @@ +type: object +description: The payment collection's details. +x-schemaName: StorePaymentCollection +required: + - id + - currency_code + - region_id + - amount + - status + - payment_providers +properties: + id: + type: string + title: id + description: The payment collection's ID. + currency_code: + type: string + title: currency_code + description: The payment collection's currency code. + region_id: + type: string + title: region_id + description: The payment collection's region id. + amount: + oneOf: + - type: string + title: amount + description: The payment collection's amount. + - type: number + title: amount + description: The payment collection's amount. + - type: string + title: amount + description: The payment collection's amount. + - $ref: ./IBigNumber.yaml + authorized_amount: + oneOf: + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - type: number + title: authorized_amount + description: The payment collection's authorized amount. + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - $ref: ./IBigNumber.yaml + captured_amount: + oneOf: + - type: string + title: captured_amount + description: The payment collection's captured amount. + - type: number + title: captured_amount + description: The payment collection's captured amount. + - type: string + title: captured_amount + description: The payment collection's captured amount. + - $ref: ./IBigNumber.yaml + refunded_amount: + oneOf: + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - type: number + title: refunded_amount + description: The payment collection's refunded amount. + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - $ref: ./IBigNumber.yaml + completed_at: + oneOf: + - type: string + title: completed_at + description: The payment collection's completed at. + - type: string + title: completed_at + description: The payment collection's completed at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The payment collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The payment collection's updated at. + metadata: + type: object + description: The payment collection's metadata. + status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + payment_providers: + type: array + description: The payment collection's payment providers. + items: + $ref: ./BasePaymentProvider.yaml + payment_sessions: + type: array + description: The payment collection's payment sessions. + items: + $ref: ./BasePaymentSession.yaml + payments: + type: array + description: The payment collection's payments. + items: + $ref: ./BasePayment.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollectionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollectionResponse.yaml new file mode 100644 index 0000000000..3f4dd244b0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollectionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StorePaymentCollectionResponse +required: + - payment_collection +properties: + payment_collection: + $ref: ./StorePaymentCollection.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StorePaymentProvider.yaml b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentProvider.yaml new file mode 100644 index 0000000000..70de4c3efc --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentProvider.yaml @@ -0,0 +1,10 @@ +type: object +description: The payment provider's payment providers. +x-schemaName: StorePaymentProvider +required: + - id +properties: + id: + type: string + title: id + description: The payment provider's 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 79fac333e5..8f607cc98a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml @@ -1,5 +1,5 @@ type: object -description: The product's products. +description: The product's details. x-schemaName: StoreProduct required: - title @@ -8,26 +8,26 @@ required: - options - description - id - - handle - - hs_code - - weight - - height - - width - - origin_country - - mid_code - - material - - thumbnail - created_at - updated_at - - deleted_at - variants + - handle - subtitle - is_giftcard + - thumbnail + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material - collection_id - type_id - images - discountable - external_id + - deleted_at properties: categories: type: array @@ -67,42 +67,6 @@ properties: metadata: type: object description: The product's metadata. - handle: - type: string - title: handle - description: The product's handle. - hs_code: - type: string - title: hs_code - description: The product's hs code. - weight: - type: number - title: weight - description: The product's weight. - height: - type: number - title: height - description: The product's height. - width: - type: number - title: width - description: The product's width. - origin_country: - type: string - title: origin_country - description: The product's origin country. - mid_code: - type: string - title: mid_code - description: The product's mid code. - material: - type: string - title: material - description: The product's material. - thumbnail: - type: string - title: thumbnail - description: The product's thumbnail. created_at: type: string format: date-time @@ -113,16 +77,15 @@ properties: format: date-time title: updated_at description: The product's updated at. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The product's deleted at. variants: type: array description: The product's variants. items: $ref: ./BaseProductVariant.yaml + handle: + type: string + title: handle + description: The product's handle. subtitle: type: string title: subtitle @@ -131,6 +94,38 @@ properties: type: boolean title: is_giftcard description: The product's is giftcard. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. collection: $ref: ./BaseCollection.yaml collection_id: @@ -159,3 +154,8 @@ properties: type: string title: external_id description: The product's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml index 5f98dcd652..6614848161 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml @@ -1,5 +1,5 @@ type: object -description: The product category's details. +description: The category's categories. x-schemaName: StoreProductCategory required: - id @@ -18,60 +18,60 @@ required: properties: products: type: array - description: The product category's products. + description: The category's products. items: $ref: ./StoreProduct.yaml id: type: string title: id - description: The product category's ID. + description: The category's ID. name: type: string title: name - description: The product category's name. + description: The category's name. description: type: string title: description - description: The product category's description. + description: The category's description. handle: type: string title: handle - description: The product category's handle. + description: The category's handle. is_active: type: boolean title: is_active - description: The product category's is active. + description: The category's is active. is_internal: type: boolean title: is_internal - description: The product category's is internal. + description: The category's is internal. rank: type: number title: rank - description: The product category's rank. + description: The category's rank. parent_category_id: type: string title: parent_category_id - description: The product category's parent category id. + description: The category's parent category id. parent_category: $ref: ./BaseProductCategory.yaml category_children: type: array - description: The product category's category children. + description: The category's category children. items: $ref: ./BaseProductCategory.yaml created_at: type: string format: date-time title: created_at - description: The product category's created at. + description: The category's created at. updated_at: type: string format: date-time title: updated_at - description: The product category's updated at. + description: The category's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The product category's deleted at. + description: The category's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductResponse.yaml new file mode 100644 index 0000000000..ac22f2a56f --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreProductResponse +required: + - product +properties: + product: + $ref: ./StoreProduct.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreRegion.yaml new file mode 100644 index 0000000000..d07d5098a6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreRegion.yaml @@ -0,0 +1,47 @@ +type: object +description: The region's details. +x-schemaName: StoreRegion +required: + - id + - name + - currency_code +properties: + id: + type: string + title: id + description: The region's ID. + name: + type: string + title: name + description: The region's name. + currency_code: + type: string + title: currency_code + description: The region's currency code. + automatic_taxes: + type: boolean + title: automatic_taxes + description: The region's automatic taxes. + countries: + type: array + description: The region's countries. + items: + $ref: ./BaseRegionCountry.yaml + payment_providers: + type: array + description: The region's payment providers. + items: + $ref: ./AdminPaymentProvider.yaml + metadata: + type: object + description: The region's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The region's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The region's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml new file mode 100644 index 0000000000..a707c05720 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml @@ -0,0 +1,66 @@ +type: object +description: The return's details. +x-schemaName: StoreReturn +required: + - id + - order_id + - order_version + - display_id + - items + - received_at + - created_at +properties: + id: + type: string + title: id + description: The return's ID. + order_id: + type: string + title: order_id + description: The return's order id. + status: + type: string + title: status + description: The return's status. + exchange_id: + type: string + title: exchange_id + description: The return's exchange id. + location_id: + type: string + title: location_id + description: The return's location id. + claim_id: + type: string + title: claim_id + description: The return's claim id. + order_version: + type: number + title: order_version + description: The return's order version. + display_id: + type: number + title: display_id + description: The return's display id. + no_notification: + type: boolean + title: no_notification + description: The return's no notification. + refund_amount: + type: number + title: refund_amount + description: The return's refund amount. + items: + type: array + description: The return's items. + items: + $ref: ./BaseReturnItem.yaml + received_at: + type: string + title: received_at + description: The return's received at. + created_at: + type: string + format: date-time + title: created_at + description: The return's created at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReason.yaml new file mode 100644 index 0000000000..0b2be3c0f3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReason.yaml @@ -0,0 +1,39 @@ +type: object +description: The return reason's details. +x-schemaName: StoreReturnReason +required: + - id + - value + - label + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The return reason's ID. + value: + type: string + title: value + description: The return reason's value. + label: + type: string + title: label + description: The return reason's label. + description: + type: string + title: description + description: The return reason's description. + metadata: + type: object + description: The return reason's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The return reason's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The return reason's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReasonResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReasonResponse.yaml new file mode 100644 index 0000000000..19edb6a521 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReasonResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreReturnReasonResponse +required: + - return_reason +properties: + return_reason: + $ref: ./StoreReturnReason.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreReturnResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnResponse.yaml new file mode 100644 index 0000000000..bac8524459 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreReturnResponse +required: + - return +properties: + return: + $ref: ./StoreReturn.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOption.yaml new file mode 100644 index 0000000000..4d8cc26173 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOption.yaml @@ -0,0 +1,65 @@ +type: object +description: The shipping option's shipping options. +x-schemaName: StoreShippingOption +required: + - id + - name + - price_type + - service_zone_id + - provider_id + - provider + - shipping_option_type_id + - type + - shipping_profile_id + - amount + - is_tax_inclusive + - data + - metadata +properties: + id: + type: string + title: id + description: The shipping option's ID. + name: + type: string + title: name + description: The shipping option's name. + price_type: + type: string + enum: + - flat + - calculated + service_zone_id: + type: string + title: service_zone_id + description: The shipping option's service zone id. + provider_id: + type: string + title: provider_id + description: The shipping option's provider id. + provider: + $ref: ./BaseFulfillmentProvider.yaml + shipping_option_type_id: + type: string + title: shipping_option_type_id + description: The shipping option's shipping option type id. + type: + type: object + shipping_profile_id: + type: string + title: shipping_profile_id + description: The shipping option's shipping profile id. + amount: + type: number + title: amount + description: The shipping option's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping option's is tax inclusive. + data: + type: object + description: The shipping option's data. + metadata: + type: object + description: The shipping option's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOptionListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOptionListResponse.yaml new file mode 100644 index 0000000000..8001c7a8c5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOptionListResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: StoreShippingOptionListResponse +required: + - shipping_options +properties: + shipping_options: + type: array + description: The shipping option's shipping options. + items: + $ref: ./StoreShippingOption.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml deleted file mode 100644 index 0b29d94268..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml +++ /dev/null @@ -1,44 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: UpdateCartData -properties: - region_id: - type: string - title: region_id - description: The cart's region id. - customer_id: - type: string - title: customer_id - description: The cart's customer id. - sales_channel_id: - type: string - title: sales_channel_id - description: The cart's sales channel id. - email: - type: string - title: email - description: The cart's email. - format: email - currency_code: - type: string - title: currency_code - description: The cart's currency code. - shipping_address_id: - type: string - title: shipping_address_id - description: The cart's shipping address id. - billing_address_id: - type: string - title: billing_address_id - description: The cart's billing address id. - billing_address: - oneOf: - - $ref: ./CreateAddress.yaml - - $ref: ./UpdateAddress.yaml - shipping_address: - oneOf: - - $ref: ./CreateAddress.yaml - - $ref: ./UpdateAddress.yaml - metadata: - type: object - description: The cart's metadata. diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 1a69b7f014..c8670d5663 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -12,6 +12,8 @@ tags: - name: Api Keys - name: Campaigns - name: Claims + x-associatedSchema: + $ref: '#/components/schemas/AdminClaim' - name: Collections x-associatedSchema: $ref: '#/components/schemas/AdminCollection' @@ -22,6 +24,8 @@ tags: externalDocs: description: How to manage currencies url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-currencies + x-associatedSchema: + $ref: '#/components/schemas/AdminCurrency' - name: Customer Groups x-associatedSchema: $ref: '#/components/schemas/AdminCustomerGroup' @@ -34,6 +38,9 @@ tags: x-associatedSchema: $ref: '#/components/schemas/AdminCustomer' - name: Draft Orders + - name: Exchanges + x-associatedSchema: + $ref: '#/components/schemas/AdminExchange' - name: Fulfillment Providers x-associatedSchema: $ref: '#/components/schemas/AdminFulfillmentProvider' @@ -41,18 +48,34 @@ tags: x-associatedSchema: $ref: '#/components/schemas/AdminFulfillmentSet' - name: Fulfillments + x-associatedSchema: + $ref: '#/components/schemas/AdminFulfillment' - name: Inventory Items + x-associatedSchema: + $ref: '#/components/schemas/AdminInventoryItem' - name: Invites description: | An admin can invite new users to manage their team. This would allow new users to authenticate as admins and perform admin functionalities. externalDocs: description: How to manage invites url: https://docs.medusajs.com/modules/users/admin/manage-invites + x-associatedSchema: + $ref: '#/components/schemas/AdminInvite' - name: Notifications + x-associatedSchema: + $ref: '#/components/schemas/AdminNotification' - name: Orders + x-associatedSchema: + $ref: '#/components/schemas/AdminOrder' - name: Payments + x-associatedSchema: + $ref: '#/components/schemas/AdminPayment' - name: Price Lists + x-associatedSchema: + $ref: '#/components/schemas/AdminPriceList' - name: Price Preferences + x-associatedSchema: + $ref: '#/components/schemas/AdminPricePreference' - name: Product Categories x-associatedSchema: $ref: '#/components/schemas/AdminProductCategory' @@ -60,10 +83,18 @@ tags: x-associatedSchema: $ref: '#/components/schemas/AdminProductTag' - name: Product Types + - name: Product Variants + x-associatedSchema: + $ref: '#/components/schemas/AdminProductVariant' - name: Products x-associatedSchema: $ref: '#/components/schemas/AdminProduct' - name: Promotions + x-associatedSchema: + $ref: '#/components/schemas/AdminPromotion' + - name: Refund Reasons + x-associatedSchema: + $ref: '#/components/schemas/AdminRefundReason' - name: Regions description: | Regions are different countries or geographical regions that the commerce store serves customers in. @@ -71,9 +102,15 @@ tags: externalDocs: description: How to manage regions url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions + x-associatedSchema: + $ref: '#/components/schemas/AdminRegion' - name: Reservations - name: Return Reasons + x-associatedSchema: + $ref: '#/components/schemas/AdminReturnReason' - name: Returns + x-associatedSchema: + $ref: '#/components/schemas/AdminReturn' - name: Sales Channels description: | A sales channel indicates a channel where products can be sold in. For example, a webshop or a mobile app. @@ -90,11 +127,21 @@ tags: x-associatedSchema: $ref: '#/components/schemas/AdminShippingProfile' - name: Stock Locations + x-associatedSchema: + $ref: '#/components/schemas/AdminStockLocation' - name: Stores + x-associatedSchema: + $ref: '#/components/schemas/AdminStore' - name: Tax Rates + x-associatedSchema: + $ref: '#/components/schemas/AdminTaxRate' - name: Tax Regions + x-associatedSchema: + $ref: '#/components/schemas/AdminTaxRegion' - name: Uploads - name: Users + x-associatedSchema: + $ref: '#/components/schemas/AdminUser' - name: Workflows Executions paths: /admin/api-keys: @@ -157,6 +204,41 @@ paths: tags: - Api Keys responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The api key's limit. + offset: + type: number + title: offset + description: The api key's offset. + count: + type: number + title: count + description: The api key's count. + - type: object + description: SUMMARY + required: + - api_keys + properties: + api_keys: + type: array + description: The api key's api keys. + items: + $ref: '#/components/schemas/ApiKeyResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -238,6 +320,12 @@ paths: tags: - Api Keys responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminApiKeyResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -250,6 +338,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createApiKeysWorkflow /admin/api-keys/{id}: get: operationId: GetApiKeysId @@ -316,6 +405,12 @@ paths: tags: - Api Keys responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminApiKeyResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -402,6 +497,12 @@ paths: tags: - Api Keys responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminApiKeyResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -479,6 +580,33 @@ paths: tags: - Api Keys responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The api key's ID. + object: + type: string + title: object + description: The api key's object. + deleted: + type: boolean + title: deleted + description: The api key's deleted. + parent: + type: object + description: The api key's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -562,6 +690,12 @@ paths: tags: - Api Keys responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminApiKeyResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -661,6 +795,12 @@ paths: tags: - Api Keys responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminApiKeyResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -733,6 +873,41 @@ paths: tags: - Campaigns responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The campaign's limit. + offset: + type: number + title: offset + description: The campaign's offset. + count: + type: number + title: count + description: The campaign's count. + - type: object + description: SUMMARY + required: + - campaigns + properties: + campaigns: + type: array + description: The campaign's campaigns. + items: + $ref: '#/components/schemas/CampaignResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -799,15 +974,7 @@ paths: content: application/json: schema: - type: object description: SUMMARY - required: - - name - - campaign_identifier - - description - - budget - - starts_at - - ends_at properties: name: type: string @@ -882,6 +1049,12 @@ paths: tags: - Campaigns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCampaignResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -960,6 +1133,12 @@ paths: tags: - Campaigns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCampaignResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1032,7 +1211,53 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminUpdateCampaign' + description: SUMMARY + properties: + name: + type: string + title: name + description: The campaign's name. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + required: + - limit + properties: + limit: + type: number + title: limit + description: The budget's limit. + 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 + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. x-codeSamples: - lang: Shell label: cURL @@ -1048,6 +1273,12 @@ paths: tags: - Campaigns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCampaignResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1125,6 +1356,33 @@ paths: tags: - Campaigns responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The campaign's ID. + object: + type: string + title: object + description: The campaign's object. + deleted: + type: boolean + title: deleted + description: The campaign's deleted. + parent: + type: object + description: The campaign's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -1224,6 +1482,12 @@ paths: tags: - Campaigns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCampaignResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1296,6 +1560,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1378,6 +1648,102 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimOrderResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/claims/{id}: + 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. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/claims/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Claims + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1461,6 +1827,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1544,6 +1916,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1556,6 +1934,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: orderClaimItemWorkflow /admin/claims/{id}/claim-items/{action_id}: post: operationId: PostClaimsIdClaimItemsAction_id @@ -1633,6 +2012,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1645,6 +2030,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateClaimItemWorkflow delete: operationId: DeleteClaimsIdClaimItemsAction_id summary: Remove Claim Items from Claim @@ -1716,6 +2102,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1728,6 +2120,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: removeItemClaimActionWorkflow /admin/claims/{id}/inbound/items: post: operationId: PostClaimsIdInboundItems @@ -1799,6 +2192,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1811,6 +2210,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: orderClaimRequestItemReturnWorkflow /admin/claims/{id}/inbound/items/{action_id}: post: operationId: PostClaimsIdInboundItemsAction_id @@ -1888,6 +2288,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1900,6 +2306,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateRequestItemReturnWorkflow delete: operationId: DeleteClaimsIdInboundItemsAction_id summary: Remove Items from Claim @@ -1971,6 +2378,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1983,6 +2396,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: removeItemReturnActionWorkflow /admin/claims/{id}/inbound/shipping-method: post: operationId: PostClaimsIdInboundShippingMethod @@ -2058,6 +2472,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2070,6 +2490,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createClaimShippingMethodWorkflow /admin/claims/{id}/inbound/shipping-method/{action_id}: post: operationId: PostClaimsIdInboundShippingMethodAction_id @@ -2147,6 +2568,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2159,6 +2586,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateReturnShippingMethodWorkflow delete: operationId: DeleteClaimsIdInboundShippingMethodAction_id summary: Remove Shipping Methods from Claim @@ -2230,6 +2658,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2242,6 +2676,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: removeClaimShippingMethodWorkflow /admin/claims/{id}/outbound/items: post: operationId: PostClaimsIdOutboundItems @@ -2313,6 +2748,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2325,6 +2766,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: orderClaimAddNewItemWorkflow /admin/claims/{id}/outbound/items/{action_id}: post: operationId: PostClaimsIdOutboundItemsAction_id @@ -2402,6 +2844,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2414,6 +2862,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateClaimAddItemWorkflow delete: operationId: DeleteClaimsIdOutboundItemsAction_id summary: Remove Items from Claim @@ -2485,6 +2934,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2497,6 +2952,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: removeAddItemClaimActionWorkflow /admin/claims/{id}/outbound/shipping-method: post: operationId: PostClaimsIdOutboundShippingMethod @@ -2572,6 +3028,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2584,6 +3046,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createClaimShippingMethodWorkflow /admin/claims/{id}/outbound/shipping-method/{action_id}: post: operationId: PostClaimsIdOutboundShippingMethodAction_id @@ -2661,6 +3124,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2673,6 +3142,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateClaimShippingMethodWorkflow delete: operationId: DeleteClaimsIdOutboundShippingMethodAction_id summary: Remove Shipping Methods from Claim @@ -2744,6 +3214,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2756,6 +3232,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: removeClaimShippingMethodWorkflow /admin/claims/{id}/request: post: operationId: PostClaimsIdRequest @@ -2822,6 +3299,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimRequestResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2838,6 +3321,7 @@ paths: content: application/json: schema: {} + x-workflow: confirmClaimRequestWorkflow delete: operationId: DeleteClaimsIdRequest summary: Remove Requests from Claim @@ -2903,6 +3387,12 @@ paths: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminClaimDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2975,6 +3465,12 @@ paths: tags: - Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCollectionListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3056,6 +3552,12 @@ paths: tags: - Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCollectionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3068,6 +3570,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createCollectionsWorkflow /admin/collections/{id}: get: operationId: GetCollectionsId @@ -3134,6 +3637,12 @@ paths: tags: - Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCollectionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3220,6 +3729,12 @@ paths: tags: - Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCollectionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3297,6 +3812,12 @@ paths: tags: - Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCollectionDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3396,6 +3917,12 @@ paths: tags: - Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCollectionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3468,6 +3995,12 @@ paths: tags: - Currencies responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCurrencyListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3546,6 +4079,12 @@ paths: tags: - Currencies responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCurrencyResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3618,6 +4157,41 @@ paths: tags: - Customer Groups responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The customer group's limit. + offset: + type: number + title: offset + description: The customer group's offset. + count: + type: number + title: count + description: The customer group's count. + - type: object + description: SUMMARY + required: + - customer_groups + properties: + customer_groups: + type: array + description: The customer group's customer groups. + items: + $ref: '#/components/schemas/AdminCustomerGroup' '400': $ref: '#/components/responses/400_error' '401': @@ -3699,6 +4273,12 @@ paths: tags: - Customer Groups responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomerGroupResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3777,6 +4357,12 @@ paths: tags: - Customer Groups responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomerGroupResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3864,6 +4450,12 @@ paths: tags: - Customer Groups responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomerGroupResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3941,6 +4533,33 @@ paths: tags: - Customer Groups responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The customer group's ID. + object: + type: string + title: object + description: The customer group's object. + deleted: + 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': @@ -4040,6 +4659,12 @@ paths: tags: - Customer Groups responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomerGroupResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -4210,7 +4835,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminCreateCustomer' + description: SUMMARY + properties: + email: + type: string + title: email + description: The customer's email. + format: email + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. x-codeSamples: - lang: Shell label: cURL @@ -4234,13 +4884,7 @@ paths: content: application/json: schema: - type: object - description: SUMMARY - required: - - customer - properties: - customer: - $ref: '#/components/schemas/AdminCustomer' + $ref: '#/components/schemas/AdminCustomerResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -4324,13 +4968,7 @@ paths: content: application/json: schema: - type: object - description: SUMMARY - required: - - customer - properties: - customer: - $ref: '#/components/schemas/AdminCustomer' + $ref: '#/components/schemas/AdminCustomerResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -4403,7 +5041,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminUpdateCustomer' + description: SUMMARY + properties: + email: + type: string + title: email + description: The customer's email. + format: email + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. x-codeSamples: - lang: Shell label: cURL @@ -4427,13 +5090,7 @@ paths: content: application/json: schema: - type: object - description: SUMMARY - required: - - customer - properties: - customer: - $ref: '#/components/schemas/AdminCustomer' + $ref: '#/components/schemas/AdminCustomerResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -4511,6 +5168,33 @@ paths: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + 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 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': @@ -4589,6 +5273,41 @@ paths: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The customer's limit. + offset: + type: number + title: offset + description: The customer's offset. + count: + type: number + title: count + description: The customer's count. + - type: object + description: SUMMARY + required: + - addresses + properties: + addresses: + type: array + description: The customer's addresses. + items: + $ref: '#/components/schemas/AdminCustomerAddress' '400': $ref: '#/components/responses/400_error' '401': @@ -4661,7 +5380,63 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminCreateCustomerAddress' + description: SUMMARY + properties: + address_name: + type: string + title: address_name + description: The customer's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The customer's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The customer's is default billing. + company: + type: string + title: company + description: The customer's company. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + address_1: + type: string + title: address_1 + description: The customer's address 1. + address_2: + type: string + title: address_2 + description: The customer's address 2. + city: + type: string + title: city + description: The customer's city. + country_code: + type: string + title: country_code + description: The customer's country code. + province: + type: string + title: province + description: The customer's province. + postal_code: + type: string + title: postal_code + description: The customer's postal code. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. x-codeSamples: - lang: Shell label: cURL @@ -4686,6 +5461,12 @@ paths: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomerResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -4770,6 +5551,12 @@ paths: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomerAddressResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -4848,7 +5635,63 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminCreateCustomerAddress' + description: SUMMARY + properties: + address_name: + type: string + title: address_name + description: The customer's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The customer's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The customer's is default billing. + company: + type: string + title: company + description: The customer's company. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + address_1: + type: string + title: address_1 + description: The customer's address 1. + address_2: + type: string + title: address_2 + description: The customer's address 2. + city: + type: string + title: city + description: The customer's city. + country_code: + type: string + title: country_code + description: The customer's country code. + province: + type: string + title: province + description: The customer's province. + postal_code: + type: string + title: postal_code + description: The customer's postal code. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. x-codeSamples: - lang: Shell label: cURL @@ -4873,6 +5716,12 @@ paths: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomerResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -4956,6 +5805,33 @@ paths: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + 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 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': @@ -5028,6 +5904,38 @@ paths: tags: - Draft Orders responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The draft order's limit. + offset: + type: number + title: offset + description: The draft order's offset. + count: + type: number + title: count + description: The draft order's count. + - type: object + description: SUMMARY + required: + - draft_orders + properties: + draft_orders: + $ref: '#/components/schemas/AdminOrder' '400': $ref: '#/components/responses/400_error' '401': @@ -5094,16 +6002,7 @@ paths: content: application/json: schema: - type: object description: SUMMARY - required: - - sales_channel_id - - email - - customer_id - - region_id - - currency_code - - shipping_methods - - metadata properties: status: type: boolean @@ -5402,6 +6301,12 @@ paths: tags: - Draft Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminDraftOrderResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -5414,6 +6319,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createOrdersWorkflow /admin/draft-orders/{id}: get: operationId: GetDraftOrdersId @@ -5480,6 +6386,1695 @@ paths: tags: - Draft Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminDraftOrderResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/exchanges: + get: + operationId: GetExchanges + summary: List Exchanges + description: Retrieve a list of exchanges. The exchanges can be filtered by fields such as `id`. The exchanges can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/exchanges' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The exchange's limit. + offset: + type: number + title: offset + description: The exchange's offset. + count: + type: number + title: count + description: The exchange's count. + - type: object + description: SUMMARY + required: + - exchanges + properties: + exchanges: + $ref: '#/components/schemas/AdminExchange' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + post: + operationId: PostExchanges + summary: Create Exchange + description: Create a exchange. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrderExchangesReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/exchanges' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "order_id": "{value}", + "metadata": {} + }' + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExchangeOrderResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/exchanges/{id}/cancel: + post: + operationId: PostExchangesIdCancel + summary: Add Cancels to Exchange + description: Add a list of cancels to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostCancelExchangeReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/exchanges/{id}/cancel' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExchangeResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/exchanges/{id}/inbound/items: + post: + operationId: PostExchangesIdInboundItems + summary: Add Items to Exchange + description: Add a list of items to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/items' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExchangeReturnResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: orderExchangeRequestItemReturnWorkflow + /admin/exchanges/{id}/inbound/items/{action_id}: + post: + operationId: PostExchangesIdInboundItemsAction_id + summary: Add Items to Exchange + description: Add a list of items to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The exchange's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExchangeReturnResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: updateRequestItemReturnWorkflow + delete: + operationId: DeleteExchangesIdInboundItemsAction_id + summary: Remove Items from Exchange + description: Remove a list of items from a exchange. This doesn't delete the Item, only the association between the Item and the exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The exchange's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExchangeReturnResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: removeItemReturnActionWorkflow + /admin/exchanges/{id}/inbound/shipping-method: + post: + operationId: PostExchangesIdInboundShippingMethod + summary: Add Shipping Methods to Exchange + description: Add a list of shipping methods to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReturnsShippingReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/shipping-method' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "shipping_option_id": "{value}" + }' + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExchangeReturnResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: createExchangeShippingMethodWorkflow + /admin/exchanges/{id}/inbound/shipping-method/{action_id}: + post: + operationId: PostExchangesIdInboundShippingMethodAction_id + summary: Add Shipping Methods to Exchange + description: Add a list of shipping methods to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The exchange's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostExchangesShippingActionReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExchangePreviewResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: updateReturnShippingMethodWorkflow + delete: + operationId: DeleteExchangesIdInboundShippingMethodAction_id + summary: Remove Shipping Methods from Exchange + description: Remove a list of shipping methods from a exchange. This doesn't delete the Shipping Method, only the association between the Shipping Method and the exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The exchange's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExchangeReturnResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: removeReturnShippingMethodWorkflow + /admin/exchanges/{id}/outbound/items: + post: + operationId: PostExchangesIdOutboundItems + summary: Add Items to Exchange + description: Add a list of items to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostExchangesAddItemsReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/items' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExchangePreviewResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: orderExchangeAddNewItemWorkflow + /admin/exchanges/{id}/outbound/items/{action_id}: + post: + operationId: PostExchangesIdOutboundItemsAction_id + summary: Add Items to Exchange + description: Add a list of items to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The exchange's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostExhangesItemsActionReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExchangePreviewResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: updateExchangeAddItemWorkflow + delete: + operationId: DeleteExchangesIdOutboundItemsAction_id + summary: Remove Items from Exchange + description: Remove a list of items from a exchange. This doesn't delete the Item, only the association between the Item and the exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The exchange's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExchangePreviewResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: removeItemExchangeActionWorkflow + /admin/exchanges/{id}/outbound/shipping-method: + post: + operationId: PostExchangesIdOutboundShippingMethod + summary: Add Shipping Methods to Exchange + description: Add a list of shipping methods to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostExchangesShippingReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/shipping-method' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "shipping_option_id": "{value}" + }' + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExchangePreviewResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: createExchangeShippingMethodWorkflow + /admin/exchanges/{id}/outbound/shipping-method/{action_id}: + post: + operationId: PostExchangesIdOutboundShippingMethodAction_id + summary: Add Shipping Methods to Exchange + description: Add a list of shipping methods to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The exchange's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostExchangesShippingActionReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExchangePreviewResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: updateExchangeShippingMethodWorkflow + delete: + operationId: DeleteExchangesIdOutboundShippingMethodAction_id + summary: Remove Shipping Methods from Exchange + description: Remove a list of shipping methods from a exchange. This doesn't delete the Shipping Method, only the association between the Shipping Method and the exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The exchange's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExchangePreviewResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: removeExchangeShippingMethodWorkflow + /admin/exchanges/{id}/request: + post: + operationId: PostExchangesIdRequest + summary: Add Requests to Exchange + description: Add a list of requests to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/exchanges/{id}/request' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExchangeRequestResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: confirmExchangeRequestWorkflow + delete: + operationId: DeleteExchangesIdRequest + summary: Remove Requests from Exchange + description: Remove a list of requests from a exchange. This doesn't delete the Request, only the association between the Request and the exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/exchanges/{id}/request' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Exchanges + responses: + '200': + description: OK + 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 exchange's object. + deleted: + type: boolean + title: deleted + description: The exchange's deleted. + parent: + type: object + description: The exchange's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -5596,6 +8191,12 @@ paths: tags: - Fulfillment Providers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminFulfillmentProviderListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -5881,6 +8482,12 @@ paths: tags: - Fulfillment Sets responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminFulfillmentSetResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -6282,6 +8889,33 @@ paths: tags: - Fulfillment Sets responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The fulfillment set's ID. + object: + type: string + title: object + description: The fulfillment set's object. + deleted: + type: boolean + title: deleted + description: The fulfillment set's deleted. + parent: + type: object + description: The fulfillment set's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -6403,6 +9037,12 @@ paths: tags: - Fulfillments responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminFulfillmentResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -6415,6 +9055,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createFulfillmentWorkflow /admin/fulfillments/{id}/cancel: post: operationId: PostFulfillmentsIdCancel @@ -6486,6 +9127,12 @@ paths: tags: - Fulfillments responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminFulfillmentResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -6579,6 +9226,12 @@ paths: tags: - Fulfillments responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminFulfillmentResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -6888,11 +9541,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The inventory item's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The inventory item's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -6906,6 +9569,41 @@ paths: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The inventory item's limit. + offset: + type: number + title: offset + description: The inventory item's offset. + count: + type: number + title: count + description: The inventory item's count. + - type: object + description: SUMMARY + required: + - inventory_items + properties: + inventory_items: + type: array + description: The inventory item's inventory items. + items: + $ref: '#/components/schemas/AdminInventoryItem' '400': $ref: '#/components/responses/400_error' '401': @@ -7090,6 +9788,12 @@ paths: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminInventoryItemResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -7102,6 +9806,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createInventoryItemsWorkflow /admin/inventory-items/{id}: get: operationId: GetInventoryItemsId @@ -7168,6 +9873,12 @@ paths: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminInventoryItemResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -7337,6 +10048,12 @@ paths: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminInventoryItemResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -7414,6 +10131,33 @@ paths: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + 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 inventory item's object. + deleted: + type: boolean + title: deleted + description: The inventory item's deleted. + parent: + type: object + description: The inventory item's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -7496,11 +10240,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The inventory item's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The inventory item's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -7514,6 +10268,41 @@ paths: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The inventory item's limit. + offset: + type: number + title: offset + description: The inventory item's offset. + count: + type: number + title: count + description: The inventory item's count. + - type: object + description: SUMMARY + required: + - inventory_levels + properties: + inventory_levels: + type: array + description: The inventory item's inventory levels. + items: + $ref: '#/components/schemas/InventoryLevel' '400': $ref: '#/components/responses/400_error' '401': @@ -7616,6 +10405,12 @@ paths: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminInventoryItemResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -7744,6 +10539,19 @@ paths: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - inventory_item + properties: + inventory_item: + type: object + description: The inventory item's details. '400': $ref: '#/components/responses/400_error' '401': @@ -7843,6 +10651,12 @@ paths: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminInventoryItemResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -7926,6 +10740,33 @@ paths: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + 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 inventory item's object. + deleted: + type: boolean + title: deleted + description: The inventory item's deleted. + parent: + type: object + description: The inventory item's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -8128,11 +10969,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The invite's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The invite's $or. + items: + type: object + title: $or x-codeSamples: - lang: Shell label: cURL @@ -8140,6 +10991,41 @@ paths: tags: - Invites responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The invite's limit. + offset: + type: number + title: offset + description: The invite's offset. + count: + type: number + title: count + description: The invite's count. + - type: object + description: SUMMARY + required: + - invites + properties: + invites: + type: array + description: The invite's invites. + items: + $ref: '#/components/schemas/AdminInvite' '400': $ref: '#/components/responses/400_error' '401': @@ -8224,6 +11110,12 @@ paths: tags: - Invites responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminInviteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -8321,6 +11213,28 @@ paths: tags: - Invites responses: + '200': + description: OK + content: + application/json: + schema: + oneOf: + - type: object + description: SUMMARY + required: + - user + properties: + user: + $ref: '#/components/schemas/AdminUser' + - type: object + description: SUMMARY + required: + - message + properties: + message: + type: string + title: message + description: The invite's message. '400': $ref: '#/components/responses/400_error' '401': @@ -8393,6 +11307,12 @@ paths: tags: - Invites responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminInviteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -8464,6 +11384,33 @@ paths: tags: - Invites responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The invite's ID. + object: + type: string + title: object + description: The invite's object. + deleted: + type: boolean + title: deleted + description: The invite's deleted. + parent: + type: object + description: The invite's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -8536,6 +11483,12 @@ paths: tags: - Invites responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminInviteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -8638,11 +11591,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The notification's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The notification's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -8656,6 +11619,12 @@ paths: tags: - Notifications responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminNotificationListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -8734,6 +11703,12 @@ paths: tags: - Notifications responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminNotificationResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -8806,6 +11781,41 @@ paths: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The order's limit. + offset: + type: number + title: offset + description: The order's offset. + count: + type: number + title: count + description: The order's count. + - type: object + description: SUMMARY + required: + - orders + properties: + orders: + type: array + description: The order's orders. + items: + $ref: '#/components/schemas/AdminOrder' '400': $ref: '#/components/responses/400_error' '401': @@ -8884,6 +11894,12 @@ paths: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -8961,6 +11977,12 @@ paths: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -9052,6 +12074,12 @@ paths: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -9130,6 +12158,12 @@ paths: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -9207,7 +12241,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminCompleteOrder' + description: SUMMARY + properties: + order_id: + type: string + title: order_id + description: The order's order id. x-codeSamples: - lang: Shell label: cURL @@ -9221,6 +12260,12 @@ paths: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -9294,7 +12339,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminOrderCreateFulfillment' + description: SUMMARY + properties: + items: + type: array + description: The order's items. + items: + 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. + location_id: + type: string + title: location_id + description: The order's location id. + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + metadata: + type: object + description: The order's metadata. x-codeSamples: - lang: Shell label: cURL @@ -9315,6 +12390,12 @@ paths: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -9394,7 +12475,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminOrderCancelFulfillment' + description: SUMMARY + properties: + no_notification: + type: boolean + title: no_notification + description: The order's no notification. x-codeSamples: - lang: Shell label: cURL @@ -9404,6 +12490,12 @@ paths: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -9483,7 +12575,56 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminOrderCreateShipment' + description: SUMMARY + properties: + items: + type: array + description: The order's items. + items: + 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. + labels: + type: array + description: The order's labels. + items: + type: object + description: The label's labels. + required: + - tracking_number + - tracking_url + - label_url + properties: + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + metadata: + type: object + description: The order's metadata. x-codeSamples: - lang: Shell label: cURL @@ -9503,6 +12644,12 @@ paths: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -9581,6 +12728,12 @@ paths: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -9781,11 +12934,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The payment's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The payment's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -9799,6 +12962,41 @@ paths: tags: - Payments responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The payment's limit. + offset: + type: number + title: offset + description: The payment's offset. + count: + type: number + title: count + description: The payment's count. + - type: object + description: SUMMARY + required: + - payments + properties: + payments: + type: array + description: The payment's payments. + items: + $ref: '#/components/schemas/AdminPayment' '400': $ref: '#/components/responses/400_error' '401': @@ -9883,11 +13081,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The payment's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The payment's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -9901,6 +13109,41 @@ paths: tags: - Payments responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The payment's limit. + offset: + type: number + title: offset + description: The payment's offset. + count: + type: number + title: count + description: The payment's count. + - type: object + description: SUMMARY + required: + - payment_providers + properties: + payment_providers: + type: array + description: The payment's payment providers. + items: + $ref: '#/components/schemas/AdminPaymentProvider' '400': $ref: '#/components/responses/400_error' '401': @@ -9979,6 +13222,12 @@ paths: tags: - Payments responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -10068,6 +13317,12 @@ paths: tags: - Payments responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -10148,6 +13403,14 @@ paths: type: number title: amount description: The payment's amount. + refund_reason_id: + type: string + title: refund_reason_id + description: The payment's refund reason id. + note: + type: string + title: note + description: The payment's note. x-codeSamples: - lang: Shell label: cURL @@ -10157,6 +13420,12 @@ paths: tags: - Payments responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -10229,6 +13498,12 @@ paths: tags: - Price Lists responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPriceListListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -10312,6 +13587,12 @@ paths: tags: - Price Lists responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPriceListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -10390,6 +13671,12 @@ paths: tags: - Price Lists responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPriceListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -10478,6 +13765,12 @@ paths: tags: - Price Lists responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPriceListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -10555,6 +13848,12 @@ paths: tags: - Price Lists responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPriceListDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -10722,6 +14021,12 @@ paths: tags: - Price Lists responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPriceListBatchResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -10821,6 +14126,12 @@ paths: tags: - Price Lists responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPriceListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -10893,6 +14204,12 @@ paths: tags: - Price Preferences responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPricePreferenceListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -10969,6 +14286,12 @@ paths: tags: - Price Preferences responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPricePreferenceResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -11047,6 +14370,12 @@ paths: tags: - Price Preferences responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPricePreferenceResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -11129,6 +14458,12 @@ paths: tags: - Price Preferences responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPricePreferenceResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -11206,6 +14541,12 @@ paths: tags: - Price Preferences responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPricePreferenceDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -11466,11 +14807,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The product category's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The product category's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -11627,6 +14978,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createProductCategoriesWorkflow /admin/product-categories/{id}: get: operationId: GetProductCategoriesId @@ -11921,6 +15273,12 @@ paths: tags: - Product Categories responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoryDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -12226,11 +15584,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The product tag's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The product tag's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -12244,6 +15612,12 @@ paths: tags: - Product Tags responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductTagListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -12337,6 +15711,12 @@ paths: tags: - Product Tags responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductTagResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -12349,6 +15729,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createProductTagsWorkflow /admin/product-tags/{id}: get: operationId: GetProductTagsId @@ -12415,6 +15796,12 @@ paths: tags: - Product Tags responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductTagResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -12512,6 +15899,12 @@ paths: tags: - Product Tags responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductTagResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -12524,6 +15917,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateProductTagsWorkflow delete: operationId: DeleteProductTagsId summary: Delete a Product Tag @@ -12589,6 +15983,12 @@ paths: tags: - Product Tags responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductTagDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -12789,11 +16189,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The product type's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The product type's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -12807,6 +16217,12 @@ paths: tags: - Product Types responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductTypeListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -12900,6 +16316,12 @@ paths: tags: - Product Types responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductTypeResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -12912,6 +16334,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createProductTypesWorkflow /admin/product-types/{id}: get: operationId: GetProductTypesId @@ -12978,6 +16401,12 @@ paths: tags: - Product Types responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductTypeResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -13075,6 +16504,12 @@ paths: tags: - Product Types responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductTypeResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -13087,6 +16522,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateProductTypesWorkflow delete: operationId: DeleteProductTypesId summary: Delete a Product Type @@ -13152,6 +16588,125 @@ paths: tags: - Product Types responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductTypeDeleteResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/product-variants: + get: + operationId: GetProductVariants + summary: List Product Variants + description: Retrieve a list of product variants. The product variants can be filtered by fields such as `id`. The product variants can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/product-variants' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Product Variants + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The product variant's limit. + offset: + type: number + title: offset + description: The product variant's offset. + count: + type: number + title: count + description: The product variant's count. + - type: object + description: SUMMARY + required: + - variants + properties: + variants: + type: array + description: The product variant's variants. + items: + $ref: '#/components/schemas/AdminProductVariant' '400': $ref: '#/components/responses/400_error' '401': @@ -25212,6 +28767,9 @@ paths: x-schemaName: BaseProductListParams - type: object description: The $or's details. + type: array + items: + type: object - name: $or in: query description: The product's $or. @@ -27126,6 +30684,9 @@ paths: x-schemaName: BaseProductListParams - type: object description: The $or's details. + type: array + items: + type: object security: - api_token: [] - cookie_auth: [] @@ -27240,7 +30801,148 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminCreateProduct' + description: SUMMARY + properties: + title: + type: string + title: title + description: The product's title. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + description: + type: string + title: description + description: The product's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + discountable: + type: boolean + title: discountable + description: The product's discountable. + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + required: + - url + properties: + url: + type: string + title: url + description: The image's url. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + handle: + type: string + title: handle + description: The product's handle. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + type_id: + type: string + title: type_id + description: The product's type id. + collection_id: + type: string + title: collection_id + description: The product's collection id. + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + required: + - id + properties: + id: + type: string + title: id + description: The category's ID. + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + required: + - id + properties: + id: + type: string + title: id + description: The tag's ID. + options: + type: array + description: The product's options. + items: + $ref: '#/components/schemas/AdminCreateProductOption' + variants: + type: array + description: The product's variants. + items: + $ref: '#/components/schemas/AdminCreateProductVariant' + sales_channels: + type: array + description: The product's sales channels. + items: + type: object + description: The sales channel's sales channels. + required: + - id + properties: + id: + type: string + title: id + description: The sales channel's ID. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + width: + type: number + title: width + description: The product's width. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + origin_country: + type: string + title: origin_country + description: The product's origin country. + material: + type: string + title: material + description: The product's material. + metadata: + type: object + description: The product's metadata. x-codeSamples: - lang: Shell label: cURL @@ -27272,6 +30974,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createProductsWorkflow /admin/products/batch: post: operationId: PostProductsBatch @@ -27355,6 +31058,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: batchProductsWorkflow /admin/products/export: post: operationId: PostProductsExport @@ -27438,6 +31142,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: exportProductsWorkflow /admin/products/import: post: operationId: PostProductsImport @@ -27521,6 +31226,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: importProductsWorkflow /admin/products/import/{transaction_id}/confirm: post: operationId: PostProductsImportTransaction_idConfirm @@ -27747,7 +31453,150 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminUpdateProduct' + description: SUMMARY + properties: + title: + type: string + title: title + description: The product's title. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + description: + type: string + title: description + description: The product's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + discountable: + type: boolean + title: discountable + description: The product's discountable. + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + required: + - url + properties: + url: + type: string + title: url + description: The image's url. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + handle: + type: string + title: handle + description: The product's handle. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + type_id: + type: string + title: type_id + description: The product's type id. + collection_id: + type: string + title: collection_id + description: The product's collection id. + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + required: + - id + properties: + id: + type: string + title: id + description: The category's ID. + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + required: + - id + properties: + id: + type: string + title: id + description: The tag's ID. + options: + type: array + description: The product's options. + items: + $ref: '#/components/schemas/AdminUpdateProductOption' + variants: + type: array + description: The product's variants. + items: + oneOf: + - $ref: '#/components/schemas/AdminCreateProductVariant' + - $ref: '#/components/schemas/AdminUpdateProductVariant' + sales_channels: + type: array + description: The product's sales channels. + items: + type: object + description: The sales channel's sales channels. + required: + - id + properties: + id: + type: string + title: id + description: The sales channel's ID. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + width: + type: number + title: width + description: The product's width. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + origin_country: + type: string + title: origin_country + description: The product's origin country. + material: + type: string + title: material + description: The product's material. + metadata: + type: object + description: The product's metadata. x-codeSamples: - lang: Shell label: cURL @@ -27775,6 +31624,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateProductsWorkflow delete: operationId: DeleteProductsId summary: Delete a Product @@ -28450,6 +32300,9 @@ paths: x-schemaName: BaseProductOptionParams - type: object description: The $or's details. + type: array + items: + type: object - name: $or in: query description: The product's $or. @@ -28939,6 +32792,9 @@ paths: x-schemaName: BaseProductOptionParams - type: object description: The $or's details. + type: array + items: + type: object security: - api_token: [] - cookie_auth: [] @@ -29059,7 +32915,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminCreateProductOption' + description: SUMMARY + properties: + title: + type: string + title: title + description: The product's title. + values: + type: array + description: The product's values. + items: + type: string + title: values + description: The value's values. x-codeSamples: - lang: Shell label: cURL @@ -29250,7 +33118,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminUpdateProductOption' + description: SUMMARY + properties: + title: + type: string + title: title + description: The product's title. + values: + type: array + description: The product's values. + items: + type: string + title: values + description: The value's values. x-codeSamples: - lang: Shell label: cURL @@ -29540,7 +33420,83 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminCreateProductVariant' + description: SUMMARY + properties: + title: + type: string + title: title + description: The product's title. + sku: + type: string + title: sku + description: The product's sku. + ean: + type: string + title: ean + description: The product's ean. + upc: + type: string + title: upc + description: The product's upc. + barcode: + type: string + title: barcode + description: The product's barcode. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The product's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The product's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The product's variant rank. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + width: + type: number + title: width + description: The product's width. + origin_country: + type: string + title: origin_country + description: The product's origin country. + material: + type: string + title: material + description: The product's material. + metadata: + type: object + description: The product's metadata. + prices: + type: array + description: The product's prices. + items: + $ref: '#/components/schemas/AdminCreateProductVariantPrice' + options: + type: object + description: The product's options. x-codeSamples: - lang: Shell label: cURL @@ -29662,6 +33618,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: batchProductVariantsWorkflow /admin/products/{id}/variants/inventory-items/batch: post: operationId: PostProductsIdVariantsInventoryItemsBatch @@ -29799,6 +33756,12 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductVariantInventoryBatchResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -29811,6 +33774,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: batchLinksWorkflow /admin/products/{id}/variants/{variant_id}: get: operationId: GetProductsIdVariantsVariant_id @@ -29967,7 +33931,83 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminUpdateProductVariant' + description: SUMMARY + properties: + title: + type: string + title: title + description: The product's title. + sku: + type: string + title: sku + description: The product's sku. + ean: + type: string + title: ean + description: The product's ean. + upc: + type: string + title: upc + description: The product's upc. + barcode: + type: string + title: barcode + description: The product's barcode. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The product's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The product's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The product's variant rank. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + width: + type: number + title: width + description: The product's width. + origin_country: + type: string + title: origin_country + description: The product's origin country. + material: + type: string + title: material + description: The product's material. + metadata: + type: object + description: The product's metadata. + prices: + type: array + description: The product's prices. + items: + $ref: '#/components/schemas/AdminCreateProductVariantPrice' + options: + type: object + description: The product's options. x-codeSamples: - lang: Shell label: cURL @@ -30166,6 +34206,12 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductVariantResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -30265,6 +34311,12 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductVariantResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -30354,6 +34406,12 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductVariantInventoryLinkDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -30366,6 +34424,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: dismissLinksWorkflow /admin/promotions: get: operationId: GetPromotions @@ -30573,11 +34632,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The promotion's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The promotion's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -30591,6 +34660,41 @@ paths: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The promotion's limit. + offset: + type: number + title: offset + description: The promotion's offset. + count: + type: number + title: count + description: The promotion's count. + - type: object + description: SUMMARY + required: + - promotions + properties: + promotions: + type: array + description: The promotion's promotions. + items: + $ref: '#/components/schemas/AdminPromotion' '400': $ref: '#/components/responses/400_error' '401': @@ -30657,13 +34761,7 @@ paths: content: application/json: schema: - type: object description: SUMMARY - required: - - code - - type - - campaign_id - - application_method properties: code: type: string @@ -30953,6 +35051,12 @@ paths: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPromotionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -31047,6 +35151,21 @@ paths: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - attributes + properties: + attributes: + type: array + description: The promotion's attributes. + items: + $ref: '#/components/schemas/AdminRuleAttributeOption' '400': $ref: '#/components/responses/400_error' '401': @@ -31147,6 +35266,21 @@ paths: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - values + properties: + values: + type: array + description: The promotion's values. + items: + $ref: '#/components/schemas/AdminRuleValueOption' '400': $ref: '#/components/responses/400_error' '401': @@ -31225,6 +35359,12 @@ paths: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPromotionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -31297,10 +35437,7 @@ paths: content: application/json: schema: - type: object description: SUMMARY - required: - - campaign_id properties: code: type: string @@ -31572,6 +35709,12 @@ paths: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPromotionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -31649,6 +35792,33 @@ paths: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The promotion's ID. + object: + type: string + title: object + description: The promotion's object. + deleted: + type: boolean + title: deleted + description: The promotion's deleted. + parent: + type: object + description: The promotion's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -31826,6 +35996,51 @@ paths: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - created + - updated + - deleted + properties: + created: + type: array + description: The promotion's created. + items: + $ref: '#/components/schemas/AdminPromotionRule' + updated: + type: array + description: The promotion's updated. + items: + $ref: '#/components/schemas/AdminPromotionRule' + deleted: + type: object + description: The promotion's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. '400': $ref: '#/components/responses/400_error' '401': @@ -31838,6 +36053,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: batchPromotionRulesWorkflow /admin/promotions/{id}/rules/batch: post: operationId: PostPromotionsIdRulesBatch @@ -32003,6 +36219,51 @@ paths: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - created + - updated + - deleted + properties: + created: + type: array + description: The promotion's created. + items: + $ref: '#/components/schemas/AdminPromotionRule' + updated: + type: array + description: The promotion's updated. + items: + $ref: '#/components/schemas/AdminPromotionRule' + deleted: + type: object + description: The promotion's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. '400': $ref: '#/components/responses/400_error' '401': @@ -32015,6 +36276,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: batchPromotionRulesWorkflow /admin/promotions/{id}/target-rules/batch: post: operationId: PostPromotionsIdTargetRulesBatch @@ -32180,6 +36442,51 @@ paths: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - created + - updated + - deleted + properties: + created: + type: array + description: The promotion's created. + items: + $ref: '#/components/schemas/AdminPromotionRule' + updated: + type: array + description: The promotion's updated. + items: + $ref: '#/components/schemas/AdminPromotionRule' + deleted: + type: object + description: The promotion's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. '400': $ref: '#/components/responses/400_error' '401': @@ -32192,6 +36499,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: batchPromotionRulesWorkflow /admin/promotions/{id}/{rule_type}: get: operationId: GetPromotionsIdRule_type @@ -32264,6 +36572,551 @@ paths: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - rules + properties: + rules: + type: array + description: The promotion's rules. + items: + $ref: '#/components/schemas/AdminPromotionRule' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/refund-reasons: + get: + operationId: GetRefundReasons + summary: List Refund Reasons + description: Retrieve a list of refund reasons. The refund reasons can be filtered by fields such as `id`. The refund reasons can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/refund-reasons' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Refund Reasons + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The refund reason's limit. + offset: + type: number + title: offset + description: The refund reason's offset. + count: + type: number + title: count + description: The refund reason's count. + - type: object + description: SUMMARY + required: + - refund_reasons + properties: + refund_reasons: + type: array + description: The refund reason's refund reasons. + items: + $ref: '#/components/schemas/AdminRefundReason' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + post: + operationId: PostRefundReasons + summary: Create Refund Reason + description: Create a refund reason. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + 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. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/refund-reasons' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "label": "{value}", + "description": "{value}" + }' + tags: + - Refund Reasons + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/RefundReasonResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: createRefundReasonsWorkflow + /admin/refund-reasons/{id}: + get: + operationId: GetRefundReasonsId + summary: Get a Refund Reason + description: Retrieve a refund reason by its ID. You can expand the refund reason's relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The refund reason's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/refund-reasons/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Refund Reasons + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/RefundReasonResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + post: + operationId: PostRefundReasonsId + summary: Update a Refund Reason + description: Update a refund reason's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The refund reason's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - description + properties: + label: + type: string + title: label + description: The refund reason's label. + description: + type: string + title: description + description: The refund reason's description. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/refund-reasons/{id}' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "description": "{value}" + }' + tags: + - Refund Reasons + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/RefundReasonResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + delete: + operationId: DeleteRefundReasonsId + summary: Delete a Refund Reason + description: Delete a refund reason. + x-authenticated: true + parameters: + - name: id + in: path + description: The refund reason's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/refund-reasons/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Refund Reasons + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The refund reason's ID. + object: + type: string + title: object + description: The refund reason's object. + deleted: + type: boolean + title: deleted + description: The refund reason's deleted. + parent: + type: object + description: The refund reason's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -32478,11 +37331,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The region's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The region's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -32496,6 +37359,41 @@ paths: tags: - Regions responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The region's limit. + offset: + type: number + title: offset + description: The region's offset. + count: + type: number + title: count + description: The region's count. + - type: object + description: SUMMARY + required: + - regions + properties: + regions: + type: array + description: The region's regions. + items: + $ref: '#/components/schemas/AdminRegion' '400': $ref: '#/components/responses/400_error' '401': @@ -32617,6 +37515,12 @@ paths: tags: - Regions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminRegionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -32629,6 +37533,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createRegionsWorkflow /admin/regions/{id}: get: operationId: GetRegionsId @@ -32695,6 +37600,12 @@ paths: tags: - Regions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminRegionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -32818,6 +37729,12 @@ paths: tags: - Regions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminRegionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -32830,6 +37747,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateRegionsWorkflow delete: operationId: DeleteRegionsId summary: Delete a Region @@ -32895,6 +37813,33 @@ paths: tags: - Regions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The region's ID. + object: + type: string + title: object + description: The region's object. + deleted: + type: boolean + title: deleted + description: The region's deleted. + parent: + type: object + description: The region's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -33193,6 +38138,41 @@ paths: tags: - Reservations responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The reservation's limit. + offset: + type: number + title: offset + description: The reservation's offset. + count: + type: number + title: count + description: The reservation's count. + - type: object + description: SUMMARY + required: + - reservations + properties: + reservations: + type: array + description: The reservation's reservations. + items: + $ref: '#/components/schemas/ReservationResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -33310,6 +38290,12 @@ paths: tags: - Reservations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReservationResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -33322,6 +38308,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createReservationsWorkflow /admin/reservations/{id}: get: operationId: GetReservationsId @@ -33388,6 +38375,12 @@ paths: tags: - Reservations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReservationResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -33495,6 +38488,12 @@ paths: tags: - Reservations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReservationResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -33572,6 +38571,33 @@ paths: tags: - Reservations responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The reservation's ID. + object: + type: string + title: object + description: The reservation's object. + deleted: + type: boolean + title: deleted + description: The reservation's deleted. + parent: + type: object + description: The reservation's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -33631,6 +38657,131 @@ 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 return reason's q. + required: false + schema: + type: string + title: q + description: The return reason's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The return reason's ID. + - type: array + description: The return reason's ID. + items: + type: string + title: id + description: The id's ID. + - name: value + in: query + required: false + schema: + oneOf: + - type: string + title: value + description: The return reason's value. + - type: array + description: The return reason's value. + items: + type: string + title: value + description: The value's details. + - name: label + in: query + required: false + schema: + oneOf: + - type: string + title: label + description: The return reason's label. + - type: array + description: The return reason's label. + items: + type: string + title: label + description: The label's details. + - name: description + in: query + required: false + schema: + oneOf: + - type: string + title: description + description: The return reason's description. + - type: array + description: The return reason's description. + items: + type: string + title: description + description: The description's details. + - name: parent_return_reason_id + in: query + required: false + schema: + oneOf: + - type: string + title: parent_return_reason_id + description: The return reason's parent return reason id. + - type: array + description: The return reason's parent return reason id. + items: + type: string + title: parent_return_reason_id + description: The parent return reason id's details. + - name: created_at + in: query + description: The return reason's created at. + required: false + schema: + type: string + format: date-time + title: created_at + description: The return reason's created at. + - name: updated_at + in: query + description: The return reason's updated at. + required: false + schema: + type: string + format: date-time + title: updated_at + description: The return reason's updated at. + - name: deleted_at + in: query + description: The return reason's deleted at. + required: false + schema: + type: string + format: date-time + title: deleted_at + description: The return reason's deleted at. + - name: $and + in: query + description: The return reason's $and. + required: false + schema: + type: array + description: The return reason's $and. + items: + type: object + title: $and + - name: $or + in: query + description: The return reason's $or. + required: false + schema: + type: array + description: The return reason's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -33644,6 +38795,12 @@ paths: tags: - Return Reasons responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnReasonListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -33725,6 +38882,12 @@ paths: tags: - Return Reasons responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnReasonResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -33803,6 +38966,12 @@ paths: tags: - Return Reasons responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnReasonResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -33885,6 +39054,12 @@ paths: tags: - Return Reasons responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnReasonResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -33962,6 +39137,33 @@ paths: tags: - Return Reasons responses: + '200': + description: OK + 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 return reason's object. + deleted: + type: boolean + title: deleted + description: The return reason's deleted. + parent: + type: object + description: The return reason's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -34034,6 +39236,41 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The return's limit. + offset: + type: number + title: offset + description: The return's offset. + count: + type: number + title: count + description: The return's count. + - type: object + description: SUMMARY + required: + - returns + properties: + returns: + type: array + description: The return's returns. + items: + $ref: '#/components/schemas/AdminReturn' '400': $ref: '#/components/responses/400_error' '401': @@ -34128,6 +39365,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderReturnResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -34206,6 +39449,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -34292,6 +39541,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -34304,6 +39559,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateReturnWorkflow /admin/returns/{id}/cancel: post: operationId: PostReturnsIdCancel @@ -34370,6 +39626,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -34458,6 +39720,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -34470,6 +39738,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: dismissItemReturnRequestWorkflow /admin/returns/{id}/dismiss-items/{action_id}: post: operationId: PostReturnsIdDismissItemsAction_id @@ -34547,6 +39816,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -34559,6 +39834,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateReceiveItemReturnRequestWorkflow delete: operationId: DeleteReturnsIdDismissItemsAction_id summary: Remove Dismiss Items from Return @@ -34630,6 +39906,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -34642,6 +39924,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: removeItemReturnActionWorkflow /admin/returns/{id}/receive: post: operationId: PostReturnsIdReceive @@ -34726,6 +40009,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderReturnResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -34803,6 +40092,33 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The return's ID. + object: + type: string + title: object + description: The return's object. + deleted: + type: boolean + title: deleted + description: The return's deleted. + parent: + type: object + description: The return's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -34886,6 +40202,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -34898,6 +40220,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: receiveItemReturnRequestWorkflow /admin/returns/{id}/receive-items/{action_id}: post: operationId: PostReturnsIdReceiveItemsAction_id @@ -34975,6 +40298,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -34987,6 +40316,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateReceiveItemReturnRequestWorkflow delete: operationId: DeleteReturnsIdReceiveItemsAction_id summary: Remove Receive Items from Return @@ -35058,6 +40388,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -35070,6 +40406,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: removeItemReceiveReturnActionWorkflow /admin/returns/{id}/receive/confirm: post: operationId: PostReturnsIdReceiveConfirm @@ -35141,6 +40478,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -35153,6 +40496,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: confirmReturnReceiveWorkflow /admin/returns/{id}/request: post: operationId: PostReturnsIdRequest @@ -35224,6 +40568,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -35236,6 +40586,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: confirmReturnRequestWorkflow delete: operationId: DeleteReturnsIdRequest summary: Remove Requests from Return @@ -35301,6 +40652,33 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The return's ID. + object: + type: string + title: object + description: The return's object. + deleted: + type: boolean + title: deleted + description: The return's deleted. + parent: + type: object + description: The return's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -35384,6 +40762,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -35396,6 +40780,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: requestItemReturnWorkflow /admin/returns/{id}/request-items/{action_id}: post: operationId: PostReturnsIdRequestItemsAction_id @@ -35473,6 +40858,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -35485,6 +40876,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateRequestItemReturnWorkflow delete: operationId: DeleteReturnsIdRequestItemsAction_id summary: Remove Request Items from Return @@ -35556,6 +40948,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -35568,6 +40966,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: removeItemReturnActionWorkflow /admin/returns/{id}/shipping-method: post: operationId: PostReturnsIdShippingMethod @@ -35643,6 +41042,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -35655,6 +41060,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createReturnShippingMethodWorkflow /admin/returns/{id}/shipping-method/{action_id}: post: operationId: PostReturnsIdShippingMethodAction_id @@ -35732,6 +41138,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -35744,6 +41156,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateReturnShippingMethodWorkflow delete: operationId: DeleteReturnsIdShippingMethodAction_id summary: Remove Shipping Methods from Return @@ -35815,6 +41228,12 @@ paths: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnPreviewResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -35827,6 +41246,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: removeReturnShippingMethodWorkflow /admin/sales-channels: get: operationId: GetSalesChannels @@ -36059,11 +41479,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The sales channel's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The sales channel's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -36077,6 +41507,41 @@ paths: tags: - Sales Channels responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The sales channel's limit. + offset: + type: number + title: offset + description: The sales channel's offset. + count: + type: number + title: count + description: The sales channel's count. + - type: object + description: SUMMARY + required: + - sales_channels + properties: + sales_channels: + type: array + description: The sales channel's sales channels. + items: + $ref: '#/components/schemas/AdminSalesChannel' '400': $ref: '#/components/responses/400_error' '401': @@ -36159,6 +41624,12 @@ paths: tags: - Sales Channels responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminSalesChannelResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -36171,6 +41642,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createSalesChannelsWorkflow /admin/sales-channels/{id}: get: operationId: GetSalesChannelsId @@ -36237,6 +41709,12 @@ paths: tags: - Sales Channels responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminSalesChannelResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -36324,6 +41802,12 @@ paths: tags: - Sales Channels responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminSalesChannelResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -36401,6 +41885,12 @@ paths: tags: - Sales Channels responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminSalesChannelDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -36500,6 +41990,12 @@ paths: tags: - Sales Channels responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminSalesChannelResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -36739,6 +42235,20 @@ paths: $lt: {} $lte: {} title: deleted_at + - name: stock_location_id + in: query + required: false + schema: + oneOf: + - type: string + title: stock_location_id + description: The shipping option's stock location id. + - type: array + description: The shipping option's stock location id. + items: + type: string + title: stock_location_id + description: The stock location id's details. security: - api_token: [] - cookie_auth: [] @@ -37503,6 +43013,51 @@ paths: tags: - Shipping Options responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - created + - updated + - deleted + properties: + created: + type: array + description: The shipping option's created. + items: + $ref: '#/components/schemas/AdminShippingOptionRule' + updated: + type: array + description: The shipping option's updated. + items: + $ref: '#/components/schemas/AdminShippingOptionRule' + deleted: + type: object + description: The shipping option's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. '400': $ref: '#/components/responses/400_error' '401': @@ -37515,6 +43070,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: batchShippingOptionRulesWorkflow /admin/shipping-profiles: get: operationId: GetShippingProfiles @@ -37705,11 +43261,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The shipping profile's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The shipping profile's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -37875,6 +43441,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createShippingProfilesWorkflow /admin/shipping-profiles/{id}: get: operationId: GetShippingProfilesId @@ -38365,11 +43932,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The stock location's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The stock location's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -38383,6 +43960,12 @@ paths: tags: - Stock Locations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStockLocationListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -38465,6 +44048,12 @@ paths: tags: - Stock Locations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStockLocationResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -38477,6 +44066,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createStockLocationsWorkflow /admin/stock-locations/{id}: get: operationId: GetStockLocationsId @@ -38543,6 +44133,12 @@ paths: tags: - Stock Locations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStockLocationResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -38630,6 +44226,12 @@ paths: tags: - Stock Locations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStockLocationResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -38707,6 +44309,12 @@ paths: tags: - Stock Locations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStockLocationDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -38806,6 +44414,12 @@ paths: tags: - Stock Locations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStockLocationResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -38907,6 +44521,12 @@ paths: tags: - Stock Locations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStockLocationResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -39006,6 +44626,12 @@ paths: tags: - Stock Locations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStockLocationResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -39104,11 +44730,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The store's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The store's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -39122,6 +44758,12 @@ paths: tags: - Stores responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStoreListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -39200,6 +44842,12 @@ paths: tags: - Stores responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStoreResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -39290,6 +44938,12 @@ paths: tags: - Stores responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStoreResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -39302,6 +44956,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateStoresWorkflow /admin/tax-rates: get: operationId: GetTaxRates @@ -39512,11 +45167,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The tax rate's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The tax rate's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -39530,6 +45195,41 @@ paths: tags: - Tax Rates responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The tax rate's limit. + offset: + type: number + title: offset + description: The tax rate's offset. + count: + type: number + title: count + description: The tax rate's count. + - type: object + description: SUMMARY + required: + - tax_rates + properties: + tax_rates: + type: array + description: The tax rate's tax rates. + items: + $ref: '#/components/schemas/AdminTaxRate' '400': $ref: '#/components/responses/400_error' '401': @@ -39612,6 +45312,12 @@ paths: tags: - Tax Rates responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminTaxRateResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -39624,6 +45330,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createTaxRatesWorkflow /admin/tax-rates/{id}: get: operationId: GetTaxRatesId @@ -39690,6 +45397,12 @@ paths: tags: - Tax Rates responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminTaxRateResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -39776,6 +45489,12 @@ paths: tags: - Tax Rates responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminTaxRateResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -39853,6 +45572,12 @@ paths: tags: - Tax Rates responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminTaxRateDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -39941,6 +45666,12 @@ paths: tags: - Tax Rates responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminTaxRateResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -40025,6 +45756,33 @@ paths: tags: - Tax Rates responses: + '200': + description: OK + content: + application/json: + schema: + 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 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': @@ -40351,11 +46109,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The tax region's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The tax region's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -40369,6 +46137,41 @@ paths: tags: - Tax Regions responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The tax region's limit. + offset: + type: number + title: offset + description: The tax region's offset. + count: + type: number + title: count + description: The tax region's count. + - type: object + description: SUMMARY + required: + - tax_regions + properties: + tax_regions: + type: array + description: The tax region's tax regions. + items: + type: object '400': $ref: '#/components/responses/400_error' '401': @@ -40452,6 +46255,12 @@ paths: tags: - Tax Regions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminTaxRegionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -40464,6 +46273,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createTaxRegionsWorkflow /admin/tax-regions/{id}: get: operationId: GetTaxRegionsId @@ -40530,6 +46340,12 @@ paths: tags: - Tax Regions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminTaxRegionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -40607,6 +46423,12 @@ paths: tags: - Tax Regions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminTaxRegionDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -40684,6 +46506,12 @@ paths: tags: - Uploads responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminFileListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -40696,6 +46524,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: uploadFilesWorkflow /admin/uploads/{id}: get: operationId: GetUploadsId @@ -40762,6 +46591,12 @@ paths: tags: - Uploads responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminFileResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -40839,6 +46674,33 @@ paths: tags: - Uploads responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The upload's ID. + object: + type: string + title: object + description: The upload's object. + deleted: + type: boolean + title: deleted + description: The upload's deleted. + parent: + type: object + description: The upload's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -40905,6 +46767,12 @@ paths: tags: - Users responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUserListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -40980,6 +46848,12 @@ paths: tags: - Users responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUserResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -40992,6 +46866,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createUserAccountWorkflow /admin/users/me: get: operationId: GetUsersMe @@ -41046,6 +46921,12 @@ paths: tags: - Users responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUserResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -41118,6 +46999,12 @@ paths: tags: - Users responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUserResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -41201,6 +47088,12 @@ paths: tags: - Users responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUserResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -41272,6 +47165,12 @@ paths: tags: - Users responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUserDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -41372,6 +47271,41 @@ paths: tags: - Workflows Executions responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The workflows execution's limit. + offset: + type: number + title: offset + description: The workflows execution's offset. + count: + type: number + title: count + description: The workflows execution's count. + - type: object + description: SUMMARY + required: + - workflow_executions + properties: + workflow_executions: + type: array + description: The workflows execution's workflow executions. + items: + $ref: '#/components/schemas/AdminWorkflowExecution' '400': $ref: '#/components/responses/400_error' '401': @@ -41450,6 +47384,12 @@ paths: tags: - Workflows Executions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminWorkflowExecutionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -41533,6 +47473,17 @@ paths: tags: - Workflows Executions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - acknowledgement + properties: + acknowledgement: {} '400': $ref: '#/components/responses/400_error' '401': @@ -41621,6 +47572,20 @@ paths: tags: - Workflows Executions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - success + properties: + success: + type: boolean + title: success + description: The workflows execution's success. '400': $ref: '#/components/responses/400_error' '401': @@ -41709,6 +47674,20 @@ paths: tags: - Workflows Executions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - success + properties: + success: + type: boolean + title: success + description: The workflows execution's success. '400': $ref: '#/components/responses/400_error' '401': @@ -41871,6 +47850,12 @@ paths: tags: - Workflows Executions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminWorkflowExecutionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -41974,146 +47959,16 @@ paths: '500': $ref: '#/components/responses/500_error' components: - responses: - default_error: - description: Default Error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - code: unknown_error - message: An unknown error occurred. - type: unknown_error - invalid_state_error: - description: Invalid State Error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - code: unknown_error - message: The request conflicted with another request. You may retry the request with the provided Idempotency-Key. - type: QueryRunnerAlreadyReleasedError - invalid_request_error: - description: Invalid Request Error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - code: invalid_request_error - message: Discount with code TEST already exists. - type: duplicate_error - not_found_error: - description: Not Found Error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - message: Entity with id 1 was not found - type: not_found - 400_error: - description: Client Error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - examples: - not_allowed: - $ref: '#/components/examples/not_allowed_error' - invalid_data: - $ref: '#/components/examples/invalid_data_error' - 500_error: - description: Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - examples: - database: - $ref: '#/components/examples/database_error' - unexpected_state: - $ref: '#/components/examples/unexpected_state_error' - invalid_argument: - $ref: '#/components/examples/invalid_argument_error' - default_error: - $ref: '#/components/examples/default_error' - unauthorized: - description: User is not authorized. Must log in first - content: - text/plain: - schema: - type: string - default: Unauthorized - example: Unauthorized - incorrect_credentials: - description: User does not exist or incorrect credentials - content: - text/plain: - schema: - type: string - default: Unauthorized - example: Unauthorized - examples: - not_allowed_error: - summary: Not Allowed Error - value: - message: Discount must be set to dynamic - type: not_allowed - invalid_data_error: - summary: Invalid Data Error - value: - message: first_name must be a string - type: invalid_data - multiple_errors: - summary: Multiple Errors - value: - message: Provided request body contains errors. Please check the data and retry the request - errors: - - message: first_name must be a string - type: invalid_data - - message: Discount must be set to dynamic - type: not_allowed - database_error: - summary: Database Error - value: - code: api_error - message: An error occured while hashing password - type: database_error - unexpected_state_error: - summary: Unexpected State Error - value: - message: cart.total must be defined - type: unexpected_state - invalid_argument_error: - summary: Invalid Argument Error - value: - message: cart.total must be defined - type: unexpected_state - default_error: - summary: Default Error - value: - code: unknown_error - message: An unknown error occurred. - type: unknown_error - securitySchemes: - api_token: - type: apiKey - x-displayName: API Token - in: header - name: x-medusa-access-token - jwt_token: - type: http - x-displayName: JWT Token - scheme: bearer - cookie_auth: - type: apiKey - in: cookie - name: connect.sid - x-displayName: Cookie Session ID schemas: + AdminApiKeyResponse: + type: object + description: SUMMARY + x-schemaName: AdminApiKeyResponse + required: + - api_key + properties: + api_key: + $ref: '#/components/schemas/ApiKeyResponse' AdminArchiveOrder: type: object description: SUMMARY @@ -42253,10 +48108,382 @@ components: type: boolean title: deleted description: The deleted's details. + AdminCampaignResponse: + type: object + description: SUMMARY + x-schemaName: AdminCampaignResponse + required: + - campaign + properties: + campaign: + $ref: '#/components/schemas/CampaignResponse' AdminCancelFulfillment: type: object description: SUMMARY x-schemaName: AdminCancelFulfillment + AdminClaim: + type: object + description: The claim's details. + x-schemaName: AdminClaim + required: + - order_id + - claim_items + - additional_items + - currency_code + - id + - region_id + - customer_id + - sales_channel_id + - email + - shipping_methods + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total + properties: + order_id: + type: string + title: order_id + description: The claim's order id. + claim_items: + type: array + description: The claim's claim items. + items: + $ref: '#/components/schemas/BaseClaimItem' + additional_items: + type: array + description: The claim's additional items. + items: {} + return: + $ref: '#/components/schemas/Return' + return_id: + type: string + title: return_id + description: The claim's return id. + no_notification: + type: boolean + title: no_notification + description: The claim's no notification. + refund_amount: + type: number + title: refund_amount + description: The claim's refund amount. + currency_code: + type: string + title: currency_code + description: The claim's currency code. + id: + type: string + title: id + description: The claim's ID. + region_id: + type: string + title: region_id + description: The claim's region id. + customer_id: + type: string + title: customer_id + description: The claim's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The claim's sales channel id. + email: + type: string + title: email + description: The claim's email. + format: email + display_id: + type: string + title: display_id + description: The claim's display id. + shipping_address: + $ref: '#/components/schemas/BaseOrderAddress' + billing_address: + $ref: '#/components/schemas/BaseOrderAddress' + shipping_methods: + type: array + description: The claim's shipping methods. + items: + $ref: '#/components/schemas/BaseOrderShippingMethod' + payment_collections: + type: array + description: The claim's payment collections. + items: + $ref: '#/components/schemas/BasePaymentCollection' + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The claim's fulfillments. + items: + $ref: '#/components/schemas/BaseOrderFulfillment' + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The claim's transactions. + items: + $ref: '#/components/schemas/BaseOrderTransaction' + summary: + $ref: '#/components/schemas/BaseOrderSummary' + metadata: + type: object + description: The claim's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The claim's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The claim's updated at. + original_item_total: + type: number + title: original_item_total + description: The claim's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The claim's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The claim's original item tax total. + item_total: + type: number + title: item_total + description: The claim's item total. + item_subtotal: + type: number + title: item_subtotal + description: The claim's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The claim's item tax total. + original_total: + type: number + title: original_total + description: The claim's original total. + original_subtotal: + type: number + title: original_subtotal + description: The claim's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The claim's original tax total. + total: + type: number + title: total + description: The claim's total. + subtotal: + type: number + title: subtotal + description: The claim's subtotal. + tax_total: + type: number + title: tax_total + description: The claim's tax total. + discount_total: + type: number + title: discount_total + description: The claim's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The claim's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The claim's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The claim's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The claim's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The claim's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The claim's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The claim's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The claim's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The claim's original shipping tax total. + AdminClaimDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminClaimDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The claim's ID. + object: + type: string + title: object + description: The claim's object. + default: claim + deleted: + type: boolean + title: deleted + description: The claim's deleted. + parent: + type: object + description: The claim's parent. + AdminClaimListResponse: + type: object + description: SUMMARY + x-schemaName: AdminClaimListResponse + required: + - limit + - offset + - count + - claims + properties: + limit: + type: number + title: limit + description: The claim's limit. + offset: + type: number + title: offset + description: The claim's offset. + count: + type: number + title: count + description: The claim's count. + claims: + type: array + description: The claim's claims. + items: + $ref: '#/components/schemas/AdminClaim' + AdminClaimOrderResponse: + type: object + description: SUMMARY + x-schemaName: AdminClaimOrderResponse + required: + - order + - claim + properties: + order: + $ref: '#/components/schemas/Order' + claim: + $ref: '#/components/schemas/AdminClaim' + AdminClaimPreviewResponse: + type: object + description: SUMMARY + x-schemaName: AdminClaimPreviewResponse + required: + - order_preview + - claim + properties: + order_preview: + $ref: '#/components/schemas/Order' + claim: + $ref: '#/components/schemas/AdminClaim' + AdminClaimRequestResponse: + type: object + description: SUMMARY + x-schemaName: AdminClaimRequestResponse + required: + - return + - order_preview + - claim + properties: + return: + $ref: '#/components/schemas/AdminReturn' + order_preview: + $ref: '#/components/schemas/Order' + claim: + $ref: '#/components/schemas/AdminClaim' + AdminClaimResponse: + type: object + description: SUMMARY + x-schemaName: AdminClaimResponse + required: + - claim + properties: + claim: + $ref: '#/components/schemas/AdminClaim' + AdminClaimReturnPreviewResponse: + type: object + description: SUMMARY + x-schemaName: AdminClaimReturnPreviewResponse + required: + - order_preview + - return + properties: + order_preview: + $ref: '#/components/schemas/Order' + return: + $ref: '#/components/schemas/AdminReturn' AdminCollection: type: object description: The parent's collection. @@ -42305,17 +48532,67 @@ components: metadata: type: object description: The collection's metadata. - AdminCompleteOrder: + AdminCollectionDeleteResponse: type: object description: SUMMARY - x-schemaName: AdminCompleteOrder + x-schemaName: AdminCollectionDeleteResponse required: - - order_id + - id + - object + - deleted properties: - order_id: + id: type: string - title: order_id - description: The order's order id. + title: id + description: The collection's ID. + object: + type: string + title: object + description: The collection's object. + default: collection + deleted: + type: boolean + title: deleted + description: The collection's deleted. + parent: + type: object + description: The collection's parent. + AdminCollectionListResponse: + type: object + description: SUMMARY + x-schemaName: AdminCollectionListResponse + required: + - limit + - offset + - count + - collections + properties: + limit: + type: number + title: limit + description: The collection's limit. + offset: + type: number + title: offset + description: The collection's offset. + count: + type: number + title: count + description: The collection's count. + collections: + type: array + description: The collection's collections. + items: + $ref: '#/components/schemas/AdminCollection' + AdminCollectionResponse: + type: object + description: SUMMARY + x-schemaName: AdminCollectionResponse + required: + - collection + properties: + collection: + $ref: '#/components/schemas/AdminCollection' AdminCreateApiKey: type: object description: SUMMARY @@ -42352,115 +48629,6 @@ components: metadata: type: object description: The collection's metadata. - AdminCreateCustomer: - type: object - description: SUMMARY - x-schemaName: AdminCreateCustomer - required: - - email - - company_name - - first_name - - last_name - - phone - - metadata - properties: - email: - type: string - title: email - description: The customer's email. - format: email - company_name: - type: string - title: company_name - description: The customer's company name. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - phone: - type: string - title: phone - description: The customer's phone. - metadata: - type: object - description: The customer's metadata. - AdminCreateCustomerAddress: - type: object - description: SUMMARY - x-schemaName: AdminCreateCustomerAddress - required: - - address_name - - company - - first_name - - last_name - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - phone - - metadata - properties: - address_name: - type: string - title: address_name - description: The customer's address name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: The customer's is default shipping. - is_default_billing: - type: boolean - title: is_default_billing - description: The customer's is default billing. - company: - type: string - title: company - description: The customer's company. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - address_1: - type: string - title: address_1 - description: The customer's address 1. - address_2: - type: string - title: address_2 - description: The customer's address 2. - city: - type: string - title: city - description: The customer's city. - country_code: - type: string - title: country_code - description: The customer's country code. - province: - type: string - title: province - description: The customer's province. - postal_code: - type: string - title: postal_code - description: The customer's postal code. - phone: - type: string - title: phone - description: The customer's phone. - metadata: - type: object - description: The customer's metadata. AdminCreateCustomerGroup: type: object description: SUMMARY @@ -42835,15 +49003,13 @@ components: items: type: object description: The tag's tags. + required: + - id properties: id: type: string title: id description: The tag's ID. - value: - type: string - title: value - description: The tag's value. options: type: array description: The create's options. @@ -43320,6 +49486,46 @@ components: type: string title: transaction_id description: The workflows execution's transaction id. + AdminCurrency: + type: object + description: The supported currency's currency. + x-schemaName: AdminCurrency + AdminCurrencyListResponse: + type: object + description: SUMMARY + x-schemaName: AdminCurrencyListResponse + required: + - limit + - offset + - count + - currencies + properties: + limit: + type: number + title: limit + description: The currency's limit. + offset: + type: number + title: offset + description: The currency's offset. + count: + type: number + title: count + description: The currency's count. + currencies: + type: array + description: The currency's currencies. + items: + $ref: '#/components/schemas/AdminCurrency' + AdminCurrencyResponse: + type: object + description: SUMMARY + x-schemaName: AdminCurrencyResponse + required: + - currency + properties: + currency: + $ref: '#/components/schemas/AdminCurrency' AdminCustomer: type: object description: The customer's details. @@ -43404,6 +49610,112 @@ components: format: date-time title: updated_at description: The customer's updated at. + AdminCustomerAddress: + type: object + description: The customer's address. + x-schemaName: AdminCustomerAddress + 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. + AdminCustomerAddressResponse: + type: object + description: SUMMARY + x-schemaName: AdminCustomerAddressResponse + required: + - address + properties: + address: + $ref: '#/components/schemas/AdminCustomerAddress' AdminCustomerGroup: type: object description: The group's groups. @@ -43442,6 +49754,345 @@ components: format: date-time title: updated_at description: The group's updated at. + AdminCustomerGroupResponse: + type: object + description: SUMMARY + x-schemaName: AdminCustomerGroupResponse + required: + - customer_group + properties: + customer_group: + $ref: '#/components/schemas/AdminCustomerGroup' + AdminCustomerResponse: + type: object + description: SUMMARY + x-schemaName: AdminCustomerResponse + required: + - customer + properties: + customer: + $ref: '#/components/schemas/AdminCustomer' + AdminDraftOrderResponse: + type: object + description: SUMMARY + x-schemaName: AdminDraftOrderResponse + required: + - draft_order + properties: + draft_order: + $ref: '#/components/schemas/AdminOrder' + AdminExchange: + type: object + description: The exchange's details. + x-schemaName: AdminExchange + required: + - order_id + - return_items + - additional_items + - currency_code + - id + - region_id + - customer_id + - sales_channel_id + - email + - shipping_methods + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total + properties: + order_id: + type: string + title: order_id + description: The exchange's order id. + return_items: + type: array + description: The exchange's return items. + items: + $ref: '#/components/schemas/AdminReturnItem' + additional_items: + type: array + description: The exchange's additional items. + items: + $ref: '#/components/schemas/BaseExchangeItem' + no_notification: + type: boolean + title: no_notification + description: The exchange's no notification. + difference_due: + type: number + title: difference_due + description: The exchange's difference due. + return: + $ref: '#/components/schemas/AdminReturn' + return_id: + type: string + title: return_id + description: The exchange's return id. + currency_code: + type: string + title: currency_code + description: The exchange's currency code. + id: + type: string + title: id + description: The exchange's ID. + region_id: + type: string + title: region_id + description: The exchange's region id. + customer_id: + type: string + title: customer_id + description: The exchange's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The exchange's sales channel id. + email: + type: string + title: email + description: The exchange's email. + format: email + display_id: + type: string + title: display_id + description: The exchange's display id. + shipping_address: + $ref: '#/components/schemas/BaseOrderAddress' + billing_address: + $ref: '#/components/schemas/BaseOrderAddress' + shipping_methods: + type: array + description: The exchange's shipping methods. + items: + $ref: '#/components/schemas/BaseOrderShippingMethod' + payment_collections: + type: array + description: The exchange's payment collections. + items: + $ref: '#/components/schemas/BasePaymentCollection' + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The exchange's fulfillments. + items: + $ref: '#/components/schemas/BaseOrderFulfillment' + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The exchange's transactions. + items: + $ref: '#/components/schemas/BaseOrderTransaction' + summary: + $ref: '#/components/schemas/BaseOrderSummary' + metadata: + type: object + description: The exchange's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The exchange's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The exchange's updated at. + original_item_total: + type: number + title: original_item_total + description: The exchange's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The exchange's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The exchange's original item tax total. + item_total: + type: number + title: item_total + description: The exchange's item total. + item_subtotal: + type: number + title: item_subtotal + description: The exchange's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The exchange's item tax total. + original_total: + type: number + title: original_total + description: The exchange's original total. + original_subtotal: + type: number + title: original_subtotal + description: The exchange's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The exchange's original tax total. + total: + type: number + title: total + description: The exchange's total. + subtotal: + type: number + title: subtotal + description: The exchange's subtotal. + tax_total: + type: number + title: tax_total + description: The exchange's tax total. + discount_total: + type: number + title: discount_total + description: The exchange's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The exchange's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The exchange's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The exchange's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The exchange's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The exchange's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The exchange's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The exchange's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The exchange's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The exchange's original shipping tax total. + AdminExchangeOrderResponse: + type: object + description: SUMMARY + x-schemaName: AdminExchangeOrderResponse + required: + - order + - exchange + properties: + order: + $ref: '#/components/schemas/Order' + exchange: + $ref: '#/components/schemas/AdminExchange' + AdminExchangePreviewResponse: + type: object + description: SUMMARY + x-schemaName: AdminExchangePreviewResponse + required: + - order_preview + - exchange + properties: + order_preview: + $ref: '#/components/schemas/Order' + exchange: + $ref: '#/components/schemas/AdminExchange' + AdminExchangeRequestResponse: + type: object + description: SUMMARY + x-schemaName: AdminExchangeRequestResponse + required: + - return + - order_preview + - exchange + properties: + return: + $ref: '#/components/schemas/AdminReturn' + order_preview: + $ref: '#/components/schemas/Order' + exchange: + $ref: '#/components/schemas/AdminExchange' + AdminExchangeResponse: + type: object + description: SUMMARY + x-schemaName: AdminExchangeResponse + required: + - exchange + properties: + exchange: + $ref: '#/components/schemas/AdminExchange' + AdminExchangeReturnResponse: + type: object + description: SUMMARY + x-schemaName: AdminExchangeReturnResponse + required: + - order_preview + - return + properties: + order_preview: + $ref: '#/components/schemas/Order' + return: + $ref: '#/components/schemas/AdminReturn' AdminExportProductRequest: type: object description: SUMMARY @@ -43457,10 +50108,374 @@ components: type: string title: transaction_id description: The product's transaction id. + AdminFile: + type: object + description: The upload's file. + x-schemaName: AdminFile + required: + - id + - url + properties: + id: + type: string + title: id + description: The file's ID. + url: + type: string + title: url + description: The file's url. + AdminFileListResponse: + type: object + description: SUMMARY + x-schemaName: AdminFileListResponse + required: + - files + properties: + files: + type: array + description: The upload's files. + items: + $ref: '#/components/schemas/AdminFile' + AdminFileResponse: + type: object + description: SUMMARY + x-schemaName: AdminFileResponse + required: + - file + properties: + file: + $ref: '#/components/schemas/AdminFile' + AdminFulfillment: + type: object + description: The fulfillment's details. + x-schemaName: AdminFulfillment + required: + - id + - location_id + - provider_id + - shipping_option_id + - provider + - delivery_address + - items + - labels + - packed_at + - shipped_at + - delivered_at + - canceled_at + - data + - metadata + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The fulfillment's ID. + location_id: + type: string + title: location_id + description: The fulfillment's location id. + provider_id: + type: string + title: provider_id + description: The fulfillment's provider id. + shipping_option_id: + type: string + title: shipping_option_id + description: The fulfillment's shipping option id. + provider: + $ref: '#/components/schemas/AdminFulfillmentProvider' + delivery_address: + $ref: '#/components/schemas/AdminFulfillmentAddress' + items: + type: array + description: The fulfillment's items. + items: + $ref: '#/components/schemas/AdminFulfillmentItem' + labels: + type: array + description: The fulfillment's labels. + items: + $ref: '#/components/schemas/AdminFulfillmentLabel' + packed_at: + type: string + title: packed_at + description: The fulfillment's packed at. + shipped_at: + type: string + title: shipped_at + description: The fulfillment's shipped at. + delivered_at: + type: string + title: delivered_at + description: The fulfillment's delivered at. + canceled_at: + type: string + title: canceled_at + description: The fulfillment's canceled at. + data: + type: object + description: The fulfillment's data. + metadata: + type: object + description: The fulfillment's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The fulfillment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The fulfillment's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The fulfillment's deleted at. + AdminFulfillmentAddress: + type: object + description: The fulfillment's delivery address. + x-schemaName: AdminFulfillmentAddress + required: + - id + - fulfillment_id + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The delivery address's ID. + fulfillment_id: + type: string + title: fulfillment_id + description: The delivery address's fulfillment id. + company: + type: string + title: company + description: The delivery address's company. + first_name: + type: string + title: first_name + description: The delivery address's first name. + last_name: + type: string + title: last_name + description: The delivery address's last name. + address_1: + type: string + title: address_1 + description: The delivery address's address 1. + address_2: + type: string + title: address_2 + description: The delivery address's address 2. + city: + type: string + title: city + description: The delivery address's city. + country_code: + type: string + title: country_code + description: The delivery address's country code. + province: + type: string + title: province + description: The delivery address's province. + postal_code: + type: string + title: postal_code + description: The delivery address's postal code. + phone: + type: string + title: phone + description: The delivery address's phone. + metadata: + type: object + description: The delivery address's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The delivery address's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The delivery address's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The delivery address's deleted at. + AdminFulfillmentItem: + type: object + description: The item's items. + x-schemaName: AdminFulfillmentItem + required: + - id + - title + - quantity + - sku + - barcode + - line_item_id + - inventory_item_id + - fulfillment_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + quantity: + type: number + title: quantity + description: The item's quantity. + sku: + type: string + title: sku + description: The item's sku. + barcode: + type: string + title: barcode + description: The item's barcode. + line_item_id: + type: string + title: line_item_id + description: The item's line item id. + inventory_item_id: + type: string + title: inventory_item_id + description: The item's inventory item id. + fulfillment_id: + type: string + title: fulfillment_id + description: The item's fulfillment id. + created_at: + type: string + format: date-time + title: created_at + description: The item's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The item's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The item's deleted at. + AdminFulfillmentLabel: + type: object + description: The label's labels. + x-schemaName: AdminFulfillmentLabel + required: + - id + - tracking_number + - tracking_url + - label_url + - fulfillment_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The label's ID. + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + fulfillment_id: + type: string + title: fulfillment_id + description: The label's fulfillment id. + created_at: + type: string + format: date-time + title: created_at + description: The label's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The label's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The label's deleted at. AdminFulfillmentProvider: type: object - description: The shipping option's provider. + description: The fulfillment provider's fulfillment providers. x-schemaName: AdminFulfillmentProvider + AdminFulfillmentProviderListResponse: + type: object + description: SUMMARY + x-schemaName: AdminFulfillmentProviderListResponse + required: + - limit + - offset + - count + - fulfillment_providers + properties: + limit: + type: number + title: limit + description: The fulfillment provider's limit. + offset: + type: number + title: offset + description: The fulfillment provider's offset. + count: + type: number + title: count + description: The fulfillment provider's count. + fulfillment_providers: + type: array + description: The fulfillment provider's fulfillment providers. + items: + $ref: '#/components/schemas/AdminFulfillmentProvider' + AdminFulfillmentResponse: + type: object + description: SUMMARY + x-schemaName: AdminFulfillmentResponse + required: + - fulfillment + properties: + fulfillment: + $ref: '#/components/schemas/AdminFulfillment' AdminFulfillmentSet: type: object description: The fulfillment set's details. @@ -43469,6 +50484,7 @@ components: - id - name - type + - location - service_zones - created_at - updated_at @@ -43486,6 +50502,8 @@ components: 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. @@ -43589,109 +50607,1403 @@ components: type: number title: toUpdate description: The summary's toupdate. - AdminOrderCancelFulfillment: + AdminInventoryItem: type: object - description: SUMMARY - x-schemaName: AdminOrderCancelFulfillment - properties: - no_notification: - type: boolean - title: no_notification - description: The order's no notification. - AdminOrderCreateFulfillment: - type: object - description: SUMMARY - x-schemaName: AdminOrderCreateFulfillment + description: The inventory item's details. + x-schemaName: AdminInventoryItem required: - - items - - location_id - - metadata + - id + - requires_shipping properties: - items: - type: array - description: The order's items. - items: - 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. - location_id: + id: type: string - title: location_id - description: The order's location id. - no_notification: + title: id + description: The inventory item's ID. + sku: + type: string + title: sku + description: The inventory item's sku. + origin_country: + type: string + title: origin_country + description: The inventory item's origin country. + hs_code: + type: string + title: hs_code + description: The inventory item's hs code. + requires_shipping: type: boolean - title: no_notification - description: The order's no notification. + title: requires_shipping + description: The inventory item's requires shipping. + 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. + 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. + title: + type: string + title: title + description: The inventory item's title. + description: + type: string + title: description + description: The inventory item's description. + thumbnail: + type: string + title: thumbnail + description: The inventory item's thumbnail. metadata: type: object - description: The order's metadata. - AdminOrderCreateShipment: + description: The inventory item's metadata. + AdminInventoryItemResponse: type: object description: SUMMARY - x-schemaName: AdminOrderCreateShipment + x-schemaName: AdminInventoryItemResponse required: - - items - - metadata + - inventory_item properties: + inventory_item: + $ref: '#/components/schemas/AdminInventoryItem' + AdminInvite: + type: object + description: The invite's details. + x-schemaName: AdminInvite + required: + - id + - email + - accepted + - token + properties: + id: + type: string + title: id + description: The invite's ID. + email: + type: string + title: email + description: The invite's email. + format: email + accepted: + type: boolean + title: accepted + description: The invite's accepted. + token: + type: string + title: token + description: The invite's token. + expires_at: + type: string + title: expires_at + description: The invite's expires at. + format: date-time + metadata: + type: object + description: The invite's metadata. + created_at: + type: string + title: created_at + description: The invite's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The invite's updated at. + format: date-time + AdminInviteResponse: + type: object + description: SUMMARY + x-schemaName: AdminInviteResponse + required: + - invite + properties: + invite: + $ref: '#/components/schemas/AdminInvite' + AdminNotification: + type: object + description: The notification's details. + x-schemaName: AdminNotification + required: + - id + - to + - channel + - template + - provider_id + - created_at + properties: + id: + type: string + title: id + description: The notification's ID. + to: + type: string + title: to + description: The notification's to. + channel: + type: string + title: channel + description: The notification's channel. + template: + type: string + title: template + description: The notification's template. + data: + type: object + description: The notification's data. + trigger_type: + type: string + title: trigger_type + description: The notification's trigger type. + resource_id: + type: string + title: resource_id + description: The notification's resource id. + resource_type: + type: string + title: resource_type + description: The notification's resource type. + receiver_id: + type: string + title: receiver_id + description: The notification's receiver id. + original_notification_id: + type: string + title: original_notification_id + description: The notification's original notification id. + external_id: + type: string + title: external_id + description: The notification's external id. + provider_id: + type: string + title: provider_id + description: The notification's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The notification's created at. + AdminNotificationListResponse: + type: object + description: SUMMARY + x-schemaName: AdminNotificationListResponse + required: + - limit + - offset + - count + - notifications + properties: + limit: + type: number + title: limit + description: The notification's limit. + offset: + type: number + title: offset + description: The notification's offset. + count: + type: number + title: count + description: The notification's count. + notifications: + type: array + description: The notification's notifications. + items: + $ref: '#/components/schemas/AdminNotification' + AdminNotificationResponse: + type: object + description: SUMMARY + x-schemaName: AdminNotificationResponse + required: + - notification + properties: + notification: + $ref: '#/components/schemas/AdminNotification' + AdminOrder: + type: object + description: The order's details. + x-schemaName: AdminOrder + required: + - payment_collections + - id + - version + - region_id + - customer_id + - sales_channel_id + - email + - currency_code + - items + - shipping_methods + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total + properties: + payment_collections: + type: array + description: The order's payment collections. + items: + $ref: '#/components/schemas/AdminPaymentCollection' + id: + type: string + title: id + description: The order's ID. + version: + type: number + title: version + description: The order's version. + region_id: + type: string + title: region_id + description: The order's region id. + customer_id: + type: string + title: customer_id + description: The order's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order's sales channel id. + email: + type: string + title: email + description: The order's email. + format: email + currency_code: + type: string + title: currency_code + description: The order's currency code. + display_id: + type: string + 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. items: - 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. - labels: + $ref: '#/components/schemas/BaseOrderLineItem' + shipping_methods: type: array - description: The order's labels. + description: The order's shipping methods. items: - type: object - description: The label's labels. - required: - - tracking_number - - tracking_url - - label_url - properties: - tracking_number: - type: string - title: tracking_number - description: The label's tracking number. - tracking_url: - type: string - title: tracking_url - description: The label's tracking url. - label_url: - type: string - title: label_url - description: The label's label url. - no_notification: - type: boolean - title: no_notification - description: The order's no notification. + $ref: '#/components/schemas/BaseOrderShippingMethod' + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The order's fulfillments. + items: + $ref: '#/components/schemas/BaseOrderFulfillment' + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The order's transactions. + items: + $ref: '#/components/schemas/BaseOrderTransaction' + summary: + $ref: '#/components/schemas/BaseOrderSummary' metadata: type: object description: The order's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The order's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order's updated at. + original_item_total: + type: number + title: original_item_total + description: The order's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The order's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The order's original item tax total. + item_total: + type: number + title: item_total + description: The order's item total. + item_subtotal: + type: number + title: item_subtotal + description: The order's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The order's item tax total. + original_total: + type: number + title: original_total + description: The order's original total. + original_subtotal: + type: number + title: original_subtotal + description: The order's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The order's original tax total. + total: + type: number + title: total + description: The order's total. + subtotal: + type: number + title: subtotal + description: The order's subtotal. + tax_total: + type: number + title: tax_total + description: The order's tax total. + discount_total: + type: number + title: discount_total + description: The order's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The order's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The order's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The order's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The order's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The order's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The order's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The order's original shipping tax total. + AdminOrderPreview: + type: object + description: The return's order preview. + x-schemaName: AdminOrderPreview + required: + - return_requested_total + - order_change + - currency_code + - id + - version + - region_id + - customer_id + - sales_channel_id + - email + - payment_collections + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total + properties: + return_requested_total: + type: number + title: return_requested_total + description: The order preview's return requested total. + order_change: + $ref: '#/components/schemas/BaseOrderChange' + items: + type: array + description: The order preview's items. + items: + allOf: + - type: object + description: The item's items. + x-schemaName: BaseOrderLineItem + required: + - id + - title + - subtitle + - thumbnail + - variant_id + - product_id + - product_title + - product_description + - product_subtitle + - product_type + - product_collection + - product_handle + - variant_sku + - variant_barcode + - variant_title + - variant_option_values + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - detail + - created_at + - updated_at + - metadata + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant: + $ref: '#/components/schemas/BaseProductVariant' + variant_id: + type: string + title: variant_id + description: The item's variant id. + product: + $ref: '#/components/schemas/BaseProduct' + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: '#/components/schemas/BaseOrderLineItemTaxLine' + adjustments: + type: array + description: The item's adjustments. + items: + $ref: '#/components/schemas/BaseOrderLineItemAdjustment' + detail: + $ref: '#/components/schemas/BaseOrderItemDetail' + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + metadata: + type: object + description: The item's metadata. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: object + description: The item's items. + properties: + actions: + type: array + description: The item's actions. + items: + type: object + description: The action's actions. + x-schemaName: BaseOrderChangeAction + shipping_methods: + type: array + description: The order preview's shipping methods. + items: + allOf: + - type: object + description: The shipping method's shipping methods. + x-schemaName: BaseOrderShippingMethod + required: + - id + - order_id + - name + - amount + - is_tax_inclusive + - shipping_option_id + - data + - metadata + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: '#/components/schemas/BaseOrderShippingMethodTaxLine' + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: '#/components/schemas/BaseOrderShippingMethodAdjustment' + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: discount_tax_total + description: The shipping method's discount tax total. + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - $ref: '#/components/schemas/IBigNumber' + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + - type: object + description: The shipping method's shipping methods. + properties: + actions: + type: array + description: The shipping method's actions. + items: + type: object + description: The action's actions. + x-schemaName: BaseOrderChangeAction + currency_code: + type: string + title: currency_code + description: The order preview's currency code. + id: + type: string + title: id + description: The order preview's ID. + version: + type: number + title: version + description: The order preview's version. + region_id: + type: string + title: region_id + description: The order preview's region id. + customer_id: + type: string + title: customer_id + description: The order preview's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order preview's sales channel id. + email: + type: string + title: email + description: The order preview's email. + format: email + display_id: + type: string + title: display_id + description: The order preview's display id. + shipping_address: + $ref: '#/components/schemas/BaseOrderAddress' + billing_address: + $ref: '#/components/schemas/BaseOrderAddress' + payment_collections: + type: array + description: The order preview's payment collections. + items: + $ref: '#/components/schemas/AdminPaymentCollection' + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The order preview's fulfillments. + items: + $ref: '#/components/schemas/BaseOrderFulfillment' + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The order preview's transactions. + items: + $ref: '#/components/schemas/BaseOrderTransaction' + summary: + $ref: '#/components/schemas/BaseOrderSummary' + metadata: + type: object + description: The order preview's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The order preview's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order preview's updated at. + original_item_total: + type: number + title: original_item_total + description: The order preview's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The order preview's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The order preview's original item tax total. + item_total: + type: number + title: item_total + description: The order preview's item total. + item_subtotal: + type: number + title: item_subtotal + description: The order preview's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The order preview's item tax total. + original_total: + type: number + title: original_total + description: The order preview's original total. + original_subtotal: + type: number + title: original_subtotal + description: The order preview's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The order preview's original tax total. + total: + type: number + title: total + description: The order preview's total. + subtotal: + type: number + title: subtotal + description: The order preview's subtotal. + tax_total: + type: number + title: tax_total + description: The order preview's tax total. + discount_total: + type: number + title: discount_total + description: The order preview's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The order preview's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The order preview's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The order preview's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The order preview's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order preview's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The order preview's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The order preview's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + AdminOrderPreviewResponse: + type: object + description: SUMMARY + x-schemaName: AdminOrderPreviewResponse + required: + - order + properties: + order: + $ref: '#/components/schemas/AdminOrderPreview' + AdminOrderResponse: + type: object + description: SUMMARY + x-schemaName: AdminOrderResponse + required: + - order + properties: + order: + $ref: '#/components/schemas/AdminOrder' + AdminOrderReturnResponse: + type: object + description: SUMMARY + x-schemaName: AdminOrderReturnResponse + required: + - order + - return + properties: + order: + $ref: '#/components/schemas/Order' + return: + $ref: '#/components/schemas/AdminReturn' + AdminPayment: + type: object + description: The payment's details. + x-schemaName: AdminPayment + required: + - id + - amount + - currency_code + - provider_id + properties: + id: + type: string + title: id + description: The payment's ID. + amount: + oneOf: + - type: string + title: amount + description: The payment's amount. + - type: number + title: amount + description: The payment's amount. + - type: string + title: amount + description: The payment's amount. + - $ref: '#/components/schemas/IBigNumber' + authorized_amount: + oneOf: + - type: string + title: authorized_amount + description: The payment's authorized amount. + - type: number + title: authorized_amount + description: The payment's authorized amount. + - type: string + title: authorized_amount + description: The payment's authorized amount. + - $ref: '#/components/schemas/IBigNumber' + currency_code: + type: string + title: currency_code + description: The payment's currency code. + provider_id: + type: string + title: provider_id + description: The payment's provider id. + cart_id: + type: string + title: cart_id + description: The payment's cart id. + order_id: + type: string + title: order_id + description: The payment's order id. + order_edit_id: + type: string + title: order_edit_id + description: The payment's order edit id. + customer_id: + type: string + title: customer_id + description: The payment's customer id. + data: + type: object + description: The payment's data. + created_at: + type: string + format: date-time + title: created_at + description: The payment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The payment's updated at. + captured_at: + oneOf: + - type: string + title: captured_at + description: The payment's captured at. + - type: string + title: captured_at + description: The payment's captured at. + format: date-time + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The payment's canceled at. + - type: string + title: canceled_at + description: The payment's canceled at. + format: date-time + captured_amount: + oneOf: + - type: string + title: captured_amount + description: The payment's captured amount. + - type: number + title: captured_amount + description: The payment's captured amount. + - type: string + title: captured_amount + description: The payment's captured amount. + - $ref: '#/components/schemas/IBigNumber' + refunded_amount: + oneOf: + - type: string + title: refunded_amount + description: The payment's refunded amount. + - type: number + title: refunded_amount + description: The payment's refunded amount. + - type: string + title: refunded_amount + description: The payment's refunded amount. + - $ref: '#/components/schemas/IBigNumber' + captures: + type: array + description: The payment's captures. + items: + $ref: '#/components/schemas/BaseCapture' + refunds: + type: array + description: The payment's refunds. + items: + $ref: '#/components/schemas/BaseRefund' + payment_collection: + $ref: '#/components/schemas/BasePaymentCollection' + payment_session: + $ref: '#/components/schemas/BasePaymentSession' + AdminPaymentCollection: + type: object + description: The payment collection's payment collections. + x-schemaName: AdminPaymentCollection + required: + - id + - currency_code + - region_id + - amount + - status + - payment_providers + properties: + id: + type: string + title: id + description: The payment collection's ID. + currency_code: + type: string + title: currency_code + description: The payment collection's currency code. + region_id: + type: string + title: region_id + description: The payment collection's region id. + amount: + oneOf: + - type: string + title: amount + description: The payment collection's amount. + - type: number + title: amount + description: The payment collection's amount. + - type: string + title: amount + description: The payment collection's amount. + - $ref: '#/components/schemas/IBigNumber' + authorized_amount: + oneOf: + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - type: number + title: authorized_amount + description: The payment collection's authorized amount. + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - $ref: '#/components/schemas/IBigNumber' + captured_amount: + oneOf: + - type: string + title: captured_amount + description: The payment collection's captured amount. + - type: number + title: captured_amount + description: The payment collection's captured amount. + - type: string + title: captured_amount + description: The payment collection's captured amount. + - $ref: '#/components/schemas/IBigNumber' + refunded_amount: + oneOf: + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - type: number + title: refunded_amount + description: The payment collection's refunded amount. + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - $ref: '#/components/schemas/IBigNumber' + completed_at: + oneOf: + - type: string + title: completed_at + description: The payment collection's completed at. + - type: string + title: completed_at + description: The payment collection's completed at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The payment collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The payment collection's updated at. + metadata: + type: object + description: The payment collection's metadata. + status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + payment_providers: + type: array + description: The payment collection's payment providers. + items: + $ref: '#/components/schemas/BasePaymentProvider' + payment_sessions: + type: array + description: The payment collection's payment sessions. + items: + $ref: '#/components/schemas/BasePaymentSession' + payments: + type: array + description: The payment collection's payments. + items: + $ref: '#/components/schemas/BasePayment' + AdminPaymentProvider: + type: object + description: The payment provider's payment providers. + x-schemaName: AdminPaymentProvider + AdminPaymentResponse: + type: object + description: SUMMARY + x-schemaName: AdminPaymentResponse + required: + - payment + properties: + payment: + $ref: '#/components/schemas/AdminPayment' AdminPostCancelClaimReqSchema: type: object description: SUMMARY @@ -43701,6 +52013,15 @@ components: type: boolean title: no_notification description: The claim's no notification. + AdminPostCancelExchangeReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostCancelExchangeReqSchema + properties: + no_notification: + type: boolean + title: no_notification + description: The exchange's no notification. AdminPostCancelReturnReqSchema: type: object description: SUMMARY @@ -43786,18 +52107,17 @@ components: type: object description: SUMMARY x-schemaName: AdminPostClaimsItemsActionReqSchema + required: + - reason_id properties: quantity: type: number title: quantity description: The claim's quantity. - reason: + reason_id: type: string - enum: - - missing_item - - wrong_item - - production_failure - - other + title: reason_id + description: The claim's reason id. internal_note: type: string title: internal_note @@ -43844,6 +52164,157 @@ components: metadata: type: object description: The claim's metadata. + AdminPostExchangesAddItemsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostExchangesAddItemsReqSchema + properties: + items: + type: array + description: The exchange's items. + items: + type: object + description: The item's items. + required: + - variant_id + - quantity + properties: + variant_id: + type: string + title: variant_id + description: The item's variant id. + quantity: + type: number + title: quantity + description: The item's quantity. + unit_price: + type: number + title: unit_price + description: The item's unit price. + internal_note: + type: string + title: internal_note + description: The item's internal note. + allow_backorder: + type: boolean + title: allow_backorder + description: The item's allow backorder. + metadata: + type: object + description: The item's metadata. + AdminPostExchangesRequestItemsReturnActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostExchangesRequestItemsReturnActionReqSchema + properties: + quantity: + type: number + title: quantity + description: The exchange's quantity. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. + reason_id: + type: string + title: reason_id + description: The exchange's reason id. + metadata: + type: object + description: The exchange's metadata. + AdminPostExchangesReturnRequestItemsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema + properties: + items: + type: array + description: The exchange's items. + items: + 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. + description: + type: string + title: description + description: The item's description. + internal_note: + type: string + title: internal_note + description: The item's internal note. + reason_id: + type: string + title: reason_id + description: The item's reason id. + metadata: + type: object + description: The item's metadata. + AdminPostExchangesShippingActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostExchangesShippingActionReqSchema + properties: + custom_price: + type: number + title: custom_price + description: The exchange's custom price. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. + metadata: + type: object + description: The exchange's metadata. + AdminPostExchangesShippingReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostExchangesShippingReqSchema + required: + - shipping_option_id + properties: + shipping_option_id: + type: string + title: shipping_option_id + description: The exchange's shipping option id. + custom_price: + type: number + title: custom_price + description: The exchange's custom price. + description: + type: string + title: description + description: The exchange's description. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. + metadata: + type: object + description: The exchange's metadata. + AdminPostExhangesItemsActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostExhangesItemsActionReqSchema + properties: + quantity: + type: number + title: quantity + description: The exchange's quantity. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. AdminPostOrderClaimsReqSchema: type: object description: SUMMARY @@ -43851,6 +52322,7 @@ components: required: - type - order_id + - reason_id - metadata properties: type: @@ -43870,9 +52342,36 @@ components: type: string title: internal_note description: The claim's internal note. + reason_id: + type: string + title: reason_id + description: The claim's reason id. metadata: type: object description: The claim's metadata. + AdminPostOrderExchangesReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostOrderExchangesReqSchema + required: + - order_id + - metadata + properties: + order_id: + type: string + title: order_id + description: The exchange's order id. + description: + type: string + title: description + description: The exchange's description. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. + metadata: + type: object + description: The exchange's metadata. AdminPostReceiveReturnsReqSchema: type: object description: SUMMARY @@ -44090,22 +52589,22 @@ components: shipping_option_id: type: string title: shipping_option_id - description: The claim's shipping option id. + description: The exchange's shipping option id. custom_price: type: number title: custom_price - description: The claim's custom price. + description: The exchange's custom price. description: type: string title: description - description: The claim's description. + description: The exchange's description. internal_note: type: string title: internal_note - description: The claim's internal note. + description: The exchange's internal note. metadata: type: object - description: The claim's metadata. + description: The exchange's metadata. AdminPrice: type: object description: The price's prices. @@ -44169,6 +52668,357 @@ components: format: date-time title: deleted_at description: The price's deleted at. + AdminPriceList: + type: object + description: The price list's details. + x-schemaName: AdminPriceList + required: + - id + - title + - description + - rules + - starts_at + - ends_at + - status + - type + - prices + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The price list's ID. + title: + type: string + title: title + description: The price list's title. + description: + type: string + title: description + description: The price list's description. + rules: + type: object + description: The price list's rules. + starts_at: + type: string + title: starts_at + description: The price list's starts at. + ends_at: + type: string + title: ends_at + description: The price list's ends at. + status: + type: string + enum: + - draft + - active + type: + type: string + enum: + - sale + - override + prices: + type: array + description: The price list's prices. + items: + $ref: '#/components/schemas/AdminPriceListPrice' + created_at: + type: string + format: date-time + title: created_at + description: The price list's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The price list's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The price list's deleted at. + AdminPriceListBatchResponse: + type: object + description: SUMMARY + x-schemaName: AdminPriceListBatchResponse + required: + - created + - updated + - deleted + properties: + created: + type: array + description: The price list's created. + items: + $ref: '#/components/schemas/AdminPrice' + updated: + type: array + description: The price list's updated. + items: + $ref: '#/components/schemas/AdminPrice' + deleted: + type: object + description: The price list's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. + AdminPriceListDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminPriceListDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The price list's ID. + object: + type: string + title: object + description: The price list's object. + default: price_list + deleted: + type: boolean + title: deleted + description: The price list's deleted. + parent: + type: object + description: The price list's parent. + AdminPriceListListResponse: + type: object + description: SUMMARY + x-schemaName: AdminPriceListListResponse + required: + - limit + - offset + - count + - price_lists + properties: + limit: + type: number + title: limit + description: The price list's limit. + offset: + type: number + title: offset + description: The price list's offset. + count: + type: number + title: count + description: The price list's count. + price_lists: + type: array + description: The price list's price lists. + items: + $ref: '#/components/schemas/AdminPriceList' + AdminPriceListPrice: + type: object + description: The price's prices. + x-schemaName: AdminPriceListPrice + required: + - variant_id + - rules + - id + - title + - currency_code + - amount + - raw_amount + - min_quantity + - max_quantity + - price_set_id + - created_at + - updated_at + - deleted_at + properties: + variant_id: + type: string + title: variant_id + description: The price's variant id. + rules: + type: object + description: The price's rules. + id: + type: string + title: id + description: The price's ID. + title: + type: string + title: title + description: The price's title. + currency_code: + type: string + title: currency_code + description: The price's currency code. + amount: + type: number + title: amount + description: The price's amount. + raw_amount: + type: object + description: The price's raw amount. + min_quantity: + type: number + title: min_quantity + description: The price's min quantity. + max_quantity: + type: number + title: max_quantity + description: The price's max quantity. + price_set_id: + type: string + title: price_set_id + description: The price's price set id. + created_at: + type: string + format: date-time + title: created_at + description: The price's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The price's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The price's deleted at. + AdminPriceListResponse: + type: object + description: SUMMARY + x-schemaName: AdminPriceListResponse + required: + - price_list + properties: + price_list: + $ref: '#/components/schemas/AdminPriceList' + AdminPricePreference: + type: object + description: The price preference's details. + x-schemaName: AdminPricePreference + required: + - id + - attribute + - value + - is_tax_inclusive + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The price preference's ID. + attribute: + type: string + title: attribute + description: The price preference's attribute. + value: + type: string + title: value + description: The price preference's value. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The price preference's is tax inclusive. + created_at: + type: string + format: date-time + title: created_at + description: The price preference's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The price preference's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The price preference's deleted at. + AdminPricePreferenceDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminPricePreferenceDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The price preference's ID. + object: + type: string + title: object + description: The price preference's object. + default: price_preference + deleted: + type: boolean + title: deleted + description: The price preference's deleted. + parent: + type: object + description: The price preference's parent. + AdminPricePreferenceListResponse: + type: object + description: SUMMARY + x-schemaName: AdminPricePreferenceListResponse + required: + - limit + - offset + - count + - price_preferences + properties: + limit: + type: number + title: limit + description: The price preference's limit. + offset: + type: number + title: offset + description: The price preference's offset. + count: + type: number + title: count + description: The price preference's count. + price_preferences: + type: array + description: The price preference's price preferences. + items: + $ref: '#/components/schemas/AdminPricePreference' + AdminPricePreferenceResponse: + type: object + description: SUMMARY + x-schemaName: AdminPricePreferenceResponse + required: + - price_preference + properties: + price_preference: + $ref: '#/components/schemas/AdminPricePreference' AdminProduct: type: object description: The product's parent. @@ -44181,25 +53031,25 @@ components: - options - description - id - - handle - - hs_code - - weight - - height - - width - - origin_country - - mid_code - - material - - thumbnail - created_at - updated_at - - deleted_at + - handle - subtitle - is_giftcard + - thumbnail + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material - collection_id - type_id - images - discountable - external_id + - deleted_at properties: collection: $ref: '#/components/schemas/AdminCollection' @@ -44256,42 +53106,6 @@ components: metadata: type: object description: The parent's metadata. - handle: - type: string - title: handle - description: The parent's handle. - hs_code: - type: string - title: hs_code - description: The parent's hs code. - weight: - type: number - title: weight - description: The parent's weight. - height: - type: number - title: height - description: The parent's height. - width: - type: number - title: width - description: The parent's width. - origin_country: - type: string - title: origin_country - description: The parent's origin country. - mid_code: - type: string - title: mid_code - description: The parent's mid code. - material: - type: string - title: material - description: The parent's material. - thumbnail: - type: string - title: thumbnail - description: The parent's thumbnail. created_at: type: string format: date-time @@ -44302,11 +53116,10 @@ components: format: date-time title: updated_at description: The parent's updated at. - deleted_at: + handle: type: string - format: date-time - title: deleted_at - description: The parent's deleted at. + title: handle + description: The parent's handle. subtitle: type: string title: subtitle @@ -44315,6 +53128,38 @@ components: type: boolean title: is_giftcard description: The parent's is giftcard. + thumbnail: + type: string + title: thumbnail + description: The parent's thumbnail. + width: + type: number + title: width + description: The parent's width. + weight: + type: number + title: weight + description: The parent's weight. + height: + type: number + title: height + description: The parent's height. + origin_country: + type: string + title: origin_country + description: The parent's origin country. + hs_code: + type: string + title: hs_code + description: The parent's hs code. + mid_code: + type: string + title: mid_code + description: The parent's mid code. + material: + type: string + title: material + description: The parent's material. collection_id: type: string title: collection_id @@ -44336,6 +53181,11 @@ components: type: string title: external_id description: The parent's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The parent's deleted at. AdminProductCategory: type: object description: The category's categories. @@ -44346,14 +53196,14 @@ components: - name - description - id - - handle - created_at - updated_at + - handle - deleted_at - - parent_category_id - - is_internal - is_active + - is_internal - rank + - parent_category_id properties: category_children: type: array @@ -44379,10 +53229,6 @@ components: type: string title: id description: The category's ID. - handle: - type: string - title: handle - description: The category's handle. created_at: type: string format: date-time @@ -44393,27 +53239,56 @@ components: format: date-time title: updated_at description: The category's updated at. + handle: + type: string + title: handle + description: The category's handle. deleted_at: type: string format: date-time title: deleted_at description: The category's deleted at. - parent_category_id: - type: string - title: parent_category_id - description: The category's parent category id. - is_internal: - type: boolean - title: is_internal - description: The category's is internal. is_active: type: boolean title: is_active description: The category's is active. + is_internal: + type: boolean + title: is_internal + description: The category's is internal. rank: type: number title: rank description: The category's rank. + parent_category_id: + type: string + title: parent_category_id + description: The category's parent category id. + AdminProductCategoryDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductCategoryDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The product category's ID. + object: + type: string + title: object + description: The product category's object. + default: product_category + deleted: + type: boolean + title: deleted + description: The product category's deleted. + parent: + type: object + description: The product category's parent. AdminProductCategoryListResponse: type: object description: SUMMARY @@ -44598,9 +53473,131 @@ components: metadata: type: object description: The tag's metadata. + AdminProductTagDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductTagDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The product tag's ID. + object: + type: string + title: object + description: The product tag's object. + default: product_tag + deleted: + type: boolean + title: deleted + description: The product tag's deleted. + parent: + type: object + description: The product tag's parent. + AdminProductTagListResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductTagListResponse + required: + - limit + - offset + - count + - product_tags + properties: + limit: + type: number + title: limit + description: The product tag's limit. + offset: + type: number + title: offset + description: The product tag's offset. + count: + type: number + title: count + description: The product tag's count. + product_tags: + type: array + description: The product tag's product tags. + items: + $ref: '#/components/schemas/AdminProductTag' + AdminProductTagResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductTagResponse + required: + - product_tag + properties: + product_tag: + $ref: '#/components/schemas/AdminProductTag' + AdminProductTypeDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductTypeDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The product type's ID. + object: + type: string + title: object + description: The product type's object. + default: product_type + deleted: + type: boolean + title: deleted + description: The product type's deleted. + parent: + type: object + description: The product type's parent. + AdminProductTypeListResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductTypeListResponse + required: + - limit + - offset + - count + - product_types + properties: + limit: + type: number + title: limit + description: The product type's limit. + offset: + type: number + title: offset + description: The product type's offset. + count: + type: number + title: count + description: The product type's count. + product_types: + type: array + description: The product type's product types. + items: + $ref: '#/components/schemas/AdminProduct' + AdminProductTypeResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductTypeResponse + required: + - product_type + properties: + product_type: + $ref: '#/components/schemas/AdminProduct' AdminProductVariant: type: object - description: The updated's details. + description: The product's parent. x-schemaName: AdminProductVariant required: - prices @@ -44627,80 +53624,80 @@ components: properties: prices: type: array - description: The updated's prices. + description: The parent's prices. items: $ref: '#/components/schemas/AdminPrice' id: type: string title: id - description: The updated's ID. + description: The parent's ID. title: type: string title: title - description: The updated's title. + description: The parent's title. sku: type: string title: sku - description: The updated's sku. + description: The parent's sku. barcode: type: string title: barcode - description: The updated's barcode. + description: The parent's barcode. ean: type: string title: ean - description: The updated's ean. + description: The parent's ean. upc: type: string title: upc - description: The updated's upc. + description: The parent's upc. allow_backorder: type: boolean title: allow_backorder - description: The updated's allow backorder. + description: The parent's allow backorder. manage_inventory: type: boolean title: manage_inventory - description: The updated's manage inventory. + description: The parent's manage inventory. hs_code: type: string title: hs_code - description: The updated's hs code. + description: The parent's hs code. origin_country: type: string title: origin_country - description: The updated's origin country. + description: The parent's origin country. mid_code: type: string title: mid_code - description: The updated's mid code. + description: The parent's mid code. material: type: string title: material - description: The updated's material. + description: The parent's material. weight: type: number title: weight - description: The updated's weight. + description: The parent's weight. length: type: number title: length - description: The updated's length. + description: The parent's length. height: type: number title: height - description: The updated's height. + description: The parent's height. width: type: number title: width - description: The updated's width. + description: The parent's width. variant_rank: type: number title: variant_rank - description: The updated's variant rank. + description: The parent's variant rank. options: type: array - description: The updated's options. + description: The parent's options. items: $ref: '#/components/schemas/BaseProductOptionValue' product: @@ -44708,27 +53705,27 @@ components: product_id: type: string title: product_id - description: The updated's product id. + description: The parent's product id. calculated_price: $ref: '#/components/schemas/BaseCalculatedPriceSet' created_at: type: string format: date-time title: created_at - description: The updated's created at. + description: The parent's created at. updated_at: type: string format: date-time title: updated_at - description: The updated's updated at. + description: The parent's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The updated's deleted at. + description: The parent's deleted at. metadata: type: object - description: The updated's metadata. + description: The parent's metadata. AdminProductVariantDeleteResponse: type: object description: SUMMARY @@ -44753,6 +53750,164 @@ components: description: The product's deleted. parent: $ref: '#/components/schemas/AdminProduct' + AdminProductVariantInventoryBatchResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductVariantInventoryBatchResponse + required: + - created + - updated + - deleted + properties: + created: + oneOf: + - $ref: '#/components/schemas/AdminProductVariantInventoryLink' + - type: array + description: The product's created. + items: + type: object + description: The created's details. + x-schemaName: AdminProductVariantInventoryLink + required: + - productService + - inventoryService + properties: + productService: + type: object + description: The created's productservice. + required: + - variant_id + properties: + variant_id: + type: string + title: variant_id + description: The productservice's variant id. + inventoryService: + type: object + description: The created's inventoryservice. + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventoryservice's inventory item id. + updated: + oneOf: + - $ref: '#/components/schemas/AdminProductVariantInventoryLink' + - type: array + description: The product's updated. + items: + type: object + description: The updated's details. + x-schemaName: AdminProductVariantInventoryLink + required: + - productService + - inventoryService + properties: + productService: + type: object + description: The updated's productservice. + required: + - variant_id + properties: + variant_id: + type: string + title: variant_id + description: The productservice's variant id. + inventoryService: + type: object + description: The updated's inventoryservice. + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventoryservice's inventory item id. + deleted: + oneOf: + - $ref: '#/components/schemas/AdminProductVariantInventoryLink' + - type: array + description: The product's deleted. + items: + type: object + description: The deleted's details. + x-schemaName: AdminProductVariantInventoryLink + required: + - productService + - inventoryService + properties: + productService: + type: object + description: The deleted's productservice. + required: + - variant_id + properties: + variant_id: + type: string + title: variant_id + description: The productservice's variant id. + inventoryService: + type: object + description: The deleted's inventoryservice. + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventoryservice's inventory item id. + AdminProductVariantInventoryLink: + type: object + description: The product's ID. + x-schemaName: AdminProductVariantInventoryLink + required: + - productService + - inventoryService + properties: + productService: + type: object + description: The id's productservice. + required: + - variant_id + properties: + variant_id: + type: string + title: variant_id + description: The productservice's variant id. + inventoryService: + type: object + description: The id's inventoryservice. + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventoryservice's inventory item id. + AdminProductVariantInventoryLinkDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductVariantInventoryLinkDeleteResponse + required: + - id + - object + - deleted + - parent + properties: + id: + $ref: '#/components/schemas/AdminProductVariantInventoryLink' + object: + type: string + title: object + description: The product's object. + deleted: + type: boolean + title: deleted + description: The product's deleted. + parent: + $ref: '#/components/schemas/AdminProductVariant' AdminProductVariantParams: type: object description: The product's variants. @@ -44818,218 +53973,20 @@ components: type: array description: The variant's $and. items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - sku: - oneOf: - - type: string - title: sku - description: The $and's sku. - - type: array - description: The $and's sku. - items: - type: string - title: sku - description: The sku's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $and's product id. - - type: array - description: The $and's product id. - items: - type: string - title: product_id - description: The product id's details. - options: - type: object - description: The $and's options. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $or's details. + type: array + description: The $and's details. + items: + type: object + title: $and $or: type: array description: The variant's $or. items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - sku: - oneOf: - - type: string - title: sku - description: The $or's sku. - - type: array - description: The $or's sku. - items: - type: string - title: sku - description: The sku's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $or's product id. - - type: array - description: The $or's product id. - items: - type: string - title: product_id - description: The product id's details. - options: - type: object - description: The $or's options. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $or's details. + type: array + description: The $or's details. + items: + type: object + title: $or AdminProductVariantResponse: type: object description: SUMMARY @@ -45039,6 +53996,395 @@ components: properties: variant: $ref: '#/components/schemas/AdminProductVariant' + AdminPromotion: + type: object + description: The promotion's details. + x-schemaName: AdminPromotion + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. + code: + type: string + title: code + description: The promotion's code. + type: + type: string + enum: + - standard + - buyget + is_automatic: + type: boolean + title: is_automatic + description: The promotion's is automatic. + application_method: + $ref: '#/components/schemas/BaseApplicationMethod' + rules: + type: array + description: The promotion's rules. + items: + $ref: '#/components/schemas/BasePromotionRule' + campaign_id: + type: string + title: campaign_id + description: The promotion's campaign id. + campaign: + $ref: '#/components/schemas/CampaignResponse' + AdminPromotionResponse: + type: object + description: SUMMARY + x-schemaName: AdminPromotionResponse + required: + - promotion + properties: + promotion: + $ref: '#/components/schemas/AdminPromotion' + AdminPromotionRule: + type: object + description: The updated's details. + x-schemaName: AdminPromotionRule + required: + - id + - values + properties: + id: + type: string + title: id + description: The updated's ID. + description: + type: string + title: description + description: The updated's description. + attribute: + type: string + title: attribute + description: The updated's attribute. + operator: + type: string + enum: + - gt + - lt + - eq + - ne + - in + - lte + - gte + values: + type: array + description: The updated's values. + items: + $ref: '#/components/schemas/BasePromotionRuleValue' + AdminRefundReason: + type: object + description: The refund reason's details. + x-schemaName: AdminRefundReason + required: + - id + - label + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The refund reason's ID. + label: + type: string + title: label + description: The refund reason's label. + description: + type: string + title: description + description: The refund reason's description. + metadata: + type: object + description: The refund reason's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The refund reason's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The refund reason's updated at. + AdminRegion: + type: object + description: The region's details. + x-schemaName: AdminRegion + required: + - id + - name + - currency_code + properties: + id: + type: string + title: id + description: The region's ID. + name: + type: string + title: name + description: The region's name. + currency_code: + type: string + title: currency_code + description: The region's currency code. + automatic_taxes: + type: boolean + title: automatic_taxes + description: The region's automatic taxes. + countries: + type: array + description: The region's countries. + items: + $ref: '#/components/schemas/BaseRegionCountry' + payment_providers: + type: array + description: The region's payment providers. + items: + $ref: '#/components/schemas/AdminPaymentProvider' + metadata: + type: object + description: The region's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The region's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The region's updated at. + AdminRegionResponse: + type: object + description: SUMMARY + x-schemaName: AdminRegionResponse + required: + - region + properties: + region: + $ref: '#/components/schemas/AdminRegion' + AdminReservationResponse: + type: object + description: SUMMARY + x-schemaName: AdminReservationResponse + required: + - reservation + properties: + reservation: + $ref: '#/components/schemas/ReservationResponse' + AdminReturn: + type: object + description: The exchange's return. + x-schemaName: AdminReturn + required: + - id + - order_id + - order_version + - display_id + - items + - received_at + - created_at + properties: + id: + type: string + title: id + description: The return's ID. + order_id: + type: string + title: order_id + description: The return's order id. + status: + type: string + title: status + description: The return's status. + exchange_id: + type: string + title: exchange_id + description: The return's exchange id. + location_id: + type: string + title: location_id + description: The return's location id. + claim_id: + type: string + title: claim_id + description: The return's claim id. + order_version: + type: number + title: order_version + description: The return's order version. + display_id: + type: number + title: display_id + description: The return's display id. + no_notification: + type: boolean + title: no_notification + description: The return's no notification. + refund_amount: + type: number + title: refund_amount + description: The return's refund amount. + items: + type: array + description: The return's items. + items: + $ref: '#/components/schemas/BaseReturnItem' + received_at: + type: string + title: received_at + description: The return's received at. + created_at: + type: string + format: date-time + title: created_at + description: The return's created at. + AdminReturnItem: + type: object + description: The return item's return items. + x-schemaName: AdminReturnItem + required: + - id + - quantity + - received_quantity + - item_id + - return_id + properties: + id: + type: string + title: id + description: The return item's ID. + quantity: + type: number + title: quantity + description: The return item's quantity. + received_quantity: + type: number + title: received_quantity + description: The return item's received quantity. + reason_id: + type: string + title: reason_id + description: The return item's reason id. + note: + type: string + title: note + description: The return item's note. + item_id: + type: string + title: item_id + description: The return item's item id. + return_id: + type: string + title: return_id + description: The return item's return id. + metadata: + type: object + description: The return item's metadata. + AdminReturnPreviewResponse: + type: object + description: SUMMARY + x-schemaName: AdminReturnPreviewResponse + required: + - order_preview + - return + properties: + order_preview: + $ref: '#/components/schemas/AdminOrderPreview' + return: + $ref: '#/components/schemas/AdminReturn' + AdminReturnReason: + type: object + description: The return reason's details. + x-schemaName: AdminReturnReason + required: + - id + - value + - label + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The return reason's ID. + value: + type: string + title: value + description: The return reason's value. + label: + type: string + title: label + description: The return reason's label. + description: + type: string + title: description + description: The return reason's description. + metadata: + type: object + description: The return reason's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The return reason's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The return reason's updated at. + AdminReturnReasonListResponse: + type: object + description: SUMMARY + x-schemaName: AdminReturnReasonListResponse + required: + - limit + - offset + - count + - return_reasons + properties: + limit: + type: number + title: limit + description: The return reason's limit. + offset: + type: number + title: offset + description: The return reason's offset. + count: + type: number + title: count + description: The return reason's count. + return_reasons: + type: array + description: The return reason's return reasons. + items: + $ref: '#/components/schemas/AdminReturnReason' + AdminReturnReasonResponse: + type: object + description: SUMMARY + x-schemaName: AdminReturnReasonResponse + required: + - return_reason + properties: + return_reason: + $ref: '#/components/schemas/AdminReturnReason' + AdminReturnResponse: + type: object + description: SUMMARY + x-schemaName: AdminReturnResponse + required: + - return + properties: + return: + $ref: '#/components/schemas/AdminReturn' AdminRevokeApiKey: type: object description: SUMMARY @@ -45048,6 +54394,69 @@ components: type: number title: revoke_in description: The api key's revoke in. + AdminRuleAttributeOption: + type: object + description: The attribute's attributes. + x-schemaName: AdminRuleAttributeOption + required: + - id + - value + - label + - field_type + - required + - disguised + - operators + properties: + id: + type: string + title: id + description: The attribute's ID. + value: + type: string + title: value + description: The attribute's value. + label: + type: string + title: label + description: The attribute's label. + field_type: + type: string + title: field_type + description: The attribute's field type. + required: + type: boolean + title: required + description: The attribute's required. + disguised: + type: boolean + title: disguised + description: The attribute's disguised. + operators: + type: array + description: The attribute's operators. + items: + $ref: '#/components/schemas/BaseRuleOperatorOptions' + AdminRuleValueOption: + type: object + description: The value's values. + x-schemaName: AdminRuleValueOption + required: + - id + - value + - label + properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value's details. + label: + type: string + title: label + description: The value's label. AdminSalesChannel: type: object description: The sales channel's sales channels. @@ -45096,6 +54505,40 @@ components: format: date-time title: deleted_at description: The sales channel's deleted at. + AdminSalesChannelDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminSalesChannelDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The sales channel's ID. + object: + type: string + title: object + description: The sales channel's object. + default: sales-channel + deleted: + type: boolean + title: deleted + description: The sales channel's deleted. + parent: + type: object + description: The sales channel's parent. + AdminSalesChannelResponse: + type: object + description: SUMMARY + x-schemaName: AdminSalesChannelResponse + required: + - sales_channel + properties: + sales_channel: + $ref: '#/components/schemas/AdminSalesChannel' AdminServiceZone: type: object description: The service zone's service zones. @@ -45104,6 +54547,7 @@ components: - id - name - fulfillment_set_id + - fulfillment_set - geo_zones - shipping_options - created_at @@ -45122,6 +54566,8 @@ components: type: string title: fulfillment_set_id description: The service zone's fulfillment set id. + fulfillment_set: + type: object geo_zones: type: array description: The service zone's geo zones. @@ -45194,6 +54640,62 @@ components: properties: shipping_option: $ref: '#/components/schemas/AdminShippingOption' + AdminShippingOptionRule: + type: object + description: The updated's details. + x-schemaName: AdminShippingOptionRule + required: + - id + - attribute + - operator + - value + - shipping_option_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The updated's ID. + attribute: + type: string + title: attribute + description: The updated's attribute. + operator: + type: string + title: operator + description: The updated's operator. + value: + oneOf: + - type: string + title: value + description: The updated's value. + - type: array + description: The updated's value. + items: + type: string + title: value + description: The value's details. + shipping_option_id: + type: string + title: shipping_option_id + description: The updated's shipping option id. + created_at: + type: string + format: date-time + title: created_at + description: The updated's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The updated's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The updated's deleted at. AdminShippingProfile: type: object description: The shipping option's shipping profile. @@ -45232,6 +54734,504 @@ components: properties: shipping_profile: $ref: '#/components/schemas/AdminShippingProfile' + AdminStockLocation: + type: object + description: The fulfillment set's location. + x-schemaName: AdminStockLocation + required: + - id + - name + - address_id + properties: + id: + type: string + title: id + description: The location's ID. + name: + type: string + title: name + description: The location's name. + address_id: + type: string + title: address_id + description: The location's address id. + address: + $ref: '#/components/schemas/AdminStockLocationAddress' + sales_channels: + type: array + description: The location's sales channels. + items: + $ref: '#/components/schemas/AdminSalesChannel' + fulfillment_providers: + type: array + description: The location's fulfillment providers. + items: + $ref: '#/components/schemas/AdminFulfillmentProvider' + fulfillment_sets: + type: array + description: The location's fulfillment sets. + items: + type: object + AdminStockLocationAddress: + type: object + description: The location's address. + x-schemaName: AdminStockLocationAddress + AdminStockLocationDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminStockLocationDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The stock location's ID. + object: + type: string + title: object + description: The stock location's object. + default: stock_location + deleted: + type: boolean + title: deleted + description: The stock location's deleted. + parent: + type: object + description: The stock location's parent. + AdminStockLocationListResponse: + type: object + description: SUMMARY + x-schemaName: AdminStockLocationListResponse + required: + - limit + - offset + - count + - stock_locations + properties: + limit: + type: number + title: limit + description: The stock location's limit. + offset: + type: number + title: offset + description: The stock location's offset. + count: + type: number + title: count + description: The stock location's count. + stock_locations: + type: array + description: The stock location's stock locations. + items: + $ref: '#/components/schemas/AdminStockLocation' + AdminStockLocationResponse: + type: object + description: SUMMARY + x-schemaName: AdminStockLocationResponse + required: + - stock_location + properties: + stock_location: + $ref: '#/components/schemas/AdminStockLocation' + AdminStore: + type: object + description: The store's details. + x-schemaName: AdminStore + required: + - id + - name + - supported_currencies + - default_sales_channel_id + - default_region_id + - default_location_id + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The store's ID. + name: + type: string + title: name + description: The store's name. + supported_currencies: + type: array + description: The store's supported currencies. + items: + $ref: '#/components/schemas/AdminStoreCurrency' + default_sales_channel_id: + type: string + title: default_sales_channel_id + description: The store's default sales channel id. + default_region_id: + type: string + title: default_region_id + description: The store's default region id. + default_location_id: + type: string + title: default_location_id + description: The store's default location id. + metadata: + type: object + description: The store's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The store's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The store's updated at. + AdminStoreCurrency: + type: object + description: The supported currency's supported currencies. + x-schemaName: AdminStoreCurrency + required: + - id + - currency_code + - store_id + - is_default + - currency + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The supported currency's ID. + currency_code: + type: string + title: currency_code + description: The supported currency's currency code. + store_id: + type: string + title: store_id + description: The supported currency's store id. + is_default: + type: boolean + title: is_default + description: The supported currency's is default. + currency: + $ref: '#/components/schemas/AdminCurrency' + created_at: + type: string + format: date-time + title: created_at + description: The supported currency's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The supported currency's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The supported currency's deleted at. + AdminStoreListResponse: + type: object + description: SUMMARY + x-schemaName: AdminStoreListResponse + required: + - limit + - offset + - count + - stores + properties: + limit: + type: number + title: limit + description: The store's limit. + offset: + type: number + title: offset + description: The store's offset. + count: + type: number + title: count + description: The store's count. + stores: + type: array + description: The store's stores. + items: + $ref: '#/components/schemas/AdminStore' + AdminStoreResponse: + type: object + description: SUMMARY + x-schemaName: AdminStoreResponse + required: + - store + properties: + store: + $ref: '#/components/schemas/AdminStore' + AdminTaxRate: + type: object + description: The tax rate's details. + x-schemaName: AdminTaxRate + required: + - id + - rate + - code + - name + - metadata + - tax_region_id + - is_combinable + - is_default + - created_at + - updated_at + - deleted_at + - created_by + - tax_region + - rules + properties: + id: + type: string + title: id + description: The tax rate's ID. + rate: + type: number + title: rate + description: The tax rate's rate. + code: + type: string + title: code + description: The tax rate's code. + name: + type: string + title: name + description: The tax rate's name. + metadata: + type: object + description: The tax rate's metadata. + tax_region_id: + type: string + title: tax_region_id + description: The tax rate's tax region id. + is_combinable: + type: boolean + title: is_combinable + description: The tax rate's is combinable. + is_default: + type: boolean + title: is_default + description: The tax rate's is default. + created_at: + type: string + format: date-time + title: created_at + description: The tax rate's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax rate's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The tax rate's deleted at. + created_by: + type: string + title: created_by + description: The tax rate's created by. + tax_region: + $ref: '#/components/schemas/AdminTaxRegion' + rules: + type: array + description: The tax rate's rules. + items: + $ref: '#/components/schemas/AdminTaxRateRule' + AdminTaxRateDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminTaxRateDeleteResponse + 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. + default: tax_rate + deleted: + type: boolean + title: deleted + description: The tax rate's deleted. + parent: + type: object + description: The tax rate's parent. + AdminTaxRateResponse: + type: object + description: SUMMARY + x-schemaName: AdminTaxRateResponse + required: + - tax_rate + properties: + tax_rate: + $ref: '#/components/schemas/AdminTaxRate' + AdminTaxRateRule: + type: object + description: The rule's rules. + x-schemaName: AdminTaxRateRule + 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. + AdminTaxRegion: + type: object + description: The tax rate's tax region. + x-schemaName: AdminTaxRegion + required: + - id + - rate + - code + - country_code + - province_code + - name + - metadata + - tax_region_id + - is_combinable + - is_default + - parent_id + - created_at + - updated_at + - deleted_at + - created_by + - tax_rates + - parent + - children + properties: + id: + type: string + title: id + description: The tax region's ID. + rate: + type: number + title: rate + description: The tax region's rate. + code: + type: string + title: code + description: The tax region's code. + country_code: + type: string + title: country_code + description: The tax region's country code. + province_code: + type: string + title: province_code + description: The tax region's province code. + name: + type: string + title: name + description: The tax region's name. + metadata: + type: object + description: The tax region's metadata. + tax_region_id: + type: string + title: tax_region_id + description: The tax region's tax region id. + is_combinable: + type: boolean + title: is_combinable + description: The tax region's is combinable. + is_default: + type: boolean + title: is_default + description: The tax region's is default. + parent_id: + type: string + title: parent_id + description: The tax region's parent id. + created_at: + type: string + format: date-time + title: created_at + description: The tax region's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax region's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The tax region's deleted at. + created_by: + type: string + title: created_by + description: The tax region's created by. + tax_rates: + type: array + description: The tax region's tax rates. + items: + type: object + parent: + type: object + children: + type: array + description: The tax region's children. + items: + type: object + AdminTaxRegionDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminTaxRegionDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The tax region's ID. + object: + type: string + title: object + description: The tax region's object. + default: tax_region + deleted: + type: boolean + title: deleted + description: The tax region's deleted. + parent: + type: object + description: The tax region's parent. + AdminTaxRegionResponse: + type: object + description: SUMMARY + x-schemaName: AdminTaxRegionResponse + required: + - tax_region + properties: + tax_region: + $ref: '#/components/schemas/AdminTaxRegion' AdminUpdateApiKey: type: object description: SUMMARY @@ -45243,60 +55243,6 @@ components: type: string title: title description: The api key's title. - AdminUpdateCampaign: - type: object - description: SUMMARY - x-schemaName: AdminUpdateCampaign - required: - - description - - starts_at - - ends_at - properties: - name: - type: string - title: name - description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. - description: - type: string - title: description - description: The campaign's description. - budget: - type: object - description: The campaign's budget. - required: - - limit - properties: - limit: - type: number - title: limit - description: The budget's limit. - 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 - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. AdminUpdateCollection: type: object description: SUMMARY @@ -45315,42 +55261,6 @@ components: metadata: type: object description: The collection's metadata. - AdminUpdateCustomer: - type: object - description: SUMMARY - x-schemaName: AdminUpdateCustomer - required: - - email - - company_name - - first_name - - last_name - - phone - - metadata - properties: - email: - type: string - title: email - description: The customer's email. - format: email - company_name: - type: string - title: company_name - description: The customer's company name. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - phone: - type: string - title: phone - description: The customer's phone. - metadata: - type: object - description: The customer's metadata. AdminUpdateCustomerGroup: type: object description: SUMMARY @@ -45500,15 +55410,13 @@ components: items: type: object description: The tag's tags. + required: + - id properties: id: type: string title: id description: The tag's ID. - value: - type: string - title: value - description: The tag's value. options: type: array description: The update's options. @@ -45518,7 +55426,168 @@ components: type: array description: The update's variants. items: - $ref: '#/components/schemas/AdminCreateProductVariant' + oneOf: + - type: object + description: The variant's variants. + x-schemaName: AdminCreateProductVariant + required: + - title + - prices + properties: + title: + type: string + title: title + description: The variant's title. + sku: + type: string + title: sku + description: The variant's sku. + ean: + type: string + title: ean + description: The variant's ean. + upc: + type: string + title: upc + description: The variant's upc. + barcode: + type: string + title: barcode + description: The variant's barcode. + hs_code: + type: string + title: hs_code + description: The variant's hs code. + mid_code: + type: string + title: mid_code + description: The variant's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + weight: + type: number + title: weight + description: The variant's weight. + length: + type: number + title: length + description: The variant's length. + height: + type: number + title: height + description: The variant's height. + width: + type: number + title: width + description: The variant's width. + origin_country: + type: string + title: origin_country + description: The variant's origin country. + material: + type: string + title: material + description: The variant's material. + metadata: + type: object + description: The variant's metadata. + prices: + type: array + description: The variant's prices. + items: + $ref: '#/components/schemas/AdminCreateProductVariantPrice' + options: + type: object + description: The variant's options. + - type: object + description: The variant's variants. + x-schemaName: AdminUpdateProductVariant + properties: + title: + type: string + title: title + description: The variant's title. + sku: + type: string + title: sku + description: The variant's sku. + ean: + type: string + title: ean + description: The variant's ean. + upc: + type: string + title: upc + description: The variant's upc. + barcode: + type: string + title: barcode + description: The variant's barcode. + hs_code: + type: string + title: hs_code + description: The variant's hs code. + mid_code: + type: string + title: mid_code + description: The variant's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + weight: + type: number + title: weight + description: The variant's weight. + length: + type: number + title: length + description: The variant's length. + height: + type: number + title: height + description: The variant's height. + width: + type: number + title: width + description: The variant's width. + origin_country: + type: string + title: origin_country + description: The variant's origin country. + material: + type: string + title: material + description: The variant's material. + metadata: + type: object + description: The variant's metadata. + prices: + type: array + description: The variant's prices. + items: + $ref: '#/components/schemas/AdminCreateProductVariantPrice' + options: + type: object + description: The variant's options. sales_channels: type: array description: The update's sales channels. @@ -45881,9 +55950,303 @@ components: type: number title: required_quantity description: The product's required quantity. + AdminUser: + type: object + description: The user's details. + x-schemaName: AdminUser + required: + - id + - email + - first_name + - last_name + - avatar_url + - metadata + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The user's ID. + email: + type: string + title: email + description: The user's email. + format: email + first_name: + type: string + title: first_name + description: The user's first name. + last_name: + type: string + title: last_name + description: The user's last name. + avatar_url: + type: string + title: avatar_url + description: The user's avatar url. + metadata: + type: object + description: The user's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The user's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The user's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The user's deleted at. + AdminUserDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminUserDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The user's ID. + object: + type: string + title: object + description: The user's object. + default: user + deleted: + type: boolean + title: deleted + description: The user's deleted. + parent: + type: object + description: The user's parent. + AdminUserListResponse: + type: object + description: SUMMARY + x-schemaName: AdminUserListResponse + required: + - limit + - offset + - count + - users + properties: + limit: + type: number + title: limit + description: The user's limit. + offset: + type: number + title: offset + description: The user's offset. + count: + type: number + title: count + description: The user's count. + users: + type: array + description: The user's users. + items: + $ref: '#/components/schemas/AdminUser' + AdminUserResponse: + type: object + description: SUMMARY + x-schemaName: AdminUserResponse + required: + - user + properties: + user: + $ref: '#/components/schemas/AdminUser' + AdminWorkflowExecution: + type: object + description: The workflows execution's workflow execution. + x-schemaName: AdminWorkflowExecution + required: + - id + - workflow_id + - transaction_id + - execution + - context + - state + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The workflow execution's ID. + workflow_id: + type: string + title: workflow_id + description: The workflow execution's workflow id. + transaction_id: + type: string + title: transaction_id + description: The workflow execution's transaction id. + execution: + type: string + title: execution + description: The workflow execution's execution. + context: + type: string + title: context + description: The workflow execution's context. + state: {} + created_at: + type: string + title: created_at + description: The workflow execution's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The workflow execution's updated at. + format: date-time + deleted_at: + type: string + title: deleted_at + description: The workflow execution's deleted at. + format: date-time + AdminWorkflowExecutionResponse: + type: object + description: SUMMARY + x-schemaName: AdminWorkflowExecutionResponse + required: + - workflow_execution + properties: + workflow_execution: + $ref: '#/components/schemas/AdminWorkflowExecution' + ApiKeyResponse: + type: object + description: The api key's details. + x-schemaName: ApiKeyResponse + required: + - id + - token + - redacted + - title + - type + - last_used_at + - created_by + - created_at + - revoked_by + - revoked_at + properties: + id: + type: string + title: id + description: The api key's ID. + token: + type: string + title: token + description: The api key's token. + redacted: + type: string + title: redacted + description: The api key's redacted. + title: + type: string + title: title + description: The api key's title. + type: + type: string + enum: + - secret + - publishable + last_used_at: + type: string + title: last_used_at + description: The api key's last used at. + format: date-time + created_by: + type: string + title: created_by + description: The api key's created by. + created_at: + type: string + title: created_at + description: The api key's created at. + format: date-time + revoked_by: + type: string + title: revoked_by + description: The api key's revoked by. + revoked_at: + type: string + title: revoked_at + description: The api key's revoked at. + format: date-time + BaseApplicationMethod: + type: object + description: The promotion's application method. + x-schemaName: BaseApplicationMethod + required: + - id + properties: + id: + type: string + title: id + description: The application method's ID. + type: + type: string + enum: + - fixed + - percentage + target_type: + type: string + enum: + - items + - shipping_methods + - order + allocation: + type: string + enum: + - each + - across + 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. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The application method's buy rules min quantity. + apply_to_quantity: + type: number + title: apply_to_quantity + description: The application method's apply to quantity. + promotion: + $ref: '#/components/schemas/BasePromotion' + target_rules: + type: array + description: The application method's target rules. + items: + $ref: '#/components/schemas/BasePromotionRule' + buy_rules: + type: array + description: The application method's buy rules. + items: + $ref: '#/components/schemas/BasePromotionRule' BaseCalculatedPriceSet: type: object - description: The updated's calculated price. + description: The parent's calculated price. x-schemaName: BaseCalculatedPriceSet required: - id @@ -45937,6 +56300,630 @@ components: original_price: type: object description: The calculated price's original price. + BaseCapture: + type: object + description: The capture's captures. + x-schemaName: BaseCapture + BaseCart: + type: object + description: The item's cart. + x-schemaName: BaseCart + BaseCartAddress: + type: object + description: The cart's billing address. + x-schemaName: BaseCartAddress + required: + - id + - created_at + - updated_at + properties: + 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. + BaseCartLineItem: + type: object + description: The item's items. + x-schemaName: BaseCartLineItem + required: + - id + - title + - quantity + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - cart + - cart_id + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + quantity: + oneOf: + - type: string + title: quantity + description: The item's quantity. + - type: number + title: quantity + description: The item's quantity. + - type: string + title: quantity + description: The item's quantity. + - $ref: '#/components/schemas/IBigNumber' + product: + $ref: '#/components/schemas/BaseProduct' + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant: + $ref: '#/components/schemas/BaseProductVariant' + variant_id: + type: string + title: variant_id + description: The item's variant id. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + oneOf: + - type: string + title: compare_at_unit_price + description: The item's compare at unit price. + - type: number + title: compare_at_unit_price + description: The item's compare at unit price. + - type: string + title: compare_at_unit_price + description: The item's compare at unit price. + - $ref: '#/components/schemas/IBigNumber' + unit_price: + oneOf: + - type: string + title: unit_price + description: The item's unit price. + - type: number + title: unit_price + description: The item's unit price. + - type: string + title: unit_price + description: The item's unit price. + - $ref: '#/components/schemas/IBigNumber' + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: '#/components/schemas/BaseLineItemTaxLine' + adjustments: + type: array + description: The item's adjustments. + items: + $ref: '#/components/schemas/BaseLineItemAdjustment' + cart: + $ref: '#/components/schemas/BaseCart' + cart_id: + type: string + title: cart_id + description: The item's cart id. + metadata: + type: object + description: The item's metadata. + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + deleted_at: + type: string + title: deleted_at + description: The item's deleted at. + format: date-time + original_total: + oneOf: + - type: string + title: original_total + description: The item's original total. + - type: number + title: original_total + description: The item's original total. + - type: string + title: original_total + description: The item's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The item's original subtotal. + - type: number + title: original_subtotal + description: The item's original subtotal. + - type: string + title: original_subtotal + description: The item's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The item's original tax total. + - type: number + title: original_tax_total + description: The item's original tax total. + - type: string + title: original_tax_total + description: The item's original tax total. + - $ref: '#/components/schemas/IBigNumber' + item_total: + oneOf: + - type: string + title: item_total + description: The item's item total. + - type: number + title: item_total + description: The item's item total. + - type: string + title: item_total + description: The item's item total. + - $ref: '#/components/schemas/IBigNumber' + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The item's item subtotal. + - type: number + title: item_subtotal + description: The item's item subtotal. + - type: string + title: item_subtotal + description: The item's item subtotal. + - $ref: '#/components/schemas/IBigNumber' + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The item's item tax total. + - type: number + title: item_tax_total + description: The item's item tax total. + - type: string + title: item_tax_total + description: The item's item tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The item's total. + - type: number + title: total + description: The item's total. + - type: string + title: total + description: The item's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The item's subtotal. + - type: number + title: subtotal + description: The item's subtotal. + - type: string + title: subtotal + description: The item's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The item's tax total. + - type: number + title: tax_total + description: The item's tax total. + - type: string + title: tax_total + description: The item's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The item's discount total. + - type: number + title: discount_total + description: The item's discount total. + - type: string + title: discount_total + description: The item's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The item's discount tax total. + - type: number + title: discount_tax_total + description: The item's discount tax total. + - type: string + title: discount_tax_total + description: The item's discount tax total. + - $ref: '#/components/schemas/IBigNumber' + BaseCartShippingMethod: + type: object + description: The shipping method's shipping methods. + x-schemaName: BaseCartShippingMethod + required: + - id + - cart_id + - name + - amount + - is_tax_inclusive + - created_at + - updated_at + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + properties: + id: + type: string + title: id + description: The shipping method's ID. + cart_id: + type: string + title: cart_id + description: The shipping method's cart id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + oneOf: + - type: string + title: amount + description: The shipping method's amount. + - type: number + title: amount + description: The shipping method's amount. + - type: string + title: amount + description: The shipping method's amount. + - $ref: '#/components/schemas/IBigNumber' + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: '#/components/schemas/BaseShippingMethodTaxLine' + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: '#/components/schemas/BaseShippingMethodAdjustment' + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: discount_tax_total + description: The shipping method's discount tax total. + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - $ref: '#/components/schemas/IBigNumber' + BaseClaim: + type: object + description: The order change's claim. + x-schemaName: BaseClaim + BaseClaimItem: + type: object + description: The claim item's claim items. + x-schemaName: BaseClaimItem + required: + - id + - claim_id + - order_id + - item_id + - quantity + - reason + - raw_quantity + properties: + id: + type: string + title: id + description: The claim item's ID. + claim_id: + type: string + title: claim_id + description: The claim item's claim id. + order_id: + type: string + title: order_id + description: The claim item's order id. + item_id: + type: string + title: item_id + description: The claim item's item id. + quantity: + type: number + title: quantity + description: The claim item's quantity. + reason: + type: string + enum: + - missing_item + - wrong_item + - production_failure + - other + raw_quantity: + type: object + description: The claim item's raw quantity. + metadata: + type: object + description: The claim item's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The claim item's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The claim item's updated at. BaseCollection: type: object description: The product's collection. @@ -46042,9 +57029,1041 @@ components: format: date-time title: updated_at description: The address's updated at. + BaseExchangeItem: + type: object + description: The additional item's additional items. + x-schemaName: BaseExchangeItem + required: + - id + - exchange_id + - order_id + - item_id + - quantity + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The additional item's ID. + exchange_id: + type: string + title: exchange_id + description: The additional item's exchange id. + order_id: + type: string + title: order_id + description: The additional item's order id. + item_id: + type: string + title: item_id + description: The additional item's item id. + quantity: + type: number + title: quantity + description: The additional item's quantity. + metadata: + type: object + description: The additional item's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The additional item's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The additional item's updated at. + BaseFulfillmentProvider: + type: object + description: The shipping option's provider. + x-schemaName: BaseFulfillmentProvider + required: + - id + - is_enabled + properties: + id: + type: string + title: id + description: The provider's ID. + is_enabled: + type: boolean + title: is_enabled + description: The provider's is enabled. + BaseLineItemAdjustment: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseLineItemAdjustment + BaseLineItemTaxLine: + type: object + description: The tax line's tax lines. + x-schemaName: BaseLineItemTaxLine + BaseOrder: + type: object + description: The order change's order. + x-schemaName: BaseOrder + BaseOrderAddress: + type: object + description: The order's billing address. + x-schemaName: BaseOrderAddress + required: + - id + - metadata + - created_at + - updated_at + properties: + 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. + BaseOrderChange: + type: object + description: The order preview's order change. + x-schemaName: BaseOrderChange + required: + - id + - order_id + - actions + - status + - requested_by + - requested_at + - confirmed_by + - confirmed_at + - declined_by + - declined_reason + - metadata + - declined_at + - canceled_by + - canceled_at + - created_at + - updated_at + - version + - return_id + - exchange_id + - claim_id + - order + - return_order + - exchange + - claim + properties: + id: + type: string + title: id + description: The order change's ID. + order_id: + type: string + title: order_id + description: The order change's order id. + actions: + type: array + description: The order change's actions. + items: + $ref: '#/components/schemas/BaseOrderChangeAction' + status: + type: string + title: status + description: The order change's status. + requested_by: + type: string + title: requested_by + description: The order change's requested by. + requested_at: + oneOf: + - type: string + title: requested_at + description: The order change's requested at. + - type: string + title: requested_at + description: The order change's requested at. + format: date-time + confirmed_by: + type: string + title: confirmed_by + description: The order change's confirmed by. + confirmed_at: + oneOf: + - type: string + title: confirmed_at + description: The order change's confirmed at. + - type: string + title: confirmed_at + description: The order change's confirmed at. + format: date-time + declined_by: + type: string + title: declined_by + description: The order change's declined by. + declined_reason: + type: string + title: declined_reason + description: The order change's declined reason. + metadata: + type: object + description: The order change's metadata. + declined_at: + oneOf: + - type: string + title: declined_at + description: The order change's declined at. + - type: string + title: declined_at + description: The order change's declined at. + format: date-time + canceled_by: + type: string + title: canceled_by + description: The order change's canceled by. + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order change's canceled at. + - type: string + title: canceled_at + description: The order change's canceled at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The order change's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order change's updated at. + version: + type: number + title: version + description: The order change's version. + change_type: + type: string + enum: + - return + - exchange + - claim + - edit + return_id: + type: string + title: return_id + description: The order change's return id. + exchange_id: + type: string + title: exchange_id + description: The order change's exchange id. + claim_id: + type: string + title: claim_id + description: The order change's claim id. + order: + $ref: '#/components/schemas/BaseOrder' + return_order: {} + exchange: {} + claim: + $ref: '#/components/schemas/BaseClaim' + BaseOrderChangeAction: + type: object + description: The action's actions. + x-schemaName: BaseOrderChangeAction + BaseOrderFulfillment: + type: object + description: The fulfillment's fulfillments. + x-schemaName: BaseOrderFulfillment + required: + - id + - location_id + - packed_at + - shipped_at + - delivered_at + - canceled_at + - data + - provider_id + - shipping_option_id + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The fulfillment's ID. + location_id: + type: string + title: location_id + description: The fulfillment's location id. + packed_at: + type: string + title: packed_at + description: The fulfillment's packed at. + format: date-time + shipped_at: + type: string + title: shipped_at + description: The fulfillment's shipped at. + format: date-time + delivered_at: + type: string + title: delivered_at + description: The fulfillment's delivered at. + format: date-time + canceled_at: + type: string + title: canceled_at + description: The fulfillment's canceled at. + format: date-time + data: + type: object + description: The fulfillment's data. + provider_id: + type: string + title: provider_id + description: The fulfillment's provider id. + shipping_option_id: + type: string + title: shipping_option_id + description: The fulfillment's shipping option id. + metadata: + type: object + description: The fulfillment's metadata. + created_at: + type: string + title: created_at + description: The fulfillment's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The fulfillment's updated at. + format: date-time + BaseOrderItemDetail: + type: object + description: The item's detail. + x-schemaName: BaseOrderItemDetail + BaseOrderLineItem: + type: object + description: The item's items. + x-schemaName: BaseOrderLineItem + required: + - id + - title + - subtitle + - thumbnail + - variant_id + - product_id + - product_title + - product_description + - product_subtitle + - product_type + - product_collection + - product_handle + - variant_sku + - variant_barcode + - variant_title + - variant_option_values + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - detail + - created_at + - updated_at + - metadata + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant: + $ref: '#/components/schemas/BaseProductVariant' + variant_id: + type: string + title: variant_id + description: The item's variant id. + product: + $ref: '#/components/schemas/BaseProduct' + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: '#/components/schemas/BaseOrderLineItemTaxLine' + adjustments: + type: array + description: The item's adjustments. + items: + $ref: '#/components/schemas/BaseOrderLineItemAdjustment' + detail: + $ref: '#/components/schemas/BaseOrderItemDetail' + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + metadata: + type: object + description: The item's metadata. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + BaseOrderLineItemAdjustment: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + BaseOrderLineItemTaxLine: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + BaseOrderShippingMethod: + type: object + description: The shipping method's shipping methods. + x-schemaName: BaseOrderShippingMethod + required: + - id + - order_id + - name + - amount + - is_tax_inclusive + - shipping_option_id + - data + - metadata + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: '#/components/schemas/BaseOrderShippingMethodTaxLine' + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: '#/components/schemas/BaseOrderShippingMethodAdjustment' + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: discount_tax_total + description: The shipping method's discount tax total. + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - $ref: '#/components/schemas/IBigNumber' + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + BaseOrderShippingMethodAdjustment: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + BaseOrderShippingMethodTaxLine: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + BaseOrderSummary: + type: object + description: The order's summary. + x-schemaName: BaseOrderSummary + required: + - total + - subtotal + - total_tax + - ordered_total + - fulfilled_total + - returned_total + - return_request_total + - write_off_total + - projected_total + - net_total + - net_subtotal + - net_total_tax + - balance + - paid_total + - refunded_total + properties: + total: + type: number + title: total + description: The summary's total. + subtotal: + type: number + title: subtotal + description: The summary's subtotal. + total_tax: + type: number + title: total_tax + description: The summary's total tax. + ordered_total: + type: number + title: ordered_total + description: The summary's ordered total. + fulfilled_total: + type: number + title: fulfilled_total + description: The summary's fulfilled total. + returned_total: + type: number + title: returned_total + description: The summary's returned total. + return_request_total: + type: number + title: return_request_total + description: The summary's return request total. + write_off_total: + type: number + title: write_off_total + description: The summary's write off total. + projected_total: + type: number + title: projected_total + description: The summary's projected total. + net_total: + type: number + title: net_total + description: The summary's net total. + net_subtotal: + type: number + title: net_subtotal + description: The summary's net subtotal. + net_total_tax: + type: number + title: net_total_tax + description: The summary's net total tax. + balance: + type: number + title: balance + description: The summary's balance. + paid_total: + type: number + title: paid_total + description: The summary's paid total. + refunded_total: + type: number + title: refunded_total + description: The summary's refunded total. + BaseOrderTransaction: + type: object + description: The transaction's transactions. + x-schemaName: BaseOrderTransaction + required: + - id + - order_id + - amount + - currency_code + - reference + - reference_id + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The transaction's ID. + order_id: + type: string + title: order_id + description: The transaction's order id. + amount: + type: number + title: amount + description: The transaction's amount. + currency_code: + type: string + title: currency_code + description: The transaction's currency code. + reference: + type: string + title: reference + description: The transaction's reference. + reference_id: + type: string + title: reference_id + description: The transaction's reference id. + metadata: + type: object + description: The transaction's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The transaction's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The transaction's updated at. + BasePayment: + type: object + description: The payment's payments. + x-schemaName: BasePayment + BasePaymentCollection: + type: object + description: The payment collection's payment collections. + x-schemaName: BasePaymentCollection + required: + - id + - currency_code + - region_id + - amount + - status + - payment_providers + properties: + id: + type: string + title: id + description: The payment collection's ID. + currency_code: + type: string + title: currency_code + description: The payment collection's currency code. + region_id: + type: string + title: region_id + description: The payment collection's region id. + amount: + oneOf: + - type: string + title: amount + description: The payment collection's amount. + - type: number + title: amount + description: The payment collection's amount. + - type: string + title: amount + description: The payment collection's amount. + - $ref: '#/components/schemas/IBigNumber' + authorized_amount: + oneOf: + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - type: number + title: authorized_amount + description: The payment collection's authorized amount. + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - $ref: '#/components/schemas/IBigNumber' + captured_amount: + oneOf: + - type: string + title: captured_amount + description: The payment collection's captured amount. + - type: number + title: captured_amount + description: The payment collection's captured amount. + - type: string + title: captured_amount + description: The payment collection's captured amount. + - $ref: '#/components/schemas/IBigNumber' + refunded_amount: + oneOf: + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - type: number + title: refunded_amount + description: The payment collection's refunded amount. + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - $ref: '#/components/schemas/IBigNumber' + completed_at: + oneOf: + - type: string + title: completed_at + description: The payment collection's completed at. + - type: string + title: completed_at + description: The payment collection's completed at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The payment collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The payment collection's updated at. + metadata: + type: object + description: The payment collection's metadata. + status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + payment_providers: + type: array + description: The payment collection's payment providers. + items: + $ref: '#/components/schemas/BasePaymentProvider' + payment_sessions: + type: array + description: The payment collection's payment sessions. + items: + $ref: '#/components/schemas/BasePaymentSession' + payments: + type: array + description: The payment collection's payments. + items: + $ref: '#/components/schemas/BasePayment' + BasePaymentProvider: + type: object + description: The payment provider's payment providers. + x-schemaName: BasePaymentProvider + BasePaymentSession: + type: object + description: The payment session's payment sessions. + x-schemaName: BasePaymentSession BaseProduct: type: object - description: The updated's product. + description: The parent's product. x-schemaName: BaseProduct required: - id @@ -46264,6 +58283,222 @@ components: type: object description: The variant's variants. x-schemaName: BaseProductVariant + BasePromotion: + type: object + description: The application method's promotion. + x-schemaName: BasePromotion + BasePromotionRule: + type: object + description: The rule's rules. + x-schemaName: BasePromotionRule + required: + - id + - values + properties: + id: + type: string + title: id + description: The rule's ID. + description: + type: string + title: description + description: The rule's description. + attribute: + type: string + title: attribute + description: The rule's attribute. + operator: + type: string + enum: + - gt + - lt + - eq + - ne + - in + - lte + - gte + values: + type: array + description: The rule's values. + items: + $ref: '#/components/schemas/BasePromotionRuleValue' + BasePromotionRuleValue: + type: object + description: The value's values. + x-schemaName: BasePromotionRuleValue + required: + - id + properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value's details. + BaseRefund: + type: object + description: The refund's refunds. + x-schemaName: BaseRefund + BaseRegion: + type: object + description: The cart's region. + x-schemaName: BaseRegion + required: + - id + - name + - currency_code + properties: + id: + type: string + title: id + description: The region's ID. + name: + type: string + title: name + description: The region's name. + currency_code: + type: string + title: currency_code + description: The region's currency code. + automatic_taxes: + type: boolean + title: automatic_taxes + description: The region's automatic taxes. + countries: + type: array + description: The region's countries. + items: + $ref: '#/components/schemas/BaseRegionCountry' + payment_providers: + type: array + description: The region's payment providers. + items: + $ref: '#/components/schemas/AdminPaymentProvider' + metadata: + type: object + description: The region's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The region's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The region's updated at. + BaseRegionCountry: + type: object + description: The country's countries. + x-schemaName: BaseRegionCountry + BaseReturnItem: + type: object + description: The item's items. + x-schemaName: BaseReturnItem + BaseRuleOperatorOptions: + type: object + description: The operator's operators. + x-schemaName: BaseRuleOperatorOptions + required: + - id + - value + - label + properties: + id: + type: string + title: id + description: The operator's ID. + value: + type: string + title: value + description: The operator's value. + label: + type: string + title: label + description: The operator's label. + BaseShippingMethodAdjustment: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseShippingMethodAdjustment + BaseShippingMethodTaxLine: + type: object + description: The tax line's tax lines. + x-schemaName: BaseShippingMethodTaxLine + CampaignResponse: + type: object + description: The campaign's details. + x-schemaName: CampaignResponse + required: + - id + - name + - description + - currency + - campaign_identifier + - starts_at + - ends_at + - budget + properties: + id: + type: string + title: id + description: The campaign's ID. + 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. + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + budget: + type: object + description: The campaign's budget. + required: + - id + - type + - currency_code + - limit + - used + properties: + id: + type: string + title: id + description: The budget's ID. + type: + type: string + 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. + used: + type: number + title: used + description: The budget's used. CreateAddress: type: object description: The cart's shipping address. @@ -46462,67 +58697,6 @@ components: metadata: type: object description: The item's metadata. - CreateCartWorkflowInput: - type: object - description: SUMMARY - x-schemaName: CreateCartWorkflowInput - properties: - region_id: - type: string - title: region_id - description: The cart's region id. - customer_id: - type: string - title: customer_id - description: The cart's customer id. - sales_channel_id: - type: string - title: sales_channel_id - description: The cart's sales channel id. - email: - type: string - title: email - description: The cart's email. - format: email - currency_code: - type: string - title: currency_code - description: The cart's currency code. - shipping_address_id: - type: string - title: shipping_address_id - description: The cart's shipping address id. - billing_address_id: - type: string - title: billing_address_id - description: The cart's billing address id. - shipping_address: - oneOf: - - type: string - title: shipping_address - description: The cart's shipping address. - - $ref: '#/components/schemas/CreateCartAddress' - billing_address: - oneOf: - - type: string - title: billing_address - description: The cart's billing address. - - $ref: '#/components/schemas/CreateCartAddress' - metadata: - type: object - description: The cart's metadata. - items: - type: array - description: The cart's items. - items: - $ref: '#/components/schemas/CreateCartCreateLineItem' - promo_codes: - type: array - description: The cart's promo codes. - items: - type: string - title: promo_codes - description: The promo code's promo codes. CreateOrderReturnReason: type: object description: SUMMARY @@ -46657,6 +58831,1962 @@ components: text: type: object description: The file's text. + IBigNumber: + type: object + description: The shipping method's discount tax total. + x-schemaName: IBigNumber + InventoryLevel: + type: object + description: The inventory level's inventory levels. + x-schemaName: InventoryLevel + required: + - id + - inventory_item_id + - location_id + - stocked_quantity + - reserved_quantity + - available_quantity + - incoming_quantity + properties: + id: + type: string + title: id + description: The inventory level's ID. + inventory_item_id: + type: string + title: inventory_item_id + description: The inventory level's inventory item id. + location_id: + type: string + title: location_id + description: The inventory level's location id. + stocked_quantity: + type: number + title: stocked_quantity + description: The inventory level's stocked quantity. + reserved_quantity: + type: number + title: reserved_quantity + description: The inventory level's reserved quantity. + available_quantity: + type: number + title: available_quantity + description: The inventory level's available quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The inventory level's incoming quantity. + metadata: + type: object + description: The inventory level's metadata. + Order: + type: object + description: The exchange's order preview. + x-schemaName: Order + required: + - id + - version + - status + - currency_code + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total + - raw_original_item_total + - raw_original_item_subtotal + - raw_original_item_tax_total + - raw_item_total + - raw_item_subtotal + - raw_item_tax_total + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + - raw_gift_card_total + - raw_gift_card_tax_total + - raw_shipping_total + - raw_shipping_subtotal + - raw_shipping_tax_total + - raw_original_shipping_total + - raw_original_shipping_subtotal + - raw_original_shipping_tax_total + properties: + id: + type: string + title: id + description: The order preview's ID. + version: + type: number + title: version + description: The order preview's version. + order_change: + $ref: '#/components/schemas/OrderChange' + status: + type: string + enum: + - canceled + - requires_action + - pending + - completed + - draft + - archived + region_id: + type: string + title: region_id + description: The order preview's region id. + customer_id: + type: string + title: customer_id + description: The order preview's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order preview's sales channel id. + email: + type: string + title: email + description: The order preview's email. + format: email + currency_code: + type: string + title: currency_code + description: The order preview's currency code. + shipping_address: + $ref: '#/components/schemas/OrderAddress' + billing_address: + $ref: '#/components/schemas/OrderAddress' + items: + type: array + description: The order preview's items. + items: + $ref: '#/components/schemas/OrderLineItem' + shipping_methods: + type: array + description: The order preview's shipping methods. + items: + $ref: '#/components/schemas/OrderShippingMethod' + transactions: + type: array + description: The order preview's transactions. + items: + $ref: '#/components/schemas/OrderTransaction' + summary: + type: object + description: The order preview's summary. + required: + - total + - subtotal + - total_tax + - ordered_total + - fulfilled_total + - returned_total + - return_request_total + - write_off_total + - projected_total + - net_total + - net_subtotal + - net_total_tax + - balance + - paid_total + - refunded_total + properties: + total: + oneOf: + - type: string + title: total + description: The summary's total. + - type: number + title: total + description: The summary's total. + - type: string + title: total + description: The summary's total. + - type: object + description: The summary's total. + x-schemaName: IBigNumber + subtotal: + oneOf: + - type: string + title: subtotal + description: The summary's subtotal. + - type: number + title: subtotal + description: The summary's subtotal. + - type: string + title: subtotal + description: The summary's subtotal. + - type: object + description: The summary's subtotal. + x-schemaName: IBigNumber + total_tax: + oneOf: + - type: string + title: total_tax + description: The summary's total tax. + - type: number + title: total_tax + description: The summary's total tax. + - type: string + title: total_tax + description: The summary's total tax. + - type: object + description: The summary's total tax. + x-schemaName: IBigNumber + ordered_total: + oneOf: + - type: string + title: ordered_total + description: The summary's ordered total. + - type: number + title: ordered_total + description: The summary's ordered total. + - type: string + title: ordered_total + description: The summary's ordered total. + - type: object + description: The summary's ordered total. + x-schemaName: IBigNumber + fulfilled_total: + oneOf: + - type: string + title: fulfilled_total + description: The summary's fulfilled total. + - type: number + title: fulfilled_total + description: The summary's fulfilled total. + - type: string + title: fulfilled_total + description: The summary's fulfilled total. + - type: object + description: The summary's fulfilled total. + x-schemaName: IBigNumber + returned_total: + oneOf: + - type: string + title: returned_total + description: The summary's returned total. + - type: number + title: returned_total + description: The summary's returned total. + - type: string + title: returned_total + description: The summary's returned total. + - type: object + description: The summary's returned total. + x-schemaName: IBigNumber + return_request_total: + oneOf: + - type: string + title: return_request_total + description: The summary's return request total. + - type: number + title: return_request_total + description: The summary's return request total. + - type: string + title: return_request_total + description: The summary's return request total. + - type: object + description: The summary's return request total. + x-schemaName: IBigNumber + write_off_total: + oneOf: + - type: string + title: write_off_total + description: The summary's write off total. + - type: number + title: write_off_total + description: The summary's write off total. + - type: string + title: write_off_total + description: The summary's write off total. + - type: object + description: The summary's write off total. + x-schemaName: IBigNumber + projected_total: + oneOf: + - type: string + title: projected_total + description: The summary's projected total. + - type: number + title: projected_total + description: The summary's projected total. + - type: string + title: projected_total + description: The summary's projected total. + - type: object + description: The summary's projected total. + x-schemaName: IBigNumber + net_total: + oneOf: + - type: string + title: net_total + description: The summary's net total. + - type: number + title: net_total + description: The summary's net total. + - type: string + title: net_total + description: The summary's net total. + - type: object + description: The summary's net total. + x-schemaName: IBigNumber + net_subtotal: + oneOf: + - type: string + title: net_subtotal + description: The summary's net subtotal. + - type: number + title: net_subtotal + description: The summary's net subtotal. + - type: string + title: net_subtotal + description: The summary's net subtotal. + - type: object + description: The summary's net subtotal. + x-schemaName: IBigNumber + net_total_tax: + oneOf: + - type: string + title: net_total_tax + description: The summary's net total tax. + - type: number + title: net_total_tax + description: The summary's net total tax. + - type: string + title: net_total_tax + description: The summary's net total tax. + - type: object + description: The summary's net total tax. + x-schemaName: IBigNumber + balance: + oneOf: + - type: string + title: balance + description: The summary's balance. + - type: number + title: balance + description: The summary's balance. + - type: string + title: balance + description: The summary's balance. + - type: object + description: The summary's balance. + x-schemaName: IBigNumber + paid_total: + oneOf: + - type: string + title: paid_total + description: The summary's paid total. + - type: number + title: paid_total + description: The summary's paid total. + - type: string + title: paid_total + description: The summary's paid total. + - type: object + description: The summary's paid total. + x-schemaName: IBigNumber + refunded_total: + oneOf: + - type: string + title: refunded_total + description: The summary's refunded total. + - type: number + title: refunded_total + description: The summary's refunded total. + - type: string + title: refunded_total + description: The summary's refunded total. + - type: object + description: The summary's refunded total. + x-schemaName: IBigNumber + metadata: + type: object + description: The order preview's metadata. + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order preview's canceled at. + - type: string + title: canceled_at + description: The order preview's canceled at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The order preview's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order preview's updated at. + original_item_total: + oneOf: + - type: string + title: original_item_total + description: The order preview's original item total. + - type: number + title: original_item_total + description: The order preview's original item total. + - type: string + title: original_item_total + description: The order preview's original item total. + - $ref: '#/components/schemas/IBigNumber' + original_item_subtotal: + oneOf: + - type: string + title: original_item_subtotal + description: The order preview's original item subtotal. + - type: number + title: original_item_subtotal + description: The order preview's original item subtotal. + - type: string + title: original_item_subtotal + description: The order preview's original item subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_item_tax_total: + oneOf: + - type: string + title: original_item_tax_total + description: The order preview's original item tax total. + - type: number + title: original_item_tax_total + description: The order preview's original item tax total. + - type: string + title: original_item_tax_total + description: The order preview's original item tax total. + - $ref: '#/components/schemas/IBigNumber' + item_total: + oneOf: + - type: string + title: item_total + description: The order preview's item total. + - type: number + title: item_total + description: The order preview's item total. + - type: string + title: item_total + description: The order preview's item total. + - $ref: '#/components/schemas/IBigNumber' + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The order preview's item subtotal. + - type: number + title: item_subtotal + description: The order preview's item subtotal. + - type: string + title: item_subtotal + description: The order preview's item subtotal. + - $ref: '#/components/schemas/IBigNumber' + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The order preview's item tax total. + - type: number + title: item_tax_total + description: The order preview's item tax total. + - type: string + title: item_tax_total + description: The order preview's item tax total. + - $ref: '#/components/schemas/IBigNumber' + original_total: + oneOf: + - type: string + title: original_total + description: The order preview's original total. + - type: number + title: original_total + description: The order preview's original total. + - type: string + title: original_total + description: The order preview's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The order preview's original subtotal. + - type: number + title: original_subtotal + description: The order preview's original subtotal. + - type: string + title: original_subtotal + description: The order preview's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The order preview's original tax total. + - type: number + title: original_tax_total + description: The order preview's original tax total. + - type: string + title: original_tax_total + description: The order preview's original tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The order preview's total. + - type: number + title: total + description: The order preview's total. + - type: string + title: total + description: The order preview's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The order preview's subtotal. + - type: number + title: subtotal + description: The order preview's subtotal. + - type: string + title: subtotal + description: The order preview's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The order preview's tax total. + - type: number + title: tax_total + description: The order preview's tax total. + - type: string + title: tax_total + description: The order preview's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The order preview's discount total. + - type: number + title: discount_total + description: The order preview's discount total. + - type: string + title: discount_total + description: The order preview's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The order preview's discount tax total. + - type: number + title: discount_tax_total + description: The order preview's discount tax total. + - type: string + title: discount_tax_total + description: The order preview's discount tax total. + - $ref: '#/components/schemas/IBigNumber' + gift_card_total: + oneOf: + - type: string + title: gift_card_total + description: The order preview's gift card total. + - type: number + title: gift_card_total + description: The order preview's gift card total. + - type: string + title: gift_card_total + description: The order preview's gift card total. + - $ref: '#/components/schemas/IBigNumber' + gift_card_tax_total: + oneOf: + - type: string + title: gift_card_tax_total + description: The order preview's gift card tax total. + - type: number + title: gift_card_tax_total + description: The order preview's gift card tax total. + - type: string + title: gift_card_tax_total + description: The order preview's gift card tax total. + - $ref: '#/components/schemas/IBigNumber' + shipping_total: + oneOf: + - type: string + title: shipping_total + description: The order preview's shipping total. + - type: number + title: shipping_total + description: The order preview's shipping total. + - type: string + title: shipping_total + description: The order preview's shipping total. + - $ref: '#/components/schemas/IBigNumber' + shipping_subtotal: + oneOf: + - type: string + title: shipping_subtotal + description: The order preview's shipping subtotal. + - type: number + title: shipping_subtotal + description: The order preview's shipping subtotal. + - type: string + title: shipping_subtotal + description: The order preview's shipping subtotal. + - $ref: '#/components/schemas/IBigNumber' + shipping_tax_total: + oneOf: + - type: string + title: shipping_tax_total + description: The order preview's shipping tax total. + - type: number + title: shipping_tax_total + description: The order preview's shipping tax total. + - type: string + title: shipping_tax_total + description: The order preview's shipping tax total. + - $ref: '#/components/schemas/IBigNumber' + original_shipping_total: + oneOf: + - type: string + title: original_shipping_total + description: The order preview's original shipping total. + - type: number + title: original_shipping_total + description: The order preview's original shipping total. + - type: string + title: original_shipping_total + description: The order preview's original shipping total. + - $ref: '#/components/schemas/IBigNumber' + original_shipping_subtotal: + oneOf: + - type: string + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - type: number + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - type: string + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_shipping_tax_total: + oneOf: + - type: string + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - type: number + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - type: string + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - $ref: '#/components/schemas/IBigNumber' + raw_original_item_total: + type: object + description: The order preview's raw original item total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item total's value. + - type: number + title: value + description: The raw original item total's value. + raw_original_item_subtotal: + type: object + description: The order preview's raw original item subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item subtotal's value. + - type: number + title: value + description: The raw original item subtotal's value. + raw_original_item_tax_total: + type: object + description: The order preview's raw original item tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item tax total's value. + - type: number + title: value + description: The raw original item tax total's value. + raw_item_total: + type: object + description: The order preview's raw item total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item total's value. + - type: number + title: value + description: The raw item total's value. + raw_item_subtotal: + type: object + description: The order preview's raw item subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item subtotal's value. + - type: number + title: value + description: The raw item subtotal's value. + raw_item_tax_total: + type: object + description: The order preview's raw item tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item tax total's value. + - type: number + title: value + description: The raw item tax total's value. + raw_original_total: + type: object + description: The order preview's raw original total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original total's value. + - type: number + title: value + description: The raw original total's value. + raw_original_subtotal: + type: object + description: The order preview's raw original subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original subtotal's value. + - type: number + title: value + description: The raw original subtotal's value. + raw_original_tax_total: + type: object + description: The order preview's raw original tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original tax total's value. + - type: number + title: value + description: The raw original tax total's value. + raw_total: + type: object + description: The order preview's raw total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw total's value. + - type: number + title: value + description: The raw total's value. + raw_subtotal: + type: object + description: The order preview's raw subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw subtotal's value. + - type: number + title: value + description: The raw subtotal's value. + raw_tax_total: + type: object + description: The order preview's raw tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw tax total's value. + - type: number + title: value + description: The raw tax total's value. + raw_discount_total: + type: object + description: The order preview's raw discount total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw discount total's value. + - type: number + title: value + description: The raw discount total's value. + raw_discount_tax_total: + type: object + description: The order preview's raw discount tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw discount tax total's value. + - type: number + title: value + description: The raw discount tax total's value. + raw_gift_card_total: + type: object + description: The order preview's raw gift card total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw gift card total's value. + - type: number + title: value + description: The raw gift card total's value. + raw_gift_card_tax_total: + type: object + description: The order preview's raw gift card tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw gift card tax total's value. + - type: number + title: value + description: The raw gift card tax total's value. + raw_shipping_total: + type: object + description: The order preview's raw shipping total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping total's value. + - type: number + title: value + description: The raw shipping total's value. + raw_shipping_subtotal: + type: object + description: The order preview's raw shipping subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping subtotal's value. + - type: number + title: value + description: The raw shipping subtotal's value. + raw_shipping_tax_total: + type: object + description: The order preview's raw shipping tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping tax total's value. + - type: number + title: value + description: The raw shipping tax total's value. + raw_original_shipping_total: + type: object + description: The order preview's raw original shipping total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping total's value. + - type: number + title: value + description: The raw original shipping total's value. + raw_original_shipping_subtotal: + type: object + description: The order preview's raw original shipping subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping subtotal's value. + - type: number + title: value + description: The raw original shipping subtotal's value. + raw_original_shipping_tax_total: + type: object + description: The order preview's raw original shipping tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping tax total's value. + - type: number + title: value + description: The raw original shipping tax total's value. + OrderAddress: + type: object + description: The order preview's billing address. + x-schemaName: OrderAddress + required: + - id + - created_at + - updated_at + properties: + 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. + OrderChange: + type: object + description: The order preview's order change. + x-schemaName: OrderChange + required: + - id + - version + - order_id + - return_id + - exchange_id + - claim_id + - order + - return_order + - exchange + - claim + - actions + - status + - requested_by + - requested_at + - confirmed_by + - confirmed_at + - declined_by + - declined_reason + - metadata + - declined_at + - canceled_by + - canceled_at + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The order change's ID. + version: + type: number + title: version + description: The order change's version. + change_type: + type: string + enum: + - return + - exchange + - claim + - edit + order_id: + type: string + title: order_id + description: The order change's order id. + return_id: + type: string + title: return_id + description: The order change's return id. + exchange_id: + type: string + title: exchange_id + description: The order change's exchange id. + claim_id: + type: string + title: claim_id + description: The order change's claim id. + order: + type: object + return_order: + $ref: '#/components/schemas/Return' + exchange: + $ref: '#/components/schemas/OrderExchange' + claim: + $ref: '#/components/schemas/OrderClaim' + actions: + type: array + description: The order change's actions. + items: + $ref: '#/components/schemas/OrderChangeAction' + status: + type: string + title: status + description: The order change's status. + requested_by: + type: string + title: requested_by + description: The order change's requested by. + requested_at: + oneOf: + - type: string + title: requested_at + description: The order change's requested at. + - type: string + title: requested_at + description: The order change's requested at. + format: date-time + confirmed_by: + type: string + title: confirmed_by + description: The order change's confirmed by. + confirmed_at: + oneOf: + - type: string + title: confirmed_at + description: The order change's confirmed at. + - type: string + title: confirmed_at + description: The order change's confirmed at. + format: date-time + declined_by: + type: string + title: declined_by + description: The order change's declined by. + declined_reason: + type: string + title: declined_reason + description: The order change's declined reason. + metadata: + type: object + description: The order change's metadata. + declined_at: + oneOf: + - type: string + title: declined_at + description: The order change's declined at. + - type: string + title: declined_at + description: The order change's declined at. + format: date-time + canceled_by: + type: string + title: canceled_by + description: The order change's canceled by. + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order change's canceled at. + - type: string + title: canceled_at + description: The order change's canceled at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The order change's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order change's updated at. + OrderChangeAction: + type: object + description: The action's actions. + x-schemaName: OrderChangeAction + OrderClaim: + type: object + description: The order change's claim. + x-schemaName: OrderClaim + OrderExchange: + type: object + description: The order change's exchange. + x-schemaName: OrderExchange + OrderItem: + type: object + description: The item's detail. + x-schemaName: OrderItem + OrderLineItem: + type: object + description: The item's items. + x-schemaName: OrderLineItem + required: + - id + - title + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - raw_unit_price + - quantity + - raw_quantity + - detail + - created_at + - updated_at + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_item_total + - raw_item_subtotal + - raw_item_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + - raw_refundable_total + - raw_refundable_total_per_unit + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant_id: + type: string + title: variant_id + description: The item's variant id. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + raw_compare_at_unit_price: + type: object + description: The item's raw compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + raw_unit_price: + type: object + description: The item's raw unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + raw_quantity: + type: object + description: The item's raw quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: '#/components/schemas/OrderLineItemTaxLine' + adjustments: + type: array + description: The item's adjustments. + items: + $ref: '#/components/schemas/OrderLineItemAdjustment' + detail: + $ref: '#/components/schemas/OrderItem' + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + metadata: + type: object + description: The item's metadata. + original_total: + oneOf: + - type: string + title: original_total + description: The item's original total. + - type: number + title: original_total + description: The item's original total. + - type: string + title: original_total + description: The item's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The item's original subtotal. + - type: number + title: original_subtotal + description: The item's original subtotal. + - type: string + title: original_subtotal + description: The item's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The item's original tax total. + - type: number + title: original_tax_total + description: The item's original tax total. + - type: string + title: original_tax_total + description: The item's original tax total. + - $ref: '#/components/schemas/IBigNumber' + item_total: + oneOf: + - type: string + title: item_total + description: The item's item total. + - type: number + title: item_total + description: The item's item total. + - type: string + title: item_total + description: The item's item total. + - $ref: '#/components/schemas/IBigNumber' + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The item's item subtotal. + - type: number + title: item_subtotal + description: The item's item subtotal. + - type: string + title: item_subtotal + description: The item's item subtotal. + - $ref: '#/components/schemas/IBigNumber' + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The item's item tax total. + - type: number + title: item_tax_total + description: The item's item tax total. + - type: string + title: item_tax_total + description: The item's item tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The item's total. + - type: number + title: total + description: The item's total. + - type: string + title: total + description: The item's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The item's subtotal. + - type: number + title: subtotal + description: The item's subtotal. + - type: string + title: subtotal + description: The item's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The item's tax total. + - type: number + title: tax_total + description: The item's tax total. + - type: string + title: tax_total + description: The item's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The item's discount total. + - type: number + title: discount_total + description: The item's discount total. + - type: string + title: discount_total + description: The item's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The item's discount tax total. + - type: number + title: discount_tax_total + description: The item's discount tax total. + - type: string + title: discount_tax_total + description: The item's discount tax total. + - $ref: '#/components/schemas/IBigNumber' + refundable_total: + oneOf: + - type: string + title: refundable_total + description: The item's refundable total. + - type: number + title: refundable_total + description: The item's refundable total. + - type: string + title: refundable_total + description: The item's refundable total. + - $ref: '#/components/schemas/IBigNumber' + refundable_total_per_unit: + oneOf: + - type: string + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: string + title: refundable_total_per_unit + description: The item's refundable total per unit. + - $ref: '#/components/schemas/IBigNumber' + raw_original_total: + type: object + description: The item's raw original total. + raw_original_subtotal: + type: object + description: The item's raw original subtotal. + raw_original_tax_total: + type: object + description: The item's raw original tax total. + raw_item_total: + type: object + description: The item's raw item total. + raw_item_subtotal: + type: object + description: The item's raw item subtotal. + raw_item_tax_total: + type: object + description: The item's raw item tax total. + raw_total: + type: object + description: The item's raw total. + raw_subtotal: + type: object + description: The item's raw subtotal. + raw_tax_total: + type: object + description: The item's raw tax total. + raw_discount_total: + type: object + description: The item's raw discount total. + raw_discount_tax_total: + type: object + description: The item's raw discount tax total. + raw_refundable_total: + type: object + description: The item's raw refundable total. + raw_refundable_total_per_unit: + type: object + description: The item's raw refundable total per unit. + OrderLineItemAdjustment: + type: object + description: The adjustment's adjustments. + x-schemaName: OrderLineItemAdjustment + OrderLineItemTaxLine: + type: object + description: The tax line's tax lines. + x-schemaName: OrderLineItemTaxLine + OrderShippingMethod: + type: object + description: The shipping method's shipping methods. + x-schemaName: OrderShippingMethod + required: + - id + - order_id + - name + - amount + - raw_amount + - is_tax_inclusive + - created_at + - updated_at + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + oneOf: + - type: string + title: amount + description: The shipping method's amount. + - type: number + title: amount + description: The shipping method's amount. + - type: string + title: amount + description: The shipping method's amount. + - $ref: '#/components/schemas/IBigNumber' + raw_amount: + type: object + description: The shipping method's raw amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: '#/components/schemas/OrderShippingMethodTaxLine' + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: '#/components/schemas/OrderShippingMethodAdjustment' + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: discount_tax_total + description: The shipping method's discount tax total. + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - $ref: '#/components/schemas/IBigNumber' + raw_original_total: + type: object + description: The shipping method's raw original total. + raw_original_subtotal: + type: object + description: The shipping method's raw original subtotal. + raw_original_tax_total: + type: object + description: The shipping method's raw original tax total. + raw_total: + type: object + description: The shipping method's raw total. + raw_subtotal: + type: object + description: The shipping method's raw subtotal. + raw_tax_total: + type: object + description: The shipping method's raw tax total. + raw_discount_total: + type: object + description: The shipping method's raw discount total. + raw_discount_tax_total: + type: object + description: The shipping method's raw discount tax total. + OrderShippingMethodAdjustment: + type: object + description: The adjustment's adjustments. + x-schemaName: OrderShippingMethodAdjustment + OrderShippingMethodTaxLine: + type: object + description: The tax line's tax lines. + x-schemaName: OrderShippingMethodTaxLine + OrderTransaction: + type: object + description: The transaction's transactions. + x-schemaName: OrderTransaction + required: + - id + - order_id + - order + - amount + - raw_amount + - currency_code + - reference + - reference_id + - created_at + - updated_at + - metadata + properties: + id: + type: string + title: id + description: The transaction's ID. + order_id: + type: string + title: order_id + description: The transaction's order id. + order: + type: object + amount: + oneOf: + - type: string + title: amount + description: The transaction's amount. + - type: number + title: amount + description: The transaction's amount. + - type: string + title: amount + description: The transaction's amount. + - $ref: '#/components/schemas/IBigNumber' + raw_amount: + type: object + description: The transaction's raw amount. + currency_code: + type: string + title: currency_code + description: The transaction's currency code. + reference: + type: string + title: reference + description: The transaction's reference. + reference_id: + type: string + title: reference_id + description: The transaction's reference id. + created_at: + type: string + format: date-time + title: created_at + description: The transaction's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The transaction's updated at. + metadata: + type: object + description: The transaction's metadata. + RefundReasonResponse: + type: object + description: SUMMARY + x-schemaName: RefundReasonResponse + required: + - refund_reason + properties: + refund_reason: + $ref: '#/components/schemas/AdminRefundReason' + ReservationResponse: + type: object + description: The reservation's details. + x-schemaName: ReservationResponse + required: + - id + - line_item_id + - location_id + - quantity + - external_id + - description + - inventory_item_id + - inventory_item + properties: + id: + type: string + title: id + description: The reservation's ID. + 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. + quantity: + type: string + title: quantity + description: The reservation's quantity. + external_id: + type: string + title: external_id + description: The reservation's external id. + description: + type: string + title: description + description: The reservation's description. + inventory_item_id: + type: string + title: inventory_item_id + description: The reservation's inventory item id. + inventory_item: + type: object + description: The reservation's inventory item. + metadata: + type: object + description: The reservation's metadata. + created_by: + type: string + title: created_by + description: The reservation's created by. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The reservation's deleted at. + created_at: + type: string + format: date-time + title: created_at + description: The reservation's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The reservation's updated at. + Return: + type: object + description: The order change's return order. + x-schemaName: Return StoreAddCartLineItem: type: object description: SUMMARY @@ -46686,6 +60816,422 @@ components: type: string title: fields description: The cart's fields. + StoreCart: + type: object + description: The cart's details. + x-schemaName: StoreCart + required: + - id + - currency_code + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total + properties: + id: + type: string + title: id + description: The cart's ID. + region: + $ref: '#/components/schemas/BaseRegion' + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address: + $ref: '#/components/schemas/BaseCartAddress' + billing_address: + $ref: '#/components/schemas/BaseCartAddress' + items: + type: array + description: The cart's items. + items: + $ref: '#/components/schemas/BaseCartLineItem' + shipping_methods: + type: array + description: The cart's shipping methods. + items: + $ref: '#/components/schemas/BaseCartShippingMethod' + payment_collection: + $ref: '#/components/schemas/BasePaymentCollection' + metadata: + type: object + description: The cart's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The cart's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The cart's updated at. + original_item_total: + oneOf: + - type: string + title: original_item_total + description: The cart's original item total. + - type: number + title: original_item_total + description: The cart's original item total. + - type: string + title: original_item_total + description: The cart'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. + - type: number + title: original_item_subtotal + description: The cart's original item subtotal. + - type: string + title: original_item_subtotal + description: The cart'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. + - type: number + title: original_item_tax_total + description: The cart's original item tax total. + - type: string + title: original_item_tax_total + description: The cart's original item tax total. + - $ref: '#/components/schemas/IBigNumber' + item_total: + oneOf: + - type: string + title: item_total + description: The cart's item total. + - type: number + title: item_total + description: The cart's item total. + - type: string + title: item_total + description: The cart's item total. + - $ref: '#/components/schemas/IBigNumber' + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The cart's item subtotal. + - type: number + title: item_subtotal + description: The cart's item subtotal. + - type: string + title: item_subtotal + description: The cart's item subtotal. + - $ref: '#/components/schemas/IBigNumber' + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The cart's item tax total. + - type: number + title: item_tax_total + description: The cart's item tax total. + - type: string + title: item_tax_total + description: The cart's item tax total. + - $ref: '#/components/schemas/IBigNumber' + original_total: + oneOf: + - type: string + title: original_total + description: The cart's original total. + - type: number + title: original_total + description: The cart's original total. + - type: string + title: original_total + description: The cart's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The cart's original subtotal. + - type: number + title: original_subtotal + description: The cart's original subtotal. + - type: string + title: original_subtotal + description: The cart's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The cart's original tax total. + - type: number + title: original_tax_total + description: The cart's original tax total. + - type: string + title: original_tax_total + description: The cart's original tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The cart's total. + - type: number + title: total + description: The cart's total. + - type: string + title: total + description: The cart's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The cart's subtotal. + - type: number + title: subtotal + description: The cart's subtotal. + - type: string + title: subtotal + description: The cart's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The cart's tax total. + - type: number + title: tax_total + description: The cart's tax total. + - type: string + title: tax_total + description: The cart's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The cart's discount total. + - type: number + title: discount_total + description: The cart's discount total. + - type: string + title: discount_total + description: The cart's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The cart's discount tax total. + - type: number + title: discount_tax_total + description: The cart's discount tax total. + - type: string + title: discount_tax_total + description: The cart'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. + - type: number + title: gift_card_total + description: The cart's gift card total. + - type: string + title: gift_card_total + description: The cart'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. + - type: number + title: gift_card_tax_total + description: The cart's gift card tax total. + - type: string + title: gift_card_tax_total + description: The cart's gift card tax total. + - $ref: '#/components/schemas/IBigNumber' + shipping_total: + oneOf: + - type: string + title: shipping_total + description: The cart's shipping total. + - type: number + title: shipping_total + description: The cart's shipping total. + - type: string + title: shipping_total + description: The cart's shipping total. + - $ref: '#/components/schemas/IBigNumber' + shipping_subtotal: + oneOf: + - type: string + title: shipping_subtotal + description: The cart's shipping subtotal. + - type: number + title: shipping_subtotal + description: The cart's shipping subtotal. + - type: string + title: shipping_subtotal + description: The cart's shipping subtotal. + - $ref: '#/components/schemas/IBigNumber' + shipping_tax_total: + oneOf: + - type: string + title: shipping_tax_total + description: The cart's shipping tax total. + - type: number + title: shipping_tax_total + description: The cart's shipping tax total. + - type: string + title: shipping_tax_total + description: The cart'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. + - type: number + title: original_shipping_total + description: The cart's original shipping total. + - type: string + title: original_shipping_total + description: The cart'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. + - type: number + title: original_shipping_subtotal + description: The cart's original shipping subtotal. + - type: string + title: original_shipping_subtotal + description: The cart'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. + - type: number + title: original_shipping_tax_total + description: The cart's original shipping tax total. + - type: string + title: original_shipping_tax_total + description: The cart's original shipping tax total. + - $ref: '#/components/schemas/IBigNumber' + StoreCartResponse: + type: object + description: SUMMARY + x-schemaName: StoreCartResponse + required: + - cart + properties: + cart: + $ref: '#/components/schemas/StoreCart' + StoreCollection: + type: object + description: The collection's details. + x-schemaName: StoreCollection + required: + - id + - title + - handle + - created_at + - updated_at + - deleted_at + - metadata + properties: + id: + type: string + title: id + description: The collection's ID. + title: + type: string + title: title + description: The collection's title. + handle: + type: string + title: handle + description: The collection's handle. + created_at: + type: string + format: date-time + title: created_at + description: The collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The collection's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The collection's deleted at. + products: + type: array + description: The collection's products. + items: + $ref: '#/components/schemas/AdminProduct' + metadata: + type: object + description: The collection's metadata. + StoreCollectionResponse: + type: object + description: SUMMARY + x-schemaName: StoreCollectionResponse + required: + - collection + properties: + collection: + $ref: '#/components/schemas/StoreCollection' StoreCreateCustomer: type: object description: SUMMARY @@ -46718,6 +61264,706 @@ components: type: string title: phone description: The customer's phone. + StoreCurrency: + type: object + description: The currency's details. + x-schemaName: StoreCurrency + 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. + StoreCurrencyListResponse: + type: object + description: SUMMARY + x-schemaName: StoreCurrencyListResponse + required: + - limit + - offset + - count + - currencies + properties: + limit: + type: number + title: limit + description: The currency's limit. + offset: + type: number + title: offset + description: The currency's offset. + count: + type: number + title: count + description: The currency's count. + currencies: + type: array + description: The currency's currencies. + items: + $ref: '#/components/schemas/StoreCurrency' + StoreCurrencyResponse: + type: object + description: SUMMARY + x-schemaName: StoreCurrencyResponse + required: + - currency + properties: + currency: + $ref: '#/components/schemas/StoreCurrency' + StoreCustomer: + type: object + description: The customer's details. + x-schemaName: StoreCustomer + required: + - id + - email + - default_billing_address_id + - default_shipping_address_id + - company_name + - first_name + - last_name + - addresses + properties: + id: + type: string + title: id + description: The customer's ID. + email: + type: string + title: email + description: The customer's email. + format: email + default_billing_address_id: + type: string + title: default_billing_address_id + description: The customer's default billing address id. + default_shipping_address_id: + type: string + title: default_shipping_address_id + description: The customer's default shipping address id. + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + addresses: + type: array + description: The customer's addresses. + items: + $ref: '#/components/schemas/BaseCustomerAddress' + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + created_by: + type: string + title: created_by + description: The customer's created by. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The customer's deleted at. + created_at: + type: string + format: date-time + title: created_at + description: The customer's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The customer's updated at. + StoreCustomerAddress: + type: object + description: The customer's address. + x-schemaName: StoreCustomerAddress + 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. + StoreCustomerAddressListResponse: + type: object + description: SUMMARY + x-schemaName: StoreCustomerAddressListResponse + required: + - limit + - offset + - count + - addresses + properties: + limit: + type: number + title: limit + description: The customer's limit. + offset: + type: number + title: offset + description: The customer's offset. + count: + type: number + title: count + description: The customer's count. + addresses: + type: array + description: The customer's addresses. + items: + $ref: '#/components/schemas/StoreCustomerAddress' + StoreCustomerAddressResponse: + type: object + description: SUMMARY + x-schemaName: StoreCustomerAddressResponse + required: + - address + properties: + address: + $ref: '#/components/schemas/StoreCustomerAddress' + StoreCustomerResponse: + type: object + description: SUMMARY + x-schemaName: StoreCustomerResponse + required: + - customer + properties: + customer: + $ref: '#/components/schemas/StoreCustomer' + StoreOrder: + type: object + description: The cart's order. + x-schemaName: StoreOrder + required: + - id + - version + - region_id + - customer_id + - sales_channel_id + - email + - currency_code + - items + - shipping_methods + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total + properties: + id: + type: string + title: id + description: The order's ID. + version: + type: number + title: version + description: The order's version. + region_id: + type: string + title: region_id + description: The order's region id. + customer_id: + type: string + title: customer_id + description: The order's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order's sales channel id. + email: + type: string + title: email + description: The order's email. + format: email + currency_code: + type: string + title: currency_code + description: The order's currency code. + display_id: + type: string + 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. + items: + $ref: '#/components/schemas/BaseOrderLineItem' + shipping_methods: + type: array + description: The order's shipping methods. + items: + $ref: '#/components/schemas/BaseOrderShippingMethod' + payment_collections: + type: array + description: The order's payment collections. + items: + $ref: '#/components/schemas/BasePaymentCollection' + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The order's fulfillments. + items: + $ref: '#/components/schemas/BaseOrderFulfillment' + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The order's transactions. + items: + $ref: '#/components/schemas/BaseOrderTransaction' + summary: + $ref: '#/components/schemas/BaseOrderSummary' + metadata: + type: object + description: The order's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The order's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order's updated at. + original_item_total: + type: number + title: original_item_total + description: The order's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The order's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The order's original item tax total. + item_total: + type: number + title: item_total + description: The order's item total. + item_subtotal: + type: number + title: item_subtotal + description: The order's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The order's item tax total. + original_total: + type: number + title: original_total + description: The order's original total. + original_subtotal: + type: number + title: original_subtotal + description: The order's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The order's original tax total. + total: + type: number + title: total + description: The order's total. + subtotal: + type: number + title: subtotal + description: The order's subtotal. + tax_total: + type: number + title: tax_total + description: The order's tax total. + discount_total: + type: number + title: discount_total + description: The order's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The order's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The order's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The order's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The order's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The order's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The order's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The order's original shipping tax total. + StoreOrderResponse: + type: object + description: SUMMARY + x-schemaName: StoreOrderResponse + required: + - order + properties: + order: + $ref: '#/components/schemas/StoreOrder' + StorePaymentCollection: + type: object + description: The payment collection's details. + x-schemaName: StorePaymentCollection + required: + - id + - currency_code + - region_id + - amount + - status + - payment_providers + properties: + id: + type: string + title: id + description: The payment collection's ID. + currency_code: + type: string + title: currency_code + description: The payment collection's currency code. + region_id: + type: string + title: region_id + description: The payment collection's region id. + amount: + oneOf: + - type: string + title: amount + description: The payment collection's amount. + - type: number + title: amount + description: The payment collection's amount. + - type: string + title: amount + description: The payment collection's amount. + - $ref: '#/components/schemas/IBigNumber' + authorized_amount: + oneOf: + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - type: number + title: authorized_amount + description: The payment collection's authorized amount. + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - $ref: '#/components/schemas/IBigNumber' + captured_amount: + oneOf: + - type: string + title: captured_amount + description: The payment collection's captured amount. + - type: number + title: captured_amount + description: The payment collection's captured amount. + - type: string + title: captured_amount + description: The payment collection's captured amount. + - $ref: '#/components/schemas/IBigNumber' + refunded_amount: + oneOf: + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - type: number + title: refunded_amount + description: The payment collection's refunded amount. + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - $ref: '#/components/schemas/IBigNumber' + completed_at: + oneOf: + - type: string + title: completed_at + description: The payment collection's completed at. + - type: string + title: completed_at + description: The payment collection's completed at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The payment collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The payment collection's updated at. + metadata: + type: object + description: The payment collection's metadata. + status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + payment_providers: + type: array + description: The payment collection's payment providers. + items: + $ref: '#/components/schemas/BasePaymentProvider' + payment_sessions: + type: array + description: The payment collection's payment sessions. + items: + $ref: '#/components/schemas/BasePaymentSession' + payments: + type: array + description: The payment collection's payments. + items: + $ref: '#/components/schemas/BasePayment' + StorePaymentCollectionResponse: + type: object + description: SUMMARY + x-schemaName: StorePaymentCollectionResponse + required: + - payment_collection + properties: + payment_collection: + $ref: '#/components/schemas/StorePaymentCollection' + StorePaymentProvider: + type: object + description: The payment provider's payment providers. + x-schemaName: StorePaymentProvider + required: + - id + properties: + id: + type: string + title: id + description: The payment provider's ID. StorePostReturnsReqSchema: type: object description: SUMMARY @@ -46789,7 +62035,7 @@ components: description: The return's location id. StoreProduct: type: object - description: The product's products. + description: The product's details. x-schemaName: StoreProduct required: - title @@ -46798,26 +62044,26 @@ components: - options - description - id - - handle - - hs_code - - weight - - height - - width - - origin_country - - mid_code - - material - - thumbnail - created_at - updated_at - - deleted_at - variants + - handle - subtitle - is_giftcard + - thumbnail + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material - collection_id - type_id - images - discountable - external_id + - deleted_at properties: categories: type: array @@ -46857,42 +62103,6 @@ components: metadata: type: object description: The product's metadata. - handle: - type: string - title: handle - description: The product's handle. - hs_code: - type: string - title: hs_code - description: The product's hs code. - weight: - type: number - title: weight - description: The product's weight. - height: - type: number - title: height - description: The product's height. - width: - type: number - title: width - description: The product's width. - origin_country: - type: string - title: origin_country - description: The product's origin country. - mid_code: - type: string - title: mid_code - description: The product's mid code. - material: - type: string - title: material - description: The product's material. - thumbnail: - type: string - title: thumbnail - description: The product's thumbnail. created_at: type: string format: date-time @@ -46903,16 +62113,15 @@ components: format: date-time title: updated_at description: The product's updated at. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The product's deleted at. variants: type: array description: The product's variants. items: $ref: '#/components/schemas/BaseProductVariant' + handle: + type: string + title: handle + description: The product's handle. subtitle: type: string title: subtitle @@ -46921,6 +62130,38 @@ components: type: boolean title: is_giftcard description: The product's is giftcard. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. collection: $ref: '#/components/schemas/BaseCollection' collection_id: @@ -46949,9 +62190,14 @@ components: type: string title: external_id description: The product's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. StoreProductCategory: type: object - description: The product category's details. + description: The category's categories. x-schemaName: StoreProductCategory required: - id @@ -46970,63 +62216,63 @@ components: properties: products: type: array - description: The product category's products. + description: The category's products. items: $ref: '#/components/schemas/StoreProduct' id: type: string title: id - description: The product category's ID. + description: The category's ID. name: type: string title: name - description: The product category's name. + description: The category's name. description: type: string title: description - description: The product category's description. + description: The category's description. handle: type: string title: handle - description: The product category's handle. + description: The category's handle. is_active: type: boolean title: is_active - description: The product category's is active. + description: The category's is active. is_internal: type: boolean title: is_internal - description: The product category's is internal. + description: The category's is internal. rank: type: number title: rank - description: The product category's rank. + description: The category's rank. parent_category_id: type: string title: parent_category_id - description: The product category's parent category id. + description: The category's parent category id. parent_category: $ref: '#/components/schemas/BaseProductCategory' category_children: type: array - description: The product category's category children. + description: The category's category children. items: $ref: '#/components/schemas/BaseProductCategory' created_at: type: string format: date-time title: created_at - description: The product category's created at. + description: The category's created at. updated_at: type: string format: date-time title: updated_at - description: The product category's updated at. + description: The category's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The product category's deleted at. + description: The category's deleted at. StoreProductCategoryListResponse: type: object description: SUMMARY @@ -47063,6 +62309,266 @@ components: properties: product_category: $ref: '#/components/schemas/StoreProductCategory' + StoreProductResponse: + type: object + description: SUMMARY + x-schemaName: StoreProductResponse + required: + - product + properties: + product: + $ref: '#/components/schemas/StoreProduct' + StoreRegion: + type: object + description: The region's details. + x-schemaName: StoreRegion + required: + - id + - name + - currency_code + properties: + id: + type: string + title: id + description: The region's ID. + name: + type: string + title: name + description: The region's name. + currency_code: + type: string + title: currency_code + description: The region's currency code. + automatic_taxes: + type: boolean + title: automatic_taxes + description: The region's automatic taxes. + countries: + type: array + description: The region's countries. + items: + $ref: '#/components/schemas/BaseRegionCountry' + payment_providers: + type: array + description: The region's payment providers. + items: + $ref: '#/components/schemas/AdminPaymentProvider' + metadata: + type: object + description: The region's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The region's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The region's updated at. + StoreReturn: + type: object + description: The return's details. + x-schemaName: StoreReturn + required: + - id + - order_id + - order_version + - display_id + - items + - received_at + - created_at + properties: + id: + type: string + title: id + description: The return's ID. + order_id: + type: string + title: order_id + description: The return's order id. + status: + type: string + title: status + description: The return's status. + exchange_id: + type: string + title: exchange_id + description: The return's exchange id. + location_id: + type: string + title: location_id + description: The return's location id. + claim_id: + type: string + title: claim_id + description: The return's claim id. + order_version: + type: number + title: order_version + description: The return's order version. + display_id: + type: number + title: display_id + description: The return's display id. + no_notification: + type: boolean + title: no_notification + description: The return's no notification. + refund_amount: + type: number + title: refund_amount + description: The return's refund amount. + items: + type: array + description: The return's items. + items: + $ref: '#/components/schemas/BaseReturnItem' + received_at: + type: string + title: received_at + description: The return's received at. + created_at: + type: string + format: date-time + title: created_at + description: The return's created at. + StoreReturnReason: + type: object + description: The return reason's details. + x-schemaName: StoreReturnReason + required: + - id + - value + - label + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The return reason's ID. + value: + type: string + title: value + description: The return reason's value. + label: + type: string + title: label + description: The return reason's label. + description: + type: string + title: description + description: The return reason's description. + metadata: + type: object + description: The return reason's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The return reason's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The return reason's updated at. + StoreReturnReasonResponse: + type: object + description: SUMMARY + x-schemaName: StoreReturnReasonResponse + required: + - return_reason + properties: + return_reason: + $ref: '#/components/schemas/StoreReturnReason' + StoreReturnResponse: + type: object + description: SUMMARY + x-schemaName: StoreReturnResponse + required: + - return + properties: + return: + $ref: '#/components/schemas/StoreReturn' + StoreShippingOption: + type: object + description: The shipping option's shipping options. + x-schemaName: StoreShippingOption + required: + - id + - name + - price_type + - service_zone_id + - provider_id + - provider + - shipping_option_type_id + - type + - shipping_profile_id + - amount + - is_tax_inclusive + - data + - metadata + properties: + id: + type: string + title: id + description: The shipping option's ID. + name: + type: string + title: name + description: The shipping option's name. + price_type: + type: string + enum: + - flat + - calculated + service_zone_id: + type: string + title: service_zone_id + description: The shipping option's service zone id. + provider_id: + type: string + title: provider_id + description: The shipping option's provider id. + provider: + $ref: '#/components/schemas/BaseFulfillmentProvider' + shipping_option_type_id: + type: string + title: shipping_option_type_id + description: The shipping option's shipping option type id. + type: + type: object + shipping_profile_id: + type: string + title: shipping_profile_id + description: The shipping option's shipping profile id. + amount: + type: number + title: amount + description: The shipping option's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping option's is tax inclusive. + data: + type: object + description: The shipping option's data. + metadata: + type: object + description: The shipping option's metadata. + StoreShippingOptionListResponse: + type: object + description: SUMMARY + x-schemaName: StoreShippingOptionListResponse + required: + - shipping_options + properties: + shipping_options: + type: array + description: The shipping option's shipping options. + items: + $ref: '#/components/schemas/StoreShippingOption' StoreUpdateCartLineItem: type: object description: SUMMARY @@ -47162,51 +62668,6 @@ components: metadata: type: object description: The shipping address's metadata. - UpdateCartData: - type: object - description: SUMMARY - x-schemaName: UpdateCartData - properties: - region_id: - type: string - title: region_id - description: The cart's region id. - customer_id: - type: string - title: customer_id - description: The cart's customer id. - sales_channel_id: - type: string - title: sales_channel_id - description: The cart's sales channel id. - email: - type: string - title: email - description: The cart's email. - format: email - currency_code: - type: string - title: currency_code - description: The cart's currency code. - shipping_address_id: - type: string - title: shipping_address_id - description: The cart's shipping address id. - billing_address_id: - type: string - title: billing_address_id - description: The cart's billing address id. - billing_address: - oneOf: - - $ref: '#/components/schemas/CreateAddress' - - $ref: '#/components/schemas/UpdateAddress' - shipping_address: - oneOf: - - $ref: '#/components/schemas/CreateAddress' - - $ref: '#/components/schemas/UpdateAddress' - metadata: - type: object - description: The cart's metadata. UpdateOrderReturnReason: type: object description: SUMMARY @@ -47231,3 +62692,142 @@ components: metadata: type: object description: The return reason's metadata. + responses: + default_error: + description: Default Error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + code: unknown_error + message: An unknown error occurred. + type: unknown_error + invalid_state_error: + description: Invalid State Error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + code: unknown_error + message: The request conflicted with another request. You may retry the request with the provided Idempotency-Key. + type: QueryRunnerAlreadyReleasedError + invalid_request_error: + description: Invalid Request Error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + code: invalid_request_error + message: Discount with code TEST already exists. + type: duplicate_error + not_found_error: + description: Not Found Error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + message: Entity with id 1 was not found + type: not_found + 400_error: + description: Client Error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + not_allowed: + $ref: '#/components/examples/not_allowed_error' + invalid_data: + $ref: '#/components/examples/invalid_data_error' + 500_error: + description: Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + database: + $ref: '#/components/examples/database_error' + unexpected_state: + $ref: '#/components/examples/unexpected_state_error' + invalid_argument: + $ref: '#/components/examples/invalid_argument_error' + default_error: + $ref: '#/components/examples/default_error' + unauthorized: + description: User is not authorized. Must log in first + content: + text/plain: + schema: + type: string + default: Unauthorized + example: Unauthorized + incorrect_credentials: + description: User does not exist or incorrect credentials + content: + text/plain: + schema: + type: string + default: Unauthorized + example: Unauthorized + examples: + not_allowed_error: + summary: Not Allowed Error + value: + message: Discount must be set to dynamic + type: not_allowed + invalid_data_error: + summary: Invalid Data Error + value: + message: first_name must be a string + type: invalid_data + multiple_errors: + summary: Multiple Errors + value: + message: Provided request body contains errors. Please check the data and retry the request + errors: + - message: first_name must be a string + type: invalid_data + - message: Discount must be set to dynamic + type: not_allowed + database_error: + summary: Database Error + value: + code: api_error + message: An error occured while hashing password + type: database_error + unexpected_state_error: + summary: Unexpected State Error + value: + message: cart.total must be defined + type: unexpected_state + invalid_argument_error: + summary: Invalid Argument Error + value: + message: cart.total must be defined + type: unexpected_state + default_error: + summary: Default Error + value: + code: unknown_error + message: An unknown error occurred. + type: unknown_error + securitySchemes: + api_token: + type: apiKey + x-displayName: API Token + in: header + name: x-medusa-access-token + jwt_token: + type: http + x-displayName: JWT Token + scheme: bearer + cookie_auth: + type: apiKey + in: cookie + name: connect.sid + x-displayName: Cookie Session ID diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index 4bbda1a63d..74b8f2a25f 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -12,6 +12,8 @@ tags: - name: Api Keys - name: Campaigns - name: Claims + x-associatedSchema: + $ref: ./components/schemas/AdminClaim.yaml - name: Collections x-associatedSchema: $ref: ./components/schemas/AdminCollection.yaml @@ -26,6 +28,8 @@ tags: description: How to manage currencies url: >- https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-currencies + x-associatedSchema: + $ref: ./components/schemas/AdminCurrency.yaml - name: Customer Groups x-associatedSchema: $ref: ./components/schemas/AdminCustomerGroup.yaml @@ -39,6 +43,9 @@ tags: x-associatedSchema: $ref: ./components/schemas/AdminCustomer.yaml - name: Draft Orders + - name: Exchanges + x-associatedSchema: + $ref: ./components/schemas/AdminExchange.yaml - name: Fulfillment Providers x-associatedSchema: $ref: ./components/schemas/AdminFulfillmentProvider.yaml @@ -46,7 +53,11 @@ tags: x-associatedSchema: $ref: ./components/schemas/AdminFulfillmentSet.yaml - name: Fulfillments + x-associatedSchema: + $ref: ./components/schemas/AdminFulfillment.yaml - name: Inventory Items + x-associatedSchema: + $ref: ./components/schemas/AdminInventoryItem.yaml - name: Invites description: > An admin can invite new users to manage their team. This would allow new @@ -54,11 +65,23 @@ tags: externalDocs: description: How to manage invites url: https://docs.medusajs.com/modules/users/admin/manage-invites + x-associatedSchema: + $ref: ./components/schemas/AdminInvite.yaml - name: Notifications + x-associatedSchema: + $ref: ./components/schemas/AdminNotification.yaml - name: Orders + x-associatedSchema: + $ref: ./components/schemas/AdminOrder.yaml - name: Payments + x-associatedSchema: + $ref: ./components/schemas/AdminPayment.yaml - name: Price Lists + x-associatedSchema: + $ref: ./components/schemas/AdminPriceList.yaml - name: Price Preferences + x-associatedSchema: + $ref: ./components/schemas/AdminPricePreference.yaml - name: Product Categories x-associatedSchema: $ref: ./components/schemas/AdminProductCategory.yaml @@ -66,10 +89,18 @@ tags: x-associatedSchema: $ref: ./components/schemas/AdminProductTag.yaml - name: Product Types + - name: Product Variants + x-associatedSchema: + $ref: ./components/schemas/AdminProductVariant.yaml - name: Products x-associatedSchema: $ref: ./components/schemas/AdminProduct.yaml - name: Promotions + x-associatedSchema: + $ref: ./components/schemas/AdminPromotion.yaml + - name: Refund Reasons + x-associatedSchema: + $ref: ./components/schemas/AdminRefundReason.yaml - name: Regions description: > Regions are different countries or geographical regions that the commerce @@ -80,9 +111,15 @@ tags: description: How to manage regions url: >- https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions + x-associatedSchema: + $ref: ./components/schemas/AdminRegion.yaml - name: Reservations - name: Return Reasons + x-associatedSchema: + $ref: ./components/schemas/AdminReturnReason.yaml - name: Returns + x-associatedSchema: + $ref: ./components/schemas/AdminReturn.yaml - name: Sales Channels description: > A sales channel indicates a channel where products can be sold in. For @@ -101,11 +138,21 @@ tags: x-associatedSchema: $ref: ./components/schemas/AdminShippingProfile.yaml - name: Stock Locations + x-associatedSchema: + $ref: ./components/schemas/AdminStockLocation.yaml - name: Stores + x-associatedSchema: + $ref: ./components/schemas/AdminStore.yaml - name: Tax Rates + x-associatedSchema: + $ref: ./components/schemas/AdminTaxRate.yaml - name: Tax Regions + x-associatedSchema: + $ref: ./components/schemas/AdminTaxRegion.yaml - name: Uploads - name: Users + x-associatedSchema: + $ref: ./components/schemas/AdminUser.yaml - name: Workflows Executions paths: /admin/api-keys: @@ -124,6 +171,8 @@ paths: $ref: paths/admin_campaigns_{id}_promotions.yaml /admin/claims: $ref: paths/admin_claims.yaml + /admin/claims/{id}: + $ref: paths/admin_claims_{id}.yaml /admin/claims/{id}/cancel: $ref: paths/admin_claims_{id}_cancel.yaml /admin/claims/{id}/claim-items: @@ -176,6 +225,28 @@ paths: $ref: paths/admin_draft-orders.yaml /admin/draft-orders/{id}: $ref: paths/admin_draft-orders_{id}.yaml + /admin/exchanges: + $ref: paths/admin_exchanges.yaml + /admin/exchanges/{id}/cancel: + $ref: paths/admin_exchanges_{id}_cancel.yaml + /admin/exchanges/{id}/inbound/items: + $ref: paths/admin_exchanges_{id}_inbound_items.yaml + /admin/exchanges/{id}/inbound/items/{action_id}: + $ref: paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml + /admin/exchanges/{id}/inbound/shipping-method: + $ref: paths/admin_exchanges_{id}_inbound_shipping-method.yaml + /admin/exchanges/{id}/inbound/shipping-method/{action_id}: + $ref: paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml + /admin/exchanges/{id}/outbound/items: + $ref: paths/admin_exchanges_{id}_outbound_items.yaml + /admin/exchanges/{id}/outbound/items/{action_id}: + $ref: paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml + /admin/exchanges/{id}/outbound/shipping-method: + $ref: paths/admin_exchanges_{id}_outbound_shipping-method.yaml + /admin/exchanges/{id}/outbound/shipping-method/{action_id}: + $ref: paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml + /admin/exchanges/{id}/request: + $ref: paths/admin_exchanges_{id}_request.yaml /admin/fulfillment-providers: $ref: paths/admin_fulfillment-providers.yaml /admin/fulfillment-sets/{id}: @@ -266,6 +337,8 @@ paths: $ref: paths/admin_product-types.yaml /admin/product-types/{id}: $ref: paths/admin_product-types_{id}.yaml + /admin/product-variants: + $ref: paths/admin_product-variants.yaml /admin/products: $ref: paths/admin_products.yaml /admin/products/batch: @@ -312,6 +385,10 @@ paths: $ref: paths/admin_promotions_{id}_target-rules_batch.yaml /admin/promotions/{id}/{rule_type}: $ref: paths/admin_promotions_{id}_{rule_type}.yaml + /admin/refund-reasons: + $ref: paths/admin_refund-reasons.yaml + /admin/refund-reasons/{id}: + $ref: paths/admin_refund-reasons_{id}.yaml /admin/regions: $ref: paths/admin_regions.yaml /admin/regions/{id}: 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 5a769c1897..c10d333661 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 @@ -73,6 +73,41 @@ get: tags: - Api Keys responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The api key's limit. + offset: + type: number + title: offset + description: The api key's offset. + count: + type: number + title: count + description: The api key's count. + - type: object + description: SUMMARY + required: + - api_keys + properties: + api_keys: + type: array + description: The api key's api keys. + items: + $ref: ../components/schemas/ApiKeyResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -163,6 +198,12 @@ post: tags: - Api Keys responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminApiKeyResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -175,3 +216,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createApiKeysWorkflow 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 96b96cee8e..389ee8d611 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 @@ -79,6 +79,12 @@ get: tags: - Api Keys responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminApiKeyResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -175,6 +181,12 @@ post: tags: - Api Keys responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminApiKeyResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -266,6 +278,33 @@ delete: tags: - Api Keys responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The api key's ID. + object: + type: string + title: object + description: The api key's object. + deleted: + type: boolean + title: deleted + description: The api key's 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_api-keys_{id}_revoke.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml index 6b2e052abe..7444130443 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml @@ -82,6 +82,12 @@ post: tags: - Api Keys responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminApiKeyResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml index 738f2c20c5..c529adb478 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml @@ -98,6 +98,12 @@ post: tags: - Api Keys responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminApiKeyResponse.yaml '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 211e519973..150ee0520c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml @@ -73,6 +73,41 @@ get: tags: - Campaigns responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The campaign's limit. + offset: + type: number + title: offset + description: The campaign's offset. + count: + type: number + title: count + description: The campaign's count. + - type: object + description: SUMMARY + required: + - campaigns + properties: + campaigns: + type: array + description: The campaign's campaigns. + items: + $ref: ../components/schemas/CampaignResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -154,15 +189,7 @@ post: content: application/json: schema: - type: object description: SUMMARY - required: - - name - - campaign_identifier - - description - - budget - - starts_at - - ends_at properties: name: type: string @@ -228,6 +255,12 @@ post: tags: - Campaigns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCampaignResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 8673efae5c..ab0199b1ec 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 @@ -79,6 +79,12 @@ get: tags: - Campaigns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCampaignResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -166,7 +172,53 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminUpdateCampaign.yaml + description: SUMMARY + properties: + name: + type: string + title: name + description: The campaign's name. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + required: + - limit + properties: + limit: + type: number + title: limit + description: The budget's limit. + 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 + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. x-codeSamples: - lang: Shell label: cURL @@ -175,6 +227,12 @@ post: tags: - Campaigns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCampaignResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -266,6 +324,33 @@ delete: tags: - Campaigns responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The campaign's ID. + object: + type: string + title: object + description: The campaign's object. + deleted: + type: boolean + title: deleted + description: The campaign's 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_campaigns_{id}_promotions.yaml b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml index 8cf7552d64..bbe24ec99a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml @@ -98,6 +98,12 @@ post: tags: - Campaigns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCampaignResponse.yaml '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 b20e277d64..aea414052e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims.yaml @@ -73,6 +73,12 @@ get: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -163,6 +169,12 @@ post: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimOrderResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 new file mode 100644 index 0000000000..d408c71f48 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}.yaml @@ -0,0 +1,97 @@ +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. + x-authenticated: true + parameters: + - name: id + in: path + description: The claim's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_claims_{id}/get.sh + tags: + - Claims + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml index 1d3376ea97..971eb7f8b3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml @@ -82,6 +82,12 @@ post: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml index 1d29886050..40ef624597 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml @@ -82,6 +82,12 @@ post: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -94,3 +100,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: orderClaimItemWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml index 68f99fbc97..18e6f27ee7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml @@ -89,6 +89,12 @@ post: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -101,6 +107,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateClaimItemWorkflow delete: operationId: DeleteClaimsIdClaimItemsAction_id summary: Remove Claim Items from Claim @@ -189,6 +196,12 @@ delete: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -201,3 +214,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: removeItemClaimActionWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml index f31cf2f2c7..1c0ac78ba4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml @@ -82,6 +82,12 @@ post: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -94,3 +100,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: orderClaimRequestItemReturnWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml index fe3f0c2b72..ea30484e3b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml @@ -90,6 +90,12 @@ post: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -102,6 +108,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateRequestItemReturnWorkflow delete: operationId: DeleteClaimsIdInboundItemsAction_id summary: Remove Items from Claim @@ -190,6 +197,12 @@ delete: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -202,3 +215,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: removeItemReturnActionWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml index 6091632562..70e969ea02 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml @@ -83,6 +83,12 @@ post: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -95,3 +101,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createClaimShippingMethodWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml index d905e70c53..956afd80c9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml @@ -89,6 +89,12 @@ post: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -101,6 +107,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateReturnShippingMethodWorkflow delete: operationId: DeleteClaimsIdInboundShippingMethodAction_id summary: Remove Shipping Methods from Claim @@ -190,6 +197,12 @@ delete: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -202,3 +215,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: removeClaimShippingMethodWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml index 3ae4a99c56..d6f4ecc8df 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml @@ -82,6 +82,12 @@ post: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -94,3 +100,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: orderClaimAddNewItemWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml index 308269d63a..236075f04f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml @@ -89,6 +89,12 @@ post: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -101,6 +107,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateClaimAddItemWorkflow delete: operationId: DeleteClaimsIdOutboundItemsAction_id summary: Remove Items from Claim @@ -189,6 +196,12 @@ delete: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -201,3 +214,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: removeAddItemClaimActionWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml index d330053584..5559594225 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml @@ -83,6 +83,12 @@ post: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -95,3 +101,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createClaimShippingMethodWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml index 802015162f..5691ecd4de 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml @@ -89,6 +89,12 @@ post: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -101,6 +107,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateClaimShippingMethodWorkflow delete: operationId: DeleteClaimsIdOutboundShippingMethodAction_id summary: Remove Shipping Methods from Claim @@ -190,6 +197,12 @@ delete: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -202,3 +215,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: removeClaimShippingMethodWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_request.yaml index aef833b8c7..d238d3bdec 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_request.yaml @@ -77,6 +77,12 @@ post: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimRequestResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -93,6 +99,7 @@ post: content: application/json: schema: {} + x-workflow: confirmClaimRequestWorkflow delete: operationId: DeleteClaimsIdRequest summary: Remove Requests from Claim @@ -174,6 +181,12 @@ delete: tags: - Claims responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminClaimDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 528fbf8b3a..fc6468e914 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections.yaml @@ -73,6 +73,12 @@ get: tags: - Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCollectionListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -163,6 +169,12 @@ post: tags: - Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCollectionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -175,3 +187,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createCollectionsWorkflow 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 dbad7869bd..b6cf504f1e 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 @@ -79,6 +79,12 @@ get: tags: - Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCollectionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -175,6 +181,12 @@ post: tags: - Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCollectionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -266,6 +278,12 @@ delete: tags: - Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCollectionDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml index cd0b7db246..bab6fe2366 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml @@ -98,6 +98,12 @@ post: tags: - Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCollectionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 8a94e0bb5d..13c728e3f8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml @@ -73,6 +73,12 @@ get: tags: - Currencies responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCurrencyListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 b4ee83fec1..68d71cf2d1 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 @@ -79,6 +79,12 @@ get: tags: - Currencies responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCurrencyResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 f02979d3ba..3b85f06c0a 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 @@ -73,6 +73,41 @@ get: tags: - Customer Groups responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The customer group's limit. + offset: + type: number + title: offset + description: The customer group's offset. + count: + type: number + title: count + description: The customer group's count. + - type: object + description: SUMMARY + required: + - customer_groups + properties: + customer_groups: + type: array + description: The customer group's customer groups. + items: + $ref: ../components/schemas/AdminCustomerGroup.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -163,6 +198,12 @@ post: tags: - Customer Groups responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCustomerGroupResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 a0e0446cee..0a08d4a45d 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 @@ -79,6 +79,12 @@ get: tags: - Customer Groups responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCustomerGroupResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -175,6 +181,12 @@ post: tags: - Customer Groups responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCustomerGroupResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -266,6 +278,33 @@ delete: tags: - Customer Groups responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The customer group's ID. + object: + type: string + title: object + description: The customer group's object. + deleted: + 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_customer-groups_{id}_customers.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml index 244951e223..bd29a1bc67 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml @@ -98,6 +98,12 @@ post: tags: - Customer Groups responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCustomerGroupResponse.yaml '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 1cc5333f16..90c46e1cd5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml @@ -186,7 +186,32 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminCreateCustomer.yaml + description: SUMMARY + properties: + email: + type: string + title: email + description: The customer's email. + format: email + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. x-codeSamples: - lang: Shell label: cURL @@ -200,13 +225,7 @@ post: content: application/json: schema: - type: object - description: SUMMARY - required: - - customer - properties: - customer: - $ref: ../components/schemas/AdminCustomer.yaml + $ref: ../components/schemas/AdminCustomerResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 7f7d841965..2f91fd4d5a 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 @@ -84,13 +84,7 @@ get: content: application/json: schema: - type: object - description: SUMMARY - required: - - customer - properties: - customer: - $ref: ../components/schemas/AdminCustomer.yaml + $ref: ../components/schemas/AdminCustomerResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -178,7 +172,32 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminUpdateCustomer.yaml + description: SUMMARY + properties: + email: + type: string + title: email + description: The customer's email. + format: email + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. x-codeSamples: - lang: Shell label: cURL @@ -192,13 +211,7 @@ post: content: application/json: schema: - type: object - description: SUMMARY - required: - - customer - properties: - customer: - $ref: ../components/schemas/AdminCustomer.yaml + $ref: ../components/schemas/AdminCustomerResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -290,6 +303,33 @@ delete: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + 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 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_customers_{id}_addresses.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml index d296c80e68..76940caa96 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 @@ -79,6 +79,41 @@ get: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The customer's limit. + offset: + type: number + title: offset + description: The customer's offset. + count: + type: number + title: count + description: The customer's count. + - type: object + description: SUMMARY + required: + - addresses + properties: + addresses: + type: array + description: The customer's addresses. + items: + $ref: ../components/schemas/AdminCustomerAddress.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -166,7 +201,63 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminCreateCustomerAddress.yaml + description: SUMMARY + properties: + address_name: + type: string + title: address_name + description: The customer's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The customer's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The customer's is default billing. + company: + type: string + title: company + description: The customer's company. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + address_1: + type: string + title: address_1 + description: The customer's address 1. + address_2: + type: string + title: address_2 + description: The customer's address 2. + city: + type: string + title: city + description: The customer's city. + country_code: + type: string + title: country_code + description: The customer's country code. + province: + type: string + title: province + description: The customer's province. + postal_code: + type: string + title: postal_code + description: The customer's postal code. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. x-codeSamples: - lang: Shell label: cURL @@ -175,6 +266,12 @@ post: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCustomerResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 87d57d7d9d..2e0a1f5b9a 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 @@ -86,6 +86,12 @@ get: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCustomerAddressResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -179,7 +185,63 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminCreateCustomerAddress.yaml + description: SUMMARY + properties: + address_name: + type: string + title: address_name + description: The customer's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The customer's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The customer's is default billing. + company: + type: string + title: company + description: The customer's company. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + address_1: + type: string + title: address_1 + description: The customer's address 1. + address_2: + type: string + title: address_2 + description: The customer's address 2. + city: + type: string + title: city + description: The customer's city. + country_code: + type: string + title: country_code + description: The customer's country code. + province: + type: string + title: province + description: The customer's province. + postal_code: + type: string + title: postal_code + description: The customer's postal code. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. x-codeSamples: - lang: Shell label: cURL @@ -189,6 +251,12 @@ post: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminCustomerResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -289,6 +357,33 @@ delete: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + 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 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 17c6eb4356..9a652e13fd 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 @@ -73,6 +73,38 @@ get: tags: - Draft Orders responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The draft order's limit. + offset: + type: number + title: offset + description: The draft order's offset. + count: + type: number + title: count + description: The draft order's count. + - type: object + description: SUMMARY + required: + - draft_orders + properties: + draft_orders: + $ref: ../components/schemas/AdminOrder.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -154,16 +186,7 @@ post: content: application/json: schema: - type: object description: SUMMARY - required: - - sales_channel_id - - email - - customer_id - - region_id - - currency_code - - shipping_methods - - metadata properties: status: type: boolean @@ -444,6 +467,12 @@ post: tags: - Draft Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminDraftOrderResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -456,3 +485,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createOrdersWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml index 4c04e02d71..87a5beb5b6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml @@ -79,6 +79,12 @@ get: tags: - Draft Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminDraftOrderResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml new file mode 100644 index 0000000000..d024dea878 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml @@ -0,0 +1,211 @@ +get: + operationId: GetExchanges + summary: List Exchanges + description: >- + Retrieve a list of exchanges. The exchanges can be filtered by fields such + as `id`. The exchanges can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_exchanges/get.sh + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The exchange's limit. + offset: + type: number + title: offset + description: The exchange's offset. + count: + type: number + title: count + description: The exchange's count. + - type: object + description: SUMMARY + required: + - exchanges + properties: + exchanges: + $ref: ../components/schemas/AdminExchange.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostExchanges + summary: Create Exchange + description: Create a exchange. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostOrderExchangesReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_exchanges/post.sh + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminExchangeOrderResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml new file mode 100644 index 0000000000..e8f0e137be --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml @@ -0,0 +1,100 @@ +post: + operationId: PostExchangesIdCancel + summary: Add Cancels to Exchange + description: Add a list of cancels to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostCancelExchangeReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_exchanges_{id}_cancel/post.sh + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminExchangeResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml new file mode 100644 index 0000000000..7cc4270e23 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml @@ -0,0 +1,102 @@ +post: + operationId: PostExchangesIdInboundItems + summary: Add Items to Exchange + description: Add a list of items to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: >- + ../components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_exchanges_{id}_inbound_items/post.sh + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminExchangeReturnResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: orderExchangeRequestItemReturnWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml new file mode 100644 index 0000000000..841e4e02fa --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml @@ -0,0 +1,214 @@ +post: + operationId: PostExchangesIdInboundItemsAction_id + summary: Add Items to Exchange + description: Add a list of items to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The exchange's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: >- + ../components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/post.sh + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminExchangeReturnResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: updateRequestItemReturnWorkflow +delete: + operationId: DeleteExchangesIdInboundItemsAction_id + summary: Remove Items from Exchange + description: >- + Remove a list of items from a exchange. This doesn't delete the Item, only + the association between the Item and the exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The exchange's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/delete.sh + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminExchangeReturnResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: removeItemReturnActionWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml new file mode 100644 index 0000000000..bf0226b477 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml @@ -0,0 +1,102 @@ +post: + operationId: PostExchangesIdInboundShippingMethod + summary: Add Shipping Methods to Exchange + description: Add a list of shipping methods to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostReturnsShippingReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method/post.sh + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminExchangeReturnResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: createExchangeShippingMethodWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml new file mode 100644 index 0000000000..348842fc37 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml @@ -0,0 +1,214 @@ +post: + operationId: PostExchangesIdInboundShippingMethodAction_id + summary: Add Shipping Methods to Exchange + description: Add a list of shipping methods to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The exchange's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostExchangesShippingActionReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/post.sh + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminExchangePreviewResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: updateReturnShippingMethodWorkflow +delete: + operationId: DeleteExchangesIdInboundShippingMethodAction_id + summary: Remove Shipping Methods from Exchange + description: >- + Remove a list of shipping methods from a exchange. This doesn't delete the + Shipping Method, only the association between the Shipping Method and the + exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The exchange's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/delete.sh + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminExchangeReturnResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: removeReturnShippingMethodWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml new file mode 100644 index 0000000000..cc678e09a3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml @@ -0,0 +1,101 @@ +post: + operationId: PostExchangesIdOutboundItems + summary: Add Items to Exchange + description: Add a list of items to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostExchangesAddItemsReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_exchanges_{id}_outbound_items/post.sh + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminExchangePreviewResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: orderExchangeAddNewItemWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml new file mode 100644 index 0000000000..402a85aca8 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml @@ -0,0 +1,213 @@ +post: + operationId: PostExchangesIdOutboundItemsAction_id + summary: Add Items to Exchange + description: Add a list of items to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The exchange's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostExhangesItemsActionReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/post.sh + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminExchangePreviewResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: updateExchangeAddItemWorkflow +delete: + operationId: DeleteExchangesIdOutboundItemsAction_id + summary: Remove Items from Exchange + description: >- + Remove a list of items from a exchange. This doesn't delete the Item, only + the association between the Item and the exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The exchange's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/delete.sh + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminExchangePreviewResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: removeItemExchangeActionWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml new file mode 100644 index 0000000000..4c766b4354 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml @@ -0,0 +1,102 @@ +post: + operationId: PostExchangesIdOutboundShippingMethod + summary: Add Shipping Methods to Exchange + description: Add a list of shipping methods to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostExchangesShippingReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method/post.sh + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminExchangePreviewResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: createExchangeShippingMethodWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml new file mode 100644 index 0000000000..50e2659e7a --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml @@ -0,0 +1,214 @@ +post: + operationId: PostExchangesIdOutboundShippingMethodAction_id + summary: Add Shipping Methods to Exchange + description: Add a list of shipping methods to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The exchange's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostExchangesShippingActionReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/post.sh + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminExchangePreviewResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: updateExchangeShippingMethodWorkflow +delete: + operationId: DeleteExchangesIdOutboundShippingMethodAction_id + summary: Remove Shipping Methods from Exchange + description: >- + Remove a list of shipping methods from a exchange. This doesn't delete the + Shipping Method, only the association between the Shipping Method and the + exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The exchange's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/delete.sh + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminExchangePreviewResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: removeExchangeShippingMethodWorkflow 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 new file mode 100644 index 0000000000..0779ce0897 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml @@ -0,0 +1,214 @@ +post: + operationId: PostExchangesIdRequest + summary: Add Requests to Exchange + description: Add a list of requests to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_exchanges_{id}_request/post.sh + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminExchangeRequestResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: confirmExchangeRequestWorkflow +delete: + operationId: DeleteExchangesIdRequest + summary: Remove Requests from Exchange + description: >- + Remove a list of requests from a exchange. This doesn't delete the Request, + only the association between the Request and the exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_exchanges_{id}_request/delete.sh + tags: + - Exchanges + responses: + '200': + description: OK + 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 exchange's object. + deleted: + type: boolean + title: deleted + description: The exchange's deleted. + parent: + type: object + description: The exchange's parent. + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml index 0b178f24c4..b5f01ac9d9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml @@ -118,6 +118,12 @@ get: tags: - Fulfillment Providers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminFulfillmentProviderListResponse.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.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml index 28a9ae09b1..05373cd993 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml @@ -197,6 +197,12 @@ post: tags: - Fulfillment Sets responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminFulfillmentSetResponse.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 a67960c0e2..22d628afff 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 @@ -433,6 +433,33 @@ delete: tags: - Fulfillment Sets responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The fulfillment set's ID. + object: + type: string + title: object + description: The fulfillment set's object. + deleted: + type: boolean + title: deleted + description: The fulfillment set's deleted. + parent: + type: object + description: The fulfillment set's parent. '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml index c08adf30dd..8dfe9d481f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml @@ -76,6 +76,12 @@ post: tags: - Fulfillments responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminFulfillmentResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -88,3 +94,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createFulfillmentWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_cancel.yaml index 2b811e6484..c10190ccd7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_cancel.yaml @@ -82,6 +82,12 @@ post: tags: - Fulfillments responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminFulfillmentResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml index 23342c13cd..19f8001ff2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml @@ -82,6 +82,12 @@ post: tags: - Fulfillments responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminFulfillmentResponse.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 1b7c370490..227b09cd80 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 @@ -311,11 +311,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The inventory item's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The inventory item's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -328,6 +338,41 @@ get: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The inventory item's limit. + offset: + type: number + title: offset + description: The inventory item's offset. + count: + type: number + title: count + description: The inventory item's count. + - type: object + description: SUMMARY + required: + - inventory_items + properties: + inventory_items: + type: array + description: The inventory item's inventory items. + items: + $ref: ../components/schemas/AdminInventoryItem.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -510,6 +555,12 @@ post: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminInventoryItemResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -522,3 +573,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createInventoryItemsWorkflow 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 c67a7a124c..cd8eed4249 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 @@ -79,6 +79,12 @@ get: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminInventoryItemResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -246,6 +252,12 @@ post: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminInventoryItemResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -337,6 +349,33 @@ delete: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + 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 inventory item's object. + deleted: + type: boolean + title: deleted + description: The inventory item's 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.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml index 0984c1e0d6..bdc1f5cf36 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml @@ -85,11 +85,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The inventory item's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The inventory item's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -103,6 +113,41 @@ get: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The inventory item's limit. + offset: + type: number + title: offset + description: The inventory item's offset. + count: + type: number + title: count + description: The inventory item's count. + - type: object + description: SUMMARY + required: + - inventory_levels + properties: + inventory_levels: + type: array + description: The inventory item's inventory levels. + items: + $ref: ../components/schemas/InventoryLevel.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -216,6 +261,12 @@ post: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminInventoryItemResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml index 1a6691dd0c..cf048f0752 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml @@ -128,6 +128,19 @@ post: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - inventory_item + properties: + inventory_item: + type: object + description: The inventory item's details. '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 0292b3116e..55884790df 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 @@ -99,6 +99,12 @@ post: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminInventoryItemResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -200,6 +206,33 @@ delete: tags: - Inventory Items responses: + '200': + description: OK + content: + application/json: + schema: + 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 inventory item's object. + deleted: + type: boolean + title: deleted + description: The inventory item's 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_invites.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml index d1ef2c0459..67f8ff541a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml @@ -204,11 +204,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The invite's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The invite's $or. + items: + type: object + title: $or x-codeSamples: - lang: Shell label: cURL @@ -217,6 +227,41 @@ get: tags: - Invites responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The invite's limit. + offset: + type: number + title: offset + description: The invite's offset. + count: + type: number + title: count + description: The invite's count. + - type: object + description: SUMMARY + required: + - invites + properties: + invites: + type: array + description: The invite's invites. + items: + $ref: ../components/schemas/AdminInvite.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -312,6 +357,12 @@ post: tags: - Invites responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminInviteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml index bc4002d21e..2f4a899477 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml @@ -91,6 +91,28 @@ post: tags: - Invites responses: + '200': + description: OK + content: + application/json: + schema: + oneOf: + - type: object + description: SUMMARY + required: + - user + properties: + user: + $ref: ../components/schemas/AdminUser.yaml + - type: object + description: SUMMARY + required: + - message + properties: + message: + type: string + title: message + description: The invite's message. '400': $ref: ../components/responses/400_error.yaml '401': 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 032a1cf791..48affe3365 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 @@ -75,6 +75,12 @@ get: tags: - Invites responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminInviteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -162,6 +168,33 @@ delete: tags: - Invites responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The invite's ID. + object: + type: string + title: object + description: The invite's object. + deleted: + type: boolean + title: deleted + description: The invite's 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_invites_{id}_resend.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml index ad05fc91a7..21cd7d77ac 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml @@ -73,6 +73,12 @@ post: tags: - Invites responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminInviteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml b/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml index cbf87b01ac..f062b7cb00 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml @@ -100,11 +100,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The notification's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The notification's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -117,6 +127,12 @@ get: tags: - Notifications responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminNotificationListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_notifications_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_notifications_{id}.yaml index d5f5674561..7e5bdb187c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_notifications_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_notifications_{id}.yaml @@ -79,6 +79,12 @@ get: tags: - Notifications responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminNotificationResponse.yaml '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 ecf17ea167..fff67acdc9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml @@ -73,6 +73,41 @@ get: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The order's limit. + offset: + type: number + title: offset + description: The order's offset. + count: + type: number + title: count + description: The order's count. + - type: object + description: SUMMARY + required: + - orders + properties: + orders: + type: array + description: The order's orders. + items: + $ref: ../components/schemas/AdminOrder.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml index 01b4b15ca5..62c40450f5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml @@ -79,6 +79,12 @@ get: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -170,6 +176,12 @@ post: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml index 8cdb268306..aa4f9fdab9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml @@ -82,6 +82,12 @@ post: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml index fa00e5d201..a21986ff6b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml @@ -77,6 +77,12 @@ post: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml index b49348465d..44f3510f05 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml @@ -73,7 +73,12 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminCompleteOrder.yaml + description: SUMMARY + properties: + order_id: + type: string + title: order_id + description: The order's order id. x-codeSamples: - lang: Shell label: cURL @@ -82,6 +87,12 @@ post: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml index 27fceeae92..066ece5955 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml @@ -73,7 +73,37 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminOrderCreateFulfillment.yaml + description: SUMMARY + properties: + items: + type: array + description: The order's items. + items: + 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. + location_id: + type: string + title: location_id + description: The order's location id. + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + metadata: + type: object + description: The order's metadata. x-codeSamples: - lang: Shell label: cURL @@ -82,6 +112,12 @@ post: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml index c59fccb354..3b76af2726 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml @@ -79,7 +79,12 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminOrderCancelFulfillment.yaml + description: SUMMARY + properties: + no_notification: + type: boolean + title: no_notification + description: The order's no notification. x-codeSamples: - lang: Shell label: cURL @@ -89,6 +94,12 @@ post: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml index c04fe26865..5a8691358d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml @@ -79,7 +79,56 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminOrderCreateShipment.yaml + description: SUMMARY + properties: + items: + type: array + description: The order's items. + items: + 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. + labels: + type: array + description: The order's labels. + items: + type: object + description: The label's labels. + required: + - tracking_number + - tracking_url + - label_url + properties: + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + metadata: + type: object + description: The order's metadata. x-codeSamples: - lang: Shell label: cURL @@ -89,6 +138,12 @@ post: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_preview.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_preview.yaml index 493342a67a..0118ccce36 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_preview.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_preview.yaml @@ -79,6 +79,12 @@ get: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderPreviewResponse.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 7f28629bac..f4df65e099 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments.yaml @@ -202,11 +202,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The payment's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The payment's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -219,6 +229,41 @@ get: tags: - Payments responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The payment's limit. + offset: + type: number + title: offset + description: The payment's offset. + count: + type: number + title: count + description: The payment's count. + - type: object + description: SUMMARY + required: + - payments + properties: + payments: + type: array + description: The payment's payments. + items: + $ref: ../components/schemas/AdminPayment.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml index 399e1694bd..0b0f255b78 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml @@ -86,11 +86,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The payment's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The payment's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -103,6 +113,41 @@ get: tags: - Payments responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The payment's limit. + offset: + type: number + title: offset + description: The payment's offset. + count: + type: number + title: count + description: The payment's count. + - type: object + description: SUMMARY + required: + - payment_providers + properties: + payment_providers: + type: array + description: The payment's payment providers. + items: + $ref: ../components/schemas/AdminPaymentProvider.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}.yaml index 84774f47b8..db0da5e9d6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}.yaml @@ -79,6 +79,12 @@ get: tags: - Payments responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPaymentResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml index cee5651f6d..2bf18d8e29 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml @@ -88,6 +88,12 @@ post: tags: - Payments responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPaymentResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml index 9086db3c76..69da43ac26 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml @@ -80,6 +80,14 @@ post: type: number title: amount description: The payment's amount. + refund_reason_id: + type: string + title: refund_reason_id + description: The payment's refund reason id. + note: + type: string + title: note + description: The payment's note. x-codeSamples: - lang: Shell label: cURL @@ -88,6 +96,12 @@ post: tags: - Payments responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPaymentResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 f46970a316..fce1c9e946 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 @@ -73,6 +73,12 @@ get: tags: - Price Lists responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPriceListListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -163,6 +169,12 @@ post: tags: - Price Lists responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPriceListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml index 540a4bb049..6ed548eb3e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml @@ -79,6 +79,12 @@ get: tags: - Price Lists responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPriceListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -175,6 +181,12 @@ post: tags: - Price Lists responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPriceListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -266,6 +278,12 @@ delete: tags: - Price Lists responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPriceListDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml index 8b8dc28d93..18d2550acc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml @@ -166,6 +166,12 @@ post: tags: - Price Lists responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPriceListBatchResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml index c03947060a..43c8dd3e92 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml @@ -98,6 +98,12 @@ post: tags: - Price Lists responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPriceListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 848598d63c..13f395aa9c 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 @@ -74,6 +74,12 @@ get: tags: - Price Preferences responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPricePreferenceListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -164,6 +170,12 @@ post: tags: - Price Preferences responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPricePreferenceResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-preferences_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-preferences_{id}.yaml index e092a8a6c4..28a16d7797 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-preferences_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-preferences_{id}.yaml @@ -79,6 +79,12 @@ get: tags: - Price Preferences responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPricePreferenceResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -175,6 +181,12 @@ post: tags: - Price Preferences responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPricePreferenceResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -266,6 +278,12 @@ delete: tags: - Price Preferences responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPricePreferenceDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 dc1e2d2034..248733e68f 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 @@ -263,11 +263,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The product category's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The product category's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -431,3 +441,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createProductCategoriesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml index c2844cf101..ba99ddfeff 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml @@ -330,6 +330,12 @@ delete: tags: - Product Categories responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductCategoryDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 21d2052461..edc68d2488 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 @@ -202,11 +202,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The product tag's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The product tag's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -219,6 +229,12 @@ get: tags: - Product Tags responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductTagListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -321,6 +337,12 @@ post: tags: - Product Tags responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductTagResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -333,3 +355,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createProductTagsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml index d5e05261b5..222f8c1923 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml @@ -79,6 +79,12 @@ get: tags: - Product Tags responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductTagResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -186,6 +192,12 @@ post: tags: - Product Tags responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductTagResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -198,6 +210,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateProductTagsWorkflow delete: operationId: DeleteProductTagsId summary: Delete a Product Tag @@ -277,6 +290,12 @@ delete: tags: - Product Tags responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductTagDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 576b70f231..51a008a784 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 @@ -202,11 +202,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The product type's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The product type's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -219,6 +229,12 @@ get: tags: - Product Types responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductTypeListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -321,6 +337,12 @@ post: tags: - Product Types responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductTypeResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -333,3 +355,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createProductTypesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml index b0ba58ecad..6652866393 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml @@ -79,6 +79,12 @@ get: tags: - Product Types responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductTypeResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -186,6 +192,12 @@ post: tags: - Product Types responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductTypeResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -198,6 +210,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateProductTypesWorkflow delete: operationId: DeleteProductTypesId summary: Delete a Product Type @@ -277,6 +290,12 @@ delete: tags: - Product Types responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductTypeDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 new file mode 100644 index 0000000000..a5da729301 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml @@ -0,0 +1,120 @@ +get: + operationId: GetProductVariants + summary: List Product Variants + description: >- + Retrieve a list of product variants. The product variants can be filtered by + fields such as `id`. The product variants can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_product-variants/get.sh + tags: + - Product Variants + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The product variant's limit. + offset: + type: number + title: offset + description: The product variant's offset. + count: + type: number + title: count + description: The product variant's count. + - type: object + description: SUMMARY + required: + - variants + properties: + variants: + type: array + description: The product variant's variants. + items: + $ref: ../components/schemas/AdminProductVariant.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_products.yaml index 55768f9cc0..0b9bf1908e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products.yaml @@ -12062,6 +12062,9 @@ get: x-schemaName: BaseProductListParams - type: object description: The $or's details. + type: array + items: + type: object - name: $or in: query description: The product's $or. @@ -13976,6 +13979,9 @@ get: x-schemaName: BaseProductListParams - type: object description: The $or's details. + type: array + items: + type: object security: - api_token: [] - cookie_auth: [] @@ -14104,7 +14110,148 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminCreateProduct.yaml + description: SUMMARY + properties: + title: + type: string + title: title + description: The product's title. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + description: + type: string + title: description + description: The product's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + discountable: + type: boolean + title: discountable + description: The product's discountable. + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + required: + - url + properties: + url: + type: string + title: url + description: The image's url. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + handle: + type: string + title: handle + description: The product's handle. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + type_id: + type: string + title: type_id + description: The product's type id. + collection_id: + type: string + title: collection_id + description: The product's collection id. + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + required: + - id + properties: + id: + type: string + title: id + description: The category's ID. + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + required: + - id + properties: + id: + type: string + title: id + description: The tag's ID. + options: + type: array + description: The product's options. + items: + $ref: ../components/schemas/AdminCreateProductOption.yaml + variants: + type: array + description: The product's variants. + items: + $ref: ../components/schemas/AdminCreateProductVariant.yaml + sales_channels: + type: array + description: The product's sales channels. + items: + type: object + description: The sales channel's sales channels. + required: + - id + properties: + id: + type: string + title: id + description: The sales channel's ID. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + width: + type: number + title: width + description: The product's width. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + origin_country: + type: string + title: origin_country + description: The product's origin country. + material: + type: string + title: material + description: The product's material. + metadata: + type: object + description: The product's metadata. x-codeSamples: - lang: Shell label: cURL @@ -14131,3 +14278,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createProductsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_batch.yaml index a44f0260ef..9f87fcf6ec 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_batch.yaml @@ -94,3 +94,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: batchProductsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml index a9970840be..3c12122204 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml @@ -94,3 +94,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: exportProductsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml index 051d7ae3f9..7e68dc7f07 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml @@ -94,3 +94,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: importProductsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml index d6350fb3bf..f4a6ec449e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml @@ -172,7 +172,150 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminUpdateProduct.yaml + description: SUMMARY + properties: + title: + type: string + title: title + description: The product's title. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + description: + type: string + title: description + description: The product's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + discountable: + type: boolean + title: discountable + description: The product's discountable. + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + required: + - url + properties: + url: + type: string + title: url + description: The image's url. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + handle: + type: string + title: handle + description: The product's handle. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + type_id: + type: string + title: type_id + description: The product's type id. + collection_id: + type: string + title: collection_id + description: The product's collection id. + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + required: + - id + properties: + id: + type: string + title: id + description: The category's ID. + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + required: + - id + properties: + id: + type: string + title: id + description: The tag's ID. + options: + type: array + description: The product's options. + items: + $ref: ../components/schemas/AdminUpdateProductOption.yaml + variants: + type: array + description: The product's variants. + items: + oneOf: + - $ref: ../components/schemas/AdminCreateProductVariant.yaml + - $ref: ../components/schemas/AdminUpdateProductVariant.yaml + sales_channels: + type: array + description: The product's sales channels. + items: + type: object + description: The sales channel's sales channels. + required: + - id + properties: + id: + type: string + title: id + description: The sales channel's ID. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + width: + type: number + title: width + description: The product's width. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + origin_country: + type: string + title: origin_country + description: The product's origin country. + material: + type: string + title: material + description: The product's material. + metadata: + type: object + description: The product's metadata. x-codeSamples: - lang: Shell label: cURL @@ -199,6 +342,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateProductsWorkflow delete: operationId: DeleteProductsId summary: Delete a Product diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml index 2f439805f0..c7c3b55e9b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml @@ -606,6 +606,9 @@ get: x-schemaName: BaseProductOptionParams - type: object description: The $or's details. + type: array + items: + type: object - name: $or in: query description: The product's $or. @@ -1095,6 +1098,9 @@ get: x-schemaName: BaseProductOptionParams - type: object description: The $or's details. + type: array + items: + type: object security: - api_token: [] - cookie_auth: [] @@ -1229,7 +1235,19 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminCreateProductOption.yaml + description: SUMMARY + properties: + title: + type: string + title: title + description: The product's title. + values: + type: array + description: The product's values. + items: + type: string + title: values + description: The value's values. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml index d6417d6c02..1a932887be 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml @@ -184,7 +184,19 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminUpdateProductOption.yaml + description: SUMMARY + properties: + title: + type: string + title: title + description: The product's title. + values: + type: array + description: The product's values. + items: + type: string + title: values + description: The value's values. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml index ccb966c1c5..d598bf43e5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml @@ -201,7 +201,83 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminCreateProductVariant.yaml + description: SUMMARY + properties: + title: + type: string + title: title + description: The product's title. + sku: + type: string + title: sku + description: The product's sku. + ean: + type: string + title: ean + description: The product's ean. + upc: + type: string + title: upc + description: The product's upc. + barcode: + type: string + title: barcode + description: The product's barcode. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The product's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The product's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The product's variant rank. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + width: + type: number + title: width + description: The product's width. + origin_country: + type: string + title: origin_country + description: The product's origin country. + material: + type: string + title: material + description: The product's material. + metadata: + type: object + description: The product's metadata. + prices: + type: array + description: The product's prices. + items: + $ref: ../components/schemas/AdminCreateProductVariantPrice.yaml + options: + type: object + description: The product's options. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_batch.yaml index 5865f7a949..0085279c02 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_batch.yaml @@ -100,3 +100,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: batchProductVariantsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml index a5c5160064..f7c918a372 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml @@ -149,6 +149,13 @@ post: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: >- + ../components/schemas/AdminProductVariantInventoryBatchResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -161,3 +168,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: batchLinksWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml index 65e7abbe51..e11f050abe 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml @@ -184,7 +184,83 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminUpdateProductVariant.yaml + description: SUMMARY + properties: + title: + type: string + title: title + description: The product's title. + sku: + type: string + title: sku + description: The product's sku. + ean: + type: string + title: ean + description: The product's ean. + upc: + type: string + title: upc + description: The product's upc. + barcode: + type: string + title: barcode + description: The product's barcode. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The product's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The product's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The product's variant rank. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + width: + type: number + title: width + description: The product's width. + origin_country: + type: string + title: origin_country + description: The product's origin country. + material: + type: string + title: material + description: The product's material. + metadata: + type: object + description: The product's metadata. + prices: + type: array + description: The product's prices. + items: + $ref: ../components/schemas/AdminCreateProductVariantPrice.yaml + options: + type: object + description: The product's options. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml index 014a6dbbbc..8f04ccd950 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml @@ -89,6 +89,12 @@ post: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductVariantResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml index e7c3ba1e09..52d09f114b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml @@ -95,6 +95,12 @@ post: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductVariantResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -202,6 +208,13 @@ delete: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: >- + ../components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -214,3 +227,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: dismissLinksWorkflow 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 cbefe03c1d..7c6906ebf3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml @@ -221,11 +221,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The promotion's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The promotion's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -238,6 +248,41 @@ get: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The promotion's limit. + offset: + type: number + title: offset + description: The promotion's offset. + count: + type: number + title: count + description: The promotion's count. + - type: object + description: SUMMARY + required: + - promotions + properties: + promotions: + type: array + description: The promotion's promotions. + items: + $ref: ../components/schemas/AdminPromotion.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -319,13 +364,7 @@ post: content: application/json: schema: - type: object description: SUMMARY - required: - - code - - type - - campaign_id - - application_method properties: code: type: string @@ -595,6 +634,12 @@ post: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPromotionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml index 7c42b5de28..5ab97bbb47 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml @@ -97,6 +97,21 @@ get: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - attributes + properties: + attributes: + type: array + description: The promotion's attributes. + items: + $ref: ../components/schemas/AdminRuleAttributeOption.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml index c12ed383ff..7138bb314a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml @@ -102,6 +102,21 @@ get: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - values + properties: + values: + type: array + description: The promotion's values. + items: + $ref: ../components/schemas/AdminRuleValueOption.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 e4ca19a175..aa0b98aad0 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 @@ -79,6 +79,12 @@ get: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPromotionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -166,10 +172,7 @@ post: content: application/json: schema: - type: object description: SUMMARY - required: - - campaign_id properties: code: type: string @@ -436,6 +439,12 @@ post: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminPromotionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -527,6 +536,33 @@ delete: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The promotion's ID. + object: + type: string + title: object + description: The promotion's object. + deleted: + type: boolean + title: deleted + description: The promotion's 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_promotions_{id}_buy-rules_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch.yaml index 6ad9fd6578..50cc535c02 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch.yaml @@ -176,6 +176,51 @@ post: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - created + - updated + - deleted + properties: + created: + type: array + description: The promotion's created. + items: + $ref: ../components/schemas/AdminPromotionRule.yaml + updated: + type: array + description: The promotion's updated. + items: + $ref: ../components/schemas/AdminPromotionRule.yaml + deleted: + type: object + description: The promotion's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. '400': $ref: ../components/responses/400_error.yaml '401': @@ -188,3 +233,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: batchPromotionRulesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch.yaml index de0c896bc4..13be0fad44 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch.yaml @@ -176,6 +176,51 @@ post: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - created + - updated + - deleted + properties: + created: + type: array + description: The promotion's created. + items: + $ref: ../components/schemas/AdminPromotionRule.yaml + updated: + type: array + description: The promotion's updated. + items: + $ref: ../components/schemas/AdminPromotionRule.yaml + deleted: + type: object + description: The promotion's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. '400': $ref: ../components/responses/400_error.yaml '401': @@ -188,3 +233,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: batchPromotionRulesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch.yaml index c40b378a5d..980977b0b4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch.yaml @@ -176,6 +176,51 @@ post: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - created + - updated + - deleted + properties: + created: + type: array + description: The promotion's created. + items: + $ref: ../components/schemas/AdminPromotionRule.yaml + updated: + type: array + description: The promotion's updated. + items: + $ref: ../components/schemas/AdminPromotionRule.yaml + deleted: + type: object + description: The promotion's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. '400': $ref: ../components/responses/400_error.yaml '401': @@ -188,3 +233,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: batchPromotionRulesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_{rule_type}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_{rule_type}.yaml index 6116671ecf..c7db32ed7d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_{rule_type}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_{rule_type}.yaml @@ -85,6 +85,21 @@ get: tags: - Promotions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - rules + properties: + rules: + type: array + description: The promotion's rules. + items: + $ref: ../components/schemas/AdminPromotionRule.yaml '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 new file mode 100644 index 0000000000..093cfc1f8b --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml @@ -0,0 +1,228 @@ +get: + operationId: GetRefundReasons + summary: List Refund Reasons + description: >- + Retrieve a list of refund reasons. The refund reasons can be filtered by + fields such as `id`. The refund reasons can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_refund-reasons/get.sh + tags: + - Refund Reasons + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The refund reason's limit. + offset: + type: number + title: offset + description: The refund reason's offset. + count: + type: number + title: count + description: The refund reason's count. + - type: object + description: SUMMARY + required: + - refund_reasons + properties: + refund_reasons: + type: array + description: The refund reason's refund reasons. + items: + $ref: ../components/schemas/AdminRefundReason.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostRefundReasons + summary: Create Refund Reason + description: Create a refund reason. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + 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. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_refund-reasons/post.sh + tags: + - Refund Reasons + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/RefundReasonResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: createRefundReasonsWorkflow 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 new file mode 100644 index 0000000000..69c1258af8 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml @@ -0,0 +1,325 @@ +get: + operationId: GetRefundReasonsId + summary: Get a Refund Reason + description: >- + Retrieve a refund reason by its ID. You can expand the refund reason's + relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The refund reason's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_refund-reasons_{id}/get.sh + tags: + - Refund Reasons + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/RefundReasonResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostRefundReasonsId + summary: Update a Refund Reason + description: Update a refund reason's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The refund reason's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - description + properties: + label: + type: string + title: label + description: The refund reason's label. + description: + type: string + title: description + description: The refund reason's description. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_refund-reasons_{id}/post.sh + tags: + - Refund Reasons + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/RefundReasonResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteRefundReasonsId + summary: Delete a Refund Reason + description: Delete a refund reason. + x-authenticated: true + parameters: + - name: id + in: path + description: The refund reason's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_refund-reasons_{id}/delete.sh + tags: + - Refund Reasons + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The refund reason's ID. + object: + type: string + title: object + description: The refund reason's object. + deleted: + type: boolean + title: deleted + description: The refund reason's deleted. + parent: + type: object + description: The refund reason's parent. + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml 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 d08bf805e4..a786cad8b2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml @@ -216,11 +216,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The region's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The region's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -233,6 +243,41 @@ get: tags: - Regions responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The region's limit. + offset: + type: number + title: offset + description: The region's offset. + count: + type: number + title: count + description: The region's count. + - type: object + description: SUMMARY + required: + - regions + properties: + regions: + type: array + description: The region's regions. + items: + $ref: ../components/schemas/AdminRegion.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -362,6 +407,12 @@ post: tags: - Regions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminRegionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -374,3 +425,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createRegionsWorkflow 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 636b09e85f..1c3a700afb 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 @@ -79,6 +79,12 @@ get: tags: - Regions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminRegionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -212,6 +218,12 @@ post: tags: - Regions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminRegionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -224,6 +236,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateRegionsWorkflow delete: operationId: DeleteRegionsId summary: Delete a Region @@ -303,6 +316,33 @@ delete: tags: - Regions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The region's ID. + object: + type: string + title: object + description: The region's object. + deleted: + type: boolean + title: deleted + description: The region's 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 e9fc8c42c1..c962aac96f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml @@ -299,6 +299,41 @@ get: tags: - Reservations responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The reservation's limit. + offset: + type: number + title: offset + description: The reservation's offset. + count: + type: number + title: count + description: The reservation's count. + - type: object + description: SUMMARY + required: + - reservations + properties: + reservations: + type: array + description: The reservation's reservations. + items: + $ref: ../components/schemas/ReservationResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -421,6 +456,12 @@ post: tags: - Reservations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReservationResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -433,3 +474,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createReservationsWorkflow 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 c92769f5df..6475969caa 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 @@ -79,6 +79,12 @@ get: tags: - Reservations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReservationResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -195,6 +201,12 @@ post: tags: - Reservations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReservationResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -286,6 +298,33 @@ delete: tags: - Reservations responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The reservation's ID. + object: + type: string + title: object + description: The reservation's object. + deleted: + type: boolean + title: deleted + description: The reservation's 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 96e692cede..cef409643a 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 @@ -61,6 +61,131 @@ 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 return reason's q. + required: false + schema: + type: string + title: q + description: The return reason's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The return reason's ID. + - type: array + description: The return reason's ID. + items: + type: string + title: id + description: The id's ID. + - name: value + in: query + required: false + schema: + oneOf: + - type: string + title: value + description: The return reason's value. + - type: array + description: The return reason's value. + items: + type: string + title: value + description: The value's details. + - name: label + in: query + required: false + schema: + oneOf: + - type: string + title: label + description: The return reason's label. + - type: array + description: The return reason's label. + items: + type: string + title: label + description: The label's details. + - name: description + in: query + required: false + schema: + oneOf: + - type: string + title: description + description: The return reason's description. + - type: array + description: The return reason's description. + items: + type: string + title: description + description: The description's details. + - name: parent_return_reason_id + in: query + required: false + schema: + oneOf: + - type: string + title: parent_return_reason_id + description: The return reason's parent return reason id. + - type: array + description: The return reason's parent return reason id. + items: + type: string + title: parent_return_reason_id + description: The parent return reason id's details. + - name: created_at + in: query + description: The return reason's created at. + required: false + schema: + type: string + format: date-time + title: created_at + description: The return reason's created at. + - name: updated_at + in: query + description: The return reason's updated at. + required: false + schema: + type: string + format: date-time + title: updated_at + description: The return reason's updated at. + - name: deleted_at + in: query + description: The return reason's deleted at. + required: false + schema: + type: string + format: date-time + title: deleted_at + description: The return reason's deleted at. + - name: $and + in: query + description: The return reason's $and. + required: false + schema: + type: array + description: The return reason's $and. + items: + type: object + title: $and + - name: $or + in: query + description: The return reason's $or. + required: false + schema: + type: array + description: The return reason's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -73,6 +198,12 @@ get: tags: - Return Reasons responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnReasonListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -163,6 +294,12 @@ post: tags: - Return Reasons responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnReasonResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 46a4affca5..ff3975be47 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 @@ -79,6 +79,12 @@ get: tags: - Return Reasons responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnReasonResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -175,6 +181,12 @@ post: tags: - Return Reasons responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnReasonResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -266,6 +278,33 @@ delete: tags: - Return Reasons responses: + '200': + description: OK + 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 return reason's object. + deleted: + type: boolean + title: deleted + description: The return reason's deleted. + parent: + type: object + description: The return reason's parent. '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 e7d20b5529..c05930614a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml @@ -73,6 +73,41 @@ get: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The return's limit. + offset: + type: number + title: offset + description: The return's offset. + count: + type: number + title: count + description: The return's count. + - type: object + description: SUMMARY + required: + - returns + properties: + returns: + type: array + description: The return's returns. + items: + $ref: ../components/schemas/AdminReturn.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -163,6 +198,12 @@ post: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderReturnResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml index 506850c7f7..9277475ea7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml @@ -79,6 +79,12 @@ get: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -175,6 +181,12 @@ post: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -187,3 +199,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateReturnWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml index 4aa235fabc..4a1f51068c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml @@ -77,6 +77,12 @@ post: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml index c642e7a29e..e2133145e8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml @@ -82,6 +82,12 @@ post: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -94,3 +100,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: dismissItemReturnRequestWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml index 223759f1af..1303256ea2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml @@ -90,6 +90,12 @@ post: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -102,6 +108,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateReceiveItemReturnRequestWorkflow delete: operationId: DeleteReturnsIdDismissItemsAction_id summary: Remove Dismiss Items from Return @@ -190,6 +197,12 @@ delete: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -202,3 +215,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: removeItemReturnActionWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml index 44ef212554..8d706eb5c9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml @@ -82,6 +82,12 @@ post: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -94,3 +100,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: receiveItemReturnRequestWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml index ee12ae986c..9ea624fb9e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml @@ -90,6 +90,12 @@ post: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -102,6 +108,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateReceiveItemReturnRequestWorkflow delete: operationId: DeleteReturnsIdReceiveItemsAction_id summary: Remove Receive Items from Return @@ -190,6 +197,12 @@ delete: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -202,3 +215,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: removeItemReceiveReturnActionWorkflow 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 f0f7669c0d..7339dcacae 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 @@ -82,6 +82,12 @@ post: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderReturnResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -175,6 +181,33 @@ delete: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The return's ID. + object: + type: string + title: object + description: The return's object. + deleted: + type: boolean + title: deleted + description: The return's 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}_receive_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml index b554050bb6..4032342b48 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml @@ -82,6 +82,12 @@ post: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -94,3 +100,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: confirmReturnReceiveWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items.yaml index 791c196c79..37ff3bd1cb 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items.yaml @@ -82,6 +82,12 @@ post: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -94,3 +100,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: requestItemReturnWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml index 42a5f01ad9..77880a4016 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml @@ -90,6 +90,12 @@ post: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -102,6 +108,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateRequestItemReturnWorkflow delete: operationId: DeleteReturnsIdRequestItemsAction_id summary: Remove Request Items from Return @@ -190,6 +197,12 @@ delete: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -202,3 +215,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: removeItemReturnActionWorkflow 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 7c1d4434ef..472cc54ad3 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 @@ -82,6 +82,12 @@ post: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -94,6 +100,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: confirmReturnRequestWorkflow delete: operationId: DeleteReturnsIdRequest summary: Remove Requests from Return @@ -175,6 +182,33 @@ delete: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The return's ID. + object: + type: string + title: object + description: The return's object. + deleted: + type: boolean + title: deleted + description: The return's 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.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method.yaml index 2ff3d9ea9e..c5f67f76fc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method.yaml @@ -82,6 +82,12 @@ post: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -94,3 +100,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createReturnShippingMethodWorkflow 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 b33c698795..1c835692c1 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 @@ -89,6 +89,12 @@ post: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -101,6 +107,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateReturnShippingMethodWorkflow delete: operationId: DeleteReturnsIdShippingMethodAction_id summary: Remove Shipping Methods from Return @@ -190,6 +197,12 @@ delete: tags: - Returns responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnPreviewResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -202,3 +215,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: removeReturnShippingMethodWorkflow 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 a02e4dd327..f7c43e58ca 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 @@ -246,11 +246,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The sales channel's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The sales channel's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -263,6 +273,41 @@ get: tags: - Sales Channels responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The sales channel's limit. + offset: + type: number + title: offset + description: The sales channel's offset. + count: + type: number + title: count + description: The sales channel's count. + - type: object + description: SUMMARY + required: + - sales_channels + properties: + sales_channels: + type: array + description: The sales channel's sales channels. + items: + $ref: ../components/schemas/AdminSalesChannel.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -353,6 +398,12 @@ post: tags: - Sales Channels responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminSalesChannelResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -365,3 +416,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createSalesChannelsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml index 837434bcf1..51ef07e35e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml @@ -79,6 +79,12 @@ get: tags: - Sales Channels responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminSalesChannelResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -175,6 +181,12 @@ post: tags: - Sales Channels responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminSalesChannelResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -266,6 +278,12 @@ delete: tags: - Sales Channels responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminSalesChannelDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml index 9269355312..a17dbddb34 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml @@ -98,6 +98,12 @@ post: tags: - Sales Channels responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminSalesChannelResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 2562d65241..a169bf593d 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 @@ -241,6 +241,20 @@ get: $lt: {} $lte: {} title: deleted_at + - name: stock_location_id + in: query + required: false + schema: + oneOf: + - type: string + title: stock_location_id + description: The shipping option's stock location id. + - type: array + description: The shipping option's stock location id. + items: + type: string + title: stock_location_id + description: The stock location id's details. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}_rules_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}_rules_batch.yaml index e367264aa6..93babcb092 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}_rules_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}_rules_batch.yaml @@ -170,6 +170,51 @@ post: tags: - Shipping Options responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - created + - updated + - deleted + properties: + created: + type: array + description: The shipping option's created. + items: + $ref: ../components/schemas/AdminShippingOptionRule.yaml + updated: + type: array + description: The shipping option's updated. + items: + $ref: ../components/schemas/AdminShippingOptionRule.yaml + deleted: + type: object + description: The shipping option's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. '400': $ref: ../components/responses/400_error.yaml '401': @@ -182,3 +227,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: batchShippingOptionRulesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml index 119df11a3b..0891e250aa 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml @@ -205,11 +205,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The shipping profile's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The shipping profile's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -382,3 +392,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createShippingProfilesWorkflow 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 be4f8bcf11..01ec416d64 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 @@ -230,11 +230,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The stock location's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The stock location's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -247,6 +257,12 @@ get: tags: - Stock Locations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminStockLocationListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -337,6 +353,12 @@ post: tags: - Stock Locations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminStockLocationResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -349,3 +371,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createStockLocationsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml index d15ab7b04c..fede4e7631 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml @@ -79,6 +79,12 @@ get: tags: - Stock Locations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminStockLocationResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -175,6 +181,12 @@ post: tags: - Stock Locations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminStockLocationResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -266,6 +278,12 @@ delete: tags: - Stock Locations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminStockLocationDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml index 95ca855150..caeae35fe9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml @@ -99,6 +99,12 @@ post: tags: - Stock Locations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminStockLocationResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-sets.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-sets.yaml index 96b652a90f..017d362138 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-sets.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-sets.yaml @@ -96,6 +96,12 @@ post: tags: - Stock Locations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminStockLocationResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml index ac977fa0f3..3aecd9fe58 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml @@ -99,6 +99,12 @@ post: tags: - Stock Locations responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminStockLocationResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_stores.yaml b/www/apps/api-reference/specs/admin/paths/admin_stores.yaml index ce792baf74..2c16e68667 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stores.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stores.yaml @@ -100,11 +100,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The store's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The store's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -117,6 +127,12 @@ get: tags: - Stores responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminStoreListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_stores_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_stores_{id}.yaml index 83eed18992..65dff755c7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stores_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stores_{id}.yaml @@ -79,6 +79,12 @@ get: tags: - Stores responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminStoreResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -175,6 +181,12 @@ post: tags: - Stores responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminStoreResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -187,3 +199,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateStoresWorkflow 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 38e3b44de4..2def39904b 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 @@ -224,11 +224,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The tax rate's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The tax rate's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -241,6 +251,41 @@ get: tags: - Tax Rates responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The tax rate's limit. + offset: + type: number + title: offset + description: The tax rate's offset. + count: + type: number + title: count + description: The tax rate's count. + - type: object + description: SUMMARY + required: + - tax_rates + properties: + tax_rates: + type: array + description: The tax rate's tax rates. + items: + $ref: ../components/schemas/AdminTaxRate.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -331,6 +376,12 @@ post: tags: - Tax Rates responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminTaxRateResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -343,3 +394,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createTaxRatesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml index d5f338ad1c..74c0c076b1 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml @@ -79,6 +79,12 @@ get: tags: - Tax Rates responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminTaxRateResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -175,6 +181,12 @@ post: tags: - Tax Rates responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminTaxRateResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -266,6 +278,12 @@ delete: tags: - Tax Rates responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminTaxRateDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules.yaml index 6b9d03ff2f..d663b16e66 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules.yaml @@ -82,6 +82,12 @@ post: tags: - Tax Rates responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminTaxRateResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 a4ab2461b6..cfa32dc578 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 @@ -85,6 +85,33 @@ delete: tags: - Tax Rates responses: + '200': + description: OK + content: + application/json: + schema: + 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 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_tax-regions.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml index d33a4d50d5..7a2609496e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml @@ -328,11 +328,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The tax region's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The tax region's $or. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -345,6 +355,41 @@ get: tags: - Tax Regions responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The tax region's limit. + offset: + type: number + title: offset + description: The tax region's offset. + count: + type: number + title: count + description: The tax region's count. + - type: object + description: SUMMARY + required: + - tax_regions + properties: + tax_regions: + type: array + description: The tax region's tax regions. + items: + type: object '400': $ref: ../components/responses/400_error.yaml '401': @@ -435,6 +480,12 @@ post: tags: - Tax Regions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminTaxRegionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -447,3 +498,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createTaxRegionsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml index d1d0d18509..3945742296 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml @@ -79,6 +79,12 @@ get: tags: - Tax Regions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminTaxRegionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -170,6 +176,12 @@ delete: tags: - Tax Regions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminTaxRegionDeleteResponse.yaml '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 f8607260c6..8097a7af8f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml @@ -76,6 +76,12 @@ post: tags: - Uploads responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminFileListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -88,3 +94,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: uploadFilesWorkflow 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 ceba9708a2..fbe427a49c 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 @@ -79,6 +79,12 @@ get: tags: - Uploads responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminFileResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -170,6 +176,33 @@ delete: tags: - Uploads responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The upload's ID. + object: + type: string + title: object + description: The upload's object. + deleted: + type: boolean + title: deleted + description: The upload's deleted. + parent: + type: object + description: The upload's parent. '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 67bce988a3..0b5ac7d82c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users.yaml @@ -69,6 +69,12 @@ get: tags: - Users responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminUserListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -155,6 +161,12 @@ post: tags: - Users responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminUserResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -167,3 +179,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createUserAccountWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml b/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml index 48668f5a32..9793a3e63b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml @@ -69,6 +69,12 @@ get: tags: - Users responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminUserResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml index 460dc17654..dcdd52142b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml @@ -75,6 +75,12 @@ get: tags: - Users responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminUserResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -167,6 +173,12 @@ post: tags: - Users responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminUserResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -254,6 +266,12 @@ delete: tags: - Users responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminUserDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml index 5a73a1eabb..502f17c599 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml @@ -102,6 +102,41 @@ get: tags: - Workflows Executions responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The workflows execution's limit. + offset: + type: number + title: offset + description: The workflows execution's offset. + count: + type: number + title: count + description: The workflows execution's count. + - type: object + description: SUMMARY + required: + - workflow_executions + properties: + workflow_executions: + type: array + description: The workflows execution's workflow executions. + items: + $ref: ../components/schemas/AdminWorkflowExecution.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{id}.yaml index 8d5651e0d1..bc9e2f3427 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{id}.yaml @@ -79,6 +79,12 @@ get: tags: - Workflows Executions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminWorkflowExecutionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_run.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_run.yaml index a21577845b..4306a96500 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_run.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_run.yaml @@ -83,6 +83,17 @@ post: tags: - Workflows Executions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - acknowledgement + properties: + acknowledgement: {} '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_failure.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_failure.yaml index e8d26fa7f2..17c04d7288 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_failure.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_failure.yaml @@ -83,6 +83,20 @@ post: tags: - Workflows Executions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - success + properties: + success: + type: boolean + title: success + description: The workflows execution's success. '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_success.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_success.yaml index ac4d19dfe4..316d4f536d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_success.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_success.yaml @@ -83,6 +83,20 @@ post: tags: - Workflows Executions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - success + properties: + success: + type: boolean + title: success + description: The workflows execution's success. '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}.yaml index bcb4a34cb7..a68c4a9789 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}.yaml @@ -86,6 +86,12 @@ get: tags: - Workflows Executions responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminWorkflowExecutionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminApiKeyResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminApiKeyResponse.yaml new file mode 100644 index 0000000000..7d07ea15a7 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminApiKeyResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminApiKeyResponse +required: + - api_key +properties: + api_key: + $ref: ./ApiKeyResponse.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCampaignResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCampaignResponse.yaml new file mode 100644 index 0000000000..a7019974cb --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCampaignResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminCampaignResponse +required: + - campaign +properties: + campaign: + $ref: ./CampaignResponse.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml new file mode 100644 index 0000000000..9eecf34368 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml @@ -0,0 +1,250 @@ +type: object +description: The claim's details. +x-schemaName: AdminClaim +required: + - order_id + - claim_items + - additional_items + - currency_code + - id + - region_id + - customer_id + - sales_channel_id + - email + - shipping_methods + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total +properties: + order_id: + type: string + title: order_id + description: The claim's order id. + claim_items: + type: array + description: The claim's claim items. + items: + $ref: ./BaseClaimItem.yaml + additional_items: + type: array + description: The claim's additional items. + items: {} + return: + $ref: ./Return.yaml + return_id: + type: string + title: return_id + description: The claim's return id. + no_notification: + type: boolean + title: no_notification + description: The claim's no notification. + refund_amount: + type: number + title: refund_amount + description: The claim's refund amount. + currency_code: + type: string + title: currency_code + description: The claim's currency code. + id: + type: string + title: id + description: The claim's ID. + region_id: + type: string + title: region_id + description: The claim's region id. + customer_id: + type: string + title: customer_id + description: The claim's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The claim's sales channel id. + email: + type: string + title: email + description: The claim's email. + format: email + display_id: + type: string + title: display_id + description: The claim's display id. + shipping_address: + $ref: ./BaseOrderAddress.yaml + billing_address: + $ref: ./BaseOrderAddress.yaml + shipping_methods: + type: array + description: The claim's shipping methods. + items: + $ref: ./BaseOrderShippingMethod.yaml + payment_collections: + type: array + description: The claim's payment collections. + items: + $ref: ./BasePaymentCollection.yaml + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The claim's fulfillments. + items: + $ref: ./BaseOrderFulfillment.yaml + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The claim's transactions. + items: + $ref: ./BaseOrderTransaction.yaml + summary: + $ref: ./BaseOrderSummary.yaml + metadata: + type: object + description: The claim's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The claim's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The claim's updated at. + original_item_total: + type: number + title: original_item_total + description: The claim's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The claim's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The claim's original item tax total. + item_total: + type: number + title: item_total + description: The claim's item total. + item_subtotal: + type: number + title: item_subtotal + description: The claim's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The claim's item tax total. + original_total: + type: number + title: original_total + description: The claim's original total. + original_subtotal: + type: number + title: original_subtotal + description: The claim's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The claim's original tax total. + total: + type: number + title: total + description: The claim's total. + subtotal: + type: number + title: subtotal + description: The claim's subtotal. + tax_total: + type: number + title: tax_total + description: The claim's tax total. + discount_total: + type: number + title: discount_total + description: The claim's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The claim's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The claim's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The claim's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The claim's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The claim's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The claim's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The claim's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The claim's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The claim's original shipping tax total. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaimDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaimDeleteResponse.yaml new file mode 100644 index 0000000000..3ef16374d2 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminClaimDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The claim's ID. + object: + type: string + title: object + description: The claim's object. + default: claim + deleted: + type: boolean + title: deleted + description: The claim's deleted. + parent: + type: object + description: The claim's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaimListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaimListResponse.yaml new file mode 100644 index 0000000000..71a3c2b604 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminClaimListResponse +required: + - limit + - offset + - count + - claims +properties: + limit: + type: number + title: limit + description: The claim's limit. + offset: + type: number + title: offset + description: The claim's offset. + count: + type: number + title: count + description: The claim's count. + claims: + type: array + description: The claim's claims. + items: + $ref: ./AdminClaim.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaimOrderResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaimOrderResponse.yaml new file mode 100644 index 0000000000..f656466d44 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimOrderResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminClaimOrderResponse +required: + - order + - claim +properties: + order: + $ref: ./Order.yaml + claim: + $ref: ./AdminClaim.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaimPreviewResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaimPreviewResponse.yaml new file mode 100644 index 0000000000..f463a9ee83 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimPreviewResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminClaimPreviewResponse +required: + - order_preview + - claim +properties: + order_preview: + $ref: ./Order.yaml + claim: + $ref: ./AdminClaim.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaimRequestResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaimRequestResponse.yaml new file mode 100644 index 0000000000..74bbc37b56 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimRequestResponse.yaml @@ -0,0 +1,14 @@ +type: object +description: SUMMARY +x-schemaName: AdminClaimRequestResponse +required: + - return + - order_preview + - claim +properties: + return: + $ref: ./AdminReturn.yaml + order_preview: + $ref: ./Order.yaml + claim: + $ref: ./AdminClaim.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaimResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaimResponse.yaml new file mode 100644 index 0000000000..f827238354 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminClaimResponse +required: + - claim +properties: + claim: + $ref: ./AdminClaim.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaimReturnPreviewResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaimReturnPreviewResponse.yaml new file mode 100644 index 0000000000..ff9659b347 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimReturnPreviewResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminClaimReturnPreviewResponse +required: + - order_preview + - return +properties: + order_preview: + $ref: ./Order.yaml + return: + $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCollectionDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCollectionDeleteResponse.yaml new file mode 100644 index 0000000000..7c95f2e8a3 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCollectionDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminCollectionDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The collection's ID. + object: + type: string + title: object + description: The collection's object. + default: collection + deleted: + type: boolean + title: deleted + description: The collection's deleted. + parent: + type: object + description: The collection's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCollectionListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCollectionListResponse.yaml new file mode 100644 index 0000000000..e97fa1ee12 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCollectionListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminCollectionListResponse +required: + - limit + - offset + - count + - collections +properties: + limit: + type: number + title: limit + description: The collection's limit. + offset: + type: number + title: offset + description: The collection's offset. + count: + type: number + title: count + description: The collection's count. + collections: + type: array + description: The collection's collections. + items: + $ref: ./AdminCollection.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCollectionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCollectionResponse.yaml new file mode 100644 index 0000000000..d48e815089 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCollectionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminCollectionResponse +required: + - collection +properties: + collection: + $ref: ./AdminCollection.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCompleteOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCompleteOrder.yaml deleted file mode 100644 index c9efe9e5a2..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCompleteOrder.yaml +++ /dev/null @@ -1,10 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminCompleteOrder -required: - - order_id -properties: - order_id: - type: string - title: order_id - description: The order's order id. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomer.yaml deleted file mode 100644 index 9b448177ad..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomer.yaml +++ /dev/null @@ -1,35 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminCreateCustomer -required: - - email - - company_name - - first_name - - last_name - - phone - - metadata -properties: - email: - type: string - title: email - description: The customer's email. - format: email - company_name: - type: string - title: company_name - description: The customer's company name. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - phone: - 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/AdminCreateCustomerAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomerAddress.yaml deleted file mode 100644 index 744dd0a854..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomerAddress.yaml +++ /dev/null @@ -1,72 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminCreateCustomerAddress -required: - - address_name - - company - - first_name - - last_name - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - phone - - metadata -properties: - address_name: - type: string - title: address_name - description: The customer's address name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: The customer's is default shipping. - is_default_billing: - type: boolean - title: is_default_billing - description: The customer's is default billing. - company: - type: string - title: company - description: The customer's company. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - address_1: - type: string - title: address_1 - description: The customer's address 1. - address_2: - type: string - title: address_2 - description: The customer's address 2. - city: - type: string - title: city - description: The customer's city. - country_code: - type: string - title: country_code - description: The customer's country code. - province: - type: string - title: province - description: The customer's province. - postal_code: - type: string - title: postal_code - description: The customer's postal code. - phone: - 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/AdminCreateProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml index a582cab145..849d38df54 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml @@ -79,15 +79,13 @@ properties: items: type: object description: The tag's tags. + required: + - id properties: id: type: string title: id description: The tag's ID. - value: - type: string - title: value - description: The tag's value. options: type: array description: The create's options. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCurrency.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCurrency.yaml new file mode 100644 index 0000000000..4b310956ab --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCurrency.yaml @@ -0,0 +1,3 @@ +type: object +description: The supported currency's currency. +x-schemaName: AdminCurrency diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCurrencyListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCurrencyListResponse.yaml new file mode 100644 index 0000000000..ad2343c380 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCurrencyListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminCurrencyListResponse +required: + - limit + - offset + - count + - currencies +properties: + limit: + type: number + title: limit + description: The currency's limit. + offset: + type: number + title: offset + description: The currency's offset. + count: + type: number + title: count + description: The currency's count. + currencies: + type: array + description: The currency's currencies. + items: + $ref: ./AdminCurrency.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCurrencyResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCurrencyResponse.yaml new file mode 100644 index 0000000000..da9a68b4d3 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCurrencyResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminCurrencyResponse +required: + - currency +properties: + currency: + $ref: ./AdminCurrency.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerAddress.yaml new file mode 100644 index 0000000000..6b2d655e7a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerAddress.yaml @@ -0,0 +1,96 @@ +type: object +description: The customer's address. +x-schemaName: AdminCustomerAddress +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/AdminCustomerAddressResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerAddressResponse.yaml new file mode 100644 index 0000000000..e84a4d16dd --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerAddressResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminCustomerAddressResponse +required: + - address +properties: + address: + $ref: ./AdminCustomerAddress.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroupResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroupResponse.yaml new file mode 100644 index 0000000000..4ddc2deae1 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroupResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminCustomerGroupResponse +required: + - customer_group +properties: + customer_group: + $ref: ./AdminCustomerGroup.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerResponse.yaml new file mode 100644 index 0000000000..06cde895cd --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminCustomerResponse +required: + - customer +properties: + customer: + $ref: ./AdminCustomer.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderResponse.yaml new file mode 100644 index 0000000000..d2fd16520c --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminDraftOrderResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminDraftOrderResponse +required: + - draft_order +properties: + draft_order: + $ref: ./AdminOrder.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml new file mode 100644 index 0000000000..109a755674 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml @@ -0,0 +1,251 @@ +type: object +description: The exchange's details. +x-schemaName: AdminExchange +required: + - order_id + - return_items + - additional_items + - currency_code + - id + - region_id + - customer_id + - sales_channel_id + - email + - shipping_methods + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total +properties: + order_id: + type: string + title: order_id + description: The exchange's order id. + return_items: + type: array + description: The exchange's return items. + items: + $ref: ./AdminReturnItem.yaml + additional_items: + type: array + description: The exchange's additional items. + items: + $ref: ./BaseExchangeItem.yaml + no_notification: + type: boolean + title: no_notification + description: The exchange's no notification. + difference_due: + type: number + title: difference_due + description: The exchange's difference due. + return: + $ref: ./AdminReturn.yaml + return_id: + type: string + title: return_id + description: The exchange's return id. + currency_code: + type: string + title: currency_code + description: The exchange's currency code. + id: + type: string + title: id + description: The exchange's ID. + region_id: + type: string + title: region_id + description: The exchange's region id. + customer_id: + type: string + title: customer_id + description: The exchange's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The exchange's sales channel id. + email: + type: string + title: email + description: The exchange's email. + format: email + display_id: + type: string + title: display_id + description: The exchange's display id. + shipping_address: + $ref: ./BaseOrderAddress.yaml + billing_address: + $ref: ./BaseOrderAddress.yaml + shipping_methods: + type: array + description: The exchange's shipping methods. + items: + $ref: ./BaseOrderShippingMethod.yaml + payment_collections: + type: array + description: The exchange's payment collections. + items: + $ref: ./BasePaymentCollection.yaml + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The exchange's fulfillments. + items: + $ref: ./BaseOrderFulfillment.yaml + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The exchange's transactions. + items: + $ref: ./BaseOrderTransaction.yaml + summary: + $ref: ./BaseOrderSummary.yaml + metadata: + type: object + description: The exchange's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The exchange's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The exchange's updated at. + original_item_total: + type: number + title: original_item_total + description: The exchange's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The exchange's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The exchange's original item tax total. + item_total: + type: number + title: item_total + description: The exchange's item total. + item_subtotal: + type: number + title: item_subtotal + description: The exchange's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The exchange's item tax total. + original_total: + type: number + title: original_total + description: The exchange's original total. + original_subtotal: + type: number + title: original_subtotal + description: The exchange's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The exchange's original tax total. + total: + type: number + title: total + description: The exchange's total. + subtotal: + type: number + title: subtotal + description: The exchange's subtotal. + tax_total: + type: number + title: tax_total + description: The exchange's tax total. + discount_total: + type: number + title: discount_total + description: The exchange's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The exchange's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The exchange's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The exchange's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The exchange's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The exchange's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The exchange's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The exchange's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The exchange's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The exchange's original shipping tax total. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeOrderResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeOrderResponse.yaml new file mode 100644 index 0000000000..356c9e7e54 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeOrderResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminExchangeOrderResponse +required: + - order + - exchange +properties: + order: + $ref: ./Order.yaml + exchange: + $ref: ./AdminExchange.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchangePreviewResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchangePreviewResponse.yaml new file mode 100644 index 0000000000..6776dd01d0 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangePreviewResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminExchangePreviewResponse +required: + - order_preview + - exchange +properties: + order_preview: + $ref: ./Order.yaml + exchange: + $ref: ./AdminExchange.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeRequestResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeRequestResponse.yaml new file mode 100644 index 0000000000..400aec0e26 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeRequestResponse.yaml @@ -0,0 +1,14 @@ +type: object +description: SUMMARY +x-schemaName: AdminExchangeRequestResponse +required: + - return + - order_preview + - exchange +properties: + return: + $ref: ./AdminReturn.yaml + order_preview: + $ref: ./Order.yaml + exchange: + $ref: ./AdminExchange.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeResponse.yaml new file mode 100644 index 0000000000..663eadccee --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminExchangeResponse +required: + - exchange +properties: + exchange: + $ref: ./AdminExchange.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeReturnResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeReturnResponse.yaml new file mode 100644 index 0000000000..f0db225699 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeReturnResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminExchangeReturnResponse +required: + - order_preview + - return +properties: + order_preview: + $ref: ./Order.yaml + return: + $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFile.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFile.yaml new file mode 100644 index 0000000000..2cd7dd88eb --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFile.yaml @@ -0,0 +1,15 @@ +type: object +description: The upload's file. +x-schemaName: AdminFile +required: + - id + - url +properties: + id: + type: string + title: id + description: The file's ID. + url: + type: string + title: url + description: The file's url. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFileListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFileListResponse.yaml new file mode 100644 index 0000000000..37160b8ed1 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFileListResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminFileListResponse +required: + - files +properties: + files: + type: array + description: The upload's files. + items: + $ref: ./AdminFile.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFileResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFileResponse.yaml new file mode 100644 index 0000000000..c0850cabdc --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFileResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminFileResponse +required: + - file +properties: + file: + $ref: ./AdminFile.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillment.yaml new file mode 100644 index 0000000000..797d72ca7b --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillment.yaml @@ -0,0 +1,89 @@ +type: object +description: The fulfillment's details. +x-schemaName: AdminFulfillment +required: + - id + - location_id + - provider_id + - shipping_option_id + - provider + - delivery_address + - items + - labels + - packed_at + - shipped_at + - delivered_at + - canceled_at + - data + - metadata + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The fulfillment's ID. + location_id: + type: string + title: location_id + description: The fulfillment's location id. + provider_id: + type: string + title: provider_id + description: The fulfillment's provider id. + shipping_option_id: + type: string + title: shipping_option_id + description: The fulfillment's shipping option id. + provider: + $ref: ./AdminFulfillmentProvider.yaml + delivery_address: + $ref: ./AdminFulfillmentAddress.yaml + items: + type: array + description: The fulfillment's items. + items: + $ref: ./AdminFulfillmentItem.yaml + labels: + type: array + description: The fulfillment's labels. + items: + $ref: ./AdminFulfillmentLabel.yaml + packed_at: + type: string + title: packed_at + description: The fulfillment's packed at. + shipped_at: + type: string + title: shipped_at + description: The fulfillment's shipped at. + delivered_at: + type: string + title: delivered_at + description: The fulfillment's delivered at. + canceled_at: + type: string + title: canceled_at + description: The fulfillment's canceled at. + data: + type: object + description: The fulfillment's data. + metadata: + type: object + description: The fulfillment's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The fulfillment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The fulfillment's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The fulfillment's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentAddress.yaml new file mode 100644 index 0000000000..4f26290089 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentAddress.yaml @@ -0,0 +1,87 @@ +type: object +description: The fulfillment's delivery address. +x-schemaName: AdminFulfillmentAddress +required: + - id + - fulfillment_id + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The delivery address's ID. + fulfillment_id: + type: string + title: fulfillment_id + description: The delivery address's fulfillment id. + company: + type: string + title: company + description: The delivery address's company. + first_name: + type: string + title: first_name + description: The delivery address's first name. + last_name: + type: string + title: last_name + description: The delivery address's last name. + address_1: + type: string + title: address_1 + description: The delivery address's address 1. + address_2: + type: string + title: address_2 + description: The delivery address's address 2. + city: + type: string + title: city + description: The delivery address's city. + country_code: + type: string + title: country_code + description: The delivery address's country code. + province: + type: string + title: province + description: The delivery address's province. + postal_code: + type: string + title: postal_code + description: The delivery address's postal code. + phone: + type: string + title: phone + description: The delivery address's phone. + metadata: + type: object + description: The delivery address's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The delivery address's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The delivery address's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The delivery address's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentItem.yaml new file mode 100644 index 0000000000..618af8761d --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentItem.yaml @@ -0,0 +1,63 @@ +type: object +description: The item's items. +x-schemaName: AdminFulfillmentItem +required: + - id + - title + - quantity + - sku + - barcode + - line_item_id + - inventory_item_id + - fulfillment_id + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + quantity: + type: number + title: quantity + description: The item's quantity. + sku: + type: string + title: sku + description: The item's sku. + barcode: + type: string + title: barcode + description: The item's barcode. + line_item_id: + type: string + title: line_item_id + description: The item's line item id. + inventory_item_id: + type: string + title: inventory_item_id + description: The item's inventory item id. + fulfillment_id: + type: string + title: fulfillment_id + description: The item's fulfillment id. + created_at: + type: string + format: date-time + title: created_at + description: The item's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The item's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The item's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentLabel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentLabel.yaml new file mode 100644 index 0000000000..6304d99832 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentLabel.yaml @@ -0,0 +1,48 @@ +type: object +description: The label's labels. +x-schemaName: AdminFulfillmentLabel +required: + - id + - tracking_number + - tracking_url + - label_url + - fulfillment_id + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The label's ID. + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + fulfillment_id: + type: string + title: fulfillment_id + description: The label's fulfillment id. + created_at: + type: string + format: date-time + title: created_at + description: The label's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The label's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The label's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProvider.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProvider.yaml index 9d7d2c4f6a..0fbdf6fd21 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProvider.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProvider.yaml @@ -1,3 +1,3 @@ type: object -description: The shipping option's provider. +description: The fulfillment provider's fulfillment providers. x-schemaName: AdminFulfillmentProvider diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProviderListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProviderListResponse.yaml new file mode 100644 index 0000000000..23fefdf665 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProviderListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminFulfillmentProviderListResponse +required: + - limit + - offset + - count + - fulfillment_providers +properties: + limit: + type: number + title: limit + description: The fulfillment provider's limit. + offset: + type: number + title: offset + description: The fulfillment provider's offset. + count: + type: number + title: count + description: The fulfillment provider's count. + fulfillment_providers: + type: array + description: The fulfillment provider's fulfillment providers. + items: + $ref: ./AdminFulfillmentProvider.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentResponse.yaml new file mode 100644 index 0000000000..8870aa903b --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminFulfillmentResponse +required: + - fulfillment +properties: + fulfillment: + $ref: ./AdminFulfillment.yaml 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 bff56cf421..01f7f452c6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSet.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSet.yaml @@ -5,6 +5,7 @@ required: - id - name - type + - location - service_zones - created_at - updated_at @@ -22,6 +23,8 @@ properties: 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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminInventoryItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminInventoryItem.yaml new file mode 100644 index 0000000000..58e6de4897 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminInventoryItem.yaml @@ -0,0 +1,66 @@ +type: object +description: The inventory item's details. +x-schemaName: AdminInventoryItem +required: + - id + - requires_shipping +properties: + id: + type: string + title: id + description: The inventory item's ID. + sku: + type: string + title: sku + description: The inventory item's sku. + origin_country: + type: string + title: origin_country + description: The inventory item's origin country. + hs_code: + type: string + title: hs_code + description: The inventory item's hs code. + requires_shipping: + type: boolean + title: requires_shipping + description: The inventory item's requires shipping. + 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. + 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. + title: + type: string + title: title + description: The inventory item's title. + description: + type: string + title: description + description: The inventory item's description. + thumbnail: + type: string + title: thumbnail + description: The inventory item's thumbnail. + metadata: + type: object + description: The inventory item's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminInventoryItemResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminInventoryItemResponse.yaml new file mode 100644 index 0000000000..9512367b8d --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminInventoryItemResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminInventoryItemResponse +required: + - inventory_item +properties: + inventory_item: + $ref: ./AdminInventoryItem.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminInvite.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminInvite.yaml new file mode 100644 index 0000000000..5b81a094fc --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminInvite.yaml @@ -0,0 +1,44 @@ +type: object +description: The invite's details. +x-schemaName: AdminInvite +required: + - id + - email + - accepted + - token +properties: + id: + type: string + title: id + description: The invite's ID. + email: + type: string + title: email + description: The invite's email. + format: email + accepted: + type: boolean + title: accepted + description: The invite's accepted. + token: + type: string + title: token + description: The invite's token. + expires_at: + type: string + title: expires_at + description: The invite's expires at. + format: date-time + metadata: + type: object + description: The invite's metadata. + created_at: + type: string + title: created_at + description: The invite's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The invite's updated at. + format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminInviteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminInviteResponse.yaml new file mode 100644 index 0000000000..d2649d5348 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminInviteResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminInviteResponse +required: + - invite +properties: + invite: + $ref: ./AdminInvite.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminNotification.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminNotification.yaml new file mode 100644 index 0000000000..4b4d98663c --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminNotification.yaml @@ -0,0 +1,63 @@ +type: object +description: The notification's details. +x-schemaName: AdminNotification +required: + - id + - to + - channel + - template + - provider_id + - created_at +properties: + id: + type: string + title: id + description: The notification's ID. + to: + type: string + title: to + description: The notification's to. + channel: + type: string + title: channel + description: The notification's channel. + template: + type: string + title: template + description: The notification's template. + data: + type: object + description: The notification's data. + trigger_type: + type: string + title: trigger_type + description: The notification's trigger type. + resource_id: + type: string + title: resource_id + description: The notification's resource id. + resource_type: + type: string + title: resource_type + description: The notification's resource type. + receiver_id: + type: string + title: receiver_id + description: The notification's receiver id. + original_notification_id: + type: string + title: original_notification_id + description: The notification's original notification id. + external_id: + type: string + title: external_id + description: The notification's external id. + provider_id: + type: string + title: provider_id + description: The notification's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The notification's created at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminNotificationListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminNotificationListResponse.yaml new file mode 100644 index 0000000000..aa51a6a023 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminNotificationListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminNotificationListResponse +required: + - limit + - offset + - count + - notifications +properties: + limit: + type: number + title: limit + description: The notification's limit. + offset: + type: number + title: offset + description: The notification's offset. + count: + type: number + title: count + description: The notification's count. + notifications: + type: array + description: The notification's notifications. + items: + $ref: ./AdminNotification.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminNotificationResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminNotificationResponse.yaml new file mode 100644 index 0000000000..b6e0ab7c90 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminNotificationResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminNotificationResponse +required: + - notification +properties: + notification: + $ref: ./AdminNotification.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml new file mode 100644 index 0000000000..347756583d --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml @@ -0,0 +1,232 @@ +type: object +description: The order's details. +x-schemaName: AdminOrder +required: + - payment_collections + - id + - version + - region_id + - customer_id + - sales_channel_id + - email + - currency_code + - items + - shipping_methods + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total +properties: + payment_collections: + type: array + description: The order's payment collections. + items: + $ref: ./AdminPaymentCollection.yaml + id: + type: string + title: id + description: The order's ID. + version: + type: number + title: version + description: The order's version. + region_id: + type: string + title: region_id + description: The order's region id. + customer_id: + type: string + title: customer_id + description: The order's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order's sales channel id. + email: + type: string + title: email + description: The order's email. + format: email + currency_code: + type: string + title: currency_code + description: The order's currency code. + display_id: + type: string + 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. + items: + $ref: ./BaseOrderLineItem.yaml + shipping_methods: + type: array + description: The order's shipping methods. + items: + $ref: ./BaseOrderShippingMethod.yaml + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The order's fulfillments. + items: + $ref: ./BaseOrderFulfillment.yaml + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The order's transactions. + items: + $ref: ./BaseOrderTransaction.yaml + summary: + $ref: ./BaseOrderSummary.yaml + metadata: + type: object + description: The order's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The order's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order's updated at. + original_item_total: + type: number + title: original_item_total + description: The order's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The order's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The order's original item tax total. + item_total: + type: number + title: item_total + description: The order's item total. + item_subtotal: + type: number + title: item_subtotal + description: The order's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The order's item tax total. + original_total: + type: number + title: original_total + description: The order's original total. + original_subtotal: + type: number + title: original_subtotal + description: The order's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The order's original tax total. + total: + type: number + title: total + description: The order's total. + subtotal: + type: number + title: subtotal + description: The order's subtotal. + tax_total: + type: number + title: tax_total + description: The order's tax total. + discount_total: + type: number + title: discount_total + description: The order's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The order's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The order's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The order's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The order's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The order's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The order's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The order's original shipping tax total. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderCreateFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderCreateFulfillment.yaml deleted file mode 100644 index 59a7bc492a..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderCreateFulfillment.yaml +++ /dev/null @@ -1,37 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminOrderCreateFulfillment -required: - - items - - location_id - - metadata -properties: - items: - type: array - description: The order's items. - items: - 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. - location_id: - type: string - title: location_id - description: The order's location id. - no_notification: - type: boolean - title: no_notification - description: The order's no notification. - metadata: - type: object - description: The order's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderCreateShipment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderCreateShipment.yaml deleted file mode 100644 index 75ce832164..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderCreateShipment.yaml +++ /dev/null @@ -1,55 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminOrderCreateShipment -required: - - items - - metadata -properties: - items: - type: array - description: The order's items. - items: - 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. - labels: - type: array - description: The order's labels. - items: - type: object - description: The label's labels. - required: - - tracking_number - - tracking_url - - label_url - properties: - tracking_number: - type: string - title: tracking_number - description: The label's tracking number. - tracking_url: - type: string - title: tracking_url - description: The label's tracking url. - label_url: - type: string - title: label_url - description: The label's label url. - no_notification: - type: boolean - title: no_notification - description: The order's no notification. - metadata: - type: object - description: The order's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml new file mode 100644 index 0000000000..4b3f9af0d3 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml @@ -0,0 +1,642 @@ +type: object +description: The return's order preview. +x-schemaName: AdminOrderPreview +required: + - return_requested_total + - order_change + - currency_code + - id + - version + - region_id + - customer_id + - sales_channel_id + - email + - payment_collections + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total +properties: + return_requested_total: + type: number + title: return_requested_total + description: The order preview's return requested total. + order_change: + $ref: ./BaseOrderChange.yaml + items: + type: array + description: The order preview's items. + items: + allOf: + - type: object + description: The item's items. + x-schemaName: BaseOrderLineItem + required: + - id + - title + - subtitle + - thumbnail + - variant_id + - product_id + - product_title + - product_description + - product_subtitle + - product_type + - product_collection + - product_handle + - variant_sku + - variant_barcode + - variant_title + - variant_option_values + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - detail + - created_at + - updated_at + - metadata + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant: + $ref: ./BaseProductVariant.yaml + variant_id: + type: string + title: variant_id + description: The item's variant id. + product: + $ref: ./BaseProduct.yaml + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: ./BaseOrderLineItemTaxLine.yaml + adjustments: + type: array + description: The item's adjustments. + items: + $ref: ./BaseOrderLineItemAdjustment.yaml + detail: + $ref: ./BaseOrderItemDetail.yaml + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + metadata: + type: object + description: The item's metadata. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: object + description: The item's items. + properties: + actions: + type: array + description: The item's actions. + items: + type: object + description: The action's actions. + x-schemaName: BaseOrderChangeAction + shipping_methods: + type: array + description: The order preview's shipping methods. + items: + allOf: + - type: object + description: The shipping method's shipping methods. + x-schemaName: BaseOrderShippingMethod + required: + - id + - order_id + - name + - amount + - is_tax_inclusive + - shipping_option_id + - data + - metadata + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: ./BaseOrderShippingMethodTaxLine.yaml + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: ./BaseOrderShippingMethodAdjustment.yaml + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: discount_tax_total + description: The shipping method's discount tax total. + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - $ref: ./IBigNumber.yaml + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + - type: object + description: The shipping method's shipping methods. + properties: + actions: + type: array + description: The shipping method's actions. + items: + type: object + description: The action's actions. + x-schemaName: BaseOrderChangeAction + currency_code: + type: string + title: currency_code + description: The order preview's currency code. + id: + type: string + title: id + description: The order preview's ID. + version: + type: number + title: version + description: The order preview's version. + region_id: + type: string + title: region_id + description: The order preview's region id. + customer_id: + type: string + title: customer_id + description: The order preview's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order preview's sales channel id. + email: + type: string + title: email + description: The order preview's email. + format: email + display_id: + type: string + title: display_id + description: The order preview's display id. + shipping_address: + $ref: ./BaseOrderAddress.yaml + billing_address: + $ref: ./BaseOrderAddress.yaml + payment_collections: + type: array + description: The order preview's payment collections. + items: + $ref: ./AdminPaymentCollection.yaml + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The order preview's fulfillments. + items: + $ref: ./BaseOrderFulfillment.yaml + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The order preview's transactions. + items: + $ref: ./BaseOrderTransaction.yaml + summary: + $ref: ./BaseOrderSummary.yaml + metadata: + type: object + description: The order preview's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The order preview's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order preview's updated at. + original_item_total: + type: number + title: original_item_total + description: The order preview's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The order preview's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The order preview's original item tax total. + item_total: + type: number + title: item_total + description: The order preview's item total. + item_subtotal: + type: number + title: item_subtotal + description: The order preview's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The order preview's item tax total. + original_total: + type: number + title: original_total + description: The order preview's original total. + original_subtotal: + type: number + title: original_subtotal + description: The order preview's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The order preview's original tax total. + total: + type: number + title: total + description: The order preview's total. + subtotal: + type: number + title: subtotal + description: The order preview's subtotal. + tax_total: + type: number + title: tax_total + description: The order preview's tax total. + discount_total: + type: number + title: discount_total + description: The order preview's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The order preview's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The order preview's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The order preview's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The order preview's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order preview's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The order preview's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The order preview's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The order preview's original shipping tax total. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreviewResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreviewResponse.yaml new file mode 100644 index 0000000000..d0f0e88f40 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreviewResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminOrderPreviewResponse +required: + - order +properties: + order: + $ref: ./AdminOrderPreview.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderResponse.yaml new file mode 100644 index 0000000000..18e28bbc59 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminOrderResponse +required: + - order +properties: + order: + $ref: ./AdminOrder.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderReturnResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderReturnResponse.yaml new file mode 100644 index 0000000000..1fed4284d0 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderReturnResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminOrderReturnResponse +required: + - order + - return +properties: + order: + $ref: ./Order.yaml + return: + $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPayment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPayment.yaml new file mode 100644 index 0000000000..2836394d2e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPayment.yaml @@ -0,0 +1,130 @@ +type: object +description: The payment's details. +x-schemaName: AdminPayment +required: + - id + - amount + - currency_code + - provider_id +properties: + id: + type: string + title: id + description: The payment's ID. + amount: + oneOf: + - type: string + title: amount + description: The payment's amount. + - type: number + title: amount + description: The payment's amount. + - type: string + title: amount + description: The payment's amount. + - $ref: ./IBigNumber.yaml + authorized_amount: + oneOf: + - type: string + title: authorized_amount + description: The payment's authorized amount. + - type: number + title: authorized_amount + description: The payment's authorized amount. + - type: string + title: authorized_amount + description: The payment's authorized amount. + - $ref: ./IBigNumber.yaml + currency_code: + type: string + title: currency_code + description: The payment's currency code. + provider_id: + type: string + title: provider_id + description: The payment's provider id. + cart_id: + type: string + title: cart_id + description: The payment's cart id. + order_id: + type: string + title: order_id + description: The payment's order id. + order_edit_id: + type: string + title: order_edit_id + description: The payment's order edit id. + customer_id: + type: string + title: customer_id + description: The payment's customer id. + data: + type: object + description: The payment's data. + created_at: + type: string + format: date-time + title: created_at + description: The payment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The payment's updated at. + captured_at: + oneOf: + - type: string + title: captured_at + description: The payment's captured at. + - type: string + title: captured_at + description: The payment's captured at. + format: date-time + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The payment's canceled at. + - type: string + title: canceled_at + description: The payment's canceled at. + format: date-time + captured_amount: + oneOf: + - type: string + title: captured_amount + description: The payment's captured amount. + - type: number + title: captured_amount + description: The payment's captured amount. + - type: string + title: captured_amount + description: The payment's captured amount. + - $ref: ./IBigNumber.yaml + refunded_amount: + oneOf: + - type: string + title: refunded_amount + description: The payment's refunded amount. + - type: number + title: refunded_amount + description: The payment's refunded amount. + - type: string + title: refunded_amount + description: The payment's refunded amount. + - $ref: ./IBigNumber.yaml + captures: + type: array + description: The payment's captures. + items: + $ref: ./BaseCapture.yaml + refunds: + type: array + description: The payment's refunds. + items: + $ref: ./BaseRefund.yaml + payment_collection: + $ref: ./BasePaymentCollection.yaml + payment_session: + $ref: ./BasePaymentSession.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml new file mode 100644 index 0000000000..e58397669a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml @@ -0,0 +1,116 @@ +type: object +description: The payment collection's payment collections. +x-schemaName: AdminPaymentCollection +required: + - id + - currency_code + - region_id + - amount + - status + - payment_providers +properties: + id: + type: string + title: id + description: The payment collection's ID. + currency_code: + type: string + title: currency_code + description: The payment collection's currency code. + region_id: + type: string + title: region_id + description: The payment collection's region id. + amount: + oneOf: + - type: string + title: amount + description: The payment collection's amount. + - type: number + title: amount + description: The payment collection's amount. + - type: string + title: amount + description: The payment collection's amount. + - $ref: ./IBigNumber.yaml + authorized_amount: + oneOf: + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - type: number + title: authorized_amount + description: The payment collection's authorized amount. + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - $ref: ./IBigNumber.yaml + captured_amount: + oneOf: + - type: string + title: captured_amount + description: The payment collection's captured amount. + - type: number + title: captured_amount + description: The payment collection's captured amount. + - type: string + title: captured_amount + description: The payment collection's captured amount. + - $ref: ./IBigNumber.yaml + refunded_amount: + oneOf: + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - type: number + title: refunded_amount + description: The payment collection's refunded amount. + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - $ref: ./IBigNumber.yaml + completed_at: + oneOf: + - type: string + title: completed_at + description: The payment collection's completed at. + - type: string + title: completed_at + description: The payment collection's completed at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The payment collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The payment collection's updated at. + metadata: + type: object + description: The payment collection's metadata. + status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + payment_providers: + type: array + description: The payment collection's payment providers. + items: + $ref: ./BasePaymentProvider.yaml + payment_sessions: + type: array + description: The payment collection's payment sessions. + items: + $ref: ./BasePaymentSession.yaml + payments: + type: array + description: The payment collection's payments. + items: + $ref: ./BasePayment.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentProvider.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentProvider.yaml new file mode 100644 index 0000000000..022e34057b --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentProvider.yaml @@ -0,0 +1,3 @@ +type: object +description: The payment provider's payment providers. +x-schemaName: AdminPaymentProvider diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentResponse.yaml new file mode 100644 index 0000000000..ede86ff43a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminPaymentResponse +required: + - payment +properties: + payment: + $ref: ./AdminPayment.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderCancelFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelExchangeReqSchema.yaml similarity index 53% rename from www/apps/api-reference/specs/admin/components/schemas/AdminOrderCancelFulfillment.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminPostCancelExchangeReqSchema.yaml index 849a186934..b73520094e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderCancelFulfillment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelExchangeReqSchema.yaml @@ -1,8 +1,8 @@ type: object description: SUMMARY -x-schemaName: AdminOrderCancelFulfillment +x-schemaName: AdminPostCancelExchangeReqSchema properties: no_notification: type: boolean title: no_notification - description: The order's no notification. + description: The exchange's no notification. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml index 2b74376fcd..b3b1589daa 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml @@ -1,18 +1,17 @@ type: object description: SUMMARY x-schemaName: AdminPostClaimsItemsActionReqSchema +required: + - reason_id properties: quantity: type: number title: quantity description: The claim's quantity. - reason: + reason_id: type: string - enum: - - missing_item - - wrong_item - - production_failure - - other + title: reason_id + description: The claim's reason id. internal_note: type: string title: internal_note diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml new file mode 100644 index 0000000000..6609955ffd --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesAddItemsReqSchema.yaml @@ -0,0 +1,37 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostExchangesAddItemsReqSchema +properties: + items: + type: array + description: The exchange's items. + items: + type: object + description: The item's items. + required: + - variant_id + - quantity + properties: + variant_id: + type: string + title: variant_id + description: The item's variant id. + quantity: + type: number + title: quantity + description: The item's quantity. + unit_price: + type: number + title: unit_price + description: The item's unit price. + internal_note: + type: string + title: internal_note + description: The item's internal note. + allow_backorder: + type: boolean + title: allow_backorder + description: The item's allow backorder. + metadata: + type: object + description: The item's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml new file mode 100644 index 0000000000..1d8aa2b4db --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.yaml @@ -0,0 +1,19 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostExchangesRequestItemsReturnActionReqSchema +properties: + quantity: + type: number + title: quantity + description: The exchange's quantity. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. + reason_id: + type: string + title: reason_id + description: The exchange's reason id. + metadata: + type: object + description: The exchange's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml new file mode 100644 index 0000000000..3e2045fd89 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml @@ -0,0 +1,37 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema +properties: + items: + type: array + description: The exchange's items. + items: + 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. + description: + type: string + title: description + description: The item's description. + internal_note: + type: string + title: internal_note + description: The item's internal note. + reason_id: + type: string + title: reason_id + description: The item's reason id. + metadata: + type: object + description: The item's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml new file mode 100644 index 0000000000..c473ba6e3a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml @@ -0,0 +1,15 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostExchangesShippingActionReqSchema +properties: + custom_price: + type: number + title: custom_price + description: The exchange's custom price. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. + metadata: + type: object + description: The exchange's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml new file mode 100644 index 0000000000..6af8ce407a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml @@ -0,0 +1,25 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostExchangesShippingReqSchema +required: + - shipping_option_id +properties: + shipping_option_id: + type: string + title: shipping_option_id + description: The exchange's shipping option id. + custom_price: + type: number + title: custom_price + description: The exchange's custom price. + description: + type: string + title: description + description: The exchange's description. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. + metadata: + type: object + description: The exchange's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExhangesItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExhangesItemsActionReqSchema.yaml new file mode 100644 index 0000000000..d058255237 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExhangesItemsActionReqSchema.yaml @@ -0,0 +1,12 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostExhangesItemsActionReqSchema +properties: + quantity: + type: number + title: quantity + description: The exchange's quantity. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml index 4eaef32fa9..2dbe34cae5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml @@ -4,6 +4,7 @@ x-schemaName: AdminPostOrderClaimsReqSchema required: - type - order_id + - reason_id - metadata properties: type: @@ -23,6 +24,10 @@ properties: type: string title: internal_note description: The claim's internal note. + reason_id: + type: string + title: reason_id + description: The claim's reason id. metadata: type: object description: The claim's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml new file mode 100644 index 0000000000..60f49ba39f --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml @@ -0,0 +1,22 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostOrderExchangesReqSchema +required: + - order_id + - metadata +properties: + order_id: + type: string + title: order_id + description: The exchange's order id. + description: + type: string + title: description + description: The exchange's description. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. + metadata: + type: object + description: The exchange's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml index a7a445758d..48a850a29f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml @@ -7,19 +7,19 @@ properties: shipping_option_id: type: string title: shipping_option_id - description: The claim's shipping option id. + description: The exchange's shipping option id. custom_price: type: number title: custom_price - description: The claim's custom price. + description: The exchange's custom price. description: type: string title: description - description: The claim's description. + description: The exchange's description. internal_note: type: string title: internal_note - description: The claim's internal note. + description: The exchange's internal note. metadata: type: object - description: The claim's metadata. + description: The exchange's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPriceList.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPriceList.yaml new file mode 100644 index 0000000000..ff8ed0bc50 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPriceList.yaml @@ -0,0 +1,70 @@ +type: object +description: The price list's details. +x-schemaName: AdminPriceList +required: + - id + - title + - description + - rules + - starts_at + - ends_at + - status + - type + - prices + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The price list's ID. + title: + type: string + title: title + description: The price list's title. + description: + type: string + title: description + description: The price list's description. + rules: + type: object + description: The price list's rules. + starts_at: + type: string + title: starts_at + description: The price list's starts at. + ends_at: + type: string + title: ends_at + description: The price list's ends at. + status: + type: string + enum: + - draft + - active + type: + type: string + enum: + - sale + - override + prices: + type: array + description: The price list's prices. + items: + $ref: ./AdminPriceListPrice.yaml + created_at: + type: string + format: date-time + title: created_at + description: The price list's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The price list's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The price list's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListBatchResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListBatchResponse.yaml new file mode 100644 index 0000000000..f525939ed7 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListBatchResponse.yaml @@ -0,0 +1,41 @@ +type: object +description: SUMMARY +x-schemaName: AdminPriceListBatchResponse +required: + - created + - updated + - deleted +properties: + created: + type: array + description: The price list's created. + items: + $ref: ./AdminPrice.yaml + updated: + type: array + description: The price list's updated. + items: + $ref: ./AdminPrice.yaml + deleted: + type: object + description: The price list's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListDeleteResponse.yaml new file mode 100644 index 0000000000..9fc53869c3 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminPriceListDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The price list's ID. + object: + type: string + title: object + description: The price list's object. + default: price_list + deleted: + type: boolean + title: deleted + description: The price list's deleted. + parent: + type: object + description: The price list's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListListResponse.yaml new file mode 100644 index 0000000000..0199ba1e0e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminPriceListListResponse +required: + - limit + - offset + - count + - price_lists +properties: + limit: + type: number + title: limit + description: The price list's limit. + offset: + type: number + title: offset + description: The price list's offset. + count: + type: number + title: count + description: The price list's count. + price_lists: + type: array + description: The price list's price lists. + items: + $ref: ./AdminPriceList.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListPrice.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListPrice.yaml new file mode 100644 index 0000000000..5e699d3feb --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListPrice.yaml @@ -0,0 +1,71 @@ +type: object +description: The price's prices. +x-schemaName: AdminPriceListPrice +required: + - variant_id + - rules + - id + - title + - currency_code + - amount + - raw_amount + - min_quantity + - max_quantity + - price_set_id + - created_at + - updated_at + - deleted_at +properties: + variant_id: + type: string + title: variant_id + description: The price's variant id. + rules: + type: object + description: The price's rules. + id: + type: string + title: id + description: The price's ID. + title: + type: string + title: title + description: The price's title. + currency_code: + type: string + title: currency_code + description: The price's currency code. + amount: + type: number + title: amount + description: The price's amount. + raw_amount: + type: object + description: The price's raw amount. + min_quantity: + type: number + title: min_quantity + description: The price's min quantity. + max_quantity: + type: number + title: max_quantity + description: The price's max quantity. + price_set_id: + type: string + title: price_set_id + description: The price's price set id. + created_at: + type: string + format: date-time + title: created_at + description: The price's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The price's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The price's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListResponse.yaml new file mode 100644 index 0000000000..b666517278 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminPriceListResponse +required: + - price_list +properties: + price_list: + $ref: ./AdminPriceList.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPricePreference.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreference.yaml new file mode 100644 index 0000000000..01479f00c8 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreference.yaml @@ -0,0 +1,43 @@ +type: object +description: The price preference's details. +x-schemaName: AdminPricePreference +required: + - id + - attribute + - value + - is_tax_inclusive + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The price preference's ID. + attribute: + type: string + title: attribute + description: The price preference's attribute. + value: + type: string + title: value + description: The price preference's value. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The price preference's is tax inclusive. + created_at: + type: string + format: date-time + title: created_at + description: The price preference's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The price preference's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The price preference's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceDeleteResponse.yaml new file mode 100644 index 0000000000..a34e982325 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminPricePreferenceDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The price preference's ID. + object: + type: string + title: object + description: The price preference's object. + default: price_preference + deleted: + type: boolean + title: deleted + description: The price preference's deleted. + parent: + type: object + description: The price preference's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceListResponse.yaml new file mode 100644 index 0000000000..1ee09e258e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminPricePreferenceListResponse +required: + - limit + - offset + - count + - price_preferences +properties: + limit: + type: number + title: limit + description: The price preference's limit. + offset: + type: number + title: offset + description: The price preference's offset. + count: + type: number + title: count + description: The price preference's count. + price_preferences: + type: array + description: The price preference's price preferences. + items: + $ref: ./AdminPricePreference.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceResponse.yaml new file mode 100644 index 0000000000..4fbab75262 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminPricePreferenceResponse +required: + - price_preference +properties: + price_preference: + $ref: ./AdminPricePreference.yaml 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 2db6ee1407..f31c9d51d9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml @@ -9,25 +9,25 @@ required: - options - description - id - - handle - - hs_code - - weight - - height - - width - - origin_country - - mid_code - - material - - thumbnail - created_at - updated_at - - deleted_at + - handle - subtitle - is_giftcard + - thumbnail + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material - collection_id - type_id - images - discountable - external_id + - deleted_at properties: collection: $ref: ./AdminCollection.yaml @@ -84,42 +84,6 @@ properties: metadata: type: object description: The parent's metadata. - handle: - type: string - title: handle - description: The parent's handle. - hs_code: - type: string - title: hs_code - description: The parent's hs code. - weight: - type: number - title: weight - description: The parent's weight. - height: - type: number - title: height - description: The parent's height. - width: - type: number - title: width - description: The parent's width. - origin_country: - type: string - title: origin_country - description: The parent's origin country. - mid_code: - type: string - title: mid_code - description: The parent's mid code. - material: - type: string - title: material - description: The parent's material. - thumbnail: - type: string - title: thumbnail - description: The parent's thumbnail. created_at: type: string format: date-time @@ -130,11 +94,10 @@ properties: format: date-time title: updated_at description: The parent's updated at. - deleted_at: + handle: type: string - format: date-time - title: deleted_at - description: The parent's deleted at. + title: handle + description: The parent's handle. subtitle: type: string title: subtitle @@ -143,6 +106,38 @@ properties: type: boolean title: is_giftcard description: The parent's is giftcard. + thumbnail: + type: string + title: thumbnail + description: The parent's thumbnail. + width: + type: number + title: width + description: The parent's width. + weight: + type: number + title: weight + description: The parent's weight. + height: + type: number + title: height + description: The parent's height. + origin_country: + type: string + title: origin_country + description: The parent's origin country. + hs_code: + type: string + title: hs_code + description: The parent's hs code. + mid_code: + type: string + title: mid_code + description: The parent's mid code. + material: + type: string + title: material + description: The parent's material. collection_id: type: string title: collection_id @@ -164,3 +159,8 @@ properties: type: string title: external_id description: The parent's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The parent's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml index 1de3721e0e..750ab66be6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml @@ -7,14 +7,14 @@ required: - name - description - id - - handle - created_at - updated_at + - handle - deleted_at - - parent_category_id - - is_internal - is_active + - is_internal - rank + - parent_category_id properties: category_children: type: array @@ -40,10 +40,6 @@ properties: type: string title: id description: The category's ID. - handle: - type: string - title: handle - description: The category's handle. created_at: type: string format: date-time @@ -54,24 +50,28 @@ properties: format: date-time title: updated_at description: The category's updated at. + handle: + type: string + title: handle + description: The category's handle. deleted_at: type: string format: date-time title: deleted_at description: The category's deleted at. - parent_category_id: - type: string - title: parent_category_id - description: The category's parent category id. - is_internal: - type: boolean - title: is_internal - description: The category's is internal. is_active: type: boolean title: is_active description: The category's is active. + is_internal: + type: boolean + title: is_internal + description: The category's is internal. rank: type: number title: rank description: The category's rank. + parent_category_id: + type: string + title: parent_category_id + description: The category's parent category id. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryDeleteResponse.yaml new file mode 100644 index 0000000000..38c8ca528b --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductCategoryDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The product category's ID. + object: + type: string + title: object + description: The product category's object. + default: product_category + deleted: + type: boolean + title: deleted + description: The product category's deleted. + parent: + type: object + description: The product category's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTagDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTagDeleteResponse.yaml new file mode 100644 index 0000000000..d723c20219 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTagDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductTagDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The product tag's ID. + object: + type: string + title: object + description: The product tag's object. + default: product_tag + deleted: + type: boolean + title: deleted + description: The product tag's deleted. + parent: + type: object + description: The product tag's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTagListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTagListResponse.yaml new file mode 100644 index 0000000000..40accb6692 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTagListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductTagListResponse +required: + - limit + - offset + - count + - product_tags +properties: + limit: + type: number + title: limit + description: The product tag's limit. + offset: + type: number + title: offset + description: The product tag's offset. + count: + type: number + title: count + description: The product tag's count. + product_tags: + type: array + description: The product tag's product tags. + items: + $ref: ./AdminProductTag.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTagResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTagResponse.yaml new file mode 100644 index 0000000000..47fe1ad408 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTagResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductTagResponse +required: + - product_tag +properties: + product_tag: + $ref: ./AdminProductTag.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeDeleteResponse.yaml new file mode 100644 index 0000000000..dcd995552c --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductTypeDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The product type's ID. + object: + type: string + title: object + description: The product type's object. + default: product_type + deleted: + type: boolean + title: deleted + description: The product type's deleted. + parent: + type: object + description: The product type's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeListResponse.yaml new file mode 100644 index 0000000000..5e6dfa5a8f --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductTypeListResponse +required: + - limit + - offset + - count + - product_types +properties: + limit: + type: number + title: limit + description: The product type's limit. + offset: + type: number + title: offset + description: The product type's offset. + count: + type: number + title: count + description: The product type's count. + product_types: + type: array + description: The product type's product types. + items: + $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeResponse.yaml new file mode 100644 index 0000000000..3e74c8b2fb --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductTypeResponse +required: + - product_type +properties: + product_type: + $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml index 8404f7168a..73384be760 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml @@ -1,5 +1,5 @@ type: object -description: The updated's details. +description: The product's parent. x-schemaName: AdminProductVariant required: - prices @@ -26,80 +26,80 @@ required: properties: prices: type: array - description: The updated's prices. + description: The parent's prices. items: $ref: ./AdminPrice.yaml id: type: string title: id - description: The updated's ID. + description: The parent's ID. title: type: string title: title - description: The updated's title. + description: The parent's title. sku: type: string title: sku - description: The updated's sku. + description: The parent's sku. barcode: type: string title: barcode - description: The updated's barcode. + description: The parent's barcode. ean: type: string title: ean - description: The updated's ean. + description: The parent's ean. upc: type: string title: upc - description: The updated's upc. + description: The parent's upc. allow_backorder: type: boolean title: allow_backorder - description: The updated's allow backorder. + description: The parent's allow backorder. manage_inventory: type: boolean title: manage_inventory - description: The updated's manage inventory. + description: The parent's manage inventory. hs_code: type: string title: hs_code - description: The updated's hs code. + description: The parent's hs code. origin_country: type: string title: origin_country - description: The updated's origin country. + description: The parent's origin country. mid_code: type: string title: mid_code - description: The updated's mid code. + description: The parent's mid code. material: type: string title: material - description: The updated's material. + description: The parent's material. weight: type: number title: weight - description: The updated's weight. + description: The parent's weight. length: type: number title: length - description: The updated's length. + description: The parent's length. height: type: number title: height - description: The updated's height. + description: The parent's height. width: type: number title: width - description: The updated's width. + description: The parent's width. variant_rank: type: number title: variant_rank - description: The updated's variant rank. + description: The parent's variant rank. options: type: array - description: The updated's options. + description: The parent's options. items: $ref: ./BaseProductOptionValue.yaml product: @@ -107,24 +107,24 @@ properties: product_id: type: string title: product_id - description: The updated's product id. + description: The parent's product id. calculated_price: $ref: ./BaseCalculatedPriceSet.yaml created_at: type: string format: date-time title: created_at - description: The updated's created at. + description: The parent's created at. updated_at: type: string format: date-time title: updated_at - description: The updated's updated at. + description: The parent's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The updated's deleted at. + description: The parent's deleted at. metadata: type: object - description: The updated's metadata. + description: The parent's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryBatchResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryBatchResponse.yaml new file mode 100644 index 0000000000..3da518f03a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryBatchResponse.yaml @@ -0,0 +1,107 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductVariantInventoryBatchResponse +required: + - created + - updated + - deleted +properties: + created: + oneOf: + - $ref: ./AdminProductVariantInventoryLink.yaml + - type: array + description: The product's created. + items: + type: object + description: The created's details. + x-schemaName: AdminProductVariantInventoryLink + required: + - productService + - inventoryService + properties: + productService: + type: object + description: The created's productservice. + required: + - variant_id + properties: + variant_id: + type: string + title: variant_id + description: The productservice's variant id. + inventoryService: + type: object + description: The created's inventoryservice. + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventoryservice's inventory item id. + updated: + oneOf: + - $ref: ./AdminProductVariantInventoryLink.yaml + - type: array + description: The product's updated. + items: + type: object + description: The updated's details. + x-schemaName: AdminProductVariantInventoryLink + required: + - productService + - inventoryService + properties: + productService: + type: object + description: The updated's productservice. + required: + - variant_id + properties: + variant_id: + type: string + title: variant_id + description: The productservice's variant id. + inventoryService: + type: object + description: The updated's inventoryservice. + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventoryservice's inventory item id. + deleted: + oneOf: + - $ref: ./AdminProductVariantInventoryLink.yaml + - type: array + description: The product's deleted. + items: + type: object + description: The deleted's details. + x-schemaName: AdminProductVariantInventoryLink + required: + - productService + - inventoryService + properties: + productService: + type: object + description: The deleted's productservice. + required: + - variant_id + properties: + variant_id: + type: string + title: variant_id + description: The productservice's variant id. + inventoryService: + type: object + description: The deleted's inventoryservice. + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventoryservice's inventory item id. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLink.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLink.yaml new file mode 100644 index 0000000000..e5938e984d --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLink.yaml @@ -0,0 +1,27 @@ +type: object +description: The product's ID. +x-schemaName: AdminProductVariantInventoryLink +required: + - productService + - inventoryService +properties: + productService: + type: object + description: The id's productservice. + required: + - variant_id + properties: + variant_id: + type: string + title: variant_id + description: The productservice's variant id. + inventoryService: + type: object + description: The id's inventoryservice. + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventoryservice's inventory item id. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml new file mode 100644 index 0000000000..4e2fdc8918 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml @@ -0,0 +1,21 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductVariantInventoryLinkDeleteResponse +required: + - id + - object + - deleted + - parent +properties: + id: + $ref: ./AdminProductVariantInventoryLink.yaml + object: + type: string + title: object + description: The product's object. + deleted: + type: boolean + title: deleted + description: The product's deleted. + parent: + $ref: ./AdminProductVariant.yaml 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 a6a154c417..0b6f5fd615 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml @@ -62,215 +62,17 @@ properties: type: array description: The variant's $and. items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - sku: - oneOf: - - type: string - title: sku - description: The $and's sku. - - type: array - description: The $and's sku. - items: - type: string - title: sku - description: The sku's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $and's product id. - - type: array - description: The $and's product id. - items: - type: string - title: product_id - description: The product id's details. - options: - type: object - description: The $and's options. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $or's details. + type: array + description: The $and's details. + items: + type: object + title: $and $or: type: array description: The variant's $or. items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - sku: - oneOf: - - type: string - title: sku - description: The $or's sku. - - type: array - description: The $or's sku. - items: - type: string - title: sku - description: The sku's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $or's product id. - - type: array - description: The $or's product id. - items: - type: string - title: product_id - description: The product id's details. - options: - type: object - description: The $or's options. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $or's details. + type: array + description: The $or's details. + items: + type: object + title: $or diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml new file mode 100644 index 0000000000..a04db87818 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml @@ -0,0 +1,36 @@ +type: object +description: The promotion's details. +x-schemaName: AdminPromotion +required: + - id +properties: + id: + type: string + title: id + description: The promotion's ID. + code: + type: string + title: code + description: The promotion's code. + type: + type: string + enum: + - standard + - buyget + is_automatic: + type: boolean + title: is_automatic + description: The promotion's is automatic. + application_method: + $ref: ./BaseApplicationMethod.yaml + rules: + type: array + description: The promotion's rules. + items: + $ref: ./BasePromotionRule.yaml + campaign_id: + type: string + title: campaign_id + description: The promotion's campaign id. + campaign: + $ref: ./CampaignResponse.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPromotionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPromotionResponse.yaml new file mode 100644 index 0000000000..3a4255fe94 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPromotionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminPromotionResponse +required: + - promotion +properties: + promotion: + $ref: ./AdminPromotion.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPromotionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPromotionRule.yaml new file mode 100644 index 0000000000..606b760d6f --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPromotionRule.yaml @@ -0,0 +1,34 @@ +type: object +description: The updated's details. +x-schemaName: AdminPromotionRule +required: + - id + - values +properties: + id: + type: string + title: id + description: The updated's ID. + description: + type: string + title: description + description: The updated's description. + attribute: + type: string + title: attribute + description: The updated's attribute. + operator: + type: string + enum: + - gt + - lt + - eq + - ne + - in + - lte + - gte + values: + type: array + description: The updated's values. + items: + $ref: ./BasePromotionRuleValue.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminRefundReason.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRefundReason.yaml new file mode 100644 index 0000000000..3110520654 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRefundReason.yaml @@ -0,0 +1,35 @@ +type: object +description: The refund reason's details. +x-schemaName: AdminRefundReason +required: + - id + - label + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The refund reason's ID. + label: + type: string + title: label + description: The refund reason's label. + description: + type: string + title: description + description: The refund reason's description. + metadata: + type: object + description: The refund reason's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The refund reason's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The refund reason's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRegion.yaml new file mode 100644 index 0000000000..0ad92660d5 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRegion.yaml @@ -0,0 +1,47 @@ +type: object +description: The region's details. +x-schemaName: AdminRegion +required: + - id + - name + - currency_code +properties: + id: + type: string + title: id + description: The region's ID. + name: + type: string + title: name + description: The region's name. + currency_code: + type: string + title: currency_code + description: The region's currency code. + automatic_taxes: + type: boolean + title: automatic_taxes + description: The region's automatic taxes. + countries: + type: array + description: The region's countries. + items: + $ref: ./BaseRegionCountry.yaml + payment_providers: + type: array + description: The region's payment providers. + items: + $ref: ./AdminPaymentProvider.yaml + metadata: + type: object + description: The region's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The region's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The region's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminRegionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRegionResponse.yaml new file mode 100644 index 0000000000..fc2373ff77 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRegionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminRegionResponse +required: + - region +properties: + region: + $ref: ./AdminRegion.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReservationResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReservationResponse.yaml new file mode 100644 index 0000000000..6f13a6c0e5 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReservationResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminReservationResponse +required: + - reservation +properties: + reservation: + $ref: ./ReservationResponse.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturn.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturn.yaml new file mode 100644 index 0000000000..f35a98e0a3 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturn.yaml @@ -0,0 +1,66 @@ +type: object +description: The exchange's return. +x-schemaName: AdminReturn +required: + - id + - order_id + - order_version + - display_id + - items + - received_at + - created_at +properties: + id: + type: string + title: id + description: The return's ID. + order_id: + type: string + title: order_id + description: The return's order id. + status: + type: string + title: status + description: The return's status. + exchange_id: + type: string + title: exchange_id + description: The return's exchange id. + location_id: + type: string + title: location_id + description: The return's location id. + claim_id: + type: string + title: claim_id + description: The return's claim id. + order_version: + type: number + title: order_version + description: The return's order version. + display_id: + type: number + title: display_id + description: The return's display id. + no_notification: + type: boolean + title: no_notification + description: The return's no notification. + refund_amount: + type: number + title: refund_amount + description: The return's refund amount. + items: + type: array + description: The return's items. + items: + $ref: ./BaseReturnItem.yaml + received_at: + type: string + title: received_at + description: The return's received at. + created_at: + type: string + format: date-time + title: created_at + description: The return's created at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturnItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturnItem.yaml new file mode 100644 index 0000000000..104e37834a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnItem.yaml @@ -0,0 +1,41 @@ +type: object +description: The return item's return items. +x-schemaName: AdminReturnItem +required: + - id + - quantity + - received_quantity + - item_id + - return_id +properties: + id: + type: string + title: id + description: The return item's ID. + quantity: + type: number + title: quantity + description: The return item's quantity. + received_quantity: + type: number + title: received_quantity + description: The return item's received quantity. + reason_id: + type: string + title: reason_id + description: The return item's reason id. + note: + type: string + title: note + description: The return item's note. + item_id: + type: string + title: item_id + description: The return item's item id. + return_id: + type: string + title: return_id + description: The return item's return id. + metadata: + type: object + description: The return item's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturnPreviewResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturnPreviewResponse.yaml new file mode 100644 index 0000000000..8b8734b2fe --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnPreviewResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminReturnPreviewResponse +required: + - order_preview + - return +properties: + order_preview: + $ref: ./AdminOrderPreview.yaml + return: + $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturnReason.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReason.yaml new file mode 100644 index 0000000000..3046e2a254 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReason.yaml @@ -0,0 +1,39 @@ +type: object +description: The return reason's details. +x-schemaName: AdminReturnReason +required: + - id + - value + - label + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The return reason's ID. + value: + type: string + title: value + description: The return reason's value. + label: + type: string + title: label + description: The return reason's label. + description: + type: string + title: description + description: The return reason's description. + metadata: + type: object + description: The return reason's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The return reason's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The return reason's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonListResponse.yaml new file mode 100644 index 0000000000..0fa69fc517 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminReturnReasonListResponse +required: + - limit + - offset + - count + - return_reasons +properties: + limit: + type: number + title: limit + description: The return reason's limit. + offset: + type: number + title: offset + description: The return reason's offset. + count: + type: number + title: count + description: The return reason's count. + return_reasons: + type: array + description: The return reason's return reasons. + items: + $ref: ./AdminReturnReason.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonResponse.yaml new file mode 100644 index 0000000000..9b3ad0f9a4 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminReturnReasonResponse +required: + - return_reason +properties: + return_reason: + $ref: ./AdminReturnReason.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturnResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturnResponse.yaml new file mode 100644 index 0000000000..8ce9535394 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminReturnResponse +required: + - return +properties: + return: + $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminRuleAttributeOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRuleAttributeOption.yaml new file mode 100644 index 0000000000..8ca5eaabf3 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRuleAttributeOption.yaml @@ -0,0 +1,41 @@ +type: object +description: The attribute's attributes. +x-schemaName: AdminRuleAttributeOption +required: + - id + - value + - label + - field_type + - required + - disguised + - operators +properties: + id: + type: string + title: id + description: The attribute's ID. + value: + type: string + title: value + description: The attribute's value. + label: + type: string + title: label + description: The attribute's label. + field_type: + type: string + title: field_type + description: The attribute's field type. + required: + type: boolean + title: required + description: The attribute's required. + disguised: + type: boolean + title: disguised + description: The attribute's disguised. + operators: + type: array + description: The attribute's operators. + items: + $ref: ./BaseRuleOperatorOptions.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminRuleValueOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRuleValueOption.yaml new file mode 100644 index 0000000000..cb8776ea83 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRuleValueOption.yaml @@ -0,0 +1,20 @@ +type: object +description: The value's values. +x-schemaName: AdminRuleValueOption +required: + - id + - value + - label +properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value's details. + label: + type: string + title: label + description: The value's label. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelDeleteResponse.yaml new file mode 100644 index 0000000000..56dff1a392 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminSalesChannelDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The sales channel's ID. + object: + type: string + title: object + description: The sales channel's object. + default: sales-channel + deleted: + type: boolean + title: deleted + description: The sales channel's deleted. + parent: + type: object + description: The sales channel's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelResponse.yaml new file mode 100644 index 0000000000..baeb779f03 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminSalesChannelResponse +required: + - sales_channel +properties: + sales_channel: + $ref: ./AdminSalesChannel.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminServiceZone.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminServiceZone.yaml index d3a3547a06..d0dff34efc 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminServiceZone.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminServiceZone.yaml @@ -5,6 +5,7 @@ required: - id - name - fulfillment_set_id + - fulfillment_set - geo_zones - shipping_options - created_at @@ -23,6 +24,8 @@ properties: type: string title: fulfillment_set_id description: The service zone's fulfillment set id. + fulfillment_set: + type: object geo_zones: type: array description: The service zone's geo zones. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionRule.yaml new file mode 100644 index 0000000000..ed10fb27e4 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionRule.yaml @@ -0,0 +1,55 @@ +type: object +description: The updated's details. +x-schemaName: AdminShippingOptionRule +required: + - id + - attribute + - operator + - value + - shipping_option_id + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The updated's ID. + attribute: + type: string + title: attribute + description: The updated's attribute. + operator: + type: string + title: operator + description: The updated's operator. + value: + oneOf: + - type: string + title: value + description: The updated's value. + - type: array + description: The updated's value. + items: + type: string + title: value + description: The value's details. + shipping_option_id: + type: string + title: shipping_option_id + description: The updated's shipping option id. + created_at: + type: string + format: date-time + title: created_at + description: The updated's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The updated's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The updated's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocation.yaml new file mode 100644 index 0000000000..e4f23a4318 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocation.yaml @@ -0,0 +1,37 @@ +type: object +description: The fulfillment set's location. +x-schemaName: AdminStockLocation +required: + - id + - name + - address_id +properties: + id: + type: string + title: id + description: The location's ID. + name: + type: string + title: name + description: The location's name. + address_id: + type: string + title: address_id + description: The location's address id. + address: + $ref: ./AdminStockLocationAddress.yaml + sales_channels: + type: array + description: The location's sales channels. + items: + $ref: ./AdminSalesChannel.yaml + fulfillment_providers: + type: array + description: The location's fulfillment providers. + items: + $ref: ./AdminFulfillmentProvider.yaml + fulfillment_sets: + type: array + description: The location's fulfillment sets. + items: + type: object diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationAddress.yaml new file mode 100644 index 0000000000..03be8aa3dd --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationAddress.yaml @@ -0,0 +1,3 @@ +type: object +description: The location's address. +x-schemaName: AdminStockLocationAddress diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationDeleteResponse.yaml new file mode 100644 index 0000000000..eded6905fb --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminStockLocationDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The stock location's ID. + object: + type: string + title: object + description: The stock location's object. + default: stock_location + deleted: + type: boolean + title: deleted + description: The stock location's deleted. + parent: + type: object + description: The stock location's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationListResponse.yaml new file mode 100644 index 0000000000..f8181758b1 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminStockLocationListResponse +required: + - limit + - offset + - count + - stock_locations +properties: + limit: + type: number + title: limit + description: The stock location's limit. + offset: + type: number + title: offset + description: The stock location's offset. + count: + type: number + title: count + description: The stock location's count. + stock_locations: + type: array + description: The stock location's stock locations. + items: + $ref: ./AdminStockLocation.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationResponse.yaml new file mode 100644 index 0000000000..68d6a4db18 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminStockLocationResponse +required: + - stock_location +properties: + stock_location: + $ref: ./AdminStockLocation.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStore.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStore.yaml new file mode 100644 index 0000000000..a56500fc7b --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStore.yaml @@ -0,0 +1,52 @@ +type: object +description: The store's details. +x-schemaName: AdminStore +required: + - id + - name + - supported_currencies + - default_sales_channel_id + - default_region_id + - default_location_id + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The store's ID. + name: + type: string + title: name + description: The store's name. + supported_currencies: + type: array + description: The store's supported currencies. + items: + $ref: ./AdminStoreCurrency.yaml + default_sales_channel_id: + type: string + title: default_sales_channel_id + description: The store's default sales channel id. + default_region_id: + type: string + title: default_region_id + description: The store's default region id. + default_location_id: + type: string + title: default_location_id + description: The store's default location id. + metadata: + type: object + description: The store's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The store's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The store's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStoreCurrency.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStoreCurrency.yaml new file mode 100644 index 0000000000..5014c7b7bc --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStoreCurrency.yaml @@ -0,0 +1,46 @@ +type: object +description: The supported currency's supported currencies. +x-schemaName: AdminStoreCurrency +required: + - id + - currency_code + - store_id + - is_default + - currency + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The supported currency's ID. + currency_code: + type: string + title: currency_code + description: The supported currency's currency code. + store_id: + type: string + title: store_id + description: The supported currency's store id. + is_default: + type: boolean + title: is_default + description: The supported currency's is default. + currency: + $ref: ./AdminCurrency.yaml + created_at: + type: string + format: date-time + title: created_at + description: The supported currency's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The supported currency's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The supported currency's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStoreListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStoreListResponse.yaml new file mode 100644 index 0000000000..33099c28f1 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStoreListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminStoreListResponse +required: + - limit + - offset + - count + - stores +properties: + limit: + type: number + title: limit + description: The store's limit. + offset: + type: number + title: offset + description: The store's offset. + count: + type: number + title: count + description: The store's count. + stores: + type: array + description: The store's stores. + items: + $ref: ./AdminStore.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStoreResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStoreResponse.yaml new file mode 100644 index 0000000000..c24cc35690 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStoreResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminStoreResponse +required: + - store +properties: + store: + $ref: ./AdminStore.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRate.yaml new file mode 100644 index 0000000000..35d3b37a92 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRate.yaml @@ -0,0 +1,76 @@ +type: object +description: The tax rate's details. +x-schemaName: AdminTaxRate +required: + - id + - rate + - code + - name + - metadata + - tax_region_id + - is_combinable + - is_default + - created_at + - updated_at + - deleted_at + - created_by + - tax_region + - rules +properties: + id: + type: string + title: id + description: The tax rate's ID. + rate: + type: number + title: rate + description: The tax rate's rate. + code: + type: string + title: code + description: The tax rate's code. + name: + type: string + title: name + description: The tax rate's name. + metadata: + type: object + description: The tax rate's metadata. + tax_region_id: + type: string + title: tax_region_id + description: The tax rate's tax region id. + is_combinable: + type: boolean + title: is_combinable + description: The tax rate's is combinable. + is_default: + type: boolean + title: is_default + description: The tax rate's is default. + created_at: + type: string + format: date-time + title: created_at + description: The tax rate's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax rate's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The tax rate's deleted at. + created_by: + type: string + title: created_by + description: The tax rate's created by. + tax_region: + $ref: ./AdminTaxRegion.yaml + rules: + type: array + description: The tax rate'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 new file mode 100644 index 0000000000..8d63342ef2 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminTaxRateDeleteResponse +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. + default: tax_rate + deleted: + type: boolean + title: deleted + description: The tax rate's deleted. + parent: + type: object + description: The tax rate's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateResponse.yaml new file mode 100644 index 0000000000..2dd828e446 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminTaxRateResponse +required: + - tax_rate +properties: + tax_rate: + $ref: ./AdminTaxRate.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateRule.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateRule.yaml new file mode 100644 index 0000000000..8e0ff14b5d --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateRule.yaml @@ -0,0 +1,15 @@ +type: object +description: The rule's rules. +x-schemaName: AdminTaxRateRule +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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml new file mode 100644 index 0000000000..360fa57763 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml @@ -0,0 +1,97 @@ +type: object +description: The tax rate's tax region. +x-schemaName: AdminTaxRegion +required: + - id + - rate + - code + - country_code + - province_code + - name + - metadata + - tax_region_id + - is_combinable + - is_default + - parent_id + - created_at + - updated_at + - deleted_at + - created_by + - tax_rates + - parent + - children +properties: + id: + type: string + title: id + description: The tax region's ID. + rate: + type: number + title: rate + description: The tax region's rate. + code: + type: string + title: code + description: The tax region's code. + country_code: + type: string + title: country_code + description: The tax region's country code. + province_code: + type: string + title: province_code + description: The tax region's province code. + name: + type: string + title: name + description: The tax region's name. + metadata: + type: object + description: The tax region's metadata. + tax_region_id: + type: string + title: tax_region_id + description: The tax region's tax region id. + is_combinable: + type: boolean + title: is_combinable + description: The tax region's is combinable. + is_default: + type: boolean + title: is_default + description: The tax region's is default. + parent_id: + type: string + title: parent_id + description: The tax region's parent id. + created_at: + type: string + format: date-time + title: created_at + description: The tax region's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax region's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The tax region's deleted at. + created_by: + type: string + title: created_by + description: The tax region's created by. + tax_rates: + type: array + description: The tax region's tax rates. + items: + $ref: ./AdminTaxRate.yaml + parent: + $ref: ./AdminTaxRegion.yaml + children: + type: array + description: The tax region's children. + items: + $ref: ./AdminTaxRegion.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionDeleteResponse.yaml new file mode 100644 index 0000000000..fcc06bd342 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminTaxRegionDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The tax region's ID. + object: + type: string + title: object + description: The tax region's object. + default: tax_region + deleted: + type: boolean + title: deleted + description: The tax region's deleted. + parent: + type: object + description: The tax region's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionResponse.yaml new file mode 100644 index 0000000000..0c200e26d0 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminTaxRegionResponse +required: + - tax_region +properties: + tax_region: + $ref: ./AdminTaxRegion.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomer.yaml deleted file mode 100644 index 81d0b149a0..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomer.yaml +++ /dev/null @@ -1,35 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminUpdateCustomer -required: - - email - - company_name - - first_name - - last_name - - phone - - metadata -properties: - email: - type: string - title: email - description: The customer's email. - format: email - company_name: - type: string - title: company_name - description: The customer's company name. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - phone: - 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/AdminUpdateProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProduct.yaml index b95015d041..c5e1c3c7a9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProduct.yaml @@ -77,15 +77,13 @@ properties: items: type: object description: The tag's tags. + required: + - id properties: id: type: string title: id description: The tag's ID. - value: - type: string - title: value - description: The tag's value. options: type: array description: The update's options. @@ -95,7 +93,168 @@ properties: type: array description: The update's variants. items: - $ref: ./AdminCreateProductVariant.yaml + oneOf: + - type: object + description: The variant's variants. + x-schemaName: AdminCreateProductVariant + required: + - title + - prices + properties: + title: + type: string + title: title + description: The variant's title. + sku: + type: string + title: sku + description: The variant's sku. + ean: + type: string + title: ean + description: The variant's ean. + upc: + type: string + title: upc + description: The variant's upc. + barcode: + type: string + title: barcode + description: The variant's barcode. + hs_code: + type: string + title: hs_code + description: The variant's hs code. + mid_code: + type: string + title: mid_code + description: The variant's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + weight: + type: number + title: weight + description: The variant's weight. + length: + type: number + title: length + description: The variant's length. + height: + type: number + title: height + description: The variant's height. + width: + type: number + title: width + description: The variant's width. + origin_country: + type: string + title: origin_country + description: The variant's origin country. + material: + type: string + title: material + description: The variant's material. + metadata: + type: object + description: The variant's metadata. + prices: + type: array + description: The variant's prices. + items: + $ref: ./AdminCreateProductVariantPrice.yaml + options: + type: object + description: The variant's options. + - type: object + description: The variant's variants. + x-schemaName: AdminUpdateProductVariant + properties: + title: + type: string + title: title + description: The variant's title. + sku: + type: string + title: sku + description: The variant's sku. + ean: + type: string + title: ean + description: The variant's ean. + upc: + type: string + title: upc + description: The variant's upc. + barcode: + type: string + title: barcode + description: The variant's barcode. + hs_code: + type: string + title: hs_code + description: The variant's hs code. + mid_code: + type: string + title: mid_code + description: The variant's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + weight: + type: number + title: weight + description: The variant's weight. + length: + type: number + title: length + description: The variant's length. + height: + type: number + title: height + description: The variant's height. + width: + type: number + title: width + description: The variant's width. + origin_country: + type: string + title: origin_country + description: The variant's origin country. + material: + type: string + title: material + description: The variant's material. + metadata: + type: object + description: The variant's metadata. + prices: + type: array + description: The variant's prices. + items: + $ref: ./AdminCreateProductVariantPrice.yaml + options: + type: object + description: The variant's options. sales_channels: type: array description: The update's sales channels. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUser.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUser.yaml new file mode 100644 index 0000000000..6fb258123e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUser.yaml @@ -0,0 +1,53 @@ +type: object +description: The user's details. +x-schemaName: AdminUser +required: + - id + - email + - first_name + - last_name + - avatar_url + - metadata + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The user's ID. + email: + type: string + title: email + description: The user's email. + format: email + first_name: + type: string + title: first_name + description: The user's first name. + last_name: + type: string + title: last_name + description: The user's last name. + avatar_url: + type: string + title: avatar_url + description: The user's avatar url. + metadata: + type: object + description: The user's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The user's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The user's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The user's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUserDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUserDeleteResponse.yaml new file mode 100644 index 0000000000..5714e8f25d --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUserDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminUserDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The user's ID. + object: + type: string + title: object + description: The user's object. + default: user + deleted: + type: boolean + title: deleted + description: The user's deleted. + parent: + type: object + description: The user's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUserListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUserListResponse.yaml new file mode 100644 index 0000000000..7aac88724a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUserListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminUserListResponse +required: + - limit + - offset + - count + - users +properties: + limit: + type: number + title: limit + description: The user's limit. + offset: + type: number + title: offset + description: The user's offset. + count: + type: number + title: count + description: The user's count. + users: + type: array + description: The user's users. + items: + $ref: ./AdminUser.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUserResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUserResponse.yaml new file mode 100644 index 0000000000..dfc78e1bc9 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUserResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminUserResponse +required: + - user +properties: + user: + $ref: ./AdminUser.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecution.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecution.yaml new file mode 100644 index 0000000000..8e71182f9e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecution.yaml @@ -0,0 +1,50 @@ +type: object +description: The workflows execution's workflow execution. +x-schemaName: AdminWorkflowExecution +required: + - id + - workflow_id + - transaction_id + - execution + - context + - state + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The workflow execution's ID. + workflow_id: + type: string + title: workflow_id + description: The workflow execution's workflow id. + transaction_id: + type: string + title: transaction_id + description: The workflow execution's transaction id. + execution: + type: string + title: execution + description: The workflow execution's execution. + context: + type: string + title: context + description: The workflow execution's context. + state: {} + created_at: + type: string + title: created_at + description: The workflow execution's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The workflow execution's updated at. + format: date-time + deleted_at: + type: string + title: deleted_at + description: The workflow execution's deleted at. + format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionResponse.yaml new file mode 100644 index 0000000000..2c21bd3e4e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminWorkflowExecutionResponse +required: + - workflow_execution +properties: + workflow_execution: + $ref: ./AdminWorkflowExecution.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/ApiKeyResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/ApiKeyResponse.yaml new file mode 100644 index 0000000000..df83ca78ff --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/ApiKeyResponse.yaml @@ -0,0 +1,59 @@ +type: object +description: The api key's details. +x-schemaName: ApiKeyResponse +required: + - id + - token + - redacted + - title + - type + - last_used_at + - created_by + - created_at + - revoked_by + - revoked_at +properties: + id: + type: string + title: id + description: The api key's ID. + token: + type: string + title: token + description: The api key's token. + redacted: + type: string + title: redacted + description: The api key's redacted. + title: + type: string + title: title + description: The api key's title. + type: + type: string + enum: + - secret + - publishable + last_used_at: + type: string + title: last_used_at + description: The api key's last used at. + format: date-time + created_by: + type: string + title: created_by + description: The api key's created by. + created_at: + type: string + title: created_at + description: The api key's created at. + format: date-time + revoked_by: + type: string + title: revoked_by + description: The api key's revoked by. + revoked_at: + type: string + title: revoked_at + description: The api key's revoked at. + format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseApplicationMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseApplicationMethod.yaml new file mode 100644 index 0000000000..b45304e208 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseApplicationMethod.yaml @@ -0,0 +1,58 @@ +type: object +description: The promotion's application method. +x-schemaName: BaseApplicationMethod +required: + - id +properties: + id: + type: string + title: id + description: The application method's ID. + type: + type: string + enum: + - fixed + - percentage + target_type: + type: string + enum: + - items + - shipping_methods + - order + allocation: + type: string + enum: + - each + - across + 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. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The application method's buy rules min quantity. + apply_to_quantity: + type: number + title: apply_to_quantity + description: The application method's apply to quantity. + promotion: + $ref: ./BasePromotion.yaml + target_rules: + type: array + description: The application method's target rules. + items: + $ref: ./BasePromotionRule.yaml + buy_rules: + type: array + description: The application method's buy rules. + items: + $ref: ./BasePromotionRule.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCalculatedPriceSet.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCalculatedPriceSet.yaml index dafb774a5f..70dd7bf660 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCalculatedPriceSet.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCalculatedPriceSet.yaml @@ -1,5 +1,5 @@ type: object -description: The updated's calculated price. +description: The parent's calculated price. x-schemaName: BaseCalculatedPriceSet required: - id diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCapture.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCapture.yaml new file mode 100644 index 0000000000..59baa7033c --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCapture.yaml @@ -0,0 +1,3 @@ +type: object +description: The capture's captures. +x-schemaName: BaseCapture diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCart.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCart.yaml new file mode 100644 index 0000000000..5cc50d1e73 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCart.yaml @@ -0,0 +1,3 @@ +type: object +description: The item's cart. +x-schemaName: BaseCart diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCartAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCartAddress.yaml new file mode 100644 index 0000000000..830384378e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCartAddress.yaml @@ -0,0 +1,69 @@ +type: object +description: The cart's billing address. +x-schemaName: BaseCartAddress +required: + - id + - created_at + - updated_at +properties: + 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/BaseCartLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCartLineItem.yaml new file mode 100644 index 0000000000..c1a1fc38f4 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCartLineItem.yaml @@ -0,0 +1,306 @@ +type: object +description: The item's items. +x-schemaName: BaseCartLineItem +required: + - id + - title + - quantity + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - cart + - cart_id + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total +properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + quantity: + oneOf: + - type: string + title: quantity + description: The item's quantity. + - type: number + title: quantity + description: The item's quantity. + - type: string + title: quantity + description: The item's quantity. + - $ref: ./IBigNumber.yaml + product: + $ref: ./BaseProduct.yaml + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant: + $ref: ./BaseProductVariant.yaml + variant_id: + type: string + title: variant_id + description: The item's variant id. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + oneOf: + - type: string + title: compare_at_unit_price + description: The item's compare at unit price. + - type: number + title: compare_at_unit_price + description: The item's compare at unit price. + - type: string + title: compare_at_unit_price + description: The item's compare at unit price. + - $ref: ./IBigNumber.yaml + unit_price: + oneOf: + - type: string + title: unit_price + description: The item's unit price. + - type: number + title: unit_price + description: The item's unit price. + - type: string + title: unit_price + description: The item's unit price. + - $ref: ./IBigNumber.yaml + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: ./BaseLineItemTaxLine.yaml + adjustments: + type: array + description: The item's adjustments. + items: + $ref: ./BaseLineItemAdjustment.yaml + cart: + $ref: ./BaseCart.yaml + cart_id: + type: string + title: cart_id + description: The item's cart id. + metadata: + type: object + description: The item's metadata. + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + deleted_at: + type: string + title: deleted_at + description: The item's deleted at. + format: date-time + original_total: + oneOf: + - type: string + title: original_total + description: The item's original total. + - type: number + title: original_total + description: The item's original total. + - type: string + title: original_total + description: The item's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The item's original subtotal. + - type: number + title: original_subtotal + description: The item's original subtotal. + - type: string + title: original_subtotal + description: The item's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The item's original tax total. + - type: number + title: original_tax_total + description: The item's original tax total. + - type: string + title: original_tax_total + description: The item's original tax total. + - $ref: ./IBigNumber.yaml + item_total: + oneOf: + - type: string + title: item_total + description: The item's item total. + - type: number + title: item_total + description: The item's item total. + - type: string + title: item_total + description: The item's item total. + - $ref: ./IBigNumber.yaml + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The item's item subtotal. + - type: number + title: item_subtotal + description: The item's item subtotal. + - type: string + title: item_subtotal + description: The item's item subtotal. + - $ref: ./IBigNumber.yaml + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The item's item tax total. + - type: number + title: item_tax_total + description: The item's item tax total. + - type: string + title: item_tax_total + description: The item's item tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The item's total. + - type: number + title: total + description: The item's total. + - type: string + title: total + description: The item's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The item's subtotal. + - type: number + title: subtotal + description: The item's subtotal. + - type: string + title: subtotal + description: The item's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The item's tax total. + - type: number + title: tax_total + description: The item's tax total. + - type: string + title: tax_total + description: The item's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The item's discount total. + - type: number + title: discount_total + description: The item's discount total. + - type: string + title: discount_total + description: The item's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The item's discount tax total. + - type: number + title: discount_tax_total + description: The item's discount tax total. + - type: string + title: discount_tax_total + description: The item's discount tax total. + - $ref: ./IBigNumber.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCartShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCartShippingMethod.yaml new file mode 100644 index 0000000000..6f613ecf88 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCartShippingMethod.yaml @@ -0,0 +1,178 @@ +type: object +description: The shipping method's shipping methods. +x-schemaName: BaseCartShippingMethod +required: + - id + - cart_id + - name + - amount + - is_tax_inclusive + - created_at + - updated_at + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total +properties: + id: + type: string + title: id + description: The shipping method's ID. + cart_id: + type: string + title: cart_id + description: The shipping method's cart id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + oneOf: + - type: string + title: amount + description: The shipping method's amount. + - type: number + title: amount + description: The shipping method's amount. + - type: string + title: amount + description: The shipping method's amount. + - $ref: ./IBigNumber.yaml + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: ./BaseShippingMethodTaxLine.yaml + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: ./BaseShippingMethodAdjustment.yaml + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: discount_tax_total + description: The shipping method's discount tax total. + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - $ref: ./IBigNumber.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseClaim.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseClaim.yaml new file mode 100644 index 0000000000..85d6a02519 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseClaim.yaml @@ -0,0 +1,3 @@ +type: object +description: The order change's claim. +x-schemaName: BaseClaim diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseClaimItem.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseClaimItem.yaml new file mode 100644 index 0000000000..bff97378cc --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseClaimItem.yaml @@ -0,0 +1,55 @@ +type: object +description: The claim item's claim items. +x-schemaName: BaseClaimItem +required: + - id + - claim_id + - order_id + - item_id + - quantity + - reason + - raw_quantity +properties: + id: + type: string + title: id + description: The claim item's ID. + claim_id: + type: string + title: claim_id + description: The claim item's claim id. + order_id: + type: string + title: order_id + description: The claim item's order id. + item_id: + type: string + title: item_id + description: The claim item's item id. + quantity: + type: number + title: quantity + description: The claim item's quantity. + reason: + type: string + enum: + - missing_item + - wrong_item + - production_failure + - other + raw_quantity: + type: object + description: The claim item's raw quantity. + metadata: + type: object + description: The claim item's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The claim item's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The claim item's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseExchangeItem.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseExchangeItem.yaml new file mode 100644 index 0000000000..852b2e0a94 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseExchangeItem.yaml @@ -0,0 +1,45 @@ +type: object +description: The additional item's additional items. +x-schemaName: BaseExchangeItem +required: + - id + - exchange_id + - order_id + - item_id + - quantity + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The additional item's ID. + exchange_id: + type: string + title: exchange_id + description: The additional item's exchange id. + order_id: + type: string + title: order_id + description: The additional item's order id. + item_id: + type: string + title: item_id + description: The additional item's item id. + quantity: + type: number + title: quantity + description: The additional item's quantity. + metadata: + type: object + description: The additional item's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The additional item's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The additional item's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseFulfillmentProvider.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseFulfillmentProvider.yaml new file mode 100644 index 0000000000..5cddd56a89 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseFulfillmentProvider.yaml @@ -0,0 +1,15 @@ +type: object +description: The shipping option's provider. +x-schemaName: BaseFulfillmentProvider +required: + - id + - is_enabled +properties: + id: + type: string + title: id + description: The provider's ID. + is_enabled: + type: boolean + title: is_enabled + description: The provider's is enabled. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseLineItemAdjustment.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseLineItemAdjustment.yaml new file mode 100644 index 0000000000..5b5a104b31 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseLineItemAdjustment.yaml @@ -0,0 +1,3 @@ +type: object +description: The adjustment's adjustments. +x-schemaName: BaseLineItemAdjustment diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseLineItemTaxLine.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseLineItemTaxLine.yaml new file mode 100644 index 0000000000..1fdd8bf379 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseLineItemTaxLine.yaml @@ -0,0 +1,3 @@ +type: object +description: The tax line's tax lines. +x-schemaName: BaseLineItemTaxLine diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml new file mode 100644 index 0000000000..09579fa8dd --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml @@ -0,0 +1,3 @@ +type: object +description: The order change's order. +x-schemaName: BaseOrder diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml new file mode 100644 index 0000000000..4c549387e7 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml @@ -0,0 +1,70 @@ +type: object +description: The order's billing address. +x-schemaName: BaseOrderAddress +required: + - id + - metadata + - created_at + - updated_at +properties: + 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/BaseOrderChange.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderChange.yaml new file mode 100644 index 0000000000..a50ab648b5 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderChange.yaml @@ -0,0 +1,144 @@ +type: object +description: The order preview's order change. +x-schemaName: BaseOrderChange +required: + - id + - order_id + - actions + - status + - requested_by + - requested_at + - confirmed_by + - confirmed_at + - declined_by + - declined_reason + - metadata + - declined_at + - canceled_by + - canceled_at + - created_at + - updated_at + - version + - return_id + - exchange_id + - claim_id + - order + - return_order + - exchange + - claim +properties: + id: + type: string + title: id + description: The order change's ID. + order_id: + type: string + title: order_id + description: The order change's order id. + actions: + type: array + description: The order change's actions. + items: + $ref: ./BaseOrderChangeAction.yaml + status: + type: string + title: status + description: The order change's status. + requested_by: + type: string + title: requested_by + description: The order change's requested by. + requested_at: + oneOf: + - type: string + title: requested_at + description: The order change's requested at. + - type: string + title: requested_at + description: The order change's requested at. + format: date-time + confirmed_by: + type: string + title: confirmed_by + description: The order change's confirmed by. + confirmed_at: + oneOf: + - type: string + title: confirmed_at + description: The order change's confirmed at. + - type: string + title: confirmed_at + description: The order change's confirmed at. + format: date-time + declined_by: + type: string + title: declined_by + description: The order change's declined by. + declined_reason: + type: string + title: declined_reason + description: The order change's declined reason. + metadata: + type: object + description: The order change's metadata. + declined_at: + oneOf: + - type: string + title: declined_at + description: The order change's declined at. + - type: string + title: declined_at + description: The order change's declined at. + format: date-time + canceled_by: + type: string + title: canceled_by + description: The order change's canceled by. + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order change's canceled at. + - type: string + title: canceled_at + description: The order change's canceled at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The order change's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order change's updated at. + version: + type: number + title: version + description: The order change's version. + change_type: + type: string + enum: + - return + - exchange + - claim + - edit + return_id: + type: string + title: return_id + description: The order change's return id. + exchange_id: + type: string + title: exchange_id + description: The order change's exchange id. + claim_id: + type: string + title: claim_id + description: The order change's claim id. + order: + $ref: ./BaseOrder.yaml + return_order: {} + exchange: {} + claim: + $ref: ./BaseClaim.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderChangeAction.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderChangeAction.yaml new file mode 100644 index 0000000000..91725525be --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderChangeAction.yaml @@ -0,0 +1,3 @@ +type: object +description: The action's actions. +x-schemaName: BaseOrderChangeAction diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml new file mode 100644 index 0000000000..3e6cbb2a1a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml @@ -0,0 +1,69 @@ +type: object +description: The fulfillment's fulfillments. +x-schemaName: BaseOrderFulfillment +required: + - id + - location_id + - packed_at + - shipped_at + - delivered_at + - canceled_at + - data + - provider_id + - shipping_option_id + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The fulfillment's ID. + location_id: + type: string + title: location_id + description: The fulfillment's location id. + packed_at: + type: string + title: packed_at + description: The fulfillment's packed at. + format: date-time + shipped_at: + type: string + title: shipped_at + description: The fulfillment's shipped at. + format: date-time + delivered_at: + type: string + title: delivered_at + description: The fulfillment's delivered at. + format: date-time + canceled_at: + type: string + title: canceled_at + description: The fulfillment's canceled at. + format: date-time + data: + type: object + description: The fulfillment's data. + provider_id: + type: string + title: provider_id + description: The fulfillment's provider id. + shipping_option_id: + type: string + title: shipping_option_id + description: The fulfillment's shipping option id. + metadata: + type: object + description: The fulfillment's metadata. + created_at: + type: string + title: created_at + description: The fulfillment's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The fulfillment's updated at. + format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderItemDetail.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderItemDetail.yaml new file mode 100644 index 0000000000..0a1f9eb14d --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderItemDetail.yaml @@ -0,0 +1,3 @@ +type: object +description: The item's detail. +x-schemaName: BaseOrderItemDetail diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml new file mode 100644 index 0000000000..e3808ee206 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml @@ -0,0 +1,211 @@ +type: object +description: The item's items. +x-schemaName: BaseOrderLineItem +required: + - id + - title + - subtitle + - thumbnail + - variant_id + - product_id + - product_title + - product_description + - product_subtitle + - product_type + - product_collection + - product_handle + - variant_sku + - variant_barcode + - variant_title + - variant_option_values + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - detail + - created_at + - updated_at + - metadata + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit +properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant: + $ref: ./BaseProductVariant.yaml + variant_id: + type: string + title: variant_id + description: The item's variant id. + product: + $ref: ./BaseProduct.yaml + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: ./BaseOrderLineItemTaxLine.yaml + adjustments: + type: array + description: The item's adjustments. + items: + $ref: ./BaseOrderLineItemAdjustment.yaml + detail: + $ref: ./BaseOrderItemDetail.yaml + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + metadata: + type: object + description: The item's metadata. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItemAdjustment.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItemAdjustment.yaml new file mode 100644 index 0000000000..a4f81ce94f --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItemAdjustment.yaml @@ -0,0 +1,3 @@ +type: object +description: The adjustment's adjustments. +x-schemaName: BaseOrderLineItemAdjustment diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItemTaxLine.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItemTaxLine.yaml new file mode 100644 index 0000000000..213da9382d --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItemTaxLine.yaml @@ -0,0 +1,3 @@ +type: object +description: The tax line's tax lines. +x-schemaName: BaseOrderLineItemTaxLine diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethod.yaml new file mode 100644 index 0000000000..4357db37d7 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethod.yaml @@ -0,0 +1,173 @@ +type: object +description: The shipping method's shipping methods. +x-schemaName: BaseOrderShippingMethod +required: + - id + - order_id + - name + - amount + - is_tax_inclusive + - shipping_option_id + - data + - metadata + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: ./BaseOrderShippingMethodTaxLine.yaml + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: ./BaseOrderShippingMethodAdjustment.yaml + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: discount_tax_total + description: The shipping method's discount tax total. + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - $ref: ./IBigNumber.yaml + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethodAdjustment.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethodAdjustment.yaml new file mode 100644 index 0000000000..0d458f73fa --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethodAdjustment.yaml @@ -0,0 +1,3 @@ +type: object +description: The adjustment's adjustments. +x-schemaName: BaseOrderShippingMethodAdjustment diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethodTaxLine.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethodTaxLine.yaml new file mode 100644 index 0000000000..3cce6d21b0 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethodTaxLine.yaml @@ -0,0 +1,3 @@ +type: object +description: The tax line's tax lines. +x-schemaName: BaseOrderShippingMethodTaxLine diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderSummary.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderSummary.yaml new file mode 100644 index 0000000000..395346dc23 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderSummary.yaml @@ -0,0 +1,80 @@ +type: object +description: The order's summary. +x-schemaName: BaseOrderSummary +required: + - total + - subtotal + - total_tax + - ordered_total + - fulfilled_total + - returned_total + - return_request_total + - write_off_total + - projected_total + - net_total + - net_subtotal + - net_total_tax + - balance + - paid_total + - refunded_total +properties: + total: + type: number + title: total + description: The summary's total. + subtotal: + type: number + title: subtotal + description: The summary's subtotal. + total_tax: + type: number + title: total_tax + description: The summary's total tax. + ordered_total: + type: number + title: ordered_total + description: The summary's ordered total. + fulfilled_total: + type: number + title: fulfilled_total + description: The summary's fulfilled total. + returned_total: + type: number + title: returned_total + description: The summary's returned total. + return_request_total: + type: number + title: return_request_total + description: The summary's return request total. + write_off_total: + type: number + title: write_off_total + description: The summary's write off total. + projected_total: + type: number + title: projected_total + description: The summary's projected total. + net_total: + type: number + title: net_total + description: The summary's net total. + net_subtotal: + type: number + title: net_subtotal + description: The summary's net subtotal. + net_total_tax: + type: number + title: net_total_tax + description: The summary's net total tax. + balance: + type: number + title: balance + description: The summary's balance. + paid_total: + type: number + title: paid_total + description: The summary's paid total. + refunded_total: + type: number + title: refunded_total + description: The summary's refunded total. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderTransaction.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderTransaction.yaml new file mode 100644 index 0000000000..8abf8cfd58 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderTransaction.yaml @@ -0,0 +1,51 @@ +type: object +description: The transaction's transactions. +x-schemaName: BaseOrderTransaction +required: + - id + - order_id + - amount + - currency_code + - reference + - reference_id + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The transaction's ID. + order_id: + type: string + title: order_id + description: The transaction's order id. + amount: + type: number + title: amount + description: The transaction's amount. + currency_code: + type: string + title: currency_code + description: The transaction's currency code. + reference: + type: string + title: reference + description: The transaction's reference. + reference_id: + type: string + title: reference_id + description: The transaction's reference id. + metadata: + type: object + description: The transaction's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The transaction's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The transaction's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/BasePayment.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePayment.yaml new file mode 100644 index 0000000000..6171436ba7 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BasePayment.yaml @@ -0,0 +1,3 @@ +type: object +description: The payment's payments. +x-schemaName: BasePayment diff --git a/www/apps/api-reference/specs/store/components/schemas/BasePaymentCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePaymentCollection.yaml new file mode 100644 index 0000000000..f60bcd7273 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BasePaymentCollection.yaml @@ -0,0 +1,116 @@ +type: object +description: The payment collection's payment collections. +x-schemaName: BasePaymentCollection +required: + - id + - currency_code + - region_id + - amount + - status + - payment_providers +properties: + id: + type: string + title: id + description: The payment collection's ID. + currency_code: + type: string + title: currency_code + description: The payment collection's currency code. + region_id: + type: string + title: region_id + description: The payment collection's region id. + amount: + oneOf: + - type: string + title: amount + description: The payment collection's amount. + - type: number + title: amount + description: The payment collection's amount. + - type: string + title: amount + description: The payment collection's amount. + - $ref: ./IBigNumber.yaml + authorized_amount: + oneOf: + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - type: number + title: authorized_amount + description: The payment collection's authorized amount. + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - $ref: ./IBigNumber.yaml + captured_amount: + oneOf: + - type: string + title: captured_amount + description: The payment collection's captured amount. + - type: number + title: captured_amount + description: The payment collection's captured amount. + - type: string + title: captured_amount + description: The payment collection's captured amount. + - $ref: ./IBigNumber.yaml + refunded_amount: + oneOf: + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - type: number + title: refunded_amount + description: The payment collection's refunded amount. + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - $ref: ./IBigNumber.yaml + completed_at: + oneOf: + - type: string + title: completed_at + description: The payment collection's completed at. + - type: string + title: completed_at + description: The payment collection's completed at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The payment collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The payment collection's updated at. + metadata: + type: object + description: The payment collection's metadata. + status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + payment_providers: + type: array + description: The payment collection's payment providers. + items: + $ref: ./BasePaymentProvider.yaml + payment_sessions: + type: array + description: The payment collection's payment sessions. + items: + $ref: ./BasePaymentSession.yaml + payments: + type: array + description: The payment collection's payments. + items: + $ref: ./BasePayment.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/BasePaymentProvider.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePaymentProvider.yaml new file mode 100644 index 0000000000..2266f0a8ea --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BasePaymentProvider.yaml @@ -0,0 +1,3 @@ +type: object +description: The payment provider's payment providers. +x-schemaName: BasePaymentProvider diff --git a/www/apps/api-reference/specs/store/components/schemas/BasePaymentSession.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePaymentSession.yaml new file mode 100644 index 0000000000..f0c1e2603a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BasePaymentSession.yaml @@ -0,0 +1,3 @@ +type: object +description: The payment session's payment sessions. +x-schemaName: BasePaymentSession diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml index 9d8d9258cf..bb621de314 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml @@ -1,5 +1,5 @@ type: object -description: The updated's product. +description: The parent's product. x-schemaName: BaseProduct required: - id diff --git a/www/apps/api-reference/specs/store/components/schemas/BasePromotion.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePromotion.yaml new file mode 100644 index 0000000000..9715373b34 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BasePromotion.yaml @@ -0,0 +1,3 @@ +type: object +description: The application method's promotion. +x-schemaName: BasePromotion diff --git a/www/apps/api-reference/specs/store/components/schemas/BasePromotionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePromotionRule.yaml new file mode 100644 index 0000000000..29325b0a3b --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BasePromotionRule.yaml @@ -0,0 +1,34 @@ +type: object +description: The rule's rules. +x-schemaName: BasePromotionRule +required: + - id + - values +properties: + id: + type: string + title: id + description: The rule's ID. + description: + type: string + title: description + description: The rule's description. + attribute: + type: string + title: attribute + description: The rule's attribute. + operator: + type: string + enum: + - gt + - lt + - eq + - ne + - in + - lte + - gte + values: + type: array + description: The rule's values. + items: + $ref: ./BasePromotionRuleValue.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/BasePromotionRuleValue.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePromotionRuleValue.yaml new file mode 100644 index 0000000000..9cba351225 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BasePromotionRuleValue.yaml @@ -0,0 +1,14 @@ +type: object +description: The value's values. +x-schemaName: BasePromotionRuleValue +required: + - id +properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value's details. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseRefund.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseRefund.yaml new file mode 100644 index 0000000000..50d12fb0f9 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseRefund.yaml @@ -0,0 +1,3 @@ +type: object +description: The refund's refunds. +x-schemaName: BaseRefund diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseRegion.yaml new file mode 100644 index 0000000000..c90e5373dc --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseRegion.yaml @@ -0,0 +1,47 @@ +type: object +description: The cart's region. +x-schemaName: BaseRegion +required: + - id + - name + - currency_code +properties: + id: + type: string + title: id + description: The region's ID. + name: + type: string + title: name + description: The region's name. + currency_code: + type: string + title: currency_code + description: The region's currency code. + automatic_taxes: + type: boolean + title: automatic_taxes + description: The region's automatic taxes. + countries: + type: array + description: The region's countries. + items: + $ref: ./BaseRegionCountry.yaml + payment_providers: + type: array + description: The region's payment providers. + items: + $ref: ./AdminPaymentProvider.yaml + metadata: + type: object + description: The region's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The region's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The region's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseRegionCountry.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseRegionCountry.yaml new file mode 100644 index 0000000000..ee76c5c787 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseRegionCountry.yaml @@ -0,0 +1,3 @@ +type: object +description: The country's countries. +x-schemaName: BaseRegionCountry diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseReturnItem.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseReturnItem.yaml new file mode 100644 index 0000000000..3f0906bd54 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseReturnItem.yaml @@ -0,0 +1,3 @@ +type: object +description: The item's items. +x-schemaName: BaseReturnItem diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseRuleOperatorOptions.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseRuleOperatorOptions.yaml new file mode 100644 index 0000000000..b5c88a34d8 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseRuleOperatorOptions.yaml @@ -0,0 +1,20 @@ +type: object +description: The operator's operators. +x-schemaName: BaseRuleOperatorOptions +required: + - id + - value + - label +properties: + id: + type: string + title: id + description: The operator's ID. + value: + type: string + title: value + description: The operator's value. + label: + type: string + title: label + description: The operator's label. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseShippingMethodAdjustment.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseShippingMethodAdjustment.yaml new file mode 100644 index 0000000000..e20885775e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseShippingMethodAdjustment.yaml @@ -0,0 +1,3 @@ +type: object +description: The adjustment's adjustments. +x-schemaName: BaseShippingMethodAdjustment diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseShippingMethodTaxLine.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseShippingMethodTaxLine.yaml new file mode 100644 index 0000000000..e7e494dae5 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseShippingMethodTaxLine.yaml @@ -0,0 +1,3 @@ +type: object +description: The tax line's tax lines. +x-schemaName: BaseShippingMethodTaxLine diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCampaign.yaml b/www/apps/api-reference/specs/store/components/schemas/CampaignResponse.yaml similarity index 51% rename from www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCampaign.yaml rename to www/apps/api-reference/specs/store/components/schemas/CampaignResponse.yaml index d273d2bfbf..aa51404c15 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCampaign.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/CampaignResponse.yaml @@ -1,53 +1,72 @@ type: object -description: SUMMARY -x-schemaName: AdminUpdateCampaign +description: The campaign's details. +x-schemaName: CampaignResponse required: + - id + - name - description + - currency + - campaign_identifier - starts_at - ends_at + - budget properties: + id: + type: string + title: id + description: The campaign's ID. name: type: string title: name description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. description: type: string title: description description: The campaign's description. - budget: - type: object - description: The campaign's budget. - required: - - limit - properties: - limit: - type: number - title: limit - description: The budget's limit. + 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 - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. + budget: + type: object + description: The campaign's budget. + required: + - id + - type + - currency_code + - limit + - used + properties: + id: + type: string + title: id + description: The budget's ID. + type: + type: string + 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. + used: + type: number + title: used + description: The budget's used. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateCartWorkflowInput.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateCartWorkflowInput.yaml deleted file mode 100644 index 369ef9b3a1..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreateCartWorkflowInput.yaml +++ /dev/null @@ -1,60 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreateCartWorkflowInput -properties: - region_id: - type: string - title: region_id - description: The cart's region id. - customer_id: - type: string - title: customer_id - description: The cart's customer id. - sales_channel_id: - type: string - title: sales_channel_id - description: The cart's sales channel id. - email: - type: string - title: email - description: The cart's email. - format: email - currency_code: - type: string - title: currency_code - description: The cart's currency code. - shipping_address_id: - type: string - title: shipping_address_id - description: The cart's shipping address id. - billing_address_id: - type: string - title: billing_address_id - description: The cart's billing address id. - shipping_address: - oneOf: - - type: string - title: shipping_address - description: The cart's shipping address. - - $ref: ./CreateCartAddress.yaml - billing_address: - oneOf: - - type: string - title: billing_address - description: The cart's billing address. - - $ref: ./CreateCartAddress.yaml - metadata: - type: object - description: The cart's metadata. - items: - type: array - description: The cart's items. - items: - $ref: ./CreateCartCreateLineItem.yaml - promo_codes: - type: array - description: The cart's promo codes. - items: - type: string - title: promo_codes - description: The promo code's promo codes. diff --git a/www/apps/api-reference/specs/store/components/schemas/IBigNumber.yaml b/www/apps/api-reference/specs/store/components/schemas/IBigNumber.yaml new file mode 100644 index 0000000000..50cf33abe6 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/IBigNumber.yaml @@ -0,0 +1,3 @@ +type: object +description: The shipping method's discount tax total. +x-schemaName: IBigNumber diff --git a/www/apps/api-reference/specs/store/components/schemas/InventoryLevel.yaml b/www/apps/api-reference/specs/store/components/schemas/InventoryLevel.yaml new file mode 100644 index 0000000000..ff883a1a28 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/InventoryLevel.yaml @@ -0,0 +1,43 @@ +type: object +description: The inventory level's inventory levels. +x-schemaName: InventoryLevel +required: + - id + - inventory_item_id + - location_id + - stocked_quantity + - reserved_quantity + - available_quantity + - incoming_quantity +properties: + id: + type: string + title: id + description: The inventory level's ID. + inventory_item_id: + type: string + title: inventory_item_id + description: The inventory level's inventory item id. + location_id: + type: string + title: location_id + description: The inventory level's location id. + stocked_quantity: + type: number + title: stocked_quantity + description: The inventory level's stocked quantity. + reserved_quantity: + type: number + title: reserved_quantity + description: The inventory level's reserved quantity. + available_quantity: + type: number + title: available_quantity + description: The inventory level's available quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The inventory level's incoming quantity. + metadata: + type: object + description: The inventory level's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/Order.yaml b/www/apps/api-reference/specs/store/components/schemas/Order.yaml new file mode 100644 index 0000000000..f138b6e974 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/Order.yaml @@ -0,0 +1,936 @@ +type: object +description: The exchange's order preview. +x-schemaName: Order +required: + - id + - version + - status + - currency_code + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total + - raw_original_item_total + - raw_original_item_subtotal + - raw_original_item_tax_total + - raw_item_total + - raw_item_subtotal + - raw_item_tax_total + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + - raw_gift_card_total + - raw_gift_card_tax_total + - raw_shipping_total + - raw_shipping_subtotal + - raw_shipping_tax_total + - raw_original_shipping_total + - raw_original_shipping_subtotal + - raw_original_shipping_tax_total +properties: + id: + type: string + title: id + description: The order preview's ID. + version: + type: number + title: version + description: The order preview's version. + order_change: + $ref: ./OrderChange.yaml + status: + type: string + enum: + - canceled + - requires_action + - pending + - completed + - draft + - archived + region_id: + type: string + title: region_id + description: The order preview's region id. + customer_id: + type: string + title: customer_id + description: The order preview's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order preview's sales channel id. + email: + type: string + title: email + description: The order preview's email. + format: email + currency_code: + type: string + title: currency_code + description: The order preview's currency code. + shipping_address: + $ref: ./OrderAddress.yaml + billing_address: + $ref: ./OrderAddress.yaml + items: + type: array + description: The order preview's items. + items: + $ref: ./OrderLineItem.yaml + shipping_methods: + type: array + description: The order preview's shipping methods. + items: + $ref: ./OrderShippingMethod.yaml + transactions: + type: array + description: The order preview's transactions. + items: + $ref: ./OrderTransaction.yaml + summary: + type: object + description: The order preview's summary. + required: + - total + - subtotal + - total_tax + - ordered_total + - fulfilled_total + - returned_total + - return_request_total + - write_off_total + - projected_total + - net_total + - net_subtotal + - net_total_tax + - balance + - paid_total + - refunded_total + properties: + total: + oneOf: + - type: string + title: total + description: The summary's total. + - type: number + title: total + description: The summary's total. + - type: string + title: total + description: The summary's total. + - type: object + description: The summary's total. + x-schemaName: IBigNumber + subtotal: + oneOf: + - type: string + title: subtotal + description: The summary's subtotal. + - type: number + title: subtotal + description: The summary's subtotal. + - type: string + title: subtotal + description: The summary's subtotal. + - type: object + description: The summary's subtotal. + x-schemaName: IBigNumber + total_tax: + oneOf: + - type: string + title: total_tax + description: The summary's total tax. + - type: number + title: total_tax + description: The summary's total tax. + - type: string + title: total_tax + description: The summary's total tax. + - type: object + description: The summary's total tax. + x-schemaName: IBigNumber + ordered_total: + oneOf: + - type: string + title: ordered_total + description: The summary's ordered total. + - type: number + title: ordered_total + description: The summary's ordered total. + - type: string + title: ordered_total + description: The summary's ordered total. + - type: object + description: The summary's ordered total. + x-schemaName: IBigNumber + fulfilled_total: + oneOf: + - type: string + title: fulfilled_total + description: The summary's fulfilled total. + - type: number + title: fulfilled_total + description: The summary's fulfilled total. + - type: string + title: fulfilled_total + description: The summary's fulfilled total. + - type: object + description: The summary's fulfilled total. + x-schemaName: IBigNumber + returned_total: + oneOf: + - type: string + title: returned_total + description: The summary's returned total. + - type: number + title: returned_total + description: The summary's returned total. + - type: string + title: returned_total + description: The summary's returned total. + - type: object + description: The summary's returned total. + x-schemaName: IBigNumber + return_request_total: + oneOf: + - type: string + title: return_request_total + description: The summary's return request total. + - type: number + title: return_request_total + description: The summary's return request total. + - type: string + title: return_request_total + description: The summary's return request total. + - type: object + description: The summary's return request total. + x-schemaName: IBigNumber + write_off_total: + oneOf: + - type: string + title: write_off_total + description: The summary's write off total. + - type: number + title: write_off_total + description: The summary's write off total. + - type: string + title: write_off_total + description: The summary's write off total. + - type: object + description: The summary's write off total. + x-schemaName: IBigNumber + projected_total: + oneOf: + - type: string + title: projected_total + description: The summary's projected total. + - type: number + title: projected_total + description: The summary's projected total. + - type: string + title: projected_total + description: The summary's projected total. + - type: object + description: The summary's projected total. + x-schemaName: IBigNumber + net_total: + oneOf: + - type: string + title: net_total + description: The summary's net total. + - type: number + title: net_total + description: The summary's net total. + - type: string + title: net_total + description: The summary's net total. + - type: object + description: The summary's net total. + x-schemaName: IBigNumber + net_subtotal: + oneOf: + - type: string + title: net_subtotal + description: The summary's net subtotal. + - type: number + title: net_subtotal + description: The summary's net subtotal. + - type: string + title: net_subtotal + description: The summary's net subtotal. + - type: object + description: The summary's net subtotal. + x-schemaName: IBigNumber + net_total_tax: + oneOf: + - type: string + title: net_total_tax + description: The summary's net total tax. + - type: number + title: net_total_tax + description: The summary's net total tax. + - type: string + title: net_total_tax + description: The summary's net total tax. + - type: object + description: The summary's net total tax. + x-schemaName: IBigNumber + balance: + oneOf: + - type: string + title: balance + description: The summary's balance. + - type: number + title: balance + description: The summary's balance. + - type: string + title: balance + description: The summary's balance. + - type: object + description: The summary's balance. + x-schemaName: IBigNumber + paid_total: + oneOf: + - type: string + title: paid_total + description: The summary's paid total. + - type: number + title: paid_total + description: The summary's paid total. + - type: string + title: paid_total + description: The summary's paid total. + - type: object + description: The summary's paid total. + x-schemaName: IBigNumber + refunded_total: + oneOf: + - type: string + title: refunded_total + description: The summary's refunded total. + - type: number + title: refunded_total + description: The summary's refunded total. + - type: string + title: refunded_total + description: The summary's refunded total. + - type: object + description: The summary's refunded total. + x-schemaName: IBigNumber + metadata: + type: object + description: The order preview's metadata. + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order preview's canceled at. + - type: string + title: canceled_at + description: The order preview's canceled at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The order preview's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order preview's updated at. + original_item_total: + oneOf: + - type: string + title: original_item_total + description: The order preview's original item total. + - type: number + title: original_item_total + description: The order preview's original item total. + - type: string + title: original_item_total + description: The order preview's original item total. + - $ref: ./IBigNumber.yaml + original_item_subtotal: + oneOf: + - type: string + title: original_item_subtotal + description: The order preview's original item subtotal. + - type: number + title: original_item_subtotal + description: The order preview's original item subtotal. + - type: string + title: original_item_subtotal + description: The order preview's original item subtotal. + - $ref: ./IBigNumber.yaml + original_item_tax_total: + oneOf: + - type: string + title: original_item_tax_total + description: The order preview's original item tax total. + - type: number + title: original_item_tax_total + description: The order preview's original item tax total. + - type: string + title: original_item_tax_total + description: The order preview's original item tax total. + - $ref: ./IBigNumber.yaml + item_total: + oneOf: + - type: string + title: item_total + description: The order preview's item total. + - type: number + title: item_total + description: The order preview's item total. + - type: string + title: item_total + description: The order preview's item total. + - $ref: ./IBigNumber.yaml + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The order preview's item subtotal. + - type: number + title: item_subtotal + description: The order preview's item subtotal. + - type: string + title: item_subtotal + description: The order preview's item subtotal. + - $ref: ./IBigNumber.yaml + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The order preview's item tax total. + - type: number + title: item_tax_total + description: The order preview's item tax total. + - type: string + title: item_tax_total + description: The order preview's item tax total. + - $ref: ./IBigNumber.yaml + original_total: + oneOf: + - type: string + title: original_total + description: The order preview's original total. + - type: number + title: original_total + description: The order preview's original total. + - type: string + title: original_total + description: The order preview's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The order preview's original subtotal. + - type: number + title: original_subtotal + description: The order preview's original subtotal. + - type: string + title: original_subtotal + description: The order preview's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The order preview's original tax total. + - type: number + title: original_tax_total + description: The order preview's original tax total. + - type: string + title: original_tax_total + description: The order preview's original tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The order preview's total. + - type: number + title: total + description: The order preview's total. + - type: string + title: total + description: The order preview's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The order preview's subtotal. + - type: number + title: subtotal + description: The order preview's subtotal. + - type: string + title: subtotal + description: The order preview's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The order preview's tax total. + - type: number + title: tax_total + description: The order preview's tax total. + - type: string + title: tax_total + description: The order preview's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The order preview's discount total. + - type: number + title: discount_total + description: The order preview's discount total. + - type: string + title: discount_total + description: The order preview's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The order preview's discount tax total. + - type: number + title: discount_tax_total + description: The order preview's discount tax total. + - type: string + title: discount_tax_total + description: The order preview's discount tax total. + - $ref: ./IBigNumber.yaml + gift_card_total: + oneOf: + - type: string + title: gift_card_total + description: The order preview's gift card total. + - type: number + title: gift_card_total + description: The order preview's gift card total. + - type: string + title: gift_card_total + description: The order preview's gift card total. + - $ref: ./IBigNumber.yaml + gift_card_tax_total: + oneOf: + - type: string + title: gift_card_tax_total + description: The order preview's gift card tax total. + - type: number + title: gift_card_tax_total + description: The order preview's gift card tax total. + - type: string + title: gift_card_tax_total + description: The order preview's gift card tax total. + - $ref: ./IBigNumber.yaml + shipping_total: + oneOf: + - type: string + title: shipping_total + description: The order preview's shipping total. + - type: number + title: shipping_total + description: The order preview's shipping total. + - type: string + title: shipping_total + description: The order preview's shipping total. + - $ref: ./IBigNumber.yaml + shipping_subtotal: + oneOf: + - type: string + title: shipping_subtotal + description: The order preview's shipping subtotal. + - type: number + title: shipping_subtotal + description: The order preview's shipping subtotal. + - type: string + title: shipping_subtotal + description: The order preview's shipping subtotal. + - $ref: ./IBigNumber.yaml + shipping_tax_total: + oneOf: + - type: string + title: shipping_tax_total + description: The order preview's shipping tax total. + - type: number + title: shipping_tax_total + description: The order preview's shipping tax total. + - type: string + title: shipping_tax_total + description: The order preview's shipping tax total. + - $ref: ./IBigNumber.yaml + original_shipping_total: + oneOf: + - type: string + title: original_shipping_total + description: The order preview's original shipping total. + - type: number + title: original_shipping_total + description: The order preview's original shipping total. + - type: string + title: original_shipping_total + description: The order preview's original shipping total. + - $ref: ./IBigNumber.yaml + original_shipping_subtotal: + oneOf: + - type: string + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - type: number + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - type: string + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - $ref: ./IBigNumber.yaml + original_shipping_tax_total: + oneOf: + - type: string + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - type: number + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - type: string + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - $ref: ./IBigNumber.yaml + raw_original_item_total: + type: object + description: The order preview's raw original item total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item total's value. + - type: number + title: value + description: The raw original item total's value. + raw_original_item_subtotal: + type: object + description: The order preview's raw original item subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item subtotal's value. + - type: number + title: value + description: The raw original item subtotal's value. + raw_original_item_tax_total: + type: object + description: The order preview's raw original item tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item tax total's value. + - type: number + title: value + description: The raw original item tax total's value. + raw_item_total: + type: object + description: The order preview's raw item total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item total's value. + - type: number + title: value + description: The raw item total's value. + raw_item_subtotal: + type: object + description: The order preview's raw item subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item subtotal's value. + - type: number + title: value + description: The raw item subtotal's value. + raw_item_tax_total: + type: object + description: The order preview's raw item tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item tax total's value. + - type: number + title: value + description: The raw item tax total's value. + raw_original_total: + type: object + description: The order preview's raw original total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original total's value. + - type: number + title: value + description: The raw original total's value. + raw_original_subtotal: + type: object + description: The order preview's raw original subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original subtotal's value. + - type: number + title: value + description: The raw original subtotal's value. + raw_original_tax_total: + type: object + description: The order preview's raw original tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original tax total's value. + - type: number + title: value + description: The raw original tax total's value. + raw_total: + type: object + description: The order preview's raw total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw total's value. + - type: number + title: value + description: The raw total's value. + raw_subtotal: + type: object + description: The order preview's raw subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw subtotal's value. + - type: number + title: value + description: The raw subtotal's value. + raw_tax_total: + type: object + description: The order preview's raw tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw tax total's value. + - type: number + title: value + description: The raw tax total's value. + raw_discount_total: + type: object + description: The order preview's raw discount total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw discount total's value. + - type: number + title: value + description: The raw discount total's value. + raw_discount_tax_total: + type: object + description: The order preview's raw discount tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw discount tax total's value. + - type: number + title: value + description: The raw discount tax total's value. + raw_gift_card_total: + type: object + description: The order preview's raw gift card total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw gift card total's value. + - type: number + title: value + description: The raw gift card total's value. + raw_gift_card_tax_total: + type: object + description: The order preview's raw gift card tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw gift card tax total's value. + - type: number + title: value + description: The raw gift card tax total's value. + raw_shipping_total: + type: object + description: The order preview's raw shipping total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping total's value. + - type: number + title: value + description: The raw shipping total's value. + raw_shipping_subtotal: + type: object + description: The order preview's raw shipping subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping subtotal's value. + - type: number + title: value + description: The raw shipping subtotal's value. + raw_shipping_tax_total: + type: object + description: The order preview's raw shipping tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping tax total's value. + - type: number + title: value + description: The raw shipping tax total's value. + raw_original_shipping_total: + type: object + description: The order preview's raw original shipping total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping total's value. + - type: number + title: value + description: The raw original shipping total's value. + raw_original_shipping_subtotal: + type: object + description: The order preview's raw original shipping subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping subtotal's value. + - type: number + title: value + description: The raw original shipping subtotal's value. + raw_original_shipping_tax_total: + type: object + description: The order preview's raw original shipping tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping tax total's value. + - type: number + title: value + description: The raw original shipping tax total's value. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderAddress.yaml new file mode 100644 index 0000000000..2006536055 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderAddress.yaml @@ -0,0 +1,69 @@ +type: object +description: The order preview's billing address. +x-schemaName: OrderAddress +required: + - id + - created_at + - updated_at +properties: + 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/OrderChange.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml new file mode 100644 index 0000000000..a414e29765 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml @@ -0,0 +1,146 @@ +type: object +description: The order preview's order change. +x-schemaName: OrderChange +required: + - id + - version + - order_id + - return_id + - exchange_id + - claim_id + - order + - return_order + - exchange + - claim + - actions + - status + - requested_by + - requested_at + - confirmed_by + - confirmed_at + - declined_by + - declined_reason + - metadata + - declined_at + - canceled_by + - canceled_at + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The order change's ID. + version: + type: number + title: version + description: The order change's version. + change_type: + type: string + enum: + - return + - exchange + - claim + - edit + order_id: + type: string + title: order_id + description: The order change's order id. + return_id: + type: string + title: return_id + description: The order change's return id. + exchange_id: + type: string + title: exchange_id + description: The order change's exchange id. + claim_id: + type: string + title: claim_id + description: The order change's claim id. + order: + type: object + return_order: + $ref: ./Return.yaml + exchange: + $ref: ./OrderExchange.yaml + claim: + $ref: ./OrderClaim.yaml + actions: + type: array + description: The order change's actions. + items: + $ref: ./OrderChangeAction.yaml + status: + type: string + title: status + description: The order change's status. + requested_by: + type: string + title: requested_by + description: The order change's requested by. + requested_at: + oneOf: + - type: string + title: requested_at + description: The order change's requested at. + - type: string + title: requested_at + description: The order change's requested at. + format: date-time + confirmed_by: + type: string + title: confirmed_by + description: The order change's confirmed by. + confirmed_at: + oneOf: + - type: string + title: confirmed_at + description: The order change's confirmed at. + - type: string + title: confirmed_at + description: The order change's confirmed at. + format: date-time + declined_by: + type: string + title: declined_by + description: The order change's declined by. + declined_reason: + type: string + title: declined_reason + description: The order change's declined reason. + metadata: + type: object + description: The order change's metadata. + declined_at: + oneOf: + - type: string + title: declined_at + description: The order change's declined at. + - type: string + title: declined_at + description: The order change's declined at. + format: date-time + canceled_by: + type: string + title: canceled_by + description: The order change's canceled by. + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order change's canceled at. + - type: string + title: canceled_at + description: The order change's canceled at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The order change's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order change's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderChangeAction.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderChangeAction.yaml new file mode 100644 index 0000000000..13a80ba767 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderChangeAction.yaml @@ -0,0 +1,3 @@ +type: object +description: The action's actions. +x-schemaName: OrderChangeAction diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderClaim.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderClaim.yaml new file mode 100644 index 0000000000..7d1a9d3366 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderClaim.yaml @@ -0,0 +1,3 @@ +type: object +description: The order change's claim. +x-schemaName: OrderClaim diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml new file mode 100644 index 0000000000..0c83b9bb1b --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml @@ -0,0 +1,3 @@ +type: object +description: The order change's exchange. +x-schemaName: OrderExchange diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderItem.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderItem.yaml new file mode 100644 index 0000000000..d7584d2fbe --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderItem.yaml @@ -0,0 +1,3 @@ +type: object +description: The item's detail. +x-schemaName: OrderItem diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml new file mode 100644 index 0000000000..971b9caf80 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml @@ -0,0 +1,359 @@ +type: object +description: The item's items. +x-schemaName: OrderLineItem +required: + - id + - title + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - raw_unit_price + - quantity + - raw_quantity + - detail + - created_at + - updated_at + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_item_total + - raw_item_subtotal + - raw_item_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + - raw_refundable_total + - raw_refundable_total_per_unit +properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant_id: + type: string + title: variant_id + description: The item's variant id. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + raw_compare_at_unit_price: + type: object + description: The item's raw compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + raw_unit_price: + type: object + description: The item's raw unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + raw_quantity: + type: object + description: The item's raw quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: ./OrderLineItemTaxLine.yaml + adjustments: + type: array + description: The item's adjustments. + items: + $ref: ./OrderLineItemAdjustment.yaml + detail: + $ref: ./OrderItem.yaml + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + metadata: + type: object + description: The item's metadata. + original_total: + oneOf: + - type: string + title: original_total + description: The item's original total. + - type: number + title: original_total + description: The item's original total. + - type: string + title: original_total + description: The item's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The item's original subtotal. + - type: number + title: original_subtotal + description: The item's original subtotal. + - type: string + title: original_subtotal + description: The item's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The item's original tax total. + - type: number + title: original_tax_total + description: The item's original tax total. + - type: string + title: original_tax_total + description: The item's original tax total. + - $ref: ./IBigNumber.yaml + item_total: + oneOf: + - type: string + title: item_total + description: The item's item total. + - type: number + title: item_total + description: The item's item total. + - type: string + title: item_total + description: The item's item total. + - $ref: ./IBigNumber.yaml + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The item's item subtotal. + - type: number + title: item_subtotal + description: The item's item subtotal. + - type: string + title: item_subtotal + description: The item's item subtotal. + - $ref: ./IBigNumber.yaml + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The item's item tax total. + - type: number + title: item_tax_total + description: The item's item tax total. + - type: string + title: item_tax_total + description: The item's item tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The item's total. + - type: number + title: total + description: The item's total. + - type: string + title: total + description: The item's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The item's subtotal. + - type: number + title: subtotal + description: The item's subtotal. + - type: string + title: subtotal + description: The item's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The item's tax total. + - type: number + title: tax_total + description: The item's tax total. + - type: string + title: tax_total + description: The item's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The item's discount total. + - type: number + title: discount_total + description: The item's discount total. + - type: string + title: discount_total + description: The item's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The item's discount tax total. + - type: number + title: discount_tax_total + description: The item's discount tax total. + - type: string + title: discount_tax_total + description: The item's discount tax total. + - $ref: ./IBigNumber.yaml + refundable_total: + oneOf: + - type: string + title: refundable_total + description: The item's refundable total. + - type: number + title: refundable_total + description: The item's refundable total. + - type: string + title: refundable_total + description: The item's refundable total. + - $ref: ./IBigNumber.yaml + refundable_total_per_unit: + oneOf: + - type: string + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: string + title: refundable_total_per_unit + description: The item's refundable total per unit. + - $ref: ./IBigNumber.yaml + raw_original_total: + type: object + description: The item's raw original total. + raw_original_subtotal: + type: object + description: The item's raw original subtotal. + raw_original_tax_total: + type: object + description: The item's raw original tax total. + raw_item_total: + type: object + description: The item's raw item total. + raw_item_subtotal: + type: object + description: The item's raw item subtotal. + raw_item_tax_total: + type: object + description: The item's raw item tax total. + raw_total: + type: object + description: The item's raw total. + raw_subtotal: + type: object + description: The item's raw subtotal. + raw_tax_total: + type: object + description: The item's raw tax total. + raw_discount_total: + type: object + description: The item's raw discount total. + raw_discount_tax_total: + type: object + description: The item's raw discount tax total. + raw_refundable_total: + type: object + description: The item's raw refundable total. + raw_refundable_total_per_unit: + type: object + description: The item's raw refundable total per unit. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderLineItemAdjustment.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderLineItemAdjustment.yaml new file mode 100644 index 0000000000..18f5e20824 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderLineItemAdjustment.yaml @@ -0,0 +1,3 @@ +type: object +description: The adjustment's adjustments. +x-schemaName: OrderLineItemAdjustment diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderLineItemTaxLine.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderLineItemTaxLine.yaml new file mode 100644 index 0000000000..0b002d0419 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderLineItemTaxLine.yaml @@ -0,0 +1,3 @@ +type: object +description: The tax line's tax lines. +x-schemaName: OrderLineItemTaxLine diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethod.yaml new file mode 100644 index 0000000000..27f2932fb3 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethod.yaml @@ -0,0 +1,214 @@ +type: object +description: The shipping method's shipping methods. +x-schemaName: OrderShippingMethod +required: + - id + - order_id + - name + - amount + - raw_amount + - is_tax_inclusive + - created_at + - updated_at + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total +properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + oneOf: + - type: string + title: amount + description: The shipping method's amount. + - type: number + title: amount + description: The shipping method's amount. + - type: string + title: amount + description: The shipping method's amount. + - $ref: ./IBigNumber.yaml + raw_amount: + type: object + description: The shipping method's raw amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: ./OrderShippingMethodTaxLine.yaml + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: ./OrderShippingMethodAdjustment.yaml + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: discount_tax_total + description: The shipping method's discount tax total. + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - $ref: ./IBigNumber.yaml + raw_original_total: + type: object + description: The shipping method's raw original total. + raw_original_subtotal: + type: object + description: The shipping method's raw original subtotal. + raw_original_tax_total: + type: object + description: The shipping method's raw original tax total. + raw_total: + type: object + description: The shipping method's raw total. + raw_subtotal: + type: object + description: The shipping method's raw subtotal. + raw_tax_total: + type: object + description: The shipping method's raw tax total. + raw_discount_total: + type: object + description: The shipping method's raw discount total. + raw_discount_tax_total: + type: object + description: The shipping method's raw discount tax total. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodAdjustment.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodAdjustment.yaml new file mode 100644 index 0000000000..a05be82f62 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodAdjustment.yaml @@ -0,0 +1,3 @@ +type: object +description: The adjustment's adjustments. +x-schemaName: OrderShippingMethodAdjustment diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodTaxLine.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodTaxLine.yaml new file mode 100644 index 0000000000..89976e41b4 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodTaxLine.yaml @@ -0,0 +1,3 @@ +type: object +description: The tax line's tax lines. +x-schemaName: OrderShippingMethodTaxLine diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderTransaction.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderTransaction.yaml new file mode 100644 index 0000000000..fe6226719f --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderTransaction.yaml @@ -0,0 +1,66 @@ +type: object +description: The transaction's transactions. +x-schemaName: OrderTransaction +required: + - id + - order_id + - order + - amount + - raw_amount + - currency_code + - reference + - reference_id + - created_at + - updated_at + - metadata +properties: + id: + type: string + title: id + description: The transaction's ID. + order_id: + type: string + title: order_id + description: The transaction's order id. + order: + type: object + amount: + oneOf: + - type: string + title: amount + description: The transaction's amount. + - type: number + title: amount + description: The transaction's amount. + - type: string + title: amount + description: The transaction's amount. + - $ref: ./IBigNumber.yaml + raw_amount: + type: object + description: The transaction's raw amount. + currency_code: + type: string + title: currency_code + description: The transaction's currency code. + reference: + type: string + title: reference + description: The transaction's reference. + reference_id: + type: string + title: reference_id + description: The transaction's reference id. + created_at: + type: string + format: date-time + title: created_at + description: The transaction's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The transaction's updated at. + metadata: + type: object + description: The transaction's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/RefundReasonResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/RefundReasonResponse.yaml new file mode 100644 index 0000000000..2ccee98673 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/RefundReasonResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: RefundReasonResponse +required: + - refund_reason +properties: + refund_reason: + $ref: ./AdminRefundReason.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/ReservationResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/ReservationResponse.yaml new file mode 100644 index 0000000000..d66cc74750 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/ReservationResponse.yaml @@ -0,0 +1,66 @@ +type: object +description: The reservation's details. +x-schemaName: ReservationResponse +required: + - id + - line_item_id + - location_id + - quantity + - external_id + - description + - inventory_item_id + - inventory_item +properties: + id: + type: string + title: id + description: The reservation's ID. + 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. + quantity: + type: string + title: quantity + description: The reservation's quantity. + external_id: + type: string + title: external_id + description: The reservation's external id. + description: + type: string + title: description + description: The reservation's description. + inventory_item_id: + type: string + title: inventory_item_id + description: The reservation's inventory item id. + inventory_item: + type: object + description: The reservation's inventory item. + metadata: + type: object + description: The reservation's metadata. + created_by: + type: string + title: created_by + description: The reservation's created by. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The reservation's deleted at. + created_at: + type: string + format: date-time + title: created_at + description: The reservation's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The reservation's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/Return.yaml b/www/apps/api-reference/specs/store/components/schemas/Return.yaml new file mode 100644 index 0000000000..529ada57ca --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/Return.yaml @@ -0,0 +1,3 @@ +type: object +description: The order change's return order. +x-schemaName: Return diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml new file mode 100644 index 0000000000..9974725fda --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml @@ -0,0 +1,349 @@ +type: object +description: The cart's details. +x-schemaName: StoreCart +required: + - id + - currency_code + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total +properties: + id: + type: string + title: id + description: The cart's ID. + region: + $ref: ./BaseRegion.yaml + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address: + $ref: ./BaseCartAddress.yaml + billing_address: + $ref: ./BaseCartAddress.yaml + items: + type: array + description: The cart's items. + items: + $ref: ./BaseCartLineItem.yaml + shipping_methods: + type: array + description: The cart's shipping methods. + items: + $ref: ./BaseCartShippingMethod.yaml + payment_collection: + $ref: ./BasePaymentCollection.yaml + metadata: + type: object + description: The cart's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The cart's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The cart's updated at. + original_item_total: + oneOf: + - type: string + title: original_item_total + description: The cart's original item total. + - type: number + title: original_item_total + description: The cart's original item total. + - type: string + title: original_item_total + description: The cart's original item total. + - $ref: ./IBigNumber.yaml + original_item_subtotal: + oneOf: + - type: string + title: original_item_subtotal + description: The cart's original item subtotal. + - type: number + title: original_item_subtotal + description: The cart's original item subtotal. + - type: string + title: original_item_subtotal + description: The cart'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. + - type: number + title: original_item_tax_total + description: The cart's original item tax total. + - type: string + title: original_item_tax_total + description: The cart's original item tax total. + - $ref: ./IBigNumber.yaml + item_total: + oneOf: + - type: string + title: item_total + description: The cart's item total. + - type: number + title: item_total + description: The cart's item total. + - type: string + title: item_total + description: The cart's item total. + - $ref: ./IBigNumber.yaml + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The cart's item subtotal. + - type: number + title: item_subtotal + description: The cart's item subtotal. + - type: string + title: item_subtotal + description: The cart's item subtotal. + - $ref: ./IBigNumber.yaml + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The cart's item tax total. + - type: number + title: item_tax_total + description: The cart's item tax total. + - type: string + title: item_tax_total + description: The cart's item tax total. + - $ref: ./IBigNumber.yaml + original_total: + oneOf: + - type: string + title: original_total + description: The cart's original total. + - type: number + title: original_total + description: The cart's original total. + - type: string + title: original_total + description: The cart's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The cart's original subtotal. + - type: number + title: original_subtotal + description: The cart's original subtotal. + - type: string + title: original_subtotal + description: The cart's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The cart's original tax total. + - type: number + title: original_tax_total + description: The cart's original tax total. + - type: string + title: original_tax_total + description: The cart's original tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The cart's total. + - type: number + title: total + description: The cart's total. + - type: string + title: total + description: The cart's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The cart's subtotal. + - type: number + title: subtotal + description: The cart's subtotal. + - type: string + title: subtotal + description: The cart's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The cart's tax total. + - type: number + title: tax_total + description: The cart's tax total. + - type: string + title: tax_total + description: The cart's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The cart's discount total. + - type: number + title: discount_total + description: The cart's discount total. + - type: string + title: discount_total + description: The cart's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The cart's discount tax total. + - type: number + title: discount_tax_total + description: The cart's discount tax total. + - type: string + title: discount_tax_total + description: The cart's discount tax total. + - $ref: ./IBigNumber.yaml + gift_card_total: + oneOf: + - type: string + title: gift_card_total + description: The cart's gift card total. + - type: number + title: gift_card_total + description: The cart's gift card total. + - type: string + title: gift_card_total + description: The cart'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. + - type: number + title: gift_card_tax_total + description: The cart's gift card tax total. + - type: string + title: gift_card_tax_total + description: The cart's gift card tax total. + - $ref: ./IBigNumber.yaml + shipping_total: + oneOf: + - type: string + title: shipping_total + description: The cart's shipping total. + - type: number + title: shipping_total + description: The cart's shipping total. + - type: string + title: shipping_total + description: The cart's shipping total. + - $ref: ./IBigNumber.yaml + shipping_subtotal: + oneOf: + - type: string + title: shipping_subtotal + description: The cart's shipping subtotal. + - type: number + title: shipping_subtotal + description: The cart's shipping subtotal. + - type: string + title: shipping_subtotal + description: The cart's shipping subtotal. + - $ref: ./IBigNumber.yaml + shipping_tax_total: + oneOf: + - type: string + title: shipping_tax_total + description: The cart's shipping tax total. + - type: number + title: shipping_tax_total + description: The cart's shipping tax total. + - type: string + title: shipping_tax_total + description: The cart's shipping tax total. + - $ref: ./IBigNumber.yaml + original_shipping_total: + oneOf: + - type: string + title: original_shipping_total + description: The cart's original shipping total. + - type: number + title: original_shipping_total + description: The cart's original shipping total. + - type: string + title: original_shipping_total + description: The cart's original shipping total. + - $ref: ./IBigNumber.yaml + original_shipping_subtotal: + oneOf: + - type: string + title: original_shipping_subtotal + description: The cart's original shipping subtotal. + - type: number + title: original_shipping_subtotal + description: The cart's original shipping subtotal. + - type: string + title: original_shipping_subtotal + description: The cart'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. + - type: number + title: original_shipping_tax_total + description: The cart's original shipping tax total. + - type: string + title: original_shipping_tax_total + description: The cart's original shipping tax total. + - $ref: ./IBigNumber.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCartResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCartResponse.yaml new file mode 100644 index 0000000000..2bfa43f956 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCartResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreCartResponse +required: + - cart +properties: + cart: + $ref: ./StoreCart.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCollection.yaml new file mode 100644 index 0000000000..a336103bb6 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCollection.yaml @@ -0,0 +1,47 @@ +type: object +description: The collection's details. +x-schemaName: StoreCollection +required: + - id + - title + - handle + - created_at + - updated_at + - deleted_at + - metadata +properties: + id: + type: string + title: id + description: The collection's ID. + title: + type: string + title: title + description: The collection's title. + handle: + type: string + title: handle + description: The collection's handle. + created_at: + type: string + format: date-time + title: created_at + description: The collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The collection's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The collection's deleted at. + products: + type: array + description: The collection's products. + items: + $ref: ./AdminProduct.yaml + metadata: + type: object + description: The collection's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCollectionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCollectionResponse.yaml new file mode 100644 index 0000000000..ad095a583e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCollectionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreCollectionResponse +required: + - collection +properties: + collection: + $ref: ./StoreCollection.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCurrency.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCurrency.yaml new file mode 100644 index 0000000000..05eec9f84d --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCurrency.yaml @@ -0,0 +1,69 @@ +type: object +description: The currency's details. +x-schemaName: StoreCurrency +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/apps/api-reference/specs/store/components/schemas/StoreCurrencyListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCurrencyListResponse.yaml new file mode 100644 index 0000000000..cb51836b4b --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCurrencyListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: StoreCurrencyListResponse +required: + - limit + - offset + - count + - currencies +properties: + limit: + type: number + title: limit + description: The currency's limit. + offset: + type: number + title: offset + description: The currency's offset. + count: + type: number + title: count + description: The currency's count. + currencies: + type: array + description: The currency's currencies. + items: + $ref: ./StoreCurrency.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCurrencyResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCurrencyResponse.yaml new file mode 100644 index 0000000000..18fffcdeeb --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCurrencyResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreCurrencyResponse +required: + - currency +properties: + currency: + $ref: ./StoreCurrency.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomer.yaml new file mode 100644 index 0000000000..bbb8caf8e9 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCustomer.yaml @@ -0,0 +1,73 @@ +type: object +description: The customer's details. +x-schemaName: StoreCustomer +required: + - id + - email + - default_billing_address_id + - default_shipping_address_id + - company_name + - first_name + - last_name + - addresses +properties: + id: + type: string + title: id + description: The customer's ID. + email: + type: string + title: email + description: The customer's email. + format: email + default_billing_address_id: + type: string + title: default_billing_address_id + description: The customer's default billing address id. + default_shipping_address_id: + type: string + title: default_shipping_address_id + description: The customer's default shipping address id. + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + addresses: + type: array + description: The customer's addresses. + items: + $ref: ./BaseCustomerAddress.yaml + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + created_by: + type: string + title: created_by + description: The customer's created by. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The customer's deleted at. + created_at: + type: string + format: date-time + title: created_at + description: The customer's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The customer's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddress.yaml new file mode 100644 index 0000000000..8bc8942adb --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddress.yaml @@ -0,0 +1,96 @@ +type: object +description: The customer's address. +x-schemaName: StoreCustomerAddress +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/StoreCustomerAddressListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddressListResponse.yaml new file mode 100644 index 0000000000..ae6cf1559e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddressListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: StoreCustomerAddressListResponse +required: + - limit + - offset + - count + - addresses +properties: + limit: + type: number + title: limit + description: The customer's limit. + offset: + type: number + title: offset + description: The customer's offset. + count: + type: number + title: count + description: The customer's count. + addresses: + type: array + description: The customer's addresses. + items: + $ref: ./StoreCustomerAddress.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddressResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddressResponse.yaml new file mode 100644 index 0000000000..a665e19eb1 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddressResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreCustomerAddressResponse +required: + - address +properties: + address: + $ref: ./StoreCustomerAddress.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomerResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerResponse.yaml new file mode 100644 index 0000000000..c121ca1d70 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreCustomerResponse +required: + - customer +properties: + customer: + $ref: ./StoreCustomer.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml new file mode 100644 index 0000000000..38c9d30978 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml @@ -0,0 +1,231 @@ +type: object +description: The cart's order. +x-schemaName: StoreOrder +required: + - id + - version + - region_id + - customer_id + - sales_channel_id + - email + - currency_code + - items + - shipping_methods + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total +properties: + id: + type: string + title: id + description: The order's ID. + version: + type: number + title: version + description: The order's version. + region_id: + type: string + title: region_id + description: The order's region id. + customer_id: + type: string + title: customer_id + description: The order's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order's sales channel id. + email: + type: string + title: email + description: The order's email. + format: email + currency_code: + type: string + title: currency_code + description: The order's currency code. + display_id: + type: string + 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. + items: + $ref: ./BaseOrderLineItem.yaml + shipping_methods: + type: array + description: The order's shipping methods. + items: + $ref: ./BaseOrderShippingMethod.yaml + payment_collections: + type: array + description: The order's payment collections. + items: + $ref: ./BasePaymentCollection.yaml + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The order's fulfillments. + items: + $ref: ./BaseOrderFulfillment.yaml + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The order's transactions. + items: + $ref: ./BaseOrderTransaction.yaml + summary: + $ref: ./BaseOrderSummary.yaml + metadata: + type: object + description: The order's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The order's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order's updated at. + original_item_total: + type: number + title: original_item_total + description: The order's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The order's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The order's original item tax total. + item_total: + type: number + title: item_total + description: The order's item total. + item_subtotal: + type: number + title: item_subtotal + description: The order's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The order's item tax total. + original_total: + type: number + title: original_total + description: The order's original total. + original_subtotal: + type: number + title: original_subtotal + description: The order's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The order's original tax total. + total: + type: number + title: total + description: The order's total. + subtotal: + type: number + title: subtotal + description: The order's subtotal. + tax_total: + type: number + title: tax_total + description: The order's tax total. + discount_total: + type: number + title: discount_total + description: The order's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The order's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The order's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The order's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The order's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The order's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The order's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The order's original shipping tax total. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrderResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrderResponse.yaml new file mode 100644 index 0000000000..c0ce372244 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrderResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreOrderResponse +required: + - order +properties: + order: + $ref: ./StoreOrder.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollection.yaml new file mode 100644 index 0000000000..d19be961a8 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollection.yaml @@ -0,0 +1,116 @@ +type: object +description: The payment collection's details. +x-schemaName: StorePaymentCollection +required: + - id + - currency_code + - region_id + - amount + - status + - payment_providers +properties: + id: + type: string + title: id + description: The payment collection's ID. + currency_code: + type: string + title: currency_code + description: The payment collection's currency code. + region_id: + type: string + title: region_id + description: The payment collection's region id. + amount: + oneOf: + - type: string + title: amount + description: The payment collection's amount. + - type: number + title: amount + description: The payment collection's amount. + - type: string + title: amount + description: The payment collection's amount. + - $ref: ./IBigNumber.yaml + authorized_amount: + oneOf: + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - type: number + title: authorized_amount + description: The payment collection's authorized amount. + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - $ref: ./IBigNumber.yaml + captured_amount: + oneOf: + - type: string + title: captured_amount + description: The payment collection's captured amount. + - type: number + title: captured_amount + description: The payment collection's captured amount. + - type: string + title: captured_amount + description: The payment collection's captured amount. + - $ref: ./IBigNumber.yaml + refunded_amount: + oneOf: + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - type: number + title: refunded_amount + description: The payment collection's refunded amount. + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - $ref: ./IBigNumber.yaml + completed_at: + oneOf: + - type: string + title: completed_at + description: The payment collection's completed at. + - type: string + title: completed_at + description: The payment collection's completed at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The payment collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The payment collection's updated at. + metadata: + type: object + description: The payment collection's metadata. + status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + payment_providers: + type: array + description: The payment collection's payment providers. + items: + $ref: ./BasePaymentProvider.yaml + payment_sessions: + type: array + description: The payment collection's payment sessions. + items: + $ref: ./BasePaymentSession.yaml + payments: + type: array + description: The payment collection's payments. + items: + $ref: ./BasePayment.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionResponse.yaml new file mode 100644 index 0000000000..3f4dd244b0 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StorePaymentCollectionResponse +required: + - payment_collection +properties: + payment_collection: + $ref: ./StorePaymentCollection.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePaymentProvider.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePaymentProvider.yaml new file mode 100644 index 0000000000..70de4c3efc --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StorePaymentProvider.yaml @@ -0,0 +1,10 @@ +type: object +description: The payment provider's payment providers. +x-schemaName: StorePaymentProvider +required: + - id +properties: + id: + type: string + title: id + description: The payment provider's 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 79fac333e5..8f607cc98a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml @@ -1,5 +1,5 @@ type: object -description: The product's products. +description: The product's details. x-schemaName: StoreProduct required: - title @@ -8,26 +8,26 @@ required: - options - description - id - - handle - - hs_code - - weight - - height - - width - - origin_country - - mid_code - - material - - thumbnail - created_at - updated_at - - deleted_at - variants + - handle - subtitle - is_giftcard + - thumbnail + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material - collection_id - type_id - images - discountable - external_id + - deleted_at properties: categories: type: array @@ -67,42 +67,6 @@ properties: metadata: type: object description: The product's metadata. - handle: - type: string - title: handle - description: The product's handle. - hs_code: - type: string - title: hs_code - description: The product's hs code. - weight: - type: number - title: weight - description: The product's weight. - height: - type: number - title: height - description: The product's height. - width: - type: number - title: width - description: The product's width. - origin_country: - type: string - title: origin_country - description: The product's origin country. - mid_code: - type: string - title: mid_code - description: The product's mid code. - material: - type: string - title: material - description: The product's material. - thumbnail: - type: string - title: thumbnail - description: The product's thumbnail. created_at: type: string format: date-time @@ -113,16 +77,15 @@ properties: format: date-time title: updated_at description: The product's updated at. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The product's deleted at. variants: type: array description: The product's variants. items: $ref: ./BaseProductVariant.yaml + handle: + type: string + title: handle + description: The product's handle. subtitle: type: string title: subtitle @@ -131,6 +94,38 @@ properties: type: boolean title: is_giftcard description: The product's is giftcard. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. collection: $ref: ./BaseCollection.yaml collection_id: @@ -159,3 +154,8 @@ properties: type: string title: external_id description: The product's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductCategory.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductCategory.yaml index 5f98dcd652..6614848161 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductCategory.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductCategory.yaml @@ -1,5 +1,5 @@ type: object -description: The product category's details. +description: The category's categories. x-schemaName: StoreProductCategory required: - id @@ -18,60 +18,60 @@ required: properties: products: type: array - description: The product category's products. + description: The category's products. items: $ref: ./StoreProduct.yaml id: type: string title: id - description: The product category's ID. + description: The category's ID. name: type: string title: name - description: The product category's name. + description: The category's name. description: type: string title: description - description: The product category's description. + description: The category's description. handle: type: string title: handle - description: The product category's handle. + description: The category's handle. is_active: type: boolean title: is_active - description: The product category's is active. + description: The category's is active. is_internal: type: boolean title: is_internal - description: The product category's is internal. + description: The category's is internal. rank: type: number title: rank - description: The product category's rank. + description: The category's rank. parent_category_id: type: string title: parent_category_id - description: The product category's parent category id. + description: The category's parent category id. parent_category: $ref: ./BaseProductCategory.yaml category_children: type: array - description: The product category's category children. + description: The category's category children. items: $ref: ./BaseProductCategory.yaml created_at: type: string format: date-time title: created_at - description: The product category's created at. + description: The category's created at. updated_at: type: string format: date-time title: updated_at - description: The product category's updated at. + description: The category's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The product category's deleted at. + description: The category's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductResponse.yaml new file mode 100644 index 0000000000..ac22f2a56f --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreProductResponse +required: + - product +properties: + product: + $ref: ./StoreProduct.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreRegion.yaml new file mode 100644 index 0000000000..d07d5098a6 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreRegion.yaml @@ -0,0 +1,47 @@ +type: object +description: The region's details. +x-schemaName: StoreRegion +required: + - id + - name + - currency_code +properties: + id: + type: string + title: id + description: The region's ID. + name: + type: string + title: name + description: The region's name. + currency_code: + type: string + title: currency_code + description: The region's currency code. + automatic_taxes: + type: boolean + title: automatic_taxes + description: The region's automatic taxes. + countries: + type: array + description: The region's countries. + items: + $ref: ./BaseRegionCountry.yaml + payment_providers: + type: array + description: The region's payment providers. + items: + $ref: ./AdminPaymentProvider.yaml + metadata: + type: object + description: The region's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The region's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The region's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturn.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturn.yaml new file mode 100644 index 0000000000..a707c05720 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreReturn.yaml @@ -0,0 +1,66 @@ +type: object +description: The return's details. +x-schemaName: StoreReturn +required: + - id + - order_id + - order_version + - display_id + - items + - received_at + - created_at +properties: + id: + type: string + title: id + description: The return's ID. + order_id: + type: string + title: order_id + description: The return's order id. + status: + type: string + title: status + description: The return's status. + exchange_id: + type: string + title: exchange_id + description: The return's exchange id. + location_id: + type: string + title: location_id + description: The return's location id. + claim_id: + type: string + title: claim_id + description: The return's claim id. + order_version: + type: number + title: order_version + description: The return's order version. + display_id: + type: number + title: display_id + description: The return's display id. + no_notification: + type: boolean + title: no_notification + description: The return's no notification. + refund_amount: + type: number + title: refund_amount + description: The return's refund amount. + items: + type: array + description: The return's items. + items: + $ref: ./BaseReturnItem.yaml + received_at: + type: string + title: received_at + description: The return's received at. + created_at: + type: string + format: date-time + title: created_at + description: The return's created at. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturnReason.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturnReason.yaml new file mode 100644 index 0000000000..0b2be3c0f3 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreReturnReason.yaml @@ -0,0 +1,39 @@ +type: object +description: The return reason's details. +x-schemaName: StoreReturnReason +required: + - id + - value + - label + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The return reason's ID. + value: + type: string + title: value + description: The return reason's value. + label: + type: string + title: label + description: The return reason's label. + description: + type: string + title: description + description: The return reason's description. + metadata: + type: object + description: The return reason's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The return reason's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The return reason's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonResponse.yaml new file mode 100644 index 0000000000..19edb6a521 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreReturnReasonResponse +required: + - return_reason +properties: + return_reason: + $ref: ./StoreReturnReason.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturnResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturnResponse.yaml new file mode 100644 index 0000000000..bac8524459 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreReturnResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreReturnResponse +required: + - return +properties: + return: + $ref: ./StoreReturn.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreShippingOption.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOption.yaml new file mode 100644 index 0000000000..4d8cc26173 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOption.yaml @@ -0,0 +1,65 @@ +type: object +description: The shipping option's shipping options. +x-schemaName: StoreShippingOption +required: + - id + - name + - price_type + - service_zone_id + - provider_id + - provider + - shipping_option_type_id + - type + - shipping_profile_id + - amount + - is_tax_inclusive + - data + - metadata +properties: + id: + type: string + title: id + description: The shipping option's ID. + name: + type: string + title: name + description: The shipping option's name. + price_type: + type: string + enum: + - flat + - calculated + service_zone_id: + type: string + title: service_zone_id + description: The shipping option's service zone id. + provider_id: + type: string + title: provider_id + description: The shipping option's provider id. + provider: + $ref: ./BaseFulfillmentProvider.yaml + shipping_option_type_id: + type: string + title: shipping_option_type_id + description: The shipping option's shipping option type id. + type: + type: object + shipping_profile_id: + type: string + title: shipping_profile_id + description: The shipping option's shipping profile id. + amount: + type: number + title: amount + description: The shipping option's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping option's is tax inclusive. + data: + type: object + description: The shipping option's data. + metadata: + type: object + description: The shipping option's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionListResponse.yaml new file mode 100644 index 0000000000..8001c7a8c5 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionListResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: StoreShippingOptionListResponse +required: + - shipping_options +properties: + shipping_options: + type: array + description: The shipping option's shipping options. + items: + $ref: ./StoreShippingOption.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml deleted file mode 100644 index 0b29d94268..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml +++ /dev/null @@ -1,44 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: UpdateCartData -properties: - region_id: - type: string - title: region_id - description: The cart's region id. - customer_id: - type: string - title: customer_id - description: The cart's customer id. - sales_channel_id: - type: string - title: sales_channel_id - description: The cart's sales channel id. - email: - type: string - title: email - description: The cart's email. - format: email - currency_code: - type: string - title: currency_code - description: The cart's currency code. - shipping_address_id: - type: string - title: shipping_address_id - description: The cart's shipping address id. - billing_address_id: - type: string - title: billing_address_id - description: The cart's billing address id. - billing_address: - oneOf: - - $ref: ./CreateAddress.yaml - - $ref: ./UpdateAddress.yaml - shipping_address: - oneOf: - - $ref: ./CreateAddress.yaml - - $ref: ./UpdateAddress.yaml - metadata: - type: object - description: The cart's metadata. diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index f4741db88d..ae876bb05e 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -16,14 +16,28 @@ tags: externalDocs: description: How to implement cart functionality in your storefront url: https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart + x-associatedSchema: + $ref: '#/components/schemas/StoreCart' - name: Collections + x-associatedSchema: + $ref: '#/components/schemas/StoreCollection' - name: Currencies + x-associatedSchema: + $ref: '#/components/schemas/StoreCurrency' - name: Customers + x-associatedSchema: + $ref: '#/components/schemas/StoreCustomer' - name: Orders + x-associatedSchema: + $ref: '#/components/schemas/StoreOrder' - name: Payment Collections description: | A payment collection is useful for managing additional payments, such as for Order Edits, or installment payments. + x-associatedSchema: + $ref: '#/components/schemas/StorePaymentCollection' - name: Payment Providers + x-associatedSchema: + $ref: '#/components/schemas/StorePaymentProvider' - name: Product Categories x-associatedSchema: $ref: '#/components/schemas/StoreProductCategory' @@ -37,9 +51,17 @@ tags: externalDocs: description: How to use regions in a storefront url: https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions + x-associatedSchema: + $ref: '#/components/schemas/StoreRegion' - name: Return + x-associatedSchema: + $ref: '#/components/schemas/StoreReturn' - name: Return Reasons + x-associatedSchema: + $ref: '#/components/schemas/StoreReturnReason' - name: Shipping Options + x-associatedSchema: + $ref: '#/components/schemas/StoreShippingOption' paths: /store/carts: post: @@ -92,7 +114,64 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateCartWorkflowInput' + description: SUMMARY + properties: + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address_id: + type: string + title: shipping_address_id + description: The cart's shipping address id. + billing_address_id: + type: string + title: billing_address_id + description: The cart's billing address id. + shipping_address: + oneOf: + - type: string + title: shipping_address + description: The cart's shipping address. + - $ref: '#/components/schemas/CreateCartAddress' + billing_address: + oneOf: + - type: string + title: billing_address + description: The cart's billing address. + - $ref: '#/components/schemas/CreateCartAddress' + metadata: + type: object + description: The cart's metadata. + items: + type: array + description: The cart's items. + items: + $ref: '#/components/schemas/CreateCartCreateLineItem' + promo_codes: + type: array + description: The cart's promo codes. + items: + type: string + title: promo_codes + description: The promo code's promo codes. x-codeSamples: - lang: Shell label: cURL @@ -100,6 +179,12 @@ paths: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCartResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -112,6 +197,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createCartWorkflow /store/carts/{id}: get: operationId: GetCartsId @@ -172,6 +258,12 @@ paths: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCartResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -240,7 +332,48 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateCartData' + description: SUMMARY + properties: + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address_id: + type: string + title: shipping_address_id + description: The cart's shipping address id. + billing_address_id: + type: string + title: billing_address_id + description: The cart's billing address id. + billing_address: + oneOf: + - $ref: '#/components/schemas/CreateAddress' + - $ref: '#/components/schemas/UpdateAddress' + shipping_address: + oneOf: + - $ref: '#/components/schemas/CreateAddress' + - $ref: '#/components/schemas/UpdateAddress' + metadata: + type: object + description: The cart's metadata. x-codeSamples: - lang: Shell label: cURL @@ -248,6 +381,18 @@ paths: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - cart + properties: + cart: + $ref: '#/components/schemas/StoreCart' '400': $ref: '#/components/responses/400_error' '401': @@ -331,6 +476,57 @@ paths: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + oneOf: + - type: object + description: SUMMARY + required: + - type + - cart + - error + properties: + type: + type: string + title: type + description: The cart's type. + cart: + $ref: '#/components/schemas/StoreCart' + error: + type: object + description: The cart's error. + required: + - message + - name + - type + properties: + message: + type: string + title: message + description: The error's message. + name: + type: string + title: name + description: The error's name. + type: + type: string + title: type + description: The error's type. + - type: object + description: SUMMARY + required: + - type + - order + properties: + type: + type: string + title: type + description: The cart's type. + order: + $ref: '#/components/schemas/StoreOrder' '400': $ref: '#/components/responses/400_error' '401': @@ -343,6 +539,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: completeCartWorkflow /store/carts/{id}/line-items: post: operationId: PostCartsIdLineItems @@ -415,6 +612,12 @@ paths: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCartResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -504,6 +707,12 @@ paths: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCartResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -703,6 +912,12 @@ paths: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCartResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -774,6 +989,18 @@ paths: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - cart + properties: + cart: + $ref: '#/components/schemas/StoreCart' '400': $ref: '#/components/responses/400_error' '401': @@ -867,6 +1094,12 @@ paths: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCartResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -944,6 +1177,12 @@ paths: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCartResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1010,6 +1249,41 @@ paths: tags: - Collections responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The collection's limit. + offset: + type: number + title: offset + description: The collection's offset. + count: + type: number + title: count + description: The collection's count. + - type: object + description: SUMMARY + required: + - collections + properties: + collections: + type: array + description: The collection's collections. + items: + $ref: '#/components/schemas/StoreCollection' '400': $ref: '#/components/responses/400_error' '401': @@ -1082,6 +1356,12 @@ paths: tags: - Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCollectionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1148,6 +1428,12 @@ paths: tags: - Currencies responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCurrencyListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1220,6 +1506,12 @@ paths: tags: - Currencies responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCurrencyResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1300,6 +1592,12 @@ paths: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCustomerResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1371,6 +1669,12 @@ paths: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCustomerResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1453,6 +1757,12 @@ paths: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCustomerResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1635,6 +1945,12 @@ paths: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCustomerAddressListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1795,6 +2111,12 @@ paths: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCustomerResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -1872,6 +2194,12 @@ paths: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCustomerAddressResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2038,6 +2366,12 @@ paths: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCustomerResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2114,6 +2448,33 @@ paths: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + 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 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': @@ -2204,11 +2565,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The order's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The order's $or. + items: + type: object + title: $or x-codeSamples: - lang: Shell label: cURL @@ -2216,6 +2587,41 @@ paths: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The order's limit. + offset: + type: number + title: offset + description: The order's offset. + count: + type: number + title: count + description: The order's count. + - type: object + description: SUMMARY + required: + - orders + properties: + orders: + type: array + description: The order's orders. + items: + $ref: '#/components/schemas/StoreOrder' '400': $ref: '#/components/responses/400_error' '401': @@ -2312,11 +2718,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The order's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The order's $or. + items: + type: object + title: $or x-codeSamples: - lang: Shell label: cURL @@ -2324,6 +2740,12 @@ paths: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreOrderResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2391,26 +2813,11 @@ paths: description: SUMMARY required: - cart_id - - region_id - - currency_code - - amount properties: cart_id: type: string title: cart_id description: The payment collection's cart id. - region_id: - type: string - title: region_id - description: The payment collection's region id. - currency_code: - type: string - title: currency_code - description: The payment collection's currency code. - amount: - type: number - title: amount - description: The payment collection's amount. x-codeSamples: - lang: Shell label: cURL @@ -2426,6 +2833,12 @@ paths: tags: - Payment Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StorePaymentCollectionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2522,6 +2935,12 @@ paths: tags: - Payment Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StorePaymentCollectionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2614,11 +3033,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The payment provider's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The payment provider's $or. + items: + type: object + title: $or x-codeSamples: - lang: Shell label: cURL @@ -2626,6 +3055,41 @@ paths: tags: - Payment Providers responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The payment provider's limit. + offset: + type: number + title: offset + description: The payment provider's offset. + count: + type: number + title: count + description: The payment provider's count. + - type: object + description: SUMMARY + required: + - payment_providers + properties: + payment_providers: + type: array + description: The payment provider's payment providers. + items: + $ref: '#/components/schemas/StorePaymentProvider' '400': $ref: '#/components/responses/400_error' '401': @@ -2870,11 +3334,21 @@ paths: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The product category's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The product category's $or. + items: + type: object + title: $or x-codeSamples: - lang: Shell label: cURL @@ -3041,22 +3515,30 @@ 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: 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: $and in: query required: false - schema: {} + schema: + type: array + description: The product's $and. + items: + type: array + description: The $and's details. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The product's $or. + items: + type: array + description: The $or's details. + items: + type: object + title: $or - name: variants in: query description: The product's variants. @@ -3065,16 +3547,6 @@ paths: type: object description: The product's variants. properties: - status: - type: array - description: The variant's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected options: type: object description: The variant's options. @@ -3090,8 +3562,6 @@ paths: type: string title: option_id description: The option's option id. - $and: {} - $or: {} - name: q in: query description: The product's q. @@ -3117,51 +3587,45 @@ paths: - name: title in: query description: The product's title. - required: true + required: false schema: - type: string - title: title - description: The product's title. + oneOf: + - type: string + title: title + description: The product's title. + - type: array + description: The product's title. + items: + type: string + title: title + description: The title's details. - name: handle in: query description: The product's handle. - required: true + required: false schema: - type: string - title: handle - description: The product's handle. + oneOf: + - type: string + title: handle + description: The product's handle. + - type: array + description: The product's handle. + items: + type: string + title: handle + description: The handle's details. - name: is_giftcard in: query description: The product's is giftcard. - required: true + required: false schema: type: boolean title: is_giftcard description: The product's is giftcard. - - name: category_id - in: query - description: The product's category id. - required: true - schema: - description: The product's category id. - items: - type: string - title: category_id - description: The category id's details. - - name: sales_channel_id - in: query - description: The product's sales channel id. - required: true - schema: - description: The product's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - name: collection_id in: query description: The product's collection id. - required: true + required: false schema: description: The product's collection id. items: @@ -3173,11 +3637,16 @@ paths: description: The product's tags. required: false schema: + type: object description: The product's tags. - items: - type: string - title: tags - description: The tag's tags. + properties: + id: + type: array + description: The tag's ID. + items: + type: string + title: id + description: The id's ID. - name: type_id in: query description: The product's type id. @@ -3193,127 +3662,6230 @@ paths: description: The product's created at. required: false schema: - type: string + type: object description: The product's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + $and: + type: array + description: The created at's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1165: + type: object + description: The $and's @match@1165. + __@replace@1167: + type: object + description: The $and's @replace@1167. + __@search@1170: + type: object + description: The $and's @search@1170. + __@split@1172: + type: object + description: The $and's @split@1172. + __@matchAll@1174: + type: object + description: The $and's @matchall@1174. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $and's $eq. + - type: object + description: The $and's $eq. + x-schemaName: RegExp + - type: array + description: The $and's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $and's $ne. + - type: object + description: The $and's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $and's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $and's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $and's $not. + - type: object + description: The $and's $not. + x-schemaName: RegExp + - type: object + description: The $and's $not. + - type: array + description: The $and's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $and's $gt. + - type: object + description: The $and's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $and's $gte. + - type: object + description: The $and's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $and's $lt. + - type: object + description: The $and's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $and's $lte. + - type: object + description: The $and's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $and's $like. + $re: + type: string + title: $re + description: The $and's $re. + $ilike: + type: string + title: $ilike + description: The $and's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $and's $fulltext. + $overlap: + type: array + description: The $and's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $and's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $and's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $and's $exists. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1165: + type: object + description: The $and's @match@1165. + __@replace@1167: + type: object + description: The $and's @replace@1167. + __@search@1170: + type: object + description: The $and's @search@1170. + __@split@1172: + type: object + description: The $and's @split@1172. + __@matchAll@1174: + type: object + description: The $and's @matchall@1174. + $or: + type: array + description: The created at's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1165: + type: object + description: The $or's @match@1165. + __@replace@1167: + type: object + description: The $or's @replace@1167. + __@search@1170: + type: object + description: The $or's @search@1170. + __@split@1172: + type: object + description: The $or's @split@1172. + __@matchAll@1174: + type: object + description: The $or's @matchall@1174. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $or's $eq. + - type: object + description: The $or's $eq. + x-schemaName: RegExp + - type: array + description: The $or's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $or's $ne. + - type: object + description: The $or's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $or's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $or's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $or's $not. + - type: object + description: The $or's $not. + x-schemaName: RegExp + - type: object + description: The $or's $not. + - type: array + description: The $or's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $or's $gt. + - type: object + description: The $or's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $or's $gte. + - type: object + description: The $or's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $or's $lt. + - type: object + description: The $or's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $or's $lte. + - type: object + description: The $or's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $or's $like. + $re: + type: string + title: $re + description: The $or's $re. + $ilike: + type: string + title: $ilike + description: The $or's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $or's $fulltext. + $overlap: + type: array + description: The $or's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $or's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $or's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $or's $exists. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1165: + type: object + description: The $or's @match@1165. + __@replace@1167: + type: object + description: The $or's @replace@1167. + __@search@1170: + type: object + description: The $or's @search@1170. + __@split@1172: + type: object + description: The $or's @split@1172. + __@matchAll@1174: + type: object + description: The $or's @matchall@1174. + $eq: + oneOf: + - type: string + title: $eq + description: The created at's $eq. + - type: object + description: The created at's $eq. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1165: + type: object + description: The $eq's @match@1165. + __@replace@1167: + type: object + description: The $eq's @replace@1167. + __@search@1170: + type: object + description: The $eq's @search@1170. + __@split@1172: + type: object + description: The $eq's @split@1172. + __@matchAll@1174: + type: object + description: The $eq's @matchall@1174. + - type: array + description: The created at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1165: + type: object + description: The $eq's @match@1165. + __@replace@1167: + type: object + description: The $eq's @replace@1167. + __@search@1170: + type: object + description: The $eq's @search@1170. + __@split@1172: + type: object + description: The $eq's @split@1172. + __@matchAll@1174: + type: object + description: The $eq's @matchall@1174. + $ne: + oneOf: + - type: string + title: $ne + description: The created at's $ne. + - type: object + description: The created at's $ne. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $ne's exec. + test: + type: object + description: The $ne's test. + source: + type: string + title: source + description: The $ne's source. + global: + type: boolean + title: global + description: The $ne's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $ne's ignorecase. + multiline: + type: boolean + title: multiline + description: The $ne's multiline. + lastIndex: + type: number + title: lastIndex + description: The $ne's lastindex. + compile: + type: object + description: The $ne's compile. + flags: + type: string + title: flags + description: The $ne's flags. + sticky: + type: boolean + title: sticky + description: The $ne's sticky. + unicode: + type: boolean + title: unicode + description: The $ne's unicode. + dotAll: + type: boolean + title: dotAll + description: The $ne's dotall. + __@match@1165: + type: object + description: The $ne's @match@1165. + __@replace@1167: + type: object + description: The $ne's @replace@1167. + __@search@1170: + type: object + description: The $ne's @search@1170. + __@split@1172: + type: object + description: The $ne's @split@1172. + __@matchAll@1174: + type: object + description: The $ne's @matchall@1174. + $in: + type: array + description: The created at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $in's exec. + test: + type: object + description: The $in's test. + source: + type: string + title: source + description: The $in's source. + global: + type: boolean + title: global + description: The $in's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $in's ignorecase. + multiline: + type: boolean + title: multiline + description: The $in's multiline. + lastIndex: + type: number + title: lastIndex + description: The $in's lastindex. + compile: + type: object + description: The $in's compile. + flags: + type: string + title: flags + description: The $in's flags. + sticky: + type: boolean + title: sticky + description: The $in's sticky. + unicode: + type: boolean + title: unicode + description: The $in's unicode. + dotAll: + type: boolean + title: dotAll + description: The $in's dotall. + __@match@1165: + type: object + description: The $in's @match@1165. + __@replace@1167: + type: object + description: The $in's @replace@1167. + __@search@1170: + type: object + description: The $in's @search@1170. + __@split@1172: + type: object + description: The $in's @split@1172. + __@matchAll@1174: + type: object + description: The $in's @matchall@1174. + $nin: + type: array + description: The created at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $nin's exec. + test: + type: object + description: The $nin's test. + source: + type: string + title: source + description: The $nin's source. + global: + type: boolean + title: global + description: The $nin's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $nin's ignorecase. + multiline: + type: boolean + title: multiline + description: The $nin's multiline. + lastIndex: + type: number + title: lastIndex + description: The $nin's lastindex. + compile: + type: object + description: The $nin's compile. + flags: + type: string + title: flags + description: The $nin's flags. + sticky: + type: boolean + title: sticky + description: The $nin's sticky. + unicode: + type: boolean + title: unicode + description: The $nin's unicode. + dotAll: + type: boolean + title: dotAll + description: The $nin's dotall. + __@match@1165: + type: object + description: The $nin's @match@1165. + __@replace@1167: + type: object + description: The $nin's @replace@1167. + __@search@1170: + type: object + description: The $nin's @search@1170. + __@split@1172: + type: object + description: The $nin's @split@1172. + __@matchAll@1174: + type: object + description: The $nin's @matchall@1174. + $not: + oneOf: + - type: string + title: $not + description: The created at's $not. + - type: object + description: The created at's $not. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1165: + type: object + description: The $not's @match@1165. + __@replace@1167: + type: object + description: The $not's @replace@1167. + __@search@1170: + type: object + description: The $not's @search@1170. + __@split@1172: + type: object + description: The $not's @split@1172. + __@matchAll@1174: + type: object + description: The $not's @matchall@1174. + - type: object + description: The created at's $not. + properties: + $and: + type: array + description: The $not's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $not's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $not's $eq. + - type: object + description: The $not's $eq. + x-schemaName: RegExp + - type: array + description: The $not's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $not's $ne. + - type: object + description: The $not's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $not's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $not's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + - type: object + description: The $not's details. + - type: array + description: The $not's details. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $not's $gt. + - type: object + description: The $not's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $not's $gte. + - type: object + description: The $not's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $not's $lt. + - type: object + description: The $not's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $not's $lte. + - type: object + description: The $not's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $not's $like. + $re: + type: string + title: $re + description: The $not's $re. + $ilike: + type: string + title: $ilike + description: The $not's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $not's $fulltext. + $overlap: + type: array + description: The $not's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $not's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $not's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $not's $exists. + - type: array + description: The created at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1165: + type: object + description: The $not's @match@1165. + __@replace@1167: + type: object + description: The $not's @replace@1167. + __@search@1170: + type: object + description: The $not's @search@1170. + __@split@1172: + type: object + description: The $not's @split@1172. + __@matchAll@1174: + type: object + description: The $not's @matchall@1174. + $gt: + oneOf: + - type: string + title: $gt + description: The created at's $gt. + - type: object + description: The created at's $gt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $gt's exec. + test: + type: object + description: The $gt's test. + source: + type: string + title: source + description: The $gt's source. + global: + type: boolean + title: global + description: The $gt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gt's lastindex. + compile: + type: object + description: The $gt's compile. + flags: + type: string + title: flags + description: The $gt's flags. + sticky: + type: boolean + title: sticky + description: The $gt's sticky. + unicode: + type: boolean + title: unicode + description: The $gt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gt's dotall. + __@match@1165: + type: object + description: The $gt's @match@1165. + __@replace@1167: + type: object + description: The $gt's @replace@1167. + __@search@1170: + type: object + description: The $gt's @search@1170. + __@split@1172: + type: object + description: The $gt's @split@1172. + __@matchAll@1174: + type: object + description: The $gt's @matchall@1174. + $gte: + oneOf: + - type: string + title: $gte + description: The created at's $gte. + - type: object + description: The created at's $gte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $gte's exec. + test: + type: object + description: The $gte's test. + source: + type: string + title: source + description: The $gte's source. + global: + type: boolean + title: global + description: The $gte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gte's lastindex. + compile: + type: object + description: The $gte's compile. + flags: + type: string + title: flags + description: The $gte's flags. + sticky: + type: boolean + title: sticky + description: The $gte's sticky. + unicode: + type: boolean + title: unicode + description: The $gte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gte's dotall. + __@match@1165: + type: object + description: The $gte's @match@1165. + __@replace@1167: + type: object + description: The $gte's @replace@1167. + __@search@1170: + type: object + description: The $gte's @search@1170. + __@split@1172: + type: object + description: The $gte's @split@1172. + __@matchAll@1174: + type: object + description: The $gte's @matchall@1174. + $lt: + oneOf: + - type: string + title: $lt + description: The created at's $lt. + - type: object + description: The created at's $lt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $lt's exec. + test: + type: object + description: The $lt's test. + source: + type: string + title: source + description: The $lt's source. + global: + type: boolean + title: global + description: The $lt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lt's lastindex. + compile: + type: object + description: The $lt's compile. + flags: + type: string + title: flags + description: The $lt's flags. + sticky: + type: boolean + title: sticky + description: The $lt's sticky. + unicode: + type: boolean + title: unicode + description: The $lt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lt's dotall. + __@match@1165: + type: object + description: The $lt's @match@1165. + __@replace@1167: + type: object + description: The $lt's @replace@1167. + __@search@1170: + type: object + description: The $lt's @search@1170. + __@split@1172: + type: object + description: The $lt's @split@1172. + __@matchAll@1174: + type: object + description: The $lt's @matchall@1174. + $lte: + oneOf: + - type: string + title: $lte + description: The created at's $lte. + - type: object + description: The created at's $lte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $lte's exec. + test: + type: object + description: The $lte's test. + source: + type: string + title: source + description: The $lte's source. + global: + type: boolean + title: global + description: The $lte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lte's lastindex. + compile: + type: object + description: The $lte's compile. + flags: + type: string + title: flags + description: The $lte's flags. + sticky: + type: boolean + title: sticky + description: The $lte's sticky. + unicode: + type: boolean + title: unicode + description: The $lte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lte's dotall. + __@match@1165: + type: object + description: The $lte's @match@1165. + __@replace@1167: + type: object + description: The $lte's @replace@1167. + __@search@1170: + type: object + description: The $lte's @search@1170. + __@split@1172: + type: object + description: The $lte's @split@1172. + __@matchAll@1174: + type: object + description: The $lte's @matchall@1174. + $like: + type: string + title: $like + description: The created at's $like. + $re: + type: string + title: $re + description: The created at's $re. + $ilike: + type: string + title: $ilike + description: The created at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The created at's $fulltext. + $overlap: + type: array + description: The created at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The created at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The created at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The created at's $exists. - name: updated_at in: query description: The product's updated at. required: false schema: - type: string + type: object description: The product's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + $and: + type: array + description: The updated at's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1165: + type: object + description: The $and's @match@1165. + __@replace@1167: + type: object + description: The $and's @replace@1167. + __@search@1170: + type: object + description: The $and's @search@1170. + __@split@1172: + type: object + description: The $and's @split@1172. + __@matchAll@1174: + type: object + description: The $and's @matchall@1174. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $and's $eq. + - type: object + description: The $and's $eq. + x-schemaName: RegExp + - type: array + description: The $and's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $and's $ne. + - type: object + description: The $and's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $and's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $and's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $and's $not. + - type: object + description: The $and's $not. + x-schemaName: RegExp + - type: object + description: The $and's $not. + - type: array + description: The $and's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $and's $gt. + - type: object + description: The $and's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $and's $gte. + - type: object + description: The $and's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $and's $lt. + - type: object + description: The $and's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $and's $lte. + - type: object + description: The $and's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $and's $like. + $re: + type: string + title: $re + description: The $and's $re. + $ilike: + type: string + title: $ilike + description: The $and's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $and's $fulltext. + $overlap: + type: array + description: The $and's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $and's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $and's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $and's $exists. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1165: + type: object + description: The $and's @match@1165. + __@replace@1167: + type: object + description: The $and's @replace@1167. + __@search@1170: + type: object + description: The $and's @search@1170. + __@split@1172: + type: object + description: The $and's @split@1172. + __@matchAll@1174: + type: object + description: The $and's @matchall@1174. + $or: + type: array + description: The updated at's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1165: + type: object + description: The $or's @match@1165. + __@replace@1167: + type: object + description: The $or's @replace@1167. + __@search@1170: + type: object + description: The $or's @search@1170. + __@split@1172: + type: object + description: The $or's @split@1172. + __@matchAll@1174: + type: object + description: The $or's @matchall@1174. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $or's $eq. + - type: object + description: The $or's $eq. + x-schemaName: RegExp + - type: array + description: The $or's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $or's $ne. + - type: object + description: The $or's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $or's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $or's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $or's $not. + - type: object + description: The $or's $not. + x-schemaName: RegExp + - type: object + description: The $or's $not. + - type: array + description: The $or's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $or's $gt. + - type: object + description: The $or's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $or's $gte. + - type: object + description: The $or's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $or's $lt. + - type: object + description: The $or's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $or's $lte. + - type: object + description: The $or's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $or's $like. + $re: + type: string + title: $re + description: The $or's $re. + $ilike: + type: string + title: $ilike + description: The $or's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $or's $fulltext. + $overlap: + type: array + description: The $or's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $or's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $or's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $or's $exists. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1165: + type: object + description: The $or's @match@1165. + __@replace@1167: + type: object + description: The $or's @replace@1167. + __@search@1170: + type: object + description: The $or's @search@1170. + __@split@1172: + type: object + description: The $or's @split@1172. + __@matchAll@1174: + type: object + description: The $or's @matchall@1174. + $eq: + oneOf: + - type: string + title: $eq + description: The updated at's $eq. + - type: object + description: The updated at's $eq. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1165: + type: object + description: The $eq's @match@1165. + __@replace@1167: + type: object + description: The $eq's @replace@1167. + __@search@1170: + type: object + description: The $eq's @search@1170. + __@split@1172: + type: object + description: The $eq's @split@1172. + __@matchAll@1174: + type: object + description: The $eq's @matchall@1174. + - type: array + description: The updated at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1165: + type: object + description: The $eq's @match@1165. + __@replace@1167: + type: object + description: The $eq's @replace@1167. + __@search@1170: + type: object + description: The $eq's @search@1170. + __@split@1172: + type: object + description: The $eq's @split@1172. + __@matchAll@1174: + type: object + description: The $eq's @matchall@1174. + $ne: + oneOf: + - type: string + title: $ne + description: The updated at's $ne. + - type: object + description: The updated at's $ne. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $ne's exec. + test: + type: object + description: The $ne's test. + source: + type: string + title: source + description: The $ne's source. + global: + type: boolean + title: global + description: The $ne's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $ne's ignorecase. + multiline: + type: boolean + title: multiline + description: The $ne's multiline. + lastIndex: + type: number + title: lastIndex + description: The $ne's lastindex. + compile: + type: object + description: The $ne's compile. + flags: + type: string + title: flags + description: The $ne's flags. + sticky: + type: boolean + title: sticky + description: The $ne's sticky. + unicode: + type: boolean + title: unicode + description: The $ne's unicode. + dotAll: + type: boolean + title: dotAll + description: The $ne's dotall. + __@match@1165: + type: object + description: The $ne's @match@1165. + __@replace@1167: + type: object + description: The $ne's @replace@1167. + __@search@1170: + type: object + description: The $ne's @search@1170. + __@split@1172: + type: object + description: The $ne's @split@1172. + __@matchAll@1174: + type: object + description: The $ne's @matchall@1174. + $in: + type: array + description: The updated at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $in's exec. + test: + type: object + description: The $in's test. + source: + type: string + title: source + description: The $in's source. + global: + type: boolean + title: global + description: The $in's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $in's ignorecase. + multiline: + type: boolean + title: multiline + description: The $in's multiline. + lastIndex: + type: number + title: lastIndex + description: The $in's lastindex. + compile: + type: object + description: The $in's compile. + flags: + type: string + title: flags + description: The $in's flags. + sticky: + type: boolean + title: sticky + description: The $in's sticky. + unicode: + type: boolean + title: unicode + description: The $in's unicode. + dotAll: + type: boolean + title: dotAll + description: The $in's dotall. + __@match@1165: + type: object + description: The $in's @match@1165. + __@replace@1167: + type: object + description: The $in's @replace@1167. + __@search@1170: + type: object + description: The $in's @search@1170. + __@split@1172: + type: object + description: The $in's @split@1172. + __@matchAll@1174: + type: object + description: The $in's @matchall@1174. + $nin: + type: array + description: The updated at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $nin's exec. + test: + type: object + description: The $nin's test. + source: + type: string + title: source + description: The $nin's source. + global: + type: boolean + title: global + description: The $nin's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $nin's ignorecase. + multiline: + type: boolean + title: multiline + description: The $nin's multiline. + lastIndex: + type: number + title: lastIndex + description: The $nin's lastindex. + compile: + type: object + description: The $nin's compile. + flags: + type: string + title: flags + description: The $nin's flags. + sticky: + type: boolean + title: sticky + description: The $nin's sticky. + unicode: + type: boolean + title: unicode + description: The $nin's unicode. + dotAll: + type: boolean + title: dotAll + description: The $nin's dotall. + __@match@1165: + type: object + description: The $nin's @match@1165. + __@replace@1167: + type: object + description: The $nin's @replace@1167. + __@search@1170: + type: object + description: The $nin's @search@1170. + __@split@1172: + type: object + description: The $nin's @split@1172. + __@matchAll@1174: + type: object + description: The $nin's @matchall@1174. + $not: + oneOf: + - type: string + title: $not + description: The updated at's $not. + - type: object + description: The updated at's $not. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1165: + type: object + description: The $not's @match@1165. + __@replace@1167: + type: object + description: The $not's @replace@1167. + __@search@1170: + type: object + description: The $not's @search@1170. + __@split@1172: + type: object + description: The $not's @split@1172. + __@matchAll@1174: + type: object + description: The $not's @matchall@1174. + - type: object + description: The updated at's $not. + properties: + $and: + type: array + description: The $not's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $not's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $not's $eq. + - type: object + description: The $not's $eq. + x-schemaName: RegExp + - type: array + description: The $not's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $not's $ne. + - type: object + description: The $not's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $not's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $not's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + - type: object + description: The $not's details. + - type: array + description: The $not's details. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $not's $gt. + - type: object + description: The $not's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $not's $gte. + - type: object + description: The $not's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $not's $lt. + - type: object + description: The $not's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $not's $lte. + - type: object + description: The $not's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $not's $like. + $re: + type: string + title: $re + description: The $not's $re. + $ilike: + type: string + title: $ilike + description: The $not's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $not's $fulltext. + $overlap: + type: array + description: The $not's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $not's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $not's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $not's $exists. + - type: array + description: The updated at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1165: + type: object + description: The $not's @match@1165. + __@replace@1167: + type: object + description: The $not's @replace@1167. + __@search@1170: + type: object + description: The $not's @search@1170. + __@split@1172: + type: object + description: The $not's @split@1172. + __@matchAll@1174: + type: object + description: The $not's @matchall@1174. + $gt: + oneOf: + - type: string + title: $gt + description: The updated at's $gt. + - type: object + description: The updated at's $gt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $gt's exec. + test: + type: object + description: The $gt's test. + source: + type: string + title: source + description: The $gt's source. + global: + type: boolean + title: global + description: The $gt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gt's lastindex. + compile: + type: object + description: The $gt's compile. + flags: + type: string + title: flags + description: The $gt's flags. + sticky: + type: boolean + title: sticky + description: The $gt's sticky. + unicode: + type: boolean + title: unicode + description: The $gt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gt's dotall. + __@match@1165: + type: object + description: The $gt's @match@1165. + __@replace@1167: + type: object + description: The $gt's @replace@1167. + __@search@1170: + type: object + description: The $gt's @search@1170. + __@split@1172: + type: object + description: The $gt's @split@1172. + __@matchAll@1174: + type: object + description: The $gt's @matchall@1174. + $gte: + oneOf: + - type: string + title: $gte + description: The updated at's $gte. + - type: object + description: The updated at's $gte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $gte's exec. + test: + type: object + description: The $gte's test. + source: + type: string + title: source + description: The $gte's source. + global: + type: boolean + title: global + description: The $gte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gte's lastindex. + compile: + type: object + description: The $gte's compile. + flags: + type: string + title: flags + description: The $gte's flags. + sticky: + type: boolean + title: sticky + description: The $gte's sticky. + unicode: + type: boolean + title: unicode + description: The $gte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gte's dotall. + __@match@1165: + type: object + description: The $gte's @match@1165. + __@replace@1167: + type: object + description: The $gte's @replace@1167. + __@search@1170: + type: object + description: The $gte's @search@1170. + __@split@1172: + type: object + description: The $gte's @split@1172. + __@matchAll@1174: + type: object + description: The $gte's @matchall@1174. + $lt: + oneOf: + - type: string + title: $lt + description: The updated at's $lt. + - type: object + description: The updated at's $lt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $lt's exec. + test: + type: object + description: The $lt's test. + source: + type: string + title: source + description: The $lt's source. + global: + type: boolean + title: global + description: The $lt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lt's lastindex. + compile: + type: object + description: The $lt's compile. + flags: + type: string + title: flags + description: The $lt's flags. + sticky: + type: boolean + title: sticky + description: The $lt's sticky. + unicode: + type: boolean + title: unicode + description: The $lt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lt's dotall. + __@match@1165: + type: object + description: The $lt's @match@1165. + __@replace@1167: + type: object + description: The $lt's @replace@1167. + __@search@1170: + type: object + description: The $lt's @search@1170. + __@split@1172: + type: object + description: The $lt's @split@1172. + __@matchAll@1174: + type: object + description: The $lt's @matchall@1174. + $lte: + oneOf: + - type: string + title: $lte + description: The updated at's $lte. + - type: object + description: The updated at's $lte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $lte's exec. + test: + type: object + description: The $lte's test. + source: + type: string + title: source + description: The $lte's source. + global: + type: boolean + title: global + description: The $lte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lte's lastindex. + compile: + type: object + description: The $lte's compile. + flags: + type: string + title: flags + description: The $lte's flags. + sticky: + type: boolean + title: sticky + description: The $lte's sticky. + unicode: + type: boolean + title: unicode + description: The $lte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lte's dotall. + __@match@1165: + type: object + description: The $lte's @match@1165. + __@replace@1167: + type: object + description: The $lte's @replace@1167. + __@search@1170: + type: object + description: The $lte's @search@1170. + __@split@1172: + type: object + description: The $lte's @split@1172. + __@matchAll@1174: + type: object + description: The $lte's @matchall@1174. + $like: + type: string + title: $like + description: The updated at's $like. + $re: + type: string + title: $re + description: The updated at's $re. + $ilike: + type: string + title: $ilike + description: The updated at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The updated at's $fulltext. + $overlap: + type: array + description: The updated at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The updated at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The updated at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The updated at's $exists. - name: deleted_at in: query description: The product's deleted at. required: false schema: - type: string + type: object description: The product's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at - - name: country_code + $and: + type: array + description: The deleted at's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1165: + type: object + description: The $and's @match@1165. + __@replace@1167: + type: object + description: The $and's @replace@1167. + __@search@1170: + type: object + description: The $and's @search@1170. + __@split@1172: + type: object + description: The $and's @split@1172. + __@matchAll@1174: + type: object + description: The $and's @matchall@1174. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $and's $eq. + - type: object + description: The $and's $eq. + x-schemaName: RegExp + - type: array + description: The $and's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $and's $ne. + - type: object + description: The $and's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $and's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $and's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $and's $not. + - type: object + description: The $and's $not. + x-schemaName: RegExp + - type: object + description: The $and's $not. + - type: array + description: The $and's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $and's $gt. + - type: object + description: The $and's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $and's $gte. + - type: object + description: The $and's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $and's $lt. + - type: object + description: The $and's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $and's $lte. + - type: object + description: The $and's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $and's $like. + $re: + type: string + title: $re + description: The $and's $re. + $ilike: + type: string + title: $ilike + description: The $and's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $and's $fulltext. + $overlap: + type: array + description: The $and's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $and's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $and's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $and's $exists. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1165: + type: object + description: The $and's @match@1165. + __@replace@1167: + type: object + description: The $and's @replace@1167. + __@search@1170: + type: object + description: The $and's @search@1170. + __@split@1172: + type: object + description: The $and's @split@1172. + __@matchAll@1174: + type: object + description: The $and's @matchall@1174. + $or: + type: array + description: The deleted at's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1165: + type: object + description: The $or's @match@1165. + __@replace@1167: + type: object + description: The $or's @replace@1167. + __@search@1170: + type: object + description: The $or's @search@1170. + __@split@1172: + type: object + description: The $or's @split@1172. + __@matchAll@1174: + type: object + description: The $or's @matchall@1174. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $or's $eq. + - type: object + description: The $or's $eq. + x-schemaName: RegExp + - type: array + description: The $or's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $or's $ne. + - type: object + description: The $or's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $or's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $or's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $or's $not. + - type: object + description: The $or's $not. + x-schemaName: RegExp + - type: object + description: The $or's $not. + - type: array + description: The $or's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $or's $gt. + - type: object + description: The $or's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $or's $gte. + - type: object + description: The $or's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $or's $lt. + - type: object + description: The $or's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $or's $lte. + - type: object + description: The $or's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $or's $like. + $re: + type: string + title: $re + description: The $or's $re. + $ilike: + type: string + title: $ilike + description: The $or's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $or's $fulltext. + $overlap: + type: array + description: The $or's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $or's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $or's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $or's $exists. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1165: + type: object + description: The $or's @match@1165. + __@replace@1167: + type: object + description: The $or's @replace@1167. + __@search@1170: + type: object + description: The $or's @search@1170. + __@split@1172: + type: object + description: The $or's @split@1172. + __@matchAll@1174: + type: object + description: The $or's @matchall@1174. + $eq: + oneOf: + - type: string + title: $eq + description: The deleted at's $eq. + - type: object + description: The deleted at's $eq. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1165: + type: object + description: The $eq's @match@1165. + __@replace@1167: + type: object + description: The $eq's @replace@1167. + __@search@1170: + type: object + description: The $eq's @search@1170. + __@split@1172: + type: object + description: The $eq's @split@1172. + __@matchAll@1174: + type: object + description: The $eq's @matchall@1174. + - type: array + description: The deleted at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1165: + type: object + description: The $eq's @match@1165. + __@replace@1167: + type: object + description: The $eq's @replace@1167. + __@search@1170: + type: object + description: The $eq's @search@1170. + __@split@1172: + type: object + description: The $eq's @split@1172. + __@matchAll@1174: + type: object + description: The $eq's @matchall@1174. + $ne: + oneOf: + - type: string + title: $ne + description: The deleted at's $ne. + - type: object + description: The deleted at's $ne. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $ne's exec. + test: + type: object + description: The $ne's test. + source: + type: string + title: source + description: The $ne's source. + global: + type: boolean + title: global + description: The $ne's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $ne's ignorecase. + multiline: + type: boolean + title: multiline + description: The $ne's multiline. + lastIndex: + type: number + title: lastIndex + description: The $ne's lastindex. + compile: + type: object + description: The $ne's compile. + flags: + type: string + title: flags + description: The $ne's flags. + sticky: + type: boolean + title: sticky + description: The $ne's sticky. + unicode: + type: boolean + title: unicode + description: The $ne's unicode. + dotAll: + type: boolean + title: dotAll + description: The $ne's dotall. + __@match@1165: + type: object + description: The $ne's @match@1165. + __@replace@1167: + type: object + description: The $ne's @replace@1167. + __@search@1170: + type: object + description: The $ne's @search@1170. + __@split@1172: + type: object + description: The $ne's @split@1172. + __@matchAll@1174: + type: object + description: The $ne's @matchall@1174. + $in: + type: array + description: The deleted at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $in's exec. + test: + type: object + description: The $in's test. + source: + type: string + title: source + description: The $in's source. + global: + type: boolean + title: global + description: The $in's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $in's ignorecase. + multiline: + type: boolean + title: multiline + description: The $in's multiline. + lastIndex: + type: number + title: lastIndex + description: The $in's lastindex. + compile: + type: object + description: The $in's compile. + flags: + type: string + title: flags + description: The $in's flags. + sticky: + type: boolean + title: sticky + description: The $in's sticky. + unicode: + type: boolean + title: unicode + description: The $in's unicode. + dotAll: + type: boolean + title: dotAll + description: The $in's dotall. + __@match@1165: + type: object + description: The $in's @match@1165. + __@replace@1167: + type: object + description: The $in's @replace@1167. + __@search@1170: + type: object + description: The $in's @search@1170. + __@split@1172: + type: object + description: The $in's @split@1172. + __@matchAll@1174: + type: object + description: The $in's @matchall@1174. + $nin: + type: array + description: The deleted at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $nin's exec. + test: + type: object + description: The $nin's test. + source: + type: string + title: source + description: The $nin's source. + global: + type: boolean + title: global + description: The $nin's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $nin's ignorecase. + multiline: + type: boolean + title: multiline + description: The $nin's multiline. + lastIndex: + type: number + title: lastIndex + description: The $nin's lastindex. + compile: + type: object + description: The $nin's compile. + flags: + type: string + title: flags + description: The $nin's flags. + sticky: + type: boolean + title: sticky + description: The $nin's sticky. + unicode: + type: boolean + title: unicode + description: The $nin's unicode. + dotAll: + type: boolean + title: dotAll + description: The $nin's dotall. + __@match@1165: + type: object + description: The $nin's @match@1165. + __@replace@1167: + type: object + description: The $nin's @replace@1167. + __@search@1170: + type: object + description: The $nin's @search@1170. + __@split@1172: + type: object + description: The $nin's @split@1172. + __@matchAll@1174: + type: object + description: The $nin's @matchall@1174. + $not: + oneOf: + - type: string + title: $not + description: The deleted at's $not. + - type: object + description: The deleted at's $not. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1165: + type: object + description: The $not's @match@1165. + __@replace@1167: + type: object + description: The $not's @replace@1167. + __@search@1170: + type: object + description: The $not's @search@1170. + __@split@1172: + type: object + description: The $not's @split@1172. + __@matchAll@1174: + type: object + description: The $not's @matchall@1174. + - type: object + description: The deleted at's $not. + properties: + $and: + type: array + description: The $not's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $not's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $not's $eq. + - type: object + description: The $not's $eq. + x-schemaName: RegExp + - type: array + description: The $not's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $not's $ne. + - type: object + description: The $not's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $not's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $not's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + - type: object + description: The $not's details. + - type: array + description: The $not's details. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $not's $gt. + - type: object + description: The $not's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $not's $gte. + - type: object + description: The $not's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $not's $lt. + - type: object + description: The $not's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $not's $lte. + - type: object + description: The $not's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $not's $like. + $re: + type: string + title: $re + description: The $not's $re. + $ilike: + type: string + title: $ilike + description: The $not's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $not's $fulltext. + $overlap: + type: array + description: The $not's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $not's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $not's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $not's $exists. + - type: array + description: The deleted at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1165: + type: object + description: The $not's @match@1165. + __@replace@1167: + type: object + description: The $not's @replace@1167. + __@search@1170: + type: object + description: The $not's @search@1170. + __@split@1172: + type: object + description: The $not's @split@1172. + __@matchAll@1174: + type: object + description: The $not's @matchall@1174. + $gt: + oneOf: + - type: string + title: $gt + description: The deleted at's $gt. + - type: object + description: The deleted at's $gt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $gt's exec. + test: + type: object + description: The $gt's test. + source: + type: string + title: source + description: The $gt's source. + global: + type: boolean + title: global + description: The $gt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gt's lastindex. + compile: + type: object + description: The $gt's compile. + flags: + type: string + title: flags + description: The $gt's flags. + sticky: + type: boolean + title: sticky + description: The $gt's sticky. + unicode: + type: boolean + title: unicode + description: The $gt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gt's dotall. + __@match@1165: + type: object + description: The $gt's @match@1165. + __@replace@1167: + type: object + description: The $gt's @replace@1167. + __@search@1170: + type: object + description: The $gt's @search@1170. + __@split@1172: + type: object + description: The $gt's @split@1172. + __@matchAll@1174: + type: object + description: The $gt's @matchall@1174. + $gte: + oneOf: + - type: string + title: $gte + description: The deleted at's $gte. + - type: object + description: The deleted at's $gte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $gte's exec. + test: + type: object + description: The $gte's test. + source: + type: string + title: source + description: The $gte's source. + global: + type: boolean + title: global + description: The $gte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gte's lastindex. + compile: + type: object + description: The $gte's compile. + flags: + type: string + title: flags + description: The $gte's flags. + sticky: + type: boolean + title: sticky + description: The $gte's sticky. + unicode: + type: boolean + title: unicode + description: The $gte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gte's dotall. + __@match@1165: + type: object + description: The $gte's @match@1165. + __@replace@1167: + type: object + description: The $gte's @replace@1167. + __@search@1170: + type: object + description: The $gte's @search@1170. + __@split@1172: + type: object + description: The $gte's @split@1172. + __@matchAll@1174: + type: object + description: The $gte's @matchall@1174. + $lt: + oneOf: + - type: string + title: $lt + description: The deleted at's $lt. + - type: object + description: The deleted at's $lt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $lt's exec. + test: + type: object + description: The $lt's test. + source: + type: string + title: source + description: The $lt's source. + global: + type: boolean + title: global + description: The $lt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lt's lastindex. + compile: + type: object + description: The $lt's compile. + flags: + type: string + title: flags + description: The $lt's flags. + sticky: + type: boolean + title: sticky + description: The $lt's sticky. + unicode: + type: boolean + title: unicode + description: The $lt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lt's dotall. + __@match@1165: + type: object + description: The $lt's @match@1165. + __@replace@1167: + type: object + description: The $lt's @replace@1167. + __@search@1170: + type: object + description: The $lt's @search@1170. + __@split@1172: + type: object + description: The $lt's @split@1172. + __@matchAll@1174: + type: object + description: The $lt's @matchall@1174. + $lte: + oneOf: + - type: string + title: $lte + description: The deleted at's $lte. + - type: object + description: The deleted at's $lte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $lte's exec. + test: + type: object + description: The $lte's test. + source: + type: string + title: source + description: The $lte's source. + global: + type: boolean + title: global + description: The $lte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lte's lastindex. + compile: + type: object + description: The $lte's compile. + flags: + type: string + title: flags + description: The $lte's flags. + sticky: + type: boolean + title: sticky + description: The $lte's sticky. + unicode: + type: boolean + title: unicode + description: The $lte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lte's dotall. + __@match@1165: + type: object + description: The $lte's @match@1165. + __@replace@1167: + type: object + description: The $lte's @replace@1167. + __@search@1170: + type: object + description: The $lte's @search@1170. + __@split@1172: + type: object + description: The $lte's @split@1172. + __@matchAll@1174: + type: object + description: The $lte's @matchall@1174. + $like: + type: string + title: $like + description: The deleted at's $like. + $re: + type: string + title: $re + description: The deleted at's $re. + $ilike: + type: string + title: $ilike + description: The deleted at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The deleted at's $fulltext. + $overlap: + type: array + description: The deleted at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The deleted at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The deleted at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The deleted at's $exists. + - name: status in: query - description: The product's country code. required: false schema: - type: string - title: country_code - description: The product's country code. - - name: province + oneOf: + - type: string + title: status + description: The product's status. + - type: string + title: status + description: The product's status. + - type: string + title: status + description: The product's status. + - type: string + title: status + description: The product's status. + - type: array + description: The product's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + - name: categories in: query - description: The product's province. required: false schema: - type: string - title: province - description: The product's province. - - name: cart_id - in: query - description: The product's cart id. - required: false - schema: - type: string - title: cart_id - description: The product's cart id. + oneOf: + - type: object + description: The product's categories. + required: + - id + properties: + id: + type: object + description: The category's ID. + properties: + $and: + type: array + description: The id's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The id's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The id's $eq. + - type: object + description: The id's $eq. + x-schemaName: RegExp + - type: array + description: The id's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The id's $ne. + - type: object + description: The id's $ne. + x-schemaName: RegExp + $in: + type: array + description: The id's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The id's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The id's $not. + - type: object + description: The id's $not. + x-schemaName: RegExp + - type: object + description: The id's $not. + - type: array + description: The id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The id's $gt. + - type: object + description: The id's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The id's $gte. + - type: object + description: The id's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The id's $lt. + - type: object + description: The id's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The id's $lte. + - type: object + description: The id's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The id's $like. + $re: + type: string + title: $re + description: The id's $re. + $ilike: + type: string + title: $ilike + description: The id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The id's $fulltext. + $overlap: + type: array + description: The id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The id's $exists. + - type: object + description: The product's categories. + required: + - id + properties: + id: + type: object + description: The category's ID. + properties: + $and: + type: array + description: The id's $and. + items: + type: array + description: The $and's details. + items: + type: array + description: The $and's details. + items: + type: object + title: $and + $or: + type: array + description: The id's $or. + items: + type: array + description: The $or's details. + items: + type: array + description: The $or's details. + items: + type: object + title: $or + $eq: + oneOf: + - type: array + description: The id's $eq. + items: + type: string + title: $eq + description: The $eq's details. + - type: array + description: The id's $eq. + items: + type: array + description: The $eq's details. + items: + type: string + title: $eq + description: The $eq's details. + $ne: + type: array + description: The id's $ne. + items: + type: string + title: $ne + description: The $ne's details. + $in: + type: array + description: The id's $in. + items: + type: array + description: The $in's details. + items: + type: string + title: $in + description: The $in's details. + $nin: + type: array + description: The id's $nin. + items: + type: array + description: The $nin's details. + items: + type: string + title: $nin + description: The $nin's details. + $not: + type: array + description: The id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + $gt: + type: array + description: The id's $gt. + items: + type: string + title: $gt + description: The $gt's details. + $gte: + type: array + description: The id's $gte. + items: + type: string + title: $gte + description: The $gte's details. + $lt: + type: array + description: The id's $lt. + items: + type: string + title: $lt + description: The $lt's details. + $lte: + type: array + description: The id's $lte. + items: + type: string + title: $lte + description: The $lte's details. + $like: + type: string + title: $like + description: The id's $like. + $re: + type: string + title: $re + description: The id's $re. + $ilike: + type: string + title: $ilike + description: The id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The id's $fulltext. + $overlap: + type: array + description: The id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The id's $exists. x-codeSamples: - lang: Shell label: cURL @@ -3321,6 +9893,41 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The product's limit. + offset: + type: number + title: offset + description: The product's offset. + count: + type: number + title: count + description: The product's count. + - type: object + description: SUMMARY + required: + - products + properties: + products: + type: array + description: The product's products. + items: + type: object '400': $ref: '#/components/responses/400_error' '401': @@ -3425,6 +10032,12 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreProductResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3491,6 +10104,41 @@ paths: tags: - Regions responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The region's limit. + offset: + type: number + title: offset + description: The region's offset. + count: + type: number + title: count + description: The region's count. + - type: object + description: SUMMARY + required: + - regions + properties: + regions: + type: array + description: The region's regions. + items: + $ref: '#/components/schemas/StoreRegion' '400': $ref: '#/components/responses/400_error' '401': @@ -3563,6 +10211,18 @@ paths: tags: - Regions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - region + properties: + region: + $ref: '#/components/schemas/StoreRegion' '400': $ref: '#/components/responses/400_error' '401': @@ -3653,6 +10313,12 @@ paths: tags: - Return responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreReturnResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3719,6 +10385,41 @@ paths: tags: - Return Reasons responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The return reason's limit. + offset: + type: number + title: offset + description: The return reason's offset. + count: + type: number + title: count + description: The return reason's count. + - type: object + description: SUMMARY + required: + - return_reasons + properties: + return_reasons: + type: array + description: The return reason's return reasons. + items: + $ref: '#/components/schemas/StoreReturnReason' '400': $ref: '#/components/responses/400_error' '401': @@ -3791,6 +10492,12 @@ paths: tags: - Return Reasons responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreReturnReasonResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3857,6 +10564,12 @@ paths: tags: - Shipping Options responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreShippingOptionListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3869,176 +10582,18 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: listShippingOptionsForCartWorkflow components: - responses: - default_error: - description: Default Error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - code: unknown_error - message: An unknown error occurred. - type: unknown_error - invalid_state_error: - description: Invalid State Error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - code: unknown_error - message: The request conflicted with another request. You may retry the request with the provided Idempotency-Key. - type: QueryRunnerAlreadyReleasedError - invalid_request_error: - description: Invalid Request Error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - code: invalid_request_error - message: Discount with code TEST already exists. - type: duplicate_error - not_found_error: - description: Not Found Error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - message: Entity with id 1 was not found - type: not_found - 400_error: - description: Client Error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - examples: - not_allowed: - $ref: '#/components/examples/not_allowed_error' - invalid_data: - $ref: '#/components/examples/invalid_data_error' - 500_error: - description: Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - examples: - database: - $ref: '#/components/examples/database_error' - unexpected_state: - $ref: '#/components/examples/unexpected_state_error' - invalid_argument: - $ref: '#/components/examples/invalid_argument_error' - default_error: - $ref: '#/components/examples/default_error' - unauthorized: - description: User is not authorized. Must log in first - content: - text/plain: - schema: - type: string - default: Unauthorized - example: Unauthorized - incorrect_credentials: - description: User does not exist or incorrect credentials - content: - text/plain: - schema: - type: string - default: Unauthorized - example: Unauthorized - examples: - not_allowed_error: - summary: Not Allowed Error - value: - message: Discount must be set to dynamic - type: not_allowed - invalid_data_error: - summary: Invalid Data Error - value: - message: first_name must be a string - type: invalid_data - multiple_errors: - summary: Multiple Errors - value: - message: Provided request body contains errors. Please check the data and retry the request - errors: - - message: first_name must be a string - type: invalid_data - - message: Discount must be set to dynamic - type: not_allowed - database_error: - summary: Database Error - value: - code: api_error - message: An error occured while hashing password - type: database_error - unexpected_state_error: - summary: Unexpected State Error - value: - message: cart.total must be defined - type: unexpected_state - invalid_argument_error: - summary: Invalid Argument Error - value: - message: cart.total must be defined - type: unexpected_state - default_error: - summary: Default Error - value: - code: unknown_error - message: An unknown error occurred. - type: unknown_error - securitySchemes: - jwt_token: - type: http - x-displayName: JWT Token - scheme: bearer - cookie_auth: - type: apiKey - x-displayName: Cookie Session ID - in: cookie - name: connect.sid - description: | - Use a cookie session to send authenticated requests. - - ### How to Obtain the Cookie Session - - If you're sending requests through a browser, using JS Client, or using tools like Postman, the cookie session should be automatically set when the customer is logged in. - - If you're sending requests using cURL, you must set the Session ID in the cookie manually. - - To do that, send a request to [authenticate the customer](#tag/Auth/operation/PostAuth) and pass the cURL option `-v`: - - ```bash - curl -v --location --request POST 'https://medusa-url.com/store/auth' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "email": "user@example.com", - "password": "supersecret" - }' - ``` - - The headers will be logged in the terminal as well as the response. You should find in the headers a Cookie header similar to this: - - ```bash - Set-Cookie: connect.sid=s%3A2Bu8BkaP9JUfHu9rG59G16Ma0QZf6Gj1.WT549XqX37PN8n0OecqnMCq798eLjZC5IT7yiDCBHPM; - ``` - - Copy the value after `connect.sid` (without the `;` at the end) and pass it as a cookie in subsequent requests as the following: - - ```bash - curl --location --request GET 'https://medusa-url.com/store/customers/me/orders' \ - --header 'Cookie: connect.sid={sid}' - ``` - - Where `{sid}` is the value of `connect.sid` that you copied. schemas: + AdminApiKeyResponse: + type: object + description: SUMMARY + x-schemaName: AdminApiKeyResponse + required: + - api_key + properties: + api_key: + $ref: '#/components/schemas/ApiKeyResponse' AdminArchiveOrder: type: object description: SUMMARY @@ -4178,10 +10733,382 @@ components: type: boolean title: deleted description: The deleted's details. + AdminCampaignResponse: + type: object + description: SUMMARY + x-schemaName: AdminCampaignResponse + required: + - campaign + properties: + campaign: + $ref: '#/components/schemas/CampaignResponse' AdminCancelFulfillment: type: object description: SUMMARY x-schemaName: AdminCancelFulfillment + AdminClaim: + type: object + description: The claim's details. + x-schemaName: AdminClaim + required: + - order_id + - claim_items + - additional_items + - currency_code + - id + - region_id + - customer_id + - sales_channel_id + - email + - shipping_methods + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total + properties: + order_id: + type: string + title: order_id + description: The claim's order id. + claim_items: + type: array + description: The claim's claim items. + items: + $ref: '#/components/schemas/BaseClaimItem' + additional_items: + type: array + description: The claim's additional items. + items: {} + return: + $ref: '#/components/schemas/Return' + return_id: + type: string + title: return_id + description: The claim's return id. + no_notification: + type: boolean + title: no_notification + description: The claim's no notification. + refund_amount: + type: number + title: refund_amount + description: The claim's refund amount. + currency_code: + type: string + title: currency_code + description: The claim's currency code. + id: + type: string + title: id + description: The claim's ID. + region_id: + type: string + title: region_id + description: The claim's region id. + customer_id: + type: string + title: customer_id + description: The claim's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The claim's sales channel id. + email: + type: string + title: email + description: The claim's email. + format: email + display_id: + type: string + title: display_id + description: The claim's display id. + shipping_address: + $ref: '#/components/schemas/BaseOrderAddress' + billing_address: + $ref: '#/components/schemas/BaseOrderAddress' + shipping_methods: + type: array + description: The claim's shipping methods. + items: + $ref: '#/components/schemas/BaseOrderShippingMethod' + payment_collections: + type: array + description: The claim's payment collections. + items: + $ref: '#/components/schemas/BasePaymentCollection' + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The claim's fulfillments. + items: + $ref: '#/components/schemas/BaseOrderFulfillment' + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The claim's transactions. + items: + $ref: '#/components/schemas/BaseOrderTransaction' + summary: + $ref: '#/components/schemas/BaseOrderSummary' + metadata: + type: object + description: The claim's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The claim's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The claim's updated at. + original_item_total: + type: number + title: original_item_total + description: The claim's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The claim's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The claim's original item tax total. + item_total: + type: number + title: item_total + description: The claim's item total. + item_subtotal: + type: number + title: item_subtotal + description: The claim's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The claim's item tax total. + original_total: + type: number + title: original_total + description: The claim's original total. + original_subtotal: + type: number + title: original_subtotal + description: The claim's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The claim's original tax total. + total: + type: number + title: total + description: The claim's total. + subtotal: + type: number + title: subtotal + description: The claim's subtotal. + tax_total: + type: number + title: tax_total + description: The claim's tax total. + discount_total: + type: number + title: discount_total + description: The claim's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The claim's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The claim's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The claim's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The claim's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The claim's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The claim's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The claim's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The claim's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The claim's original shipping tax total. + AdminClaimDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminClaimDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The claim's ID. + object: + type: string + title: object + description: The claim's object. + default: claim + deleted: + type: boolean + title: deleted + description: The claim's deleted. + parent: + type: object + description: The claim's parent. + AdminClaimListResponse: + type: object + description: SUMMARY + x-schemaName: AdminClaimListResponse + required: + - limit + - offset + - count + - claims + properties: + limit: + type: number + title: limit + description: The claim's limit. + offset: + type: number + title: offset + description: The claim's offset. + count: + type: number + title: count + description: The claim's count. + claims: + type: array + description: The claim's claims. + items: + $ref: '#/components/schemas/AdminClaim' + AdminClaimOrderResponse: + type: object + description: SUMMARY + x-schemaName: AdminClaimOrderResponse + required: + - order + - claim + properties: + order: + $ref: '#/components/schemas/Order' + claim: + $ref: '#/components/schemas/AdminClaim' + AdminClaimPreviewResponse: + type: object + description: SUMMARY + x-schemaName: AdminClaimPreviewResponse + required: + - order_preview + - claim + properties: + order_preview: + $ref: '#/components/schemas/Order' + claim: + $ref: '#/components/schemas/AdminClaim' + AdminClaimRequestResponse: + type: object + description: SUMMARY + x-schemaName: AdminClaimRequestResponse + required: + - return + - order_preview + - claim + properties: + return: + $ref: '#/components/schemas/AdminReturn' + order_preview: + $ref: '#/components/schemas/Order' + claim: + $ref: '#/components/schemas/AdminClaim' + AdminClaimResponse: + type: object + description: SUMMARY + x-schemaName: AdminClaimResponse + required: + - claim + properties: + claim: + $ref: '#/components/schemas/AdminClaim' + AdminClaimReturnPreviewResponse: + type: object + description: SUMMARY + x-schemaName: AdminClaimReturnPreviewResponse + required: + - order_preview + - return + properties: + order_preview: + $ref: '#/components/schemas/Order' + return: + $ref: '#/components/schemas/AdminReturn' AdminCollection: type: object description: The parent's collection. @@ -4230,17 +11157,67 @@ components: metadata: type: object description: The collection's metadata. - AdminCompleteOrder: + AdminCollectionDeleteResponse: type: object description: SUMMARY - x-schemaName: AdminCompleteOrder + x-schemaName: AdminCollectionDeleteResponse required: - - order_id + - id + - object + - deleted properties: - order_id: + id: type: string - title: order_id - description: The order's order id. + title: id + description: The collection's ID. + object: + type: string + title: object + description: The collection's object. + default: collection + deleted: + type: boolean + title: deleted + description: The collection's deleted. + parent: + type: object + description: The collection's parent. + AdminCollectionListResponse: + type: object + description: SUMMARY + x-schemaName: AdminCollectionListResponse + required: + - limit + - offset + - count + - collections + properties: + limit: + type: number + title: limit + description: The collection's limit. + offset: + type: number + title: offset + description: The collection's offset. + count: + type: number + title: count + description: The collection's count. + collections: + type: array + description: The collection's collections. + items: + $ref: '#/components/schemas/AdminCollection' + AdminCollectionResponse: + type: object + description: SUMMARY + x-schemaName: AdminCollectionResponse + required: + - collection + properties: + collection: + $ref: '#/components/schemas/AdminCollection' AdminCreateApiKey: type: object description: SUMMARY @@ -4277,115 +11254,6 @@ components: metadata: type: object description: The collection's metadata. - AdminCreateCustomer: - type: object - description: SUMMARY - x-schemaName: AdminCreateCustomer - required: - - email - - company_name - - first_name - - last_name - - phone - - metadata - properties: - email: - type: string - title: email - description: The customer's email. - format: email - company_name: - type: string - title: company_name - description: The customer's company name. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - phone: - type: string - title: phone - description: The customer's phone. - metadata: - type: object - description: The customer's metadata. - AdminCreateCustomerAddress: - type: object - description: SUMMARY - x-schemaName: AdminCreateCustomerAddress - required: - - address_name - - company - - first_name - - last_name - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - phone - - metadata - properties: - address_name: - type: string - title: address_name - description: The customer's address name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: The customer's is default shipping. - is_default_billing: - type: boolean - title: is_default_billing - description: The customer's is default billing. - company: - type: string - title: company - description: The customer's company. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - address_1: - type: string - title: address_1 - description: The customer's address 1. - address_2: - type: string - title: address_2 - description: The customer's address 2. - city: - type: string - title: city - description: The customer's city. - country_code: - type: string - title: country_code - description: The customer's country code. - province: - type: string - title: province - description: The customer's province. - postal_code: - type: string - title: postal_code - description: The customer's postal code. - phone: - type: string - title: phone - description: The customer's phone. - metadata: - type: object - description: The customer's metadata. AdminCreateCustomerGroup: type: object description: SUMMARY @@ -4760,15 +11628,13 @@ components: items: type: object description: The tag's tags. + required: + - id properties: id: type: string title: id description: The tag's ID. - value: - type: string - title: value - description: The tag's value. options: type: array description: The create's options. @@ -5245,6 +12111,46 @@ components: type: string title: transaction_id description: The workflows execution's transaction id. + AdminCurrency: + type: object + description: The supported currency's currency. + x-schemaName: AdminCurrency + AdminCurrencyListResponse: + type: object + description: SUMMARY + x-schemaName: AdminCurrencyListResponse + required: + - limit + - offset + - count + - currencies + properties: + limit: + type: number + title: limit + description: The currency's limit. + offset: + type: number + title: offset + description: The currency's offset. + count: + type: number + title: count + description: The currency's count. + currencies: + type: array + description: The currency's currencies. + items: + $ref: '#/components/schemas/AdminCurrency' + AdminCurrencyResponse: + type: object + description: SUMMARY + x-schemaName: AdminCurrencyResponse + required: + - currency + properties: + currency: + $ref: '#/components/schemas/AdminCurrency' AdminCustomer: type: object description: The customer's details. @@ -5329,6 +12235,112 @@ components: format: date-time title: updated_at description: The customer's updated at. + AdminCustomerAddress: + type: object + description: The customer's address. + x-schemaName: AdminCustomerAddress + 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. + AdminCustomerAddressResponse: + type: object + description: SUMMARY + x-schemaName: AdminCustomerAddressResponse + required: + - address + properties: + address: + $ref: '#/components/schemas/AdminCustomerAddress' AdminCustomerGroup: type: object description: The group's groups. @@ -5367,6 +12379,345 @@ components: format: date-time title: updated_at description: The group's updated at. + AdminCustomerGroupResponse: + type: object + description: SUMMARY + x-schemaName: AdminCustomerGroupResponse + required: + - customer_group + properties: + customer_group: + $ref: '#/components/schemas/AdminCustomerGroup' + AdminCustomerResponse: + type: object + description: SUMMARY + x-schemaName: AdminCustomerResponse + required: + - customer + properties: + customer: + $ref: '#/components/schemas/AdminCustomer' + AdminDraftOrderResponse: + type: object + description: SUMMARY + x-schemaName: AdminDraftOrderResponse + required: + - draft_order + properties: + draft_order: + $ref: '#/components/schemas/AdminOrder' + AdminExchange: + type: object + description: The exchange's details. + x-schemaName: AdminExchange + required: + - order_id + - return_items + - additional_items + - currency_code + - id + - region_id + - customer_id + - sales_channel_id + - email + - shipping_methods + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total + properties: + order_id: + type: string + title: order_id + description: The exchange's order id. + return_items: + type: array + description: The exchange's return items. + items: + $ref: '#/components/schemas/AdminReturnItem' + additional_items: + type: array + description: The exchange's additional items. + items: + $ref: '#/components/schemas/BaseExchangeItem' + no_notification: + type: boolean + title: no_notification + description: The exchange's no notification. + difference_due: + type: number + title: difference_due + description: The exchange's difference due. + return: + $ref: '#/components/schemas/AdminReturn' + return_id: + type: string + title: return_id + description: The exchange's return id. + currency_code: + type: string + title: currency_code + description: The exchange's currency code. + id: + type: string + title: id + description: The exchange's ID. + region_id: + type: string + title: region_id + description: The exchange's region id. + customer_id: + type: string + title: customer_id + description: The exchange's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The exchange's sales channel id. + email: + type: string + title: email + description: The exchange's email. + format: email + display_id: + type: string + title: display_id + description: The exchange's display id. + shipping_address: + $ref: '#/components/schemas/BaseOrderAddress' + billing_address: + $ref: '#/components/schemas/BaseOrderAddress' + shipping_methods: + type: array + description: The exchange's shipping methods. + items: + $ref: '#/components/schemas/BaseOrderShippingMethod' + payment_collections: + type: array + description: The exchange's payment collections. + items: + $ref: '#/components/schemas/BasePaymentCollection' + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The exchange's fulfillments. + items: + $ref: '#/components/schemas/BaseOrderFulfillment' + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The exchange's transactions. + items: + $ref: '#/components/schemas/BaseOrderTransaction' + summary: + $ref: '#/components/schemas/BaseOrderSummary' + metadata: + type: object + description: The exchange's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The exchange's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The exchange's updated at. + original_item_total: + type: number + title: original_item_total + description: The exchange's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The exchange's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The exchange's original item tax total. + item_total: + type: number + title: item_total + description: The exchange's item total. + item_subtotal: + type: number + title: item_subtotal + description: The exchange's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The exchange's item tax total. + original_total: + type: number + title: original_total + description: The exchange's original total. + original_subtotal: + type: number + title: original_subtotal + description: The exchange's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The exchange's original tax total. + total: + type: number + title: total + description: The exchange's total. + subtotal: + type: number + title: subtotal + description: The exchange's subtotal. + tax_total: + type: number + title: tax_total + description: The exchange's tax total. + discount_total: + type: number + title: discount_total + description: The exchange's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The exchange's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The exchange's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The exchange's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The exchange's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The exchange's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The exchange's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The exchange's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The exchange's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The exchange's original shipping tax total. + AdminExchangeOrderResponse: + type: object + description: SUMMARY + x-schemaName: AdminExchangeOrderResponse + required: + - order + - exchange + properties: + order: + $ref: '#/components/schemas/Order' + exchange: + $ref: '#/components/schemas/AdminExchange' + AdminExchangePreviewResponse: + type: object + description: SUMMARY + x-schemaName: AdminExchangePreviewResponse + required: + - order_preview + - exchange + properties: + order_preview: + $ref: '#/components/schemas/Order' + exchange: + $ref: '#/components/schemas/AdminExchange' + AdminExchangeRequestResponse: + type: object + description: SUMMARY + x-schemaName: AdminExchangeRequestResponse + required: + - return + - order_preview + - exchange + properties: + return: + $ref: '#/components/schemas/AdminReturn' + order_preview: + $ref: '#/components/schemas/Order' + exchange: + $ref: '#/components/schemas/AdminExchange' + AdminExchangeResponse: + type: object + description: SUMMARY + x-schemaName: AdminExchangeResponse + required: + - exchange + properties: + exchange: + $ref: '#/components/schemas/AdminExchange' + AdminExchangeReturnResponse: + type: object + description: SUMMARY + x-schemaName: AdminExchangeReturnResponse + required: + - order_preview + - return + properties: + order_preview: + $ref: '#/components/schemas/Order' + return: + $ref: '#/components/schemas/AdminReturn' AdminExportProductRequest: type: object description: SUMMARY @@ -5382,10 +12733,374 @@ components: type: string title: transaction_id description: The product's transaction id. + AdminFile: + type: object + description: The upload's file. + x-schemaName: AdminFile + required: + - id + - url + properties: + id: + type: string + title: id + description: The file's ID. + url: + type: string + title: url + description: The file's url. + AdminFileListResponse: + type: object + description: SUMMARY + x-schemaName: AdminFileListResponse + required: + - files + properties: + files: + type: array + description: The upload's files. + items: + $ref: '#/components/schemas/AdminFile' + AdminFileResponse: + type: object + description: SUMMARY + x-schemaName: AdminFileResponse + required: + - file + properties: + file: + $ref: '#/components/schemas/AdminFile' + AdminFulfillment: + type: object + description: The fulfillment's details. + x-schemaName: AdminFulfillment + required: + - id + - location_id + - provider_id + - shipping_option_id + - provider + - delivery_address + - items + - labels + - packed_at + - shipped_at + - delivered_at + - canceled_at + - data + - metadata + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The fulfillment's ID. + location_id: + type: string + title: location_id + description: The fulfillment's location id. + provider_id: + type: string + title: provider_id + description: The fulfillment's provider id. + shipping_option_id: + type: string + title: shipping_option_id + description: The fulfillment's shipping option id. + provider: + $ref: '#/components/schemas/AdminFulfillmentProvider' + delivery_address: + $ref: '#/components/schemas/AdminFulfillmentAddress' + items: + type: array + description: The fulfillment's items. + items: + $ref: '#/components/schemas/AdminFulfillmentItem' + labels: + type: array + description: The fulfillment's labels. + items: + $ref: '#/components/schemas/AdminFulfillmentLabel' + packed_at: + type: string + title: packed_at + description: The fulfillment's packed at. + shipped_at: + type: string + title: shipped_at + description: The fulfillment's shipped at. + delivered_at: + type: string + title: delivered_at + description: The fulfillment's delivered at. + canceled_at: + type: string + title: canceled_at + description: The fulfillment's canceled at. + data: + type: object + description: The fulfillment's data. + metadata: + type: object + description: The fulfillment's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The fulfillment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The fulfillment's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The fulfillment's deleted at. + AdminFulfillmentAddress: + type: object + description: The fulfillment's delivery address. + x-schemaName: AdminFulfillmentAddress + required: + - id + - fulfillment_id + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The delivery address's ID. + fulfillment_id: + type: string + title: fulfillment_id + description: The delivery address's fulfillment id. + company: + type: string + title: company + description: The delivery address's company. + first_name: + type: string + title: first_name + description: The delivery address's first name. + last_name: + type: string + title: last_name + description: The delivery address's last name. + address_1: + type: string + title: address_1 + description: The delivery address's address 1. + address_2: + type: string + title: address_2 + description: The delivery address's address 2. + city: + type: string + title: city + description: The delivery address's city. + country_code: + type: string + title: country_code + description: The delivery address's country code. + province: + type: string + title: province + description: The delivery address's province. + postal_code: + type: string + title: postal_code + description: The delivery address's postal code. + phone: + type: string + title: phone + description: The delivery address's phone. + metadata: + type: object + description: The delivery address's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The delivery address's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The delivery address's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The delivery address's deleted at. + AdminFulfillmentItem: + type: object + description: The item's items. + x-schemaName: AdminFulfillmentItem + required: + - id + - title + - quantity + - sku + - barcode + - line_item_id + - inventory_item_id + - fulfillment_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + quantity: + type: number + title: quantity + description: The item's quantity. + sku: + type: string + title: sku + description: The item's sku. + barcode: + type: string + title: barcode + description: The item's barcode. + line_item_id: + type: string + title: line_item_id + description: The item's line item id. + inventory_item_id: + type: string + title: inventory_item_id + description: The item's inventory item id. + fulfillment_id: + type: string + title: fulfillment_id + description: The item's fulfillment id. + created_at: + type: string + format: date-time + title: created_at + description: The item's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The item's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The item's deleted at. + AdminFulfillmentLabel: + type: object + description: The label's labels. + x-schemaName: AdminFulfillmentLabel + required: + - id + - tracking_number + - tracking_url + - label_url + - fulfillment_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The label's ID. + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + fulfillment_id: + type: string + title: fulfillment_id + description: The label's fulfillment id. + created_at: + type: string + format: date-time + title: created_at + description: The label's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The label's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The label's deleted at. AdminFulfillmentProvider: type: object - description: The shipping option's provider. + description: The fulfillment provider's fulfillment providers. x-schemaName: AdminFulfillmentProvider + AdminFulfillmentProviderListResponse: + type: object + description: SUMMARY + x-schemaName: AdminFulfillmentProviderListResponse + required: + - limit + - offset + - count + - fulfillment_providers + properties: + limit: + type: number + title: limit + description: The fulfillment provider's limit. + offset: + type: number + title: offset + description: The fulfillment provider's offset. + count: + type: number + title: count + description: The fulfillment provider's count. + fulfillment_providers: + type: array + description: The fulfillment provider's fulfillment providers. + items: + $ref: '#/components/schemas/AdminFulfillmentProvider' + AdminFulfillmentResponse: + type: object + description: SUMMARY + x-schemaName: AdminFulfillmentResponse + required: + - fulfillment + properties: + fulfillment: + $ref: '#/components/schemas/AdminFulfillment' AdminFulfillmentSet: type: object description: The fulfillment set's details. @@ -5394,6 +13109,7 @@ components: - id - name - type + - location - service_zones - created_at - updated_at @@ -5411,6 +13127,8 @@ components: 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. @@ -5514,109 +13232,1403 @@ components: type: number title: toUpdate description: The summary's toupdate. - AdminOrderCancelFulfillment: + AdminInventoryItem: type: object - description: SUMMARY - x-schemaName: AdminOrderCancelFulfillment - properties: - no_notification: - type: boolean - title: no_notification - description: The order's no notification. - AdminOrderCreateFulfillment: - type: object - description: SUMMARY - x-schemaName: AdminOrderCreateFulfillment + description: The inventory item's details. + x-schemaName: AdminInventoryItem required: - - items - - location_id - - metadata + - id + - requires_shipping properties: - items: - type: array - description: The order's items. - items: - 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. - location_id: + id: type: string - title: location_id - description: The order's location id. - no_notification: + title: id + description: The inventory item's ID. + sku: + type: string + title: sku + description: The inventory item's sku. + origin_country: + type: string + title: origin_country + description: The inventory item's origin country. + hs_code: + type: string + title: hs_code + description: The inventory item's hs code. + requires_shipping: type: boolean - title: no_notification - description: The order's no notification. + title: requires_shipping + description: The inventory item's requires shipping. + 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. + 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. + title: + type: string + title: title + description: The inventory item's title. + description: + type: string + title: description + description: The inventory item's description. + thumbnail: + type: string + title: thumbnail + description: The inventory item's thumbnail. metadata: type: object - description: The order's metadata. - AdminOrderCreateShipment: + description: The inventory item's metadata. + AdminInventoryItemResponse: type: object description: SUMMARY - x-schemaName: AdminOrderCreateShipment + x-schemaName: AdminInventoryItemResponse required: - - items - - metadata + - inventory_item properties: + inventory_item: + $ref: '#/components/schemas/AdminInventoryItem' + AdminInvite: + type: object + description: The invite's details. + x-schemaName: AdminInvite + required: + - id + - email + - accepted + - token + properties: + id: + type: string + title: id + description: The invite's ID. + email: + type: string + title: email + description: The invite's email. + format: email + accepted: + type: boolean + title: accepted + description: The invite's accepted. + token: + type: string + title: token + description: The invite's token. + expires_at: + type: string + title: expires_at + description: The invite's expires at. + format: date-time + metadata: + type: object + description: The invite's metadata. + created_at: + type: string + title: created_at + description: The invite's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The invite's updated at. + format: date-time + AdminInviteResponse: + type: object + description: SUMMARY + x-schemaName: AdminInviteResponse + required: + - invite + properties: + invite: + $ref: '#/components/schemas/AdminInvite' + AdminNotification: + type: object + description: The notification's details. + x-schemaName: AdminNotification + required: + - id + - to + - channel + - template + - provider_id + - created_at + properties: + id: + type: string + title: id + description: The notification's ID. + to: + type: string + title: to + description: The notification's to. + channel: + type: string + title: channel + description: The notification's channel. + template: + type: string + title: template + description: The notification's template. + data: + type: object + description: The notification's data. + trigger_type: + type: string + title: trigger_type + description: The notification's trigger type. + resource_id: + type: string + title: resource_id + description: The notification's resource id. + resource_type: + type: string + title: resource_type + description: The notification's resource type. + receiver_id: + type: string + title: receiver_id + description: The notification's receiver id. + original_notification_id: + type: string + title: original_notification_id + description: The notification's original notification id. + external_id: + type: string + title: external_id + description: The notification's external id. + provider_id: + type: string + title: provider_id + description: The notification's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The notification's created at. + AdminNotificationListResponse: + type: object + description: SUMMARY + x-schemaName: AdminNotificationListResponse + required: + - limit + - offset + - count + - notifications + properties: + limit: + type: number + title: limit + description: The notification's limit. + offset: + type: number + title: offset + description: The notification's offset. + count: + type: number + title: count + description: The notification's count. + notifications: + type: array + description: The notification's notifications. + items: + $ref: '#/components/schemas/AdminNotification' + AdminNotificationResponse: + type: object + description: SUMMARY + x-schemaName: AdminNotificationResponse + required: + - notification + properties: + notification: + $ref: '#/components/schemas/AdminNotification' + AdminOrder: + type: object + description: The order's details. + x-schemaName: AdminOrder + required: + - payment_collections + - id + - version + - region_id + - customer_id + - sales_channel_id + - email + - currency_code + - items + - shipping_methods + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total + properties: + payment_collections: + type: array + description: The order's payment collections. + items: + $ref: '#/components/schemas/AdminPaymentCollection' + id: + type: string + title: id + description: The order's ID. + version: + type: number + title: version + description: The order's version. + region_id: + type: string + title: region_id + description: The order's region id. + customer_id: + type: string + title: customer_id + description: The order's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order's sales channel id. + email: + type: string + title: email + description: The order's email. + format: email + currency_code: + type: string + title: currency_code + description: The order's currency code. + display_id: + type: string + 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. items: - 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. - labels: + $ref: '#/components/schemas/BaseOrderLineItem' + shipping_methods: type: array - description: The order's labels. + description: The order's shipping methods. items: - type: object - description: The label's labels. - required: - - tracking_number - - tracking_url - - label_url - properties: - tracking_number: - type: string - title: tracking_number - description: The label's tracking number. - tracking_url: - type: string - title: tracking_url - description: The label's tracking url. - label_url: - type: string - title: label_url - description: The label's label url. - no_notification: - type: boolean - title: no_notification - description: The order's no notification. + $ref: '#/components/schemas/BaseOrderShippingMethod' + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The order's fulfillments. + items: + $ref: '#/components/schemas/BaseOrderFulfillment' + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The order's transactions. + items: + $ref: '#/components/schemas/BaseOrderTransaction' + summary: + $ref: '#/components/schemas/BaseOrderSummary' metadata: type: object description: The order's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The order's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order's updated at. + original_item_total: + type: number + title: original_item_total + description: The order's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The order's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The order's original item tax total. + item_total: + type: number + title: item_total + description: The order's item total. + item_subtotal: + type: number + title: item_subtotal + description: The order's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The order's item tax total. + original_total: + type: number + title: original_total + description: The order's original total. + original_subtotal: + type: number + title: original_subtotal + description: The order's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The order's original tax total. + total: + type: number + title: total + description: The order's total. + subtotal: + type: number + title: subtotal + description: The order's subtotal. + tax_total: + type: number + title: tax_total + description: The order's tax total. + discount_total: + type: number + title: discount_total + description: The order's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The order's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The order's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The order's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The order's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The order's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The order's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The order's original shipping tax total. + AdminOrderPreview: + type: object + description: The return's order preview. + x-schemaName: AdminOrderPreview + required: + - return_requested_total + - order_change + - currency_code + - id + - version + - region_id + - customer_id + - sales_channel_id + - email + - payment_collections + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total + properties: + return_requested_total: + type: number + title: return_requested_total + description: The order preview's return requested total. + order_change: + $ref: '#/components/schemas/BaseOrderChange' + items: + type: array + description: The order preview's items. + items: + allOf: + - type: object + description: The item's items. + x-schemaName: BaseOrderLineItem + required: + - id + - title + - subtitle + - thumbnail + - variant_id + - product_id + - product_title + - product_description + - product_subtitle + - product_type + - product_collection + - product_handle + - variant_sku + - variant_barcode + - variant_title + - variant_option_values + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - detail + - created_at + - updated_at + - metadata + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant: + $ref: '#/components/schemas/BaseProductVariant' + variant_id: + type: string + title: variant_id + description: The item's variant id. + product: + $ref: '#/components/schemas/BaseProduct' + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: '#/components/schemas/BaseOrderLineItemTaxLine' + adjustments: + type: array + description: The item's adjustments. + items: + $ref: '#/components/schemas/BaseOrderLineItemAdjustment' + detail: + $ref: '#/components/schemas/BaseOrderItemDetail' + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + metadata: + type: object + description: The item's metadata. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: object + description: The item's items. + properties: + actions: + type: array + description: The item's actions. + items: + type: object + description: The action's actions. + x-schemaName: BaseOrderChangeAction + shipping_methods: + type: array + description: The order preview's shipping methods. + items: + allOf: + - type: object + description: The shipping method's shipping methods. + x-schemaName: BaseOrderShippingMethod + required: + - id + - order_id + - name + - amount + - is_tax_inclusive + - shipping_option_id + - data + - metadata + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: '#/components/schemas/BaseOrderShippingMethodTaxLine' + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: '#/components/schemas/BaseOrderShippingMethodAdjustment' + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: discount_tax_total + description: The shipping method's discount tax total. + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - $ref: '#/components/schemas/IBigNumber' + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + - type: object + description: The shipping method's shipping methods. + properties: + actions: + type: array + description: The shipping method's actions. + items: + type: object + description: The action's actions. + x-schemaName: BaseOrderChangeAction + currency_code: + type: string + title: currency_code + description: The order preview's currency code. + id: + type: string + title: id + description: The order preview's ID. + version: + type: number + title: version + description: The order preview's version. + region_id: + type: string + title: region_id + description: The order preview's region id. + customer_id: + type: string + title: customer_id + description: The order preview's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order preview's sales channel id. + email: + type: string + title: email + description: The order preview's email. + format: email + display_id: + type: string + title: display_id + description: The order preview's display id. + shipping_address: + $ref: '#/components/schemas/BaseOrderAddress' + billing_address: + $ref: '#/components/schemas/BaseOrderAddress' + payment_collections: + type: array + description: The order preview's payment collections. + items: + $ref: '#/components/schemas/AdminPaymentCollection' + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The order preview's fulfillments. + items: + $ref: '#/components/schemas/BaseOrderFulfillment' + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The order preview's transactions. + items: + $ref: '#/components/schemas/BaseOrderTransaction' + summary: + $ref: '#/components/schemas/BaseOrderSummary' + metadata: + type: object + description: The order preview's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The order preview's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order preview's updated at. + original_item_total: + type: number + title: original_item_total + description: The order preview's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The order preview's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The order preview's original item tax total. + item_total: + type: number + title: item_total + description: The order preview's item total. + item_subtotal: + type: number + title: item_subtotal + description: The order preview's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The order preview's item tax total. + original_total: + type: number + title: original_total + description: The order preview's original total. + original_subtotal: + type: number + title: original_subtotal + description: The order preview's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The order preview's original tax total. + total: + type: number + title: total + description: The order preview's total. + subtotal: + type: number + title: subtotal + description: The order preview's subtotal. + tax_total: + type: number + title: tax_total + description: The order preview's tax total. + discount_total: + type: number + title: discount_total + description: The order preview's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The order preview's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The order preview's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The order preview's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The order preview's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order preview's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The order preview's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The order preview's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + AdminOrderPreviewResponse: + type: object + description: SUMMARY + x-schemaName: AdminOrderPreviewResponse + required: + - order + properties: + order: + $ref: '#/components/schemas/AdminOrderPreview' + AdminOrderResponse: + type: object + description: SUMMARY + x-schemaName: AdminOrderResponse + required: + - order + properties: + order: + $ref: '#/components/schemas/AdminOrder' + AdminOrderReturnResponse: + type: object + description: SUMMARY + x-schemaName: AdminOrderReturnResponse + required: + - order + - return + properties: + order: + $ref: '#/components/schemas/Order' + return: + $ref: '#/components/schemas/AdminReturn' + AdminPayment: + type: object + description: The payment's details. + x-schemaName: AdminPayment + required: + - id + - amount + - currency_code + - provider_id + properties: + id: + type: string + title: id + description: The payment's ID. + amount: + oneOf: + - type: string + title: amount + description: The payment's amount. + - type: number + title: amount + description: The payment's amount. + - type: string + title: amount + description: The payment's amount. + - $ref: '#/components/schemas/IBigNumber' + authorized_amount: + oneOf: + - type: string + title: authorized_amount + description: The payment's authorized amount. + - type: number + title: authorized_amount + description: The payment's authorized amount. + - type: string + title: authorized_amount + description: The payment's authorized amount. + - $ref: '#/components/schemas/IBigNumber' + currency_code: + type: string + title: currency_code + description: The payment's currency code. + provider_id: + type: string + title: provider_id + description: The payment's provider id. + cart_id: + type: string + title: cart_id + description: The payment's cart id. + order_id: + type: string + title: order_id + description: The payment's order id. + order_edit_id: + type: string + title: order_edit_id + description: The payment's order edit id. + customer_id: + type: string + title: customer_id + description: The payment's customer id. + data: + type: object + description: The payment's data. + created_at: + type: string + format: date-time + title: created_at + description: The payment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The payment's updated at. + captured_at: + oneOf: + - type: string + title: captured_at + description: The payment's captured at. + - type: string + title: captured_at + description: The payment's captured at. + format: date-time + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The payment's canceled at. + - type: string + title: canceled_at + description: The payment's canceled at. + format: date-time + captured_amount: + oneOf: + - type: string + title: captured_amount + description: The payment's captured amount. + - type: number + title: captured_amount + description: The payment's captured amount. + - type: string + title: captured_amount + description: The payment's captured amount. + - $ref: '#/components/schemas/IBigNumber' + refunded_amount: + oneOf: + - type: string + title: refunded_amount + description: The payment's refunded amount. + - type: number + title: refunded_amount + description: The payment's refunded amount. + - type: string + title: refunded_amount + description: The payment's refunded amount. + - $ref: '#/components/schemas/IBigNumber' + captures: + type: array + description: The payment's captures. + items: + $ref: '#/components/schemas/BaseCapture' + refunds: + type: array + description: The payment's refunds. + items: + $ref: '#/components/schemas/BaseRefund' + payment_collection: + $ref: '#/components/schemas/BasePaymentCollection' + payment_session: + $ref: '#/components/schemas/BasePaymentSession' + AdminPaymentCollection: + type: object + description: The payment collection's payment collections. + x-schemaName: AdminPaymentCollection + required: + - id + - currency_code + - region_id + - amount + - status + - payment_providers + properties: + id: + type: string + title: id + description: The payment collection's ID. + currency_code: + type: string + title: currency_code + description: The payment collection's currency code. + region_id: + type: string + title: region_id + description: The payment collection's region id. + amount: + oneOf: + - type: string + title: amount + description: The payment collection's amount. + - type: number + title: amount + description: The payment collection's amount. + - type: string + title: amount + description: The payment collection's amount. + - $ref: '#/components/schemas/IBigNumber' + authorized_amount: + oneOf: + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - type: number + title: authorized_amount + description: The payment collection's authorized amount. + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - $ref: '#/components/schemas/IBigNumber' + captured_amount: + oneOf: + - type: string + title: captured_amount + description: The payment collection's captured amount. + - type: number + title: captured_amount + description: The payment collection's captured amount. + - type: string + title: captured_amount + description: The payment collection's captured amount. + - $ref: '#/components/schemas/IBigNumber' + refunded_amount: + oneOf: + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - type: number + title: refunded_amount + description: The payment collection's refunded amount. + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - $ref: '#/components/schemas/IBigNumber' + completed_at: + oneOf: + - type: string + title: completed_at + description: The payment collection's completed at. + - type: string + title: completed_at + description: The payment collection's completed at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The payment collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The payment collection's updated at. + metadata: + type: object + description: The payment collection's metadata. + status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + payment_providers: + type: array + description: The payment collection's payment providers. + items: + $ref: '#/components/schemas/BasePaymentProvider' + payment_sessions: + type: array + description: The payment collection's payment sessions. + items: + $ref: '#/components/schemas/BasePaymentSession' + payments: + type: array + description: The payment collection's payments. + items: + $ref: '#/components/schemas/BasePayment' + AdminPaymentProvider: + type: object + description: The payment provider's payment providers. + x-schemaName: AdminPaymentProvider + AdminPaymentResponse: + type: object + description: SUMMARY + x-schemaName: AdminPaymentResponse + required: + - payment + properties: + payment: + $ref: '#/components/schemas/AdminPayment' AdminPostCancelClaimReqSchema: type: object description: SUMMARY @@ -5626,6 +14638,15 @@ components: type: boolean title: no_notification description: The claim's no notification. + AdminPostCancelExchangeReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostCancelExchangeReqSchema + properties: + no_notification: + type: boolean + title: no_notification + description: The exchange's no notification. AdminPostCancelReturnReqSchema: type: object description: SUMMARY @@ -5711,18 +14732,17 @@ components: type: object description: SUMMARY x-schemaName: AdminPostClaimsItemsActionReqSchema + required: + - reason_id properties: quantity: type: number title: quantity description: The claim's quantity. - reason: + reason_id: type: string - enum: - - missing_item - - wrong_item - - production_failure - - other + title: reason_id + description: The claim's reason id. internal_note: type: string title: internal_note @@ -5769,6 +14789,157 @@ components: metadata: type: object description: The claim's metadata. + AdminPostExchangesAddItemsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostExchangesAddItemsReqSchema + properties: + items: + type: array + description: The exchange's items. + items: + type: object + description: The item's items. + required: + - variant_id + - quantity + properties: + variant_id: + type: string + title: variant_id + description: The item's variant id. + quantity: + type: number + title: quantity + description: The item's quantity. + unit_price: + type: number + title: unit_price + description: The item's unit price. + internal_note: + type: string + title: internal_note + description: The item's internal note. + allow_backorder: + type: boolean + title: allow_backorder + description: The item's allow backorder. + metadata: + type: object + description: The item's metadata. + AdminPostExchangesRequestItemsReturnActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostExchangesRequestItemsReturnActionReqSchema + properties: + quantity: + type: number + title: quantity + description: The exchange's quantity. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. + reason_id: + type: string + title: reason_id + description: The exchange's reason id. + metadata: + type: object + description: The exchange's metadata. + AdminPostExchangesReturnRequestItemsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema + properties: + items: + type: array + description: The exchange's items. + items: + 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. + description: + type: string + title: description + description: The item's description. + internal_note: + type: string + title: internal_note + description: The item's internal note. + reason_id: + type: string + title: reason_id + description: The item's reason id. + metadata: + type: object + description: The item's metadata. + AdminPostExchangesShippingActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostExchangesShippingActionReqSchema + properties: + custom_price: + type: number + title: custom_price + description: The exchange's custom price. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. + metadata: + type: object + description: The exchange's metadata. + AdminPostExchangesShippingReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostExchangesShippingReqSchema + required: + - shipping_option_id + properties: + shipping_option_id: + type: string + title: shipping_option_id + description: The exchange's shipping option id. + custom_price: + type: number + title: custom_price + description: The exchange's custom price. + description: + type: string + title: description + description: The exchange's description. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. + metadata: + type: object + description: The exchange's metadata. + AdminPostExhangesItemsActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostExhangesItemsActionReqSchema + properties: + quantity: + type: number + title: quantity + description: The exchange's quantity. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. AdminPostOrderClaimsReqSchema: type: object description: SUMMARY @@ -5776,6 +14947,7 @@ components: required: - type - order_id + - reason_id - metadata properties: type: @@ -5795,9 +14967,36 @@ components: type: string title: internal_note description: The claim's internal note. + reason_id: + type: string + title: reason_id + description: The claim's reason id. metadata: type: object description: The claim's metadata. + AdminPostOrderExchangesReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostOrderExchangesReqSchema + required: + - order_id + - metadata + properties: + order_id: + type: string + title: order_id + description: The exchange's order id. + description: + type: string + title: description + description: The exchange's description. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. + metadata: + type: object + description: The exchange's metadata. AdminPostReceiveReturnsReqSchema: type: object description: SUMMARY @@ -6015,22 +15214,22 @@ components: shipping_option_id: type: string title: shipping_option_id - description: The claim's shipping option id. + description: The exchange's shipping option id. custom_price: type: number title: custom_price - description: The claim's custom price. + description: The exchange's custom price. description: type: string title: description - description: The claim's description. + description: The exchange's description. internal_note: type: string title: internal_note - description: The claim's internal note. + description: The exchange's internal note. metadata: type: object - description: The claim's metadata. + description: The exchange's metadata. AdminPrice: type: object description: The price's prices. @@ -6094,6 +15293,357 @@ components: format: date-time title: deleted_at description: The price's deleted at. + AdminPriceList: + type: object + description: The price list's details. + x-schemaName: AdminPriceList + required: + - id + - title + - description + - rules + - starts_at + - ends_at + - status + - type + - prices + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The price list's ID. + title: + type: string + title: title + description: The price list's title. + description: + type: string + title: description + description: The price list's description. + rules: + type: object + description: The price list's rules. + starts_at: + type: string + title: starts_at + description: The price list's starts at. + ends_at: + type: string + title: ends_at + description: The price list's ends at. + status: + type: string + enum: + - draft + - active + type: + type: string + enum: + - sale + - override + prices: + type: array + description: The price list's prices. + items: + $ref: '#/components/schemas/AdminPriceListPrice' + created_at: + type: string + format: date-time + title: created_at + description: The price list's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The price list's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The price list's deleted at. + AdminPriceListBatchResponse: + type: object + description: SUMMARY + x-schemaName: AdminPriceListBatchResponse + required: + - created + - updated + - deleted + properties: + created: + type: array + description: The price list's created. + items: + $ref: '#/components/schemas/AdminPrice' + updated: + type: array + description: The price list's updated. + items: + $ref: '#/components/schemas/AdminPrice' + deleted: + type: object + description: The price list's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. + AdminPriceListDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminPriceListDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The price list's ID. + object: + type: string + title: object + description: The price list's object. + default: price_list + deleted: + type: boolean + title: deleted + description: The price list's deleted. + parent: + type: object + description: The price list's parent. + AdminPriceListListResponse: + type: object + description: SUMMARY + x-schemaName: AdminPriceListListResponse + required: + - limit + - offset + - count + - price_lists + properties: + limit: + type: number + title: limit + description: The price list's limit. + offset: + type: number + title: offset + description: The price list's offset. + count: + type: number + title: count + description: The price list's count. + price_lists: + type: array + description: The price list's price lists. + items: + $ref: '#/components/schemas/AdminPriceList' + AdminPriceListPrice: + type: object + description: The price's prices. + x-schemaName: AdminPriceListPrice + required: + - variant_id + - rules + - id + - title + - currency_code + - amount + - raw_amount + - min_quantity + - max_quantity + - price_set_id + - created_at + - updated_at + - deleted_at + properties: + variant_id: + type: string + title: variant_id + description: The price's variant id. + rules: + type: object + description: The price's rules. + id: + type: string + title: id + description: The price's ID. + title: + type: string + title: title + description: The price's title. + currency_code: + type: string + title: currency_code + description: The price's currency code. + amount: + type: number + title: amount + description: The price's amount. + raw_amount: + type: object + description: The price's raw amount. + min_quantity: + type: number + title: min_quantity + description: The price's min quantity. + max_quantity: + type: number + title: max_quantity + description: The price's max quantity. + price_set_id: + type: string + title: price_set_id + description: The price's price set id. + created_at: + type: string + format: date-time + title: created_at + description: The price's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The price's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The price's deleted at. + AdminPriceListResponse: + type: object + description: SUMMARY + x-schemaName: AdminPriceListResponse + required: + - price_list + properties: + price_list: + $ref: '#/components/schemas/AdminPriceList' + AdminPricePreference: + type: object + description: The price preference's details. + x-schemaName: AdminPricePreference + required: + - id + - attribute + - value + - is_tax_inclusive + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The price preference's ID. + attribute: + type: string + title: attribute + description: The price preference's attribute. + value: + type: string + title: value + description: The price preference's value. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The price preference's is tax inclusive. + created_at: + type: string + format: date-time + title: created_at + description: The price preference's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The price preference's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The price preference's deleted at. + AdminPricePreferenceDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminPricePreferenceDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The price preference's ID. + object: + type: string + title: object + description: The price preference's object. + default: price_preference + deleted: + type: boolean + title: deleted + description: The price preference's deleted. + parent: + type: object + description: The price preference's parent. + AdminPricePreferenceListResponse: + type: object + description: SUMMARY + x-schemaName: AdminPricePreferenceListResponse + required: + - limit + - offset + - count + - price_preferences + properties: + limit: + type: number + title: limit + description: The price preference's limit. + offset: + type: number + title: offset + description: The price preference's offset. + count: + type: number + title: count + description: The price preference's count. + price_preferences: + type: array + description: The price preference's price preferences. + items: + $ref: '#/components/schemas/AdminPricePreference' + AdminPricePreferenceResponse: + type: object + description: SUMMARY + x-schemaName: AdminPricePreferenceResponse + required: + - price_preference + properties: + price_preference: + $ref: '#/components/schemas/AdminPricePreference' AdminProduct: type: object description: The product's parent. @@ -6106,25 +15656,25 @@ components: - options - description - id - - handle - - hs_code - - weight - - height - - width - - origin_country - - mid_code - - material - - thumbnail - created_at - updated_at - - deleted_at + - handle - subtitle - is_giftcard + - thumbnail + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material - collection_id - type_id - images - discountable - external_id + - deleted_at properties: collection: $ref: '#/components/schemas/AdminCollection' @@ -6181,42 +15731,6 @@ components: metadata: type: object description: The parent's metadata. - handle: - type: string - title: handle - description: The parent's handle. - hs_code: - type: string - title: hs_code - description: The parent's hs code. - weight: - type: number - title: weight - description: The parent's weight. - height: - type: number - title: height - description: The parent's height. - width: - type: number - title: width - description: The parent's width. - origin_country: - type: string - title: origin_country - description: The parent's origin country. - mid_code: - type: string - title: mid_code - description: The parent's mid code. - material: - type: string - title: material - description: The parent's material. - thumbnail: - type: string - title: thumbnail - description: The parent's thumbnail. created_at: type: string format: date-time @@ -6227,11 +15741,10 @@ components: format: date-time title: updated_at description: The parent's updated at. - deleted_at: + handle: type: string - format: date-time - title: deleted_at - description: The parent's deleted at. + title: handle + description: The parent's handle. subtitle: type: string title: subtitle @@ -6240,6 +15753,38 @@ components: type: boolean title: is_giftcard description: The parent's is giftcard. + thumbnail: + type: string + title: thumbnail + description: The parent's thumbnail. + width: + type: number + title: width + description: The parent's width. + weight: + type: number + title: weight + description: The parent's weight. + height: + type: number + title: height + description: The parent's height. + origin_country: + type: string + title: origin_country + description: The parent's origin country. + hs_code: + type: string + title: hs_code + description: The parent's hs code. + mid_code: + type: string + title: mid_code + description: The parent's mid code. + material: + type: string + title: material + description: The parent's material. collection_id: type: string title: collection_id @@ -6261,6 +15806,11 @@ components: type: string title: external_id description: The parent's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The parent's deleted at. AdminProductCategory: type: object description: The category's categories. @@ -6271,14 +15821,14 @@ components: - name - description - id - - handle - created_at - updated_at + - handle - deleted_at - - parent_category_id - - is_internal - is_active + - is_internal - rank + - parent_category_id properties: category_children: type: array @@ -6304,10 +15854,6 @@ components: type: string title: id description: The category's ID. - handle: - type: string - title: handle - description: The category's handle. created_at: type: string format: date-time @@ -6318,27 +15864,56 @@ components: format: date-time title: updated_at description: The category's updated at. + handle: + type: string + title: handle + description: The category's handle. deleted_at: type: string format: date-time title: deleted_at description: The category's deleted at. - parent_category_id: - type: string - title: parent_category_id - description: The category's parent category id. - is_internal: - type: boolean - title: is_internal - description: The category's is internal. is_active: type: boolean title: is_active description: The category's is active. + is_internal: + type: boolean + title: is_internal + description: The category's is internal. rank: type: number title: rank description: The category's rank. + parent_category_id: + type: string + title: parent_category_id + description: The category's parent category id. + AdminProductCategoryDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductCategoryDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The product category's ID. + object: + type: string + title: object + description: The product category's object. + default: product_category + deleted: + type: boolean + title: deleted + description: The product category's deleted. + parent: + type: object + description: The product category's parent. AdminProductCategoryListResponse: type: object description: SUMMARY @@ -6523,9 +16098,131 @@ components: metadata: type: object description: The tag's metadata. + AdminProductTagDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductTagDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The product tag's ID. + object: + type: string + title: object + description: The product tag's object. + default: product_tag + deleted: + type: boolean + title: deleted + description: The product tag's deleted. + parent: + type: object + description: The product tag's parent. + AdminProductTagListResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductTagListResponse + required: + - limit + - offset + - count + - product_tags + properties: + limit: + type: number + title: limit + description: The product tag's limit. + offset: + type: number + title: offset + description: The product tag's offset. + count: + type: number + title: count + description: The product tag's count. + product_tags: + type: array + description: The product tag's product tags. + items: + $ref: '#/components/schemas/AdminProductTag' + AdminProductTagResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductTagResponse + required: + - product_tag + properties: + product_tag: + $ref: '#/components/schemas/AdminProductTag' + AdminProductTypeDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductTypeDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The product type's ID. + object: + type: string + title: object + description: The product type's object. + default: product_type + deleted: + type: boolean + title: deleted + description: The product type's deleted. + parent: + type: object + description: The product type's parent. + AdminProductTypeListResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductTypeListResponse + required: + - limit + - offset + - count + - product_types + properties: + limit: + type: number + title: limit + description: The product type's limit. + offset: + type: number + title: offset + description: The product type's offset. + count: + type: number + title: count + description: The product type's count. + product_types: + type: array + description: The product type's product types. + items: + $ref: '#/components/schemas/AdminProduct' + AdminProductTypeResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductTypeResponse + required: + - product_type + properties: + product_type: + $ref: '#/components/schemas/AdminProduct' AdminProductVariant: type: object - description: The updated's details. + description: The product's parent. x-schemaName: AdminProductVariant required: - prices @@ -6552,80 +16249,80 @@ components: properties: prices: type: array - description: The updated's prices. + description: The parent's prices. items: $ref: '#/components/schemas/AdminPrice' id: type: string title: id - description: The updated's ID. + description: The parent's ID. title: type: string title: title - description: The updated's title. + description: The parent's title. sku: type: string title: sku - description: The updated's sku. + description: The parent's sku. barcode: type: string title: barcode - description: The updated's barcode. + description: The parent's barcode. ean: type: string title: ean - description: The updated's ean. + description: The parent's ean. upc: type: string title: upc - description: The updated's upc. + description: The parent's upc. allow_backorder: type: boolean title: allow_backorder - description: The updated's allow backorder. + description: The parent's allow backorder. manage_inventory: type: boolean title: manage_inventory - description: The updated's manage inventory. + description: The parent's manage inventory. hs_code: type: string title: hs_code - description: The updated's hs code. + description: The parent's hs code. origin_country: type: string title: origin_country - description: The updated's origin country. + description: The parent's origin country. mid_code: type: string title: mid_code - description: The updated's mid code. + description: The parent's mid code. material: type: string title: material - description: The updated's material. + description: The parent's material. weight: type: number title: weight - description: The updated's weight. + description: The parent's weight. length: type: number title: length - description: The updated's length. + description: The parent's length. height: type: number title: height - description: The updated's height. + description: The parent's height. width: type: number title: width - description: The updated's width. + description: The parent's width. variant_rank: type: number title: variant_rank - description: The updated's variant rank. + description: The parent's variant rank. options: type: array - description: The updated's options. + description: The parent's options. items: $ref: '#/components/schemas/BaseProductOptionValue' product: @@ -6633,27 +16330,27 @@ components: product_id: type: string title: product_id - description: The updated's product id. + description: The parent's product id. calculated_price: $ref: '#/components/schemas/BaseCalculatedPriceSet' created_at: type: string format: date-time title: created_at - description: The updated's created at. + description: The parent's created at. updated_at: type: string format: date-time title: updated_at - description: The updated's updated at. + description: The parent's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The updated's deleted at. + description: The parent's deleted at. metadata: type: object - description: The updated's metadata. + description: The parent's metadata. AdminProductVariantDeleteResponse: type: object description: SUMMARY @@ -6678,6 +16375,164 @@ components: description: The product's deleted. parent: $ref: '#/components/schemas/AdminProduct' + AdminProductVariantInventoryBatchResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductVariantInventoryBatchResponse + required: + - created + - updated + - deleted + properties: + created: + oneOf: + - $ref: '#/components/schemas/AdminProductVariantInventoryLink' + - type: array + description: The product's created. + items: + type: object + description: The created's details. + x-schemaName: AdminProductVariantInventoryLink + required: + - productService + - inventoryService + properties: + productService: + type: object + description: The created's productservice. + required: + - variant_id + properties: + variant_id: + type: string + title: variant_id + description: The productservice's variant id. + inventoryService: + type: object + description: The created's inventoryservice. + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventoryservice's inventory item id. + updated: + oneOf: + - $ref: '#/components/schemas/AdminProductVariantInventoryLink' + - type: array + description: The product's updated. + items: + type: object + description: The updated's details. + x-schemaName: AdminProductVariantInventoryLink + required: + - productService + - inventoryService + properties: + productService: + type: object + description: The updated's productservice. + required: + - variant_id + properties: + variant_id: + type: string + title: variant_id + description: The productservice's variant id. + inventoryService: + type: object + description: The updated's inventoryservice. + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventoryservice's inventory item id. + deleted: + oneOf: + - $ref: '#/components/schemas/AdminProductVariantInventoryLink' + - type: array + description: The product's deleted. + items: + type: object + description: The deleted's details. + x-schemaName: AdminProductVariantInventoryLink + required: + - productService + - inventoryService + properties: + productService: + type: object + description: The deleted's productservice. + required: + - variant_id + properties: + variant_id: + type: string + title: variant_id + description: The productservice's variant id. + inventoryService: + type: object + description: The deleted's inventoryservice. + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventoryservice's inventory item id. + AdminProductVariantInventoryLink: + type: object + description: The product's ID. + x-schemaName: AdminProductVariantInventoryLink + required: + - productService + - inventoryService + properties: + productService: + type: object + description: The id's productservice. + required: + - variant_id + properties: + variant_id: + type: string + title: variant_id + description: The productservice's variant id. + inventoryService: + type: object + description: The id's inventoryservice. + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventoryservice's inventory item id. + AdminProductVariantInventoryLinkDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductVariantInventoryLinkDeleteResponse + required: + - id + - object + - deleted + - parent + properties: + id: + $ref: '#/components/schemas/AdminProductVariantInventoryLink' + object: + type: string + title: object + description: The product's object. + deleted: + type: boolean + title: deleted + description: The product's deleted. + parent: + $ref: '#/components/schemas/AdminProductVariant' AdminProductVariantParams: type: object description: The product's variants. @@ -6743,218 +16598,20 @@ components: type: array description: The variant's $and. items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - sku: - oneOf: - - type: string - title: sku - description: The $and's sku. - - type: array - description: The $and's sku. - items: - type: string - title: sku - description: The sku's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $and's product id. - - type: array - description: The $and's product id. - items: - type: string - title: product_id - description: The product id's details. - options: - type: object - description: The $and's options. - limit: - type: number - title: limit - description: The $and's limit. - offset: - type: number - title: offset - description: The $and's offset. - order: - type: string - title: order - description: The $and's order. - fields: - type: string - title: fields - description: The $and's fields. - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $or's details. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $and's details. - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $or's details. + type: array + description: The $and's details. + items: + type: object + title: $and $or: type: array description: The variant's $or. items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - sku: - oneOf: - - type: string - title: sku - description: The $or's sku. - - type: array - description: The $or's sku. - items: - type: string - title: sku - description: The sku's details. - product_id: - oneOf: - - type: string - title: product_id - description: The $or's product id. - - type: array - description: The $or's product id. - items: - type: string - title: product_id - description: The product id's details. - options: - type: object - description: The $or's options. - limit: - type: number - title: limit - description: The $or's limit. - offset: - type: number - title: offset - description: The $or's offset. - order: - type: string - title: order - description: The $or's order. - fields: - type: string - title: fields - description: The $or's fields. - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $or's details. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: object - description: The $and's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $and's details. - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: object - description: The $or's details. - x-schemaName: BaseProductVariantParams - - type: object - description: The $or's details. + type: array + description: The $or's details. + items: + type: object + title: $or AdminProductVariantResponse: type: object description: SUMMARY @@ -6964,6 +16621,395 @@ components: properties: variant: $ref: '#/components/schemas/AdminProductVariant' + AdminPromotion: + type: object + description: The promotion's details. + x-schemaName: AdminPromotion + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. + code: + type: string + title: code + description: The promotion's code. + type: + type: string + enum: + - standard + - buyget + is_automatic: + type: boolean + title: is_automatic + description: The promotion's is automatic. + application_method: + $ref: '#/components/schemas/BaseApplicationMethod' + rules: + type: array + description: The promotion's rules. + items: + $ref: '#/components/schemas/BasePromotionRule' + campaign_id: + type: string + title: campaign_id + description: The promotion's campaign id. + campaign: + $ref: '#/components/schemas/CampaignResponse' + AdminPromotionResponse: + type: object + description: SUMMARY + x-schemaName: AdminPromotionResponse + required: + - promotion + properties: + promotion: + $ref: '#/components/schemas/AdminPromotion' + AdminPromotionRule: + type: object + description: The updated's details. + x-schemaName: AdminPromotionRule + required: + - id + - values + properties: + id: + type: string + title: id + description: The updated's ID. + description: + type: string + title: description + description: The updated's description. + attribute: + type: string + title: attribute + description: The updated's attribute. + operator: + type: string + enum: + - gt + - lt + - eq + - ne + - in + - lte + - gte + values: + type: array + description: The updated's values. + items: + $ref: '#/components/schemas/BasePromotionRuleValue' + AdminRefundReason: + type: object + description: The refund reason's details. + x-schemaName: AdminRefundReason + required: + - id + - label + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The refund reason's ID. + label: + type: string + title: label + description: The refund reason's label. + description: + type: string + title: description + description: The refund reason's description. + metadata: + type: object + description: The refund reason's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The refund reason's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The refund reason's updated at. + AdminRegion: + type: object + description: The region's details. + x-schemaName: AdminRegion + required: + - id + - name + - currency_code + properties: + id: + type: string + title: id + description: The region's ID. + name: + type: string + title: name + description: The region's name. + currency_code: + type: string + title: currency_code + description: The region's currency code. + automatic_taxes: + type: boolean + title: automatic_taxes + description: The region's automatic taxes. + countries: + type: array + description: The region's countries. + items: + $ref: '#/components/schemas/BaseRegionCountry' + payment_providers: + type: array + description: The region's payment providers. + items: + $ref: '#/components/schemas/AdminPaymentProvider' + metadata: + type: object + description: The region's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The region's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The region's updated at. + AdminRegionResponse: + type: object + description: SUMMARY + x-schemaName: AdminRegionResponse + required: + - region + properties: + region: + $ref: '#/components/schemas/AdminRegion' + AdminReservationResponse: + type: object + description: SUMMARY + x-schemaName: AdminReservationResponse + required: + - reservation + properties: + reservation: + $ref: '#/components/schemas/ReservationResponse' + AdminReturn: + type: object + description: The exchange's return. + x-schemaName: AdminReturn + required: + - id + - order_id + - order_version + - display_id + - items + - received_at + - created_at + properties: + id: + type: string + title: id + description: The return's ID. + order_id: + type: string + title: order_id + description: The return's order id. + status: + type: string + title: status + description: The return's status. + exchange_id: + type: string + title: exchange_id + description: The return's exchange id. + location_id: + type: string + title: location_id + description: The return's location id. + claim_id: + type: string + title: claim_id + description: The return's claim id. + order_version: + type: number + title: order_version + description: The return's order version. + display_id: + type: number + title: display_id + description: The return's display id. + no_notification: + type: boolean + title: no_notification + description: The return's no notification. + refund_amount: + type: number + title: refund_amount + description: The return's refund amount. + items: + type: array + description: The return's items. + items: + $ref: '#/components/schemas/BaseReturnItem' + received_at: + type: string + title: received_at + description: The return's received at. + created_at: + type: string + format: date-time + title: created_at + description: The return's created at. + AdminReturnItem: + type: object + description: The return item's return items. + x-schemaName: AdminReturnItem + required: + - id + - quantity + - received_quantity + - item_id + - return_id + properties: + id: + type: string + title: id + description: The return item's ID. + quantity: + type: number + title: quantity + description: The return item's quantity. + received_quantity: + type: number + title: received_quantity + description: The return item's received quantity. + reason_id: + type: string + title: reason_id + description: The return item's reason id. + note: + type: string + title: note + description: The return item's note. + item_id: + type: string + title: item_id + description: The return item's item id. + return_id: + type: string + title: return_id + description: The return item's return id. + metadata: + type: object + description: The return item's metadata. + AdminReturnPreviewResponse: + type: object + description: SUMMARY + x-schemaName: AdminReturnPreviewResponse + required: + - order_preview + - return + properties: + order_preview: + $ref: '#/components/schemas/AdminOrderPreview' + return: + $ref: '#/components/schemas/AdminReturn' + AdminReturnReason: + type: object + description: The return reason's details. + x-schemaName: AdminReturnReason + required: + - id + - value + - label + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The return reason's ID. + value: + type: string + title: value + description: The return reason's value. + label: + type: string + title: label + description: The return reason's label. + description: + type: string + title: description + description: The return reason's description. + metadata: + type: object + description: The return reason's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The return reason's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The return reason's updated at. + AdminReturnReasonListResponse: + type: object + description: SUMMARY + x-schemaName: AdminReturnReasonListResponse + required: + - limit + - offset + - count + - return_reasons + properties: + limit: + type: number + title: limit + description: The return reason's limit. + offset: + type: number + title: offset + description: The return reason's offset. + count: + type: number + title: count + description: The return reason's count. + return_reasons: + type: array + description: The return reason's return reasons. + items: + $ref: '#/components/schemas/AdminReturnReason' + AdminReturnReasonResponse: + type: object + description: SUMMARY + x-schemaName: AdminReturnReasonResponse + required: + - return_reason + properties: + return_reason: + $ref: '#/components/schemas/AdminReturnReason' + AdminReturnResponse: + type: object + description: SUMMARY + x-schemaName: AdminReturnResponse + required: + - return + properties: + return: + $ref: '#/components/schemas/AdminReturn' AdminRevokeApiKey: type: object description: SUMMARY @@ -6973,6 +17019,69 @@ components: type: number title: revoke_in description: The api key's revoke in. + AdminRuleAttributeOption: + type: object + description: The attribute's attributes. + x-schemaName: AdminRuleAttributeOption + required: + - id + - value + - label + - field_type + - required + - disguised + - operators + properties: + id: + type: string + title: id + description: The attribute's ID. + value: + type: string + title: value + description: The attribute's value. + label: + type: string + title: label + description: The attribute's label. + field_type: + type: string + title: field_type + description: The attribute's field type. + required: + type: boolean + title: required + description: The attribute's required. + disguised: + type: boolean + title: disguised + description: The attribute's disguised. + operators: + type: array + description: The attribute's operators. + items: + $ref: '#/components/schemas/BaseRuleOperatorOptions' + AdminRuleValueOption: + type: object + description: The value's values. + x-schemaName: AdminRuleValueOption + required: + - id + - value + - label + properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value's details. + label: + type: string + title: label + description: The value's label. AdminSalesChannel: type: object description: The sales channel's sales channels. @@ -7021,6 +17130,40 @@ components: format: date-time title: deleted_at description: The sales channel's deleted at. + AdminSalesChannelDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminSalesChannelDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The sales channel's ID. + object: + type: string + title: object + description: The sales channel's object. + default: sales-channel + deleted: + type: boolean + title: deleted + description: The sales channel's deleted. + parent: + type: object + description: The sales channel's parent. + AdminSalesChannelResponse: + type: object + description: SUMMARY + x-schemaName: AdminSalesChannelResponse + required: + - sales_channel + properties: + sales_channel: + $ref: '#/components/schemas/AdminSalesChannel' AdminServiceZone: type: object description: The service zone's service zones. @@ -7029,6 +17172,7 @@ components: - id - name - fulfillment_set_id + - fulfillment_set - geo_zones - shipping_options - created_at @@ -7047,6 +17191,8 @@ components: type: string title: fulfillment_set_id description: The service zone's fulfillment set id. + fulfillment_set: + type: object geo_zones: type: array description: The service zone's geo zones. @@ -7119,6 +17265,62 @@ components: properties: shipping_option: $ref: '#/components/schemas/AdminShippingOption' + AdminShippingOptionRule: + type: object + description: The updated's details. + x-schemaName: AdminShippingOptionRule + required: + - id + - attribute + - operator + - value + - shipping_option_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The updated's ID. + attribute: + type: string + title: attribute + description: The updated's attribute. + operator: + type: string + title: operator + description: The updated's operator. + value: + oneOf: + - type: string + title: value + description: The updated's value. + - type: array + description: The updated's value. + items: + type: string + title: value + description: The value's details. + shipping_option_id: + type: string + title: shipping_option_id + description: The updated's shipping option id. + created_at: + type: string + format: date-time + title: created_at + description: The updated's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The updated's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The updated's deleted at. AdminShippingProfile: type: object description: The shipping option's shipping profile. @@ -7157,6 +17359,504 @@ components: properties: shipping_profile: $ref: '#/components/schemas/AdminShippingProfile' + AdminStockLocation: + type: object + description: The fulfillment set's location. + x-schemaName: AdminStockLocation + required: + - id + - name + - address_id + properties: + id: + type: string + title: id + description: The location's ID. + name: + type: string + title: name + description: The location's name. + address_id: + type: string + title: address_id + description: The location's address id. + address: + $ref: '#/components/schemas/AdminStockLocationAddress' + sales_channels: + type: array + description: The location's sales channels. + items: + $ref: '#/components/schemas/AdminSalesChannel' + fulfillment_providers: + type: array + description: The location's fulfillment providers. + items: + $ref: '#/components/schemas/AdminFulfillmentProvider' + fulfillment_sets: + type: array + description: The location's fulfillment sets. + items: + type: object + AdminStockLocationAddress: + type: object + description: The location's address. + x-schemaName: AdminStockLocationAddress + AdminStockLocationDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminStockLocationDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The stock location's ID. + object: + type: string + title: object + description: The stock location's object. + default: stock_location + deleted: + type: boolean + title: deleted + description: The stock location's deleted. + parent: + type: object + description: The stock location's parent. + AdminStockLocationListResponse: + type: object + description: SUMMARY + x-schemaName: AdminStockLocationListResponse + required: + - limit + - offset + - count + - stock_locations + properties: + limit: + type: number + title: limit + description: The stock location's limit. + offset: + type: number + title: offset + description: The stock location's offset. + count: + type: number + title: count + description: The stock location's count. + stock_locations: + type: array + description: The stock location's stock locations. + items: + $ref: '#/components/schemas/AdminStockLocation' + AdminStockLocationResponse: + type: object + description: SUMMARY + x-schemaName: AdminStockLocationResponse + required: + - stock_location + properties: + stock_location: + $ref: '#/components/schemas/AdminStockLocation' + AdminStore: + type: object + description: The store's details. + x-schemaName: AdminStore + required: + - id + - name + - supported_currencies + - default_sales_channel_id + - default_region_id + - default_location_id + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The store's ID. + name: + type: string + title: name + description: The store's name. + supported_currencies: + type: array + description: The store's supported currencies. + items: + $ref: '#/components/schemas/AdminStoreCurrency' + default_sales_channel_id: + type: string + title: default_sales_channel_id + description: The store's default sales channel id. + default_region_id: + type: string + title: default_region_id + description: The store's default region id. + default_location_id: + type: string + title: default_location_id + description: The store's default location id. + metadata: + type: object + description: The store's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The store's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The store's updated at. + AdminStoreCurrency: + type: object + description: The supported currency's supported currencies. + x-schemaName: AdminStoreCurrency + required: + - id + - currency_code + - store_id + - is_default + - currency + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The supported currency's ID. + currency_code: + type: string + title: currency_code + description: The supported currency's currency code. + store_id: + type: string + title: store_id + description: The supported currency's store id. + is_default: + type: boolean + title: is_default + description: The supported currency's is default. + currency: + $ref: '#/components/schemas/AdminCurrency' + created_at: + type: string + format: date-time + title: created_at + description: The supported currency's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The supported currency's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The supported currency's deleted at. + AdminStoreListResponse: + type: object + description: SUMMARY + x-schemaName: AdminStoreListResponse + required: + - limit + - offset + - count + - stores + properties: + limit: + type: number + title: limit + description: The store's limit. + offset: + type: number + title: offset + description: The store's offset. + count: + type: number + title: count + description: The store's count. + stores: + type: array + description: The store's stores. + items: + $ref: '#/components/schemas/AdminStore' + AdminStoreResponse: + type: object + description: SUMMARY + x-schemaName: AdminStoreResponse + required: + - store + properties: + store: + $ref: '#/components/schemas/AdminStore' + AdminTaxRate: + type: object + description: The tax rate's details. + x-schemaName: AdminTaxRate + required: + - id + - rate + - code + - name + - metadata + - tax_region_id + - is_combinable + - is_default + - created_at + - updated_at + - deleted_at + - created_by + - tax_region + - rules + properties: + id: + type: string + title: id + description: The tax rate's ID. + rate: + type: number + title: rate + description: The tax rate's rate. + code: + type: string + title: code + description: The tax rate's code. + name: + type: string + title: name + description: The tax rate's name. + metadata: + type: object + description: The tax rate's metadata. + tax_region_id: + type: string + title: tax_region_id + description: The tax rate's tax region id. + is_combinable: + type: boolean + title: is_combinable + description: The tax rate's is combinable. + is_default: + type: boolean + title: is_default + description: The tax rate's is default. + created_at: + type: string + format: date-time + title: created_at + description: The tax rate's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax rate's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The tax rate's deleted at. + created_by: + type: string + title: created_by + description: The tax rate's created by. + tax_region: + $ref: '#/components/schemas/AdminTaxRegion' + rules: + type: array + description: The tax rate's rules. + items: + $ref: '#/components/schemas/AdminTaxRateRule' + AdminTaxRateDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminTaxRateDeleteResponse + 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. + default: tax_rate + deleted: + type: boolean + title: deleted + description: The tax rate's deleted. + parent: + type: object + description: The tax rate's parent. + AdminTaxRateResponse: + type: object + description: SUMMARY + x-schemaName: AdminTaxRateResponse + required: + - tax_rate + properties: + tax_rate: + $ref: '#/components/schemas/AdminTaxRate' + AdminTaxRateRule: + type: object + description: The rule's rules. + x-schemaName: AdminTaxRateRule + 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. + AdminTaxRegion: + type: object + description: The tax rate's tax region. + x-schemaName: AdminTaxRegion + required: + - id + - rate + - code + - country_code + - province_code + - name + - metadata + - tax_region_id + - is_combinable + - is_default + - parent_id + - created_at + - updated_at + - deleted_at + - created_by + - tax_rates + - parent + - children + properties: + id: + type: string + title: id + description: The tax region's ID. + rate: + type: number + title: rate + description: The tax region's rate. + code: + type: string + title: code + description: The tax region's code. + country_code: + type: string + title: country_code + description: The tax region's country code. + province_code: + type: string + title: province_code + description: The tax region's province code. + name: + type: string + title: name + description: The tax region's name. + metadata: + type: object + description: The tax region's metadata. + tax_region_id: + type: string + title: tax_region_id + description: The tax region's tax region id. + is_combinable: + type: boolean + title: is_combinable + description: The tax region's is combinable. + is_default: + type: boolean + title: is_default + description: The tax region's is default. + parent_id: + type: string + title: parent_id + description: The tax region's parent id. + created_at: + type: string + format: date-time + title: created_at + description: The tax region's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax region's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The tax region's deleted at. + created_by: + type: string + title: created_by + description: The tax region's created by. + tax_rates: + type: array + description: The tax region's tax rates. + items: + type: object + parent: + type: object + children: + type: array + description: The tax region's children. + items: + type: object + AdminTaxRegionDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminTaxRegionDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The tax region's ID. + object: + type: string + title: object + description: The tax region's object. + default: tax_region + deleted: + type: boolean + title: deleted + description: The tax region's deleted. + parent: + type: object + description: The tax region's parent. + AdminTaxRegionResponse: + type: object + description: SUMMARY + x-schemaName: AdminTaxRegionResponse + required: + - tax_region + properties: + tax_region: + $ref: '#/components/schemas/AdminTaxRegion' AdminUpdateApiKey: type: object description: SUMMARY @@ -7168,60 +17868,6 @@ components: type: string title: title description: The api key's title. - AdminUpdateCampaign: - type: object - description: SUMMARY - x-schemaName: AdminUpdateCampaign - required: - - description - - starts_at - - ends_at - properties: - name: - type: string - title: name - description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. - description: - type: string - title: description - description: The campaign's description. - budget: - type: object - description: The campaign's budget. - required: - - limit - properties: - limit: - type: number - title: limit - description: The budget's limit. - 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 - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. AdminUpdateCollection: type: object description: SUMMARY @@ -7240,42 +17886,6 @@ components: metadata: type: object description: The collection's metadata. - AdminUpdateCustomer: - type: object - description: SUMMARY - x-schemaName: AdminUpdateCustomer - required: - - email - - company_name - - first_name - - last_name - - phone - - metadata - properties: - email: - type: string - title: email - description: The customer's email. - format: email - company_name: - type: string - title: company_name - description: The customer's company name. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - phone: - type: string - title: phone - description: The customer's phone. - metadata: - type: object - description: The customer's metadata. AdminUpdateCustomerGroup: type: object description: SUMMARY @@ -7425,15 +18035,13 @@ components: items: type: object description: The tag's tags. + required: + - id properties: id: type: string title: id description: The tag's ID. - value: - type: string - title: value - description: The tag's value. options: type: array description: The update's options. @@ -7443,7 +18051,168 @@ components: type: array description: The update's variants. items: - $ref: '#/components/schemas/AdminCreateProductVariant' + oneOf: + - type: object + description: The variant's variants. + x-schemaName: AdminCreateProductVariant + required: + - title + - prices + properties: + title: + type: string + title: title + description: The variant's title. + sku: + type: string + title: sku + description: The variant's sku. + ean: + type: string + title: ean + description: The variant's ean. + upc: + type: string + title: upc + description: The variant's upc. + barcode: + type: string + title: barcode + description: The variant's barcode. + hs_code: + type: string + title: hs_code + description: The variant's hs code. + mid_code: + type: string + title: mid_code + description: The variant's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + weight: + type: number + title: weight + description: The variant's weight. + length: + type: number + title: length + description: The variant's length. + height: + type: number + title: height + description: The variant's height. + width: + type: number + title: width + description: The variant's width. + origin_country: + type: string + title: origin_country + description: The variant's origin country. + material: + type: string + title: material + description: The variant's material. + metadata: + type: object + description: The variant's metadata. + prices: + type: array + description: The variant's prices. + items: + $ref: '#/components/schemas/AdminCreateProductVariantPrice' + options: + type: object + description: The variant's options. + - type: object + description: The variant's variants. + x-schemaName: AdminUpdateProductVariant + properties: + title: + type: string + title: title + description: The variant's title. + sku: + type: string + title: sku + description: The variant's sku. + ean: + type: string + title: ean + description: The variant's ean. + upc: + type: string + title: upc + description: The variant's upc. + barcode: + type: string + title: barcode + description: The variant's barcode. + hs_code: + type: string + title: hs_code + description: The variant's hs code. + mid_code: + type: string + title: mid_code + description: The variant's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + weight: + type: number + title: weight + description: The variant's weight. + length: + type: number + title: length + description: The variant's length. + height: + type: number + title: height + description: The variant's height. + width: + type: number + title: width + description: The variant's width. + origin_country: + type: string + title: origin_country + description: The variant's origin country. + material: + type: string + title: material + description: The variant's material. + metadata: + type: object + description: The variant's metadata. + prices: + type: array + description: The variant's prices. + items: + $ref: '#/components/schemas/AdminCreateProductVariantPrice' + options: + type: object + description: The variant's options. sales_channels: type: array description: The update's sales channels. @@ -7806,9 +18575,303 @@ components: type: number title: required_quantity description: The product's required quantity. + AdminUser: + type: object + description: The user's details. + x-schemaName: AdminUser + required: + - id + - email + - first_name + - last_name + - avatar_url + - metadata + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The user's ID. + email: + type: string + title: email + description: The user's email. + format: email + first_name: + type: string + title: first_name + description: The user's first name. + last_name: + type: string + title: last_name + description: The user's last name. + avatar_url: + type: string + title: avatar_url + description: The user's avatar url. + metadata: + type: object + description: The user's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The user's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The user's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The user's deleted at. + AdminUserDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminUserDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The user's ID. + object: + type: string + title: object + description: The user's object. + default: user + deleted: + type: boolean + title: deleted + description: The user's deleted. + parent: + type: object + description: The user's parent. + AdminUserListResponse: + type: object + description: SUMMARY + x-schemaName: AdminUserListResponse + required: + - limit + - offset + - count + - users + properties: + limit: + type: number + title: limit + description: The user's limit. + offset: + type: number + title: offset + description: The user's offset. + count: + type: number + title: count + description: The user's count. + users: + type: array + description: The user's users. + items: + $ref: '#/components/schemas/AdminUser' + AdminUserResponse: + type: object + description: SUMMARY + x-schemaName: AdminUserResponse + required: + - user + properties: + user: + $ref: '#/components/schemas/AdminUser' + AdminWorkflowExecution: + type: object + description: The workflows execution's workflow execution. + x-schemaName: AdminWorkflowExecution + required: + - id + - workflow_id + - transaction_id + - execution + - context + - state + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The workflow execution's ID. + workflow_id: + type: string + title: workflow_id + description: The workflow execution's workflow id. + transaction_id: + type: string + title: transaction_id + description: The workflow execution's transaction id. + execution: + type: string + title: execution + description: The workflow execution's execution. + context: + type: string + title: context + description: The workflow execution's context. + state: {} + created_at: + type: string + title: created_at + description: The workflow execution's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The workflow execution's updated at. + format: date-time + deleted_at: + type: string + title: deleted_at + description: The workflow execution's deleted at. + format: date-time + AdminWorkflowExecutionResponse: + type: object + description: SUMMARY + x-schemaName: AdminWorkflowExecutionResponse + required: + - workflow_execution + properties: + workflow_execution: + $ref: '#/components/schemas/AdminWorkflowExecution' + ApiKeyResponse: + type: object + description: The api key's details. + x-schemaName: ApiKeyResponse + required: + - id + - token + - redacted + - title + - type + - last_used_at + - created_by + - created_at + - revoked_by + - revoked_at + properties: + id: + type: string + title: id + description: The api key's ID. + token: + type: string + title: token + description: The api key's token. + redacted: + type: string + title: redacted + description: The api key's redacted. + title: + type: string + title: title + description: The api key's title. + type: + type: string + enum: + - secret + - publishable + last_used_at: + type: string + title: last_used_at + description: The api key's last used at. + format: date-time + created_by: + type: string + title: created_by + description: The api key's created by. + created_at: + type: string + title: created_at + description: The api key's created at. + format: date-time + revoked_by: + type: string + title: revoked_by + description: The api key's revoked by. + revoked_at: + type: string + title: revoked_at + description: The api key's revoked at. + format: date-time + BaseApplicationMethod: + type: object + description: The promotion's application method. + x-schemaName: BaseApplicationMethod + required: + - id + properties: + id: + type: string + title: id + description: The application method's ID. + type: + type: string + enum: + - fixed + - percentage + target_type: + type: string + enum: + - items + - shipping_methods + - order + allocation: + type: string + enum: + - each + - across + 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. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The application method's buy rules min quantity. + apply_to_quantity: + type: number + title: apply_to_quantity + description: The application method's apply to quantity. + promotion: + $ref: '#/components/schemas/BasePromotion' + target_rules: + type: array + description: The application method's target rules. + items: + $ref: '#/components/schemas/BasePromotionRule' + buy_rules: + type: array + description: The application method's buy rules. + items: + $ref: '#/components/schemas/BasePromotionRule' BaseCalculatedPriceSet: type: object - description: The updated's calculated price. + description: The parent's calculated price. x-schemaName: BaseCalculatedPriceSet required: - id @@ -7862,6 +18925,630 @@ components: original_price: type: object description: The calculated price's original price. + BaseCapture: + type: object + description: The capture's captures. + x-schemaName: BaseCapture + BaseCart: + type: object + description: The item's cart. + x-schemaName: BaseCart + BaseCartAddress: + type: object + description: The cart's billing address. + x-schemaName: BaseCartAddress + required: + - id + - created_at + - updated_at + properties: + 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. + BaseCartLineItem: + type: object + description: The item's items. + x-schemaName: BaseCartLineItem + required: + - id + - title + - quantity + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - cart + - cart_id + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + quantity: + oneOf: + - type: string + title: quantity + description: The item's quantity. + - type: number + title: quantity + description: The item's quantity. + - type: string + title: quantity + description: The item's quantity. + - $ref: '#/components/schemas/IBigNumber' + product: + $ref: '#/components/schemas/BaseProduct' + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant: + $ref: '#/components/schemas/BaseProductVariant' + variant_id: + type: string + title: variant_id + description: The item's variant id. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + oneOf: + - type: string + title: compare_at_unit_price + description: The item's compare at unit price. + - type: number + title: compare_at_unit_price + description: The item's compare at unit price. + - type: string + title: compare_at_unit_price + description: The item's compare at unit price. + - $ref: '#/components/schemas/IBigNumber' + unit_price: + oneOf: + - type: string + title: unit_price + description: The item's unit price. + - type: number + title: unit_price + description: The item's unit price. + - type: string + title: unit_price + description: The item's unit price. + - $ref: '#/components/schemas/IBigNumber' + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: '#/components/schemas/BaseLineItemTaxLine' + adjustments: + type: array + description: The item's adjustments. + items: + $ref: '#/components/schemas/BaseLineItemAdjustment' + cart: + $ref: '#/components/schemas/BaseCart' + cart_id: + type: string + title: cart_id + description: The item's cart id. + metadata: + type: object + description: The item's metadata. + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + deleted_at: + type: string + title: deleted_at + description: The item's deleted at. + format: date-time + original_total: + oneOf: + - type: string + title: original_total + description: The item's original total. + - type: number + title: original_total + description: The item's original total. + - type: string + title: original_total + description: The item's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The item's original subtotal. + - type: number + title: original_subtotal + description: The item's original subtotal. + - type: string + title: original_subtotal + description: The item's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The item's original tax total. + - type: number + title: original_tax_total + description: The item's original tax total. + - type: string + title: original_tax_total + description: The item's original tax total. + - $ref: '#/components/schemas/IBigNumber' + item_total: + oneOf: + - type: string + title: item_total + description: The item's item total. + - type: number + title: item_total + description: The item's item total. + - type: string + title: item_total + description: The item's item total. + - $ref: '#/components/schemas/IBigNumber' + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The item's item subtotal. + - type: number + title: item_subtotal + description: The item's item subtotal. + - type: string + title: item_subtotal + description: The item's item subtotal. + - $ref: '#/components/schemas/IBigNumber' + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The item's item tax total. + - type: number + title: item_tax_total + description: The item's item tax total. + - type: string + title: item_tax_total + description: The item's item tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The item's total. + - type: number + title: total + description: The item's total. + - type: string + title: total + description: The item's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The item's subtotal. + - type: number + title: subtotal + description: The item's subtotal. + - type: string + title: subtotal + description: The item's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The item's tax total. + - type: number + title: tax_total + description: The item's tax total. + - type: string + title: tax_total + description: The item's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The item's discount total. + - type: number + title: discount_total + description: The item's discount total. + - type: string + title: discount_total + description: The item's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The item's discount tax total. + - type: number + title: discount_tax_total + description: The item's discount tax total. + - type: string + title: discount_tax_total + description: The item's discount tax total. + - $ref: '#/components/schemas/IBigNumber' + BaseCartShippingMethod: + type: object + description: The shipping method's shipping methods. + x-schemaName: BaseCartShippingMethod + required: + - id + - cart_id + - name + - amount + - is_tax_inclusive + - created_at + - updated_at + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + properties: + id: + type: string + title: id + description: The shipping method's ID. + cart_id: + type: string + title: cart_id + description: The shipping method's cart id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + oneOf: + - type: string + title: amount + description: The shipping method's amount. + - type: number + title: amount + description: The shipping method's amount. + - type: string + title: amount + description: The shipping method's amount. + - $ref: '#/components/schemas/IBigNumber' + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: '#/components/schemas/BaseShippingMethodTaxLine' + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: '#/components/schemas/BaseShippingMethodAdjustment' + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: discount_tax_total + description: The shipping method's discount tax total. + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - $ref: '#/components/schemas/IBigNumber' + BaseClaim: + type: object + description: The order change's claim. + x-schemaName: BaseClaim + BaseClaimItem: + type: object + description: The claim item's claim items. + x-schemaName: BaseClaimItem + required: + - id + - claim_id + - order_id + - item_id + - quantity + - reason + - raw_quantity + properties: + id: + type: string + title: id + description: The claim item's ID. + claim_id: + type: string + title: claim_id + description: The claim item's claim id. + order_id: + type: string + title: order_id + description: The claim item's order id. + item_id: + type: string + title: item_id + description: The claim item's item id. + quantity: + type: number + title: quantity + description: The claim item's quantity. + reason: + type: string + enum: + - missing_item + - wrong_item + - production_failure + - other + raw_quantity: + type: object + description: The claim item's raw quantity. + metadata: + type: object + description: The claim item's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The claim item's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The claim item's updated at. BaseCollection: type: object description: The product's collection. @@ -7967,9 +19654,1041 @@ components: format: date-time title: updated_at description: The address's updated at. + BaseExchangeItem: + type: object + description: The additional item's additional items. + x-schemaName: BaseExchangeItem + required: + - id + - exchange_id + - order_id + - item_id + - quantity + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The additional item's ID. + exchange_id: + type: string + title: exchange_id + description: The additional item's exchange id. + order_id: + type: string + title: order_id + description: The additional item's order id. + item_id: + type: string + title: item_id + description: The additional item's item id. + quantity: + type: number + title: quantity + description: The additional item's quantity. + metadata: + type: object + description: The additional item's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The additional item's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The additional item's updated at. + BaseFulfillmentProvider: + type: object + description: The shipping option's provider. + x-schemaName: BaseFulfillmentProvider + required: + - id + - is_enabled + properties: + id: + type: string + title: id + description: The provider's ID. + is_enabled: + type: boolean + title: is_enabled + description: The provider's is enabled. + BaseLineItemAdjustment: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseLineItemAdjustment + BaseLineItemTaxLine: + type: object + description: The tax line's tax lines. + x-schemaName: BaseLineItemTaxLine + BaseOrder: + type: object + description: The order change's order. + x-schemaName: BaseOrder + BaseOrderAddress: + type: object + description: The order's billing address. + x-schemaName: BaseOrderAddress + required: + - id + - metadata + - created_at + - updated_at + properties: + 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. + BaseOrderChange: + type: object + description: The order preview's order change. + x-schemaName: BaseOrderChange + required: + - id + - order_id + - actions + - status + - requested_by + - requested_at + - confirmed_by + - confirmed_at + - declined_by + - declined_reason + - metadata + - declined_at + - canceled_by + - canceled_at + - created_at + - updated_at + - version + - return_id + - exchange_id + - claim_id + - order + - return_order + - exchange + - claim + properties: + id: + type: string + title: id + description: The order change's ID. + order_id: + type: string + title: order_id + description: The order change's order id. + actions: + type: array + description: The order change's actions. + items: + $ref: '#/components/schemas/BaseOrderChangeAction' + status: + type: string + title: status + description: The order change's status. + requested_by: + type: string + title: requested_by + description: The order change's requested by. + requested_at: + oneOf: + - type: string + title: requested_at + description: The order change's requested at. + - type: string + title: requested_at + description: The order change's requested at. + format: date-time + confirmed_by: + type: string + title: confirmed_by + description: The order change's confirmed by. + confirmed_at: + oneOf: + - type: string + title: confirmed_at + description: The order change's confirmed at. + - type: string + title: confirmed_at + description: The order change's confirmed at. + format: date-time + declined_by: + type: string + title: declined_by + description: The order change's declined by. + declined_reason: + type: string + title: declined_reason + description: The order change's declined reason. + metadata: + type: object + description: The order change's metadata. + declined_at: + oneOf: + - type: string + title: declined_at + description: The order change's declined at. + - type: string + title: declined_at + description: The order change's declined at. + format: date-time + canceled_by: + type: string + title: canceled_by + description: The order change's canceled by. + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order change's canceled at. + - type: string + title: canceled_at + description: The order change's canceled at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The order change's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order change's updated at. + version: + type: number + title: version + description: The order change's version. + change_type: + type: string + enum: + - return + - exchange + - claim + - edit + return_id: + type: string + title: return_id + description: The order change's return id. + exchange_id: + type: string + title: exchange_id + description: The order change's exchange id. + claim_id: + type: string + title: claim_id + description: The order change's claim id. + order: + $ref: '#/components/schemas/BaseOrder' + return_order: {} + exchange: {} + claim: + $ref: '#/components/schemas/BaseClaim' + BaseOrderChangeAction: + type: object + description: The action's actions. + x-schemaName: BaseOrderChangeAction + BaseOrderFulfillment: + type: object + description: The fulfillment's fulfillments. + x-schemaName: BaseOrderFulfillment + required: + - id + - location_id + - packed_at + - shipped_at + - delivered_at + - canceled_at + - data + - provider_id + - shipping_option_id + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The fulfillment's ID. + location_id: + type: string + title: location_id + description: The fulfillment's location id. + packed_at: + type: string + title: packed_at + description: The fulfillment's packed at. + format: date-time + shipped_at: + type: string + title: shipped_at + description: The fulfillment's shipped at. + format: date-time + delivered_at: + type: string + title: delivered_at + description: The fulfillment's delivered at. + format: date-time + canceled_at: + type: string + title: canceled_at + description: The fulfillment's canceled at. + format: date-time + data: + type: object + description: The fulfillment's data. + provider_id: + type: string + title: provider_id + description: The fulfillment's provider id. + shipping_option_id: + type: string + title: shipping_option_id + description: The fulfillment's shipping option id. + metadata: + type: object + description: The fulfillment's metadata. + created_at: + type: string + title: created_at + description: The fulfillment's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The fulfillment's updated at. + format: date-time + BaseOrderItemDetail: + type: object + description: The item's detail. + x-schemaName: BaseOrderItemDetail + BaseOrderLineItem: + type: object + description: The item's items. + x-schemaName: BaseOrderLineItem + required: + - id + - title + - subtitle + - thumbnail + - variant_id + - product_id + - product_title + - product_description + - product_subtitle + - product_type + - product_collection + - product_handle + - variant_sku + - variant_barcode + - variant_title + - variant_option_values + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - detail + - created_at + - updated_at + - metadata + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant: + $ref: '#/components/schemas/BaseProductVariant' + variant_id: + type: string + title: variant_id + description: The item's variant id. + product: + $ref: '#/components/schemas/BaseProduct' + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: '#/components/schemas/BaseOrderLineItemTaxLine' + adjustments: + type: array + description: The item's adjustments. + items: + $ref: '#/components/schemas/BaseOrderLineItemAdjustment' + detail: + $ref: '#/components/schemas/BaseOrderItemDetail' + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + metadata: + type: object + description: The item's metadata. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + BaseOrderLineItemAdjustment: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + BaseOrderLineItemTaxLine: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + BaseOrderShippingMethod: + type: object + description: The shipping method's shipping methods. + x-schemaName: BaseOrderShippingMethod + required: + - id + - order_id + - name + - amount + - is_tax_inclusive + - shipping_option_id + - data + - metadata + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: '#/components/schemas/BaseOrderShippingMethodTaxLine' + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: '#/components/schemas/BaseOrderShippingMethodAdjustment' + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: discount_tax_total + description: The shipping method's discount tax total. + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - $ref: '#/components/schemas/IBigNumber' + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + BaseOrderShippingMethodAdjustment: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + BaseOrderShippingMethodTaxLine: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + BaseOrderSummary: + type: object + description: The order's summary. + x-schemaName: BaseOrderSummary + required: + - total + - subtotal + - total_tax + - ordered_total + - fulfilled_total + - returned_total + - return_request_total + - write_off_total + - projected_total + - net_total + - net_subtotal + - net_total_tax + - balance + - paid_total + - refunded_total + properties: + total: + type: number + title: total + description: The summary's total. + subtotal: + type: number + title: subtotal + description: The summary's subtotal. + total_tax: + type: number + title: total_tax + description: The summary's total tax. + ordered_total: + type: number + title: ordered_total + description: The summary's ordered total. + fulfilled_total: + type: number + title: fulfilled_total + description: The summary's fulfilled total. + returned_total: + type: number + title: returned_total + description: The summary's returned total. + return_request_total: + type: number + title: return_request_total + description: The summary's return request total. + write_off_total: + type: number + title: write_off_total + description: The summary's write off total. + projected_total: + type: number + title: projected_total + description: The summary's projected total. + net_total: + type: number + title: net_total + description: The summary's net total. + net_subtotal: + type: number + title: net_subtotal + description: The summary's net subtotal. + net_total_tax: + type: number + title: net_total_tax + description: The summary's net total tax. + balance: + type: number + title: balance + description: The summary's balance. + paid_total: + type: number + title: paid_total + description: The summary's paid total. + refunded_total: + type: number + title: refunded_total + description: The summary's refunded total. + BaseOrderTransaction: + type: object + description: The transaction's transactions. + x-schemaName: BaseOrderTransaction + required: + - id + - order_id + - amount + - currency_code + - reference + - reference_id + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The transaction's ID. + order_id: + type: string + title: order_id + description: The transaction's order id. + amount: + type: number + title: amount + description: The transaction's amount. + currency_code: + type: string + title: currency_code + description: The transaction's currency code. + reference: + type: string + title: reference + description: The transaction's reference. + reference_id: + type: string + title: reference_id + description: The transaction's reference id. + metadata: + type: object + description: The transaction's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The transaction's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The transaction's updated at. + BasePayment: + type: object + description: The payment's payments. + x-schemaName: BasePayment + BasePaymentCollection: + type: object + description: The payment collection's payment collections. + x-schemaName: BasePaymentCollection + required: + - id + - currency_code + - region_id + - amount + - status + - payment_providers + properties: + id: + type: string + title: id + description: The payment collection's ID. + currency_code: + type: string + title: currency_code + description: The payment collection's currency code. + region_id: + type: string + title: region_id + description: The payment collection's region id. + amount: + oneOf: + - type: string + title: amount + description: The payment collection's amount. + - type: number + title: amount + description: The payment collection's amount. + - type: string + title: amount + description: The payment collection's amount. + - $ref: '#/components/schemas/IBigNumber' + authorized_amount: + oneOf: + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - type: number + title: authorized_amount + description: The payment collection's authorized amount. + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - $ref: '#/components/schemas/IBigNumber' + captured_amount: + oneOf: + - type: string + title: captured_amount + description: The payment collection's captured amount. + - type: number + title: captured_amount + description: The payment collection's captured amount. + - type: string + title: captured_amount + description: The payment collection's captured amount. + - $ref: '#/components/schemas/IBigNumber' + refunded_amount: + oneOf: + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - type: number + title: refunded_amount + description: The payment collection's refunded amount. + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - $ref: '#/components/schemas/IBigNumber' + completed_at: + oneOf: + - type: string + title: completed_at + description: The payment collection's completed at. + - type: string + title: completed_at + description: The payment collection's completed at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The payment collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The payment collection's updated at. + metadata: + type: object + description: The payment collection's metadata. + status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + payment_providers: + type: array + description: The payment collection's payment providers. + items: + $ref: '#/components/schemas/BasePaymentProvider' + payment_sessions: + type: array + description: The payment collection's payment sessions. + items: + $ref: '#/components/schemas/BasePaymentSession' + payments: + type: array + description: The payment collection's payments. + items: + $ref: '#/components/schemas/BasePayment' + BasePaymentProvider: + type: object + description: The payment provider's payment providers. + x-schemaName: BasePaymentProvider + BasePaymentSession: + type: object + description: The payment session's payment sessions. + x-schemaName: BasePaymentSession BaseProduct: type: object - description: The updated's product. + description: The parent's product. x-schemaName: BaseProduct required: - id @@ -8189,6 +20908,222 @@ components: type: object description: The variant's variants. x-schemaName: BaseProductVariant + BasePromotion: + type: object + description: The application method's promotion. + x-schemaName: BasePromotion + BasePromotionRule: + type: object + description: The rule's rules. + x-schemaName: BasePromotionRule + required: + - id + - values + properties: + id: + type: string + title: id + description: The rule's ID. + description: + type: string + title: description + description: The rule's description. + attribute: + type: string + title: attribute + description: The rule's attribute. + operator: + type: string + enum: + - gt + - lt + - eq + - ne + - in + - lte + - gte + values: + type: array + description: The rule's values. + items: + $ref: '#/components/schemas/BasePromotionRuleValue' + BasePromotionRuleValue: + type: object + description: The value's values. + x-schemaName: BasePromotionRuleValue + required: + - id + properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value's details. + BaseRefund: + type: object + description: The refund's refunds. + x-schemaName: BaseRefund + BaseRegion: + type: object + description: The cart's region. + x-schemaName: BaseRegion + required: + - id + - name + - currency_code + properties: + id: + type: string + title: id + description: The region's ID. + name: + type: string + title: name + description: The region's name. + currency_code: + type: string + title: currency_code + description: The region's currency code. + automatic_taxes: + type: boolean + title: automatic_taxes + description: The region's automatic taxes. + countries: + type: array + description: The region's countries. + items: + $ref: '#/components/schemas/BaseRegionCountry' + payment_providers: + type: array + description: The region's payment providers. + items: + $ref: '#/components/schemas/AdminPaymentProvider' + metadata: + type: object + description: The region's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The region's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The region's updated at. + BaseRegionCountry: + type: object + description: The country's countries. + x-schemaName: BaseRegionCountry + BaseReturnItem: + type: object + description: The item's items. + x-schemaName: BaseReturnItem + BaseRuleOperatorOptions: + type: object + description: The operator's operators. + x-schemaName: BaseRuleOperatorOptions + required: + - id + - value + - label + properties: + id: + type: string + title: id + description: The operator's ID. + value: + type: string + title: value + description: The operator's value. + label: + type: string + title: label + description: The operator's label. + BaseShippingMethodAdjustment: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseShippingMethodAdjustment + BaseShippingMethodTaxLine: + type: object + description: The tax line's tax lines. + x-schemaName: BaseShippingMethodTaxLine + CampaignResponse: + type: object + description: The campaign's details. + x-schemaName: CampaignResponse + required: + - id + - name + - description + - currency + - campaign_identifier + - starts_at + - ends_at + - budget + properties: + id: + type: string + title: id + description: The campaign's ID. + 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. + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + budget: + type: object + description: The campaign's budget. + required: + - id + - type + - currency_code + - limit + - used + properties: + id: + type: string + title: id + description: The budget's ID. + type: + type: string + 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. + used: + type: number + title: used + description: The budget's used. CreateAddress: type: object description: The cart's shipping address. @@ -8387,67 +21322,6 @@ components: metadata: type: object description: The item's metadata. - CreateCartWorkflowInput: - type: object - description: SUMMARY - x-schemaName: CreateCartWorkflowInput - properties: - region_id: - type: string - title: region_id - description: The cart's region id. - customer_id: - type: string - title: customer_id - description: The cart's customer id. - sales_channel_id: - type: string - title: sales_channel_id - description: The cart's sales channel id. - email: - type: string - title: email - description: The cart's email. - format: email - currency_code: - type: string - title: currency_code - description: The cart's currency code. - shipping_address_id: - type: string - title: shipping_address_id - description: The cart's shipping address id. - billing_address_id: - type: string - title: billing_address_id - description: The cart's billing address id. - shipping_address: - oneOf: - - type: string - title: shipping_address - description: The cart's shipping address. - - $ref: '#/components/schemas/CreateCartAddress' - billing_address: - oneOf: - - type: string - title: billing_address - description: The cart's billing address. - - $ref: '#/components/schemas/CreateCartAddress' - metadata: - type: object - description: The cart's metadata. - items: - type: array - description: The cart's items. - items: - $ref: '#/components/schemas/CreateCartCreateLineItem' - promo_codes: - type: array - description: The cart's promo codes. - items: - type: string - title: promo_codes - description: The promo code's promo codes. CreateOrderReturnReason: type: object description: SUMMARY @@ -8582,6 +21456,1962 @@ components: text: type: object description: The file's text. + IBigNumber: + type: object + description: The shipping method's discount tax total. + x-schemaName: IBigNumber + InventoryLevel: + type: object + description: The inventory level's inventory levels. + x-schemaName: InventoryLevel + required: + - id + - inventory_item_id + - location_id + - stocked_quantity + - reserved_quantity + - available_quantity + - incoming_quantity + properties: + id: + type: string + title: id + description: The inventory level's ID. + inventory_item_id: + type: string + title: inventory_item_id + description: The inventory level's inventory item id. + location_id: + type: string + title: location_id + description: The inventory level's location id. + stocked_quantity: + type: number + title: stocked_quantity + description: The inventory level's stocked quantity. + reserved_quantity: + type: number + title: reserved_quantity + description: The inventory level's reserved quantity. + available_quantity: + type: number + title: available_quantity + description: The inventory level's available quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The inventory level's incoming quantity. + metadata: + type: object + description: The inventory level's metadata. + Order: + type: object + description: The exchange's order preview. + x-schemaName: Order + required: + - id + - version + - status + - currency_code + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total + - raw_original_item_total + - raw_original_item_subtotal + - raw_original_item_tax_total + - raw_item_total + - raw_item_subtotal + - raw_item_tax_total + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + - raw_gift_card_total + - raw_gift_card_tax_total + - raw_shipping_total + - raw_shipping_subtotal + - raw_shipping_tax_total + - raw_original_shipping_total + - raw_original_shipping_subtotal + - raw_original_shipping_tax_total + properties: + id: + type: string + title: id + description: The order preview's ID. + version: + type: number + title: version + description: The order preview's version. + order_change: + $ref: '#/components/schemas/OrderChange' + status: + type: string + enum: + - canceled + - requires_action + - pending + - completed + - draft + - archived + region_id: + type: string + title: region_id + description: The order preview's region id. + customer_id: + type: string + title: customer_id + description: The order preview's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order preview's sales channel id. + email: + type: string + title: email + description: The order preview's email. + format: email + currency_code: + type: string + title: currency_code + description: The order preview's currency code. + shipping_address: + $ref: '#/components/schemas/OrderAddress' + billing_address: + $ref: '#/components/schemas/OrderAddress' + items: + type: array + description: The order preview's items. + items: + $ref: '#/components/schemas/OrderLineItem' + shipping_methods: + type: array + description: The order preview's shipping methods. + items: + $ref: '#/components/schemas/OrderShippingMethod' + transactions: + type: array + description: The order preview's transactions. + items: + $ref: '#/components/schemas/OrderTransaction' + summary: + type: object + description: The order preview's summary. + required: + - total + - subtotal + - total_tax + - ordered_total + - fulfilled_total + - returned_total + - return_request_total + - write_off_total + - projected_total + - net_total + - net_subtotal + - net_total_tax + - balance + - paid_total + - refunded_total + properties: + total: + oneOf: + - type: string + title: total + description: The summary's total. + - type: number + title: total + description: The summary's total. + - type: string + title: total + description: The summary's total. + - type: object + description: The summary's total. + x-schemaName: IBigNumber + subtotal: + oneOf: + - type: string + title: subtotal + description: The summary's subtotal. + - type: number + title: subtotal + description: The summary's subtotal. + - type: string + title: subtotal + description: The summary's subtotal. + - type: object + description: The summary's subtotal. + x-schemaName: IBigNumber + total_tax: + oneOf: + - type: string + title: total_tax + description: The summary's total tax. + - type: number + title: total_tax + description: The summary's total tax. + - type: string + title: total_tax + description: The summary's total tax. + - type: object + description: The summary's total tax. + x-schemaName: IBigNumber + ordered_total: + oneOf: + - type: string + title: ordered_total + description: The summary's ordered total. + - type: number + title: ordered_total + description: The summary's ordered total. + - type: string + title: ordered_total + description: The summary's ordered total. + - type: object + description: The summary's ordered total. + x-schemaName: IBigNumber + fulfilled_total: + oneOf: + - type: string + title: fulfilled_total + description: The summary's fulfilled total. + - type: number + title: fulfilled_total + description: The summary's fulfilled total. + - type: string + title: fulfilled_total + description: The summary's fulfilled total. + - type: object + description: The summary's fulfilled total. + x-schemaName: IBigNumber + returned_total: + oneOf: + - type: string + title: returned_total + description: The summary's returned total. + - type: number + title: returned_total + description: The summary's returned total. + - type: string + title: returned_total + description: The summary's returned total. + - type: object + description: The summary's returned total. + x-schemaName: IBigNumber + return_request_total: + oneOf: + - type: string + title: return_request_total + description: The summary's return request total. + - type: number + title: return_request_total + description: The summary's return request total. + - type: string + title: return_request_total + description: The summary's return request total. + - type: object + description: The summary's return request total. + x-schemaName: IBigNumber + write_off_total: + oneOf: + - type: string + title: write_off_total + description: The summary's write off total. + - type: number + title: write_off_total + description: The summary's write off total. + - type: string + title: write_off_total + description: The summary's write off total. + - type: object + description: The summary's write off total. + x-schemaName: IBigNumber + projected_total: + oneOf: + - type: string + title: projected_total + description: The summary's projected total. + - type: number + title: projected_total + description: The summary's projected total. + - type: string + title: projected_total + description: The summary's projected total. + - type: object + description: The summary's projected total. + x-schemaName: IBigNumber + net_total: + oneOf: + - type: string + title: net_total + description: The summary's net total. + - type: number + title: net_total + description: The summary's net total. + - type: string + title: net_total + description: The summary's net total. + - type: object + description: The summary's net total. + x-schemaName: IBigNumber + net_subtotal: + oneOf: + - type: string + title: net_subtotal + description: The summary's net subtotal. + - type: number + title: net_subtotal + description: The summary's net subtotal. + - type: string + title: net_subtotal + description: The summary's net subtotal. + - type: object + description: The summary's net subtotal. + x-schemaName: IBigNumber + net_total_tax: + oneOf: + - type: string + title: net_total_tax + description: The summary's net total tax. + - type: number + title: net_total_tax + description: The summary's net total tax. + - type: string + title: net_total_tax + description: The summary's net total tax. + - type: object + description: The summary's net total tax. + x-schemaName: IBigNumber + balance: + oneOf: + - type: string + title: balance + description: The summary's balance. + - type: number + title: balance + description: The summary's balance. + - type: string + title: balance + description: The summary's balance. + - type: object + description: The summary's balance. + x-schemaName: IBigNumber + paid_total: + oneOf: + - type: string + title: paid_total + description: The summary's paid total. + - type: number + title: paid_total + description: The summary's paid total. + - type: string + title: paid_total + description: The summary's paid total. + - type: object + description: The summary's paid total. + x-schemaName: IBigNumber + refunded_total: + oneOf: + - type: string + title: refunded_total + description: The summary's refunded total. + - type: number + title: refunded_total + description: The summary's refunded total. + - type: string + title: refunded_total + description: The summary's refunded total. + - type: object + description: The summary's refunded total. + x-schemaName: IBigNumber + metadata: + type: object + description: The order preview's metadata. + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order preview's canceled at. + - type: string + title: canceled_at + description: The order preview's canceled at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The order preview's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order preview's updated at. + original_item_total: + oneOf: + - type: string + title: original_item_total + description: The order preview's original item total. + - type: number + title: original_item_total + description: The order preview's original item total. + - type: string + title: original_item_total + description: The order preview's original item total. + - $ref: '#/components/schemas/IBigNumber' + original_item_subtotal: + oneOf: + - type: string + title: original_item_subtotal + description: The order preview's original item subtotal. + - type: number + title: original_item_subtotal + description: The order preview's original item subtotal. + - type: string + title: original_item_subtotal + description: The order preview's original item subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_item_tax_total: + oneOf: + - type: string + title: original_item_tax_total + description: The order preview's original item tax total. + - type: number + title: original_item_tax_total + description: The order preview's original item tax total. + - type: string + title: original_item_tax_total + description: The order preview's original item tax total. + - $ref: '#/components/schemas/IBigNumber' + item_total: + oneOf: + - type: string + title: item_total + description: The order preview's item total. + - type: number + title: item_total + description: The order preview's item total. + - type: string + title: item_total + description: The order preview's item total. + - $ref: '#/components/schemas/IBigNumber' + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The order preview's item subtotal. + - type: number + title: item_subtotal + description: The order preview's item subtotal. + - type: string + title: item_subtotal + description: The order preview's item subtotal. + - $ref: '#/components/schemas/IBigNumber' + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The order preview's item tax total. + - type: number + title: item_tax_total + description: The order preview's item tax total. + - type: string + title: item_tax_total + description: The order preview's item tax total. + - $ref: '#/components/schemas/IBigNumber' + original_total: + oneOf: + - type: string + title: original_total + description: The order preview's original total. + - type: number + title: original_total + description: The order preview's original total. + - type: string + title: original_total + description: The order preview's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The order preview's original subtotal. + - type: number + title: original_subtotal + description: The order preview's original subtotal. + - type: string + title: original_subtotal + description: The order preview's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The order preview's original tax total. + - type: number + title: original_tax_total + description: The order preview's original tax total. + - type: string + title: original_tax_total + description: The order preview's original tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The order preview's total. + - type: number + title: total + description: The order preview's total. + - type: string + title: total + description: The order preview's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The order preview's subtotal. + - type: number + title: subtotal + description: The order preview's subtotal. + - type: string + title: subtotal + description: The order preview's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The order preview's tax total. + - type: number + title: tax_total + description: The order preview's tax total. + - type: string + title: tax_total + description: The order preview's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The order preview's discount total. + - type: number + title: discount_total + description: The order preview's discount total. + - type: string + title: discount_total + description: The order preview's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The order preview's discount tax total. + - type: number + title: discount_tax_total + description: The order preview's discount tax total. + - type: string + title: discount_tax_total + description: The order preview's discount tax total. + - $ref: '#/components/schemas/IBigNumber' + gift_card_total: + oneOf: + - type: string + title: gift_card_total + description: The order preview's gift card total. + - type: number + title: gift_card_total + description: The order preview's gift card total. + - type: string + title: gift_card_total + description: The order preview's gift card total. + - $ref: '#/components/schemas/IBigNumber' + gift_card_tax_total: + oneOf: + - type: string + title: gift_card_tax_total + description: The order preview's gift card tax total. + - type: number + title: gift_card_tax_total + description: The order preview's gift card tax total. + - type: string + title: gift_card_tax_total + description: The order preview's gift card tax total. + - $ref: '#/components/schemas/IBigNumber' + shipping_total: + oneOf: + - type: string + title: shipping_total + description: The order preview's shipping total. + - type: number + title: shipping_total + description: The order preview's shipping total. + - type: string + title: shipping_total + description: The order preview's shipping total. + - $ref: '#/components/schemas/IBigNumber' + shipping_subtotal: + oneOf: + - type: string + title: shipping_subtotal + description: The order preview's shipping subtotal. + - type: number + title: shipping_subtotal + description: The order preview's shipping subtotal. + - type: string + title: shipping_subtotal + description: The order preview's shipping subtotal. + - $ref: '#/components/schemas/IBigNumber' + shipping_tax_total: + oneOf: + - type: string + title: shipping_tax_total + description: The order preview's shipping tax total. + - type: number + title: shipping_tax_total + description: The order preview's shipping tax total. + - type: string + title: shipping_tax_total + description: The order preview's shipping tax total. + - $ref: '#/components/schemas/IBigNumber' + original_shipping_total: + oneOf: + - type: string + title: original_shipping_total + description: The order preview's original shipping total. + - type: number + title: original_shipping_total + description: The order preview's original shipping total. + - type: string + title: original_shipping_total + description: The order preview's original shipping total. + - $ref: '#/components/schemas/IBigNumber' + original_shipping_subtotal: + oneOf: + - type: string + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - type: number + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - type: string + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_shipping_tax_total: + oneOf: + - type: string + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - type: number + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - type: string + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - $ref: '#/components/schemas/IBigNumber' + raw_original_item_total: + type: object + description: The order preview's raw original item total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item total's value. + - type: number + title: value + description: The raw original item total's value. + raw_original_item_subtotal: + type: object + description: The order preview's raw original item subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item subtotal's value. + - type: number + title: value + description: The raw original item subtotal's value. + raw_original_item_tax_total: + type: object + description: The order preview's raw original item tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item tax total's value. + - type: number + title: value + description: The raw original item tax total's value. + raw_item_total: + type: object + description: The order preview's raw item total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item total's value. + - type: number + title: value + description: The raw item total's value. + raw_item_subtotal: + type: object + description: The order preview's raw item subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item subtotal's value. + - type: number + title: value + description: The raw item subtotal's value. + raw_item_tax_total: + type: object + description: The order preview's raw item tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item tax total's value. + - type: number + title: value + description: The raw item tax total's value. + raw_original_total: + type: object + description: The order preview's raw original total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original total's value. + - type: number + title: value + description: The raw original total's value. + raw_original_subtotal: + type: object + description: The order preview's raw original subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original subtotal's value. + - type: number + title: value + description: The raw original subtotal's value. + raw_original_tax_total: + type: object + description: The order preview's raw original tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original tax total's value. + - type: number + title: value + description: The raw original tax total's value. + raw_total: + type: object + description: The order preview's raw total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw total's value. + - type: number + title: value + description: The raw total's value. + raw_subtotal: + type: object + description: The order preview's raw subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw subtotal's value. + - type: number + title: value + description: The raw subtotal's value. + raw_tax_total: + type: object + description: The order preview's raw tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw tax total's value. + - type: number + title: value + description: The raw tax total's value. + raw_discount_total: + type: object + description: The order preview's raw discount total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw discount total's value. + - type: number + title: value + description: The raw discount total's value. + raw_discount_tax_total: + type: object + description: The order preview's raw discount tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw discount tax total's value. + - type: number + title: value + description: The raw discount tax total's value. + raw_gift_card_total: + type: object + description: The order preview's raw gift card total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw gift card total's value. + - type: number + title: value + description: The raw gift card total's value. + raw_gift_card_tax_total: + type: object + description: The order preview's raw gift card tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw gift card tax total's value. + - type: number + title: value + description: The raw gift card tax total's value. + raw_shipping_total: + type: object + description: The order preview's raw shipping total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping total's value. + - type: number + title: value + description: The raw shipping total's value. + raw_shipping_subtotal: + type: object + description: The order preview's raw shipping subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping subtotal's value. + - type: number + title: value + description: The raw shipping subtotal's value. + raw_shipping_tax_total: + type: object + description: The order preview's raw shipping tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping tax total's value. + - type: number + title: value + description: The raw shipping tax total's value. + raw_original_shipping_total: + type: object + description: The order preview's raw original shipping total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping total's value. + - type: number + title: value + description: The raw original shipping total's value. + raw_original_shipping_subtotal: + type: object + description: The order preview's raw original shipping subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping subtotal's value. + - type: number + title: value + description: The raw original shipping subtotal's value. + raw_original_shipping_tax_total: + type: object + description: The order preview's raw original shipping tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping tax total's value. + - type: number + title: value + description: The raw original shipping tax total's value. + OrderAddress: + type: object + description: The order preview's billing address. + x-schemaName: OrderAddress + required: + - id + - created_at + - updated_at + properties: + 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. + OrderChange: + type: object + description: The order preview's order change. + x-schemaName: OrderChange + required: + - id + - version + - order_id + - return_id + - exchange_id + - claim_id + - order + - return_order + - exchange + - claim + - actions + - status + - requested_by + - requested_at + - confirmed_by + - confirmed_at + - declined_by + - declined_reason + - metadata + - declined_at + - canceled_by + - canceled_at + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The order change's ID. + version: + type: number + title: version + description: The order change's version. + change_type: + type: string + enum: + - return + - exchange + - claim + - edit + order_id: + type: string + title: order_id + description: The order change's order id. + return_id: + type: string + title: return_id + description: The order change's return id. + exchange_id: + type: string + title: exchange_id + description: The order change's exchange id. + claim_id: + type: string + title: claim_id + description: The order change's claim id. + order: + type: object + return_order: + $ref: '#/components/schemas/Return' + exchange: + $ref: '#/components/schemas/OrderExchange' + claim: + $ref: '#/components/schemas/OrderClaim' + actions: + type: array + description: The order change's actions. + items: + $ref: '#/components/schemas/OrderChangeAction' + status: + type: string + title: status + description: The order change's status. + requested_by: + type: string + title: requested_by + description: The order change's requested by. + requested_at: + oneOf: + - type: string + title: requested_at + description: The order change's requested at. + - type: string + title: requested_at + description: The order change's requested at. + format: date-time + confirmed_by: + type: string + title: confirmed_by + description: The order change's confirmed by. + confirmed_at: + oneOf: + - type: string + title: confirmed_at + description: The order change's confirmed at. + - type: string + title: confirmed_at + description: The order change's confirmed at. + format: date-time + declined_by: + type: string + title: declined_by + description: The order change's declined by. + declined_reason: + type: string + title: declined_reason + description: The order change's declined reason. + metadata: + type: object + description: The order change's metadata. + declined_at: + oneOf: + - type: string + title: declined_at + description: The order change's declined at. + - type: string + title: declined_at + description: The order change's declined at. + format: date-time + canceled_by: + type: string + title: canceled_by + description: The order change's canceled by. + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order change's canceled at. + - type: string + title: canceled_at + description: The order change's canceled at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The order change's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order change's updated at. + OrderChangeAction: + type: object + description: The action's actions. + x-schemaName: OrderChangeAction + OrderClaim: + type: object + description: The order change's claim. + x-schemaName: OrderClaim + OrderExchange: + type: object + description: The order change's exchange. + x-schemaName: OrderExchange + OrderItem: + type: object + description: The item's detail. + x-schemaName: OrderItem + OrderLineItem: + type: object + description: The item's items. + x-schemaName: OrderLineItem + required: + - id + - title + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - raw_unit_price + - quantity + - raw_quantity + - detail + - created_at + - updated_at + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_item_total + - raw_item_subtotal + - raw_item_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + - raw_refundable_total + - raw_refundable_total_per_unit + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant_id: + type: string + title: variant_id + description: The item's variant id. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + raw_compare_at_unit_price: + type: object + description: The item's raw compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + raw_unit_price: + type: object + description: The item's raw unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + raw_quantity: + type: object + description: The item's raw quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: '#/components/schemas/OrderLineItemTaxLine' + adjustments: + type: array + description: The item's adjustments. + items: + $ref: '#/components/schemas/OrderLineItemAdjustment' + detail: + $ref: '#/components/schemas/OrderItem' + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + metadata: + type: object + description: The item's metadata. + original_total: + oneOf: + - type: string + title: original_total + description: The item's original total. + - type: number + title: original_total + description: The item's original total. + - type: string + title: original_total + description: The item's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The item's original subtotal. + - type: number + title: original_subtotal + description: The item's original subtotal. + - type: string + title: original_subtotal + description: The item's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The item's original tax total. + - type: number + title: original_tax_total + description: The item's original tax total. + - type: string + title: original_tax_total + description: The item's original tax total. + - $ref: '#/components/schemas/IBigNumber' + item_total: + oneOf: + - type: string + title: item_total + description: The item's item total. + - type: number + title: item_total + description: The item's item total. + - type: string + title: item_total + description: The item's item total. + - $ref: '#/components/schemas/IBigNumber' + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The item's item subtotal. + - type: number + title: item_subtotal + description: The item's item subtotal. + - type: string + title: item_subtotal + description: The item's item subtotal. + - $ref: '#/components/schemas/IBigNumber' + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The item's item tax total. + - type: number + title: item_tax_total + description: The item's item tax total. + - type: string + title: item_tax_total + description: The item's item tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The item's total. + - type: number + title: total + description: The item's total. + - type: string + title: total + description: The item's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The item's subtotal. + - type: number + title: subtotal + description: The item's subtotal. + - type: string + title: subtotal + description: The item's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The item's tax total. + - type: number + title: tax_total + description: The item's tax total. + - type: string + title: tax_total + description: The item's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The item's discount total. + - type: number + title: discount_total + description: The item's discount total. + - type: string + title: discount_total + description: The item's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The item's discount tax total. + - type: number + title: discount_tax_total + description: The item's discount tax total. + - type: string + title: discount_tax_total + description: The item's discount tax total. + - $ref: '#/components/schemas/IBigNumber' + refundable_total: + oneOf: + - type: string + title: refundable_total + description: The item's refundable total. + - type: number + title: refundable_total + description: The item's refundable total. + - type: string + title: refundable_total + description: The item's refundable total. + - $ref: '#/components/schemas/IBigNumber' + refundable_total_per_unit: + oneOf: + - type: string + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: string + title: refundable_total_per_unit + description: The item's refundable total per unit. + - $ref: '#/components/schemas/IBigNumber' + raw_original_total: + type: object + description: The item's raw original total. + raw_original_subtotal: + type: object + description: The item's raw original subtotal. + raw_original_tax_total: + type: object + description: The item's raw original tax total. + raw_item_total: + type: object + description: The item's raw item total. + raw_item_subtotal: + type: object + description: The item's raw item subtotal. + raw_item_tax_total: + type: object + description: The item's raw item tax total. + raw_total: + type: object + description: The item's raw total. + raw_subtotal: + type: object + description: The item's raw subtotal. + raw_tax_total: + type: object + description: The item's raw tax total. + raw_discount_total: + type: object + description: The item's raw discount total. + raw_discount_tax_total: + type: object + description: The item's raw discount tax total. + raw_refundable_total: + type: object + description: The item's raw refundable total. + raw_refundable_total_per_unit: + type: object + description: The item's raw refundable total per unit. + OrderLineItemAdjustment: + type: object + description: The adjustment's adjustments. + x-schemaName: OrderLineItemAdjustment + OrderLineItemTaxLine: + type: object + description: The tax line's tax lines. + x-schemaName: OrderLineItemTaxLine + OrderShippingMethod: + type: object + description: The shipping method's shipping methods. + x-schemaName: OrderShippingMethod + required: + - id + - order_id + - name + - amount + - raw_amount + - is_tax_inclusive + - created_at + - updated_at + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + oneOf: + - type: string + title: amount + description: The shipping method's amount. + - type: number + title: amount + description: The shipping method's amount. + - type: string + title: amount + description: The shipping method's amount. + - $ref: '#/components/schemas/IBigNumber' + raw_amount: + type: object + description: The shipping method's raw amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: '#/components/schemas/OrderShippingMethodTaxLine' + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: '#/components/schemas/OrderShippingMethodAdjustment' + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: discount_tax_total + description: The shipping method's discount tax total. + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - $ref: '#/components/schemas/IBigNumber' + raw_original_total: + type: object + description: The shipping method's raw original total. + raw_original_subtotal: + type: object + description: The shipping method's raw original subtotal. + raw_original_tax_total: + type: object + description: The shipping method's raw original tax total. + raw_total: + type: object + description: The shipping method's raw total. + raw_subtotal: + type: object + description: The shipping method's raw subtotal. + raw_tax_total: + type: object + description: The shipping method's raw tax total. + raw_discount_total: + type: object + description: The shipping method's raw discount total. + raw_discount_tax_total: + type: object + description: The shipping method's raw discount tax total. + OrderShippingMethodAdjustment: + type: object + description: The adjustment's adjustments. + x-schemaName: OrderShippingMethodAdjustment + OrderShippingMethodTaxLine: + type: object + description: The tax line's tax lines. + x-schemaName: OrderShippingMethodTaxLine + OrderTransaction: + type: object + description: The transaction's transactions. + x-schemaName: OrderTransaction + required: + - id + - order_id + - order + - amount + - raw_amount + - currency_code + - reference + - reference_id + - created_at + - updated_at + - metadata + properties: + id: + type: string + title: id + description: The transaction's ID. + order_id: + type: string + title: order_id + description: The transaction's order id. + order: + type: object + amount: + oneOf: + - type: string + title: amount + description: The transaction's amount. + - type: number + title: amount + description: The transaction's amount. + - type: string + title: amount + description: The transaction's amount. + - $ref: '#/components/schemas/IBigNumber' + raw_amount: + type: object + description: The transaction's raw amount. + currency_code: + type: string + title: currency_code + description: The transaction's currency code. + reference: + type: string + title: reference + description: The transaction's reference. + reference_id: + type: string + title: reference_id + description: The transaction's reference id. + created_at: + type: string + format: date-time + title: created_at + description: The transaction's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The transaction's updated at. + metadata: + type: object + description: The transaction's metadata. + RefundReasonResponse: + type: object + description: SUMMARY + x-schemaName: RefundReasonResponse + required: + - refund_reason + properties: + refund_reason: + $ref: '#/components/schemas/AdminRefundReason' + ReservationResponse: + type: object + description: The reservation's details. + x-schemaName: ReservationResponse + required: + - id + - line_item_id + - location_id + - quantity + - external_id + - description + - inventory_item_id + - inventory_item + properties: + id: + type: string + title: id + description: The reservation's ID. + 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. + quantity: + type: string + title: quantity + description: The reservation's quantity. + external_id: + type: string + title: external_id + description: The reservation's external id. + description: + type: string + title: description + description: The reservation's description. + inventory_item_id: + type: string + title: inventory_item_id + description: The reservation's inventory item id. + inventory_item: + type: object + description: The reservation's inventory item. + metadata: + type: object + description: The reservation's metadata. + created_by: + type: string + title: created_by + description: The reservation's created by. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The reservation's deleted at. + created_at: + type: string + format: date-time + title: created_at + description: The reservation's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The reservation's updated at. + Return: + type: object + description: The order change's return order. + x-schemaName: Return StoreAddCartLineItem: type: object description: SUMMARY @@ -8611,6 +23441,422 @@ components: type: string title: fields description: The cart's fields. + StoreCart: + type: object + description: The cart's details. + x-schemaName: StoreCart + required: + - id + - currency_code + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total + properties: + id: + type: string + title: id + description: The cart's ID. + region: + $ref: '#/components/schemas/BaseRegion' + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address: + $ref: '#/components/schemas/BaseCartAddress' + billing_address: + $ref: '#/components/schemas/BaseCartAddress' + items: + type: array + description: The cart's items. + items: + $ref: '#/components/schemas/BaseCartLineItem' + shipping_methods: + type: array + description: The cart's shipping methods. + items: + $ref: '#/components/schemas/BaseCartShippingMethod' + payment_collection: + $ref: '#/components/schemas/BasePaymentCollection' + metadata: + type: object + description: The cart's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The cart's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The cart's updated at. + original_item_total: + oneOf: + - type: string + title: original_item_total + description: The cart's original item total. + - type: number + title: original_item_total + description: The cart's original item total. + - type: string + title: original_item_total + description: The cart'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. + - type: number + title: original_item_subtotal + description: The cart's original item subtotal. + - type: string + title: original_item_subtotal + description: The cart'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. + - type: number + title: original_item_tax_total + description: The cart's original item tax total. + - type: string + title: original_item_tax_total + description: The cart's original item tax total. + - $ref: '#/components/schemas/IBigNumber' + item_total: + oneOf: + - type: string + title: item_total + description: The cart's item total. + - type: number + title: item_total + description: The cart's item total. + - type: string + title: item_total + description: The cart's item total. + - $ref: '#/components/schemas/IBigNumber' + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The cart's item subtotal. + - type: number + title: item_subtotal + description: The cart's item subtotal. + - type: string + title: item_subtotal + description: The cart's item subtotal. + - $ref: '#/components/schemas/IBigNumber' + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The cart's item tax total. + - type: number + title: item_tax_total + description: The cart's item tax total. + - type: string + title: item_tax_total + description: The cart's item tax total. + - $ref: '#/components/schemas/IBigNumber' + original_total: + oneOf: + - type: string + title: original_total + description: The cart's original total. + - type: number + title: original_total + description: The cart's original total. + - type: string + title: original_total + description: The cart's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The cart's original subtotal. + - type: number + title: original_subtotal + description: The cart's original subtotal. + - type: string + title: original_subtotal + description: The cart's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The cart's original tax total. + - type: number + title: original_tax_total + description: The cart's original tax total. + - type: string + title: original_tax_total + description: The cart's original tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The cart's total. + - type: number + title: total + description: The cart's total. + - type: string + title: total + description: The cart's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The cart's subtotal. + - type: number + title: subtotal + description: The cart's subtotal. + - type: string + title: subtotal + description: The cart's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The cart's tax total. + - type: number + title: tax_total + description: The cart's tax total. + - type: string + title: tax_total + description: The cart's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The cart's discount total. + - type: number + title: discount_total + description: The cart's discount total. + - type: string + title: discount_total + description: The cart's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The cart's discount tax total. + - type: number + title: discount_tax_total + description: The cart's discount tax total. + - type: string + title: discount_tax_total + description: The cart'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. + - type: number + title: gift_card_total + description: The cart's gift card total. + - type: string + title: gift_card_total + description: The cart'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. + - type: number + title: gift_card_tax_total + description: The cart's gift card tax total. + - type: string + title: gift_card_tax_total + description: The cart's gift card tax total. + - $ref: '#/components/schemas/IBigNumber' + shipping_total: + oneOf: + - type: string + title: shipping_total + description: The cart's shipping total. + - type: number + title: shipping_total + description: The cart's shipping total. + - type: string + title: shipping_total + description: The cart's shipping total. + - $ref: '#/components/schemas/IBigNumber' + shipping_subtotal: + oneOf: + - type: string + title: shipping_subtotal + description: The cart's shipping subtotal. + - type: number + title: shipping_subtotal + description: The cart's shipping subtotal. + - type: string + title: shipping_subtotal + description: The cart's shipping subtotal. + - $ref: '#/components/schemas/IBigNumber' + shipping_tax_total: + oneOf: + - type: string + title: shipping_tax_total + description: The cart's shipping tax total. + - type: number + title: shipping_tax_total + description: The cart's shipping tax total. + - type: string + title: shipping_tax_total + description: The cart'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. + - type: number + title: original_shipping_total + description: The cart's original shipping total. + - type: string + title: original_shipping_total + description: The cart'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. + - type: number + title: original_shipping_subtotal + description: The cart's original shipping subtotal. + - type: string + title: original_shipping_subtotal + description: The cart'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. + - type: number + title: original_shipping_tax_total + description: The cart's original shipping tax total. + - type: string + title: original_shipping_tax_total + description: The cart's original shipping tax total. + - $ref: '#/components/schemas/IBigNumber' + StoreCartResponse: + type: object + description: SUMMARY + x-schemaName: StoreCartResponse + required: + - cart + properties: + cart: + $ref: '#/components/schemas/StoreCart' + StoreCollection: + type: object + description: The collection's details. + x-schemaName: StoreCollection + required: + - id + - title + - handle + - created_at + - updated_at + - deleted_at + - metadata + properties: + id: + type: string + title: id + description: The collection's ID. + title: + type: string + title: title + description: The collection's title. + handle: + type: string + title: handle + description: The collection's handle. + created_at: + type: string + format: date-time + title: created_at + description: The collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The collection's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The collection's deleted at. + products: + type: array + description: The collection's products. + items: + $ref: '#/components/schemas/AdminProduct' + metadata: + type: object + description: The collection's metadata. + StoreCollectionResponse: + type: object + description: SUMMARY + x-schemaName: StoreCollectionResponse + required: + - collection + properties: + collection: + $ref: '#/components/schemas/StoreCollection' StoreCreateCustomer: type: object description: SUMMARY @@ -8643,6 +23889,706 @@ components: type: string title: phone description: The customer's phone. + StoreCurrency: + type: object + description: The currency's details. + x-schemaName: StoreCurrency + 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. + StoreCurrencyListResponse: + type: object + description: SUMMARY + x-schemaName: StoreCurrencyListResponse + required: + - limit + - offset + - count + - currencies + properties: + limit: + type: number + title: limit + description: The currency's limit. + offset: + type: number + title: offset + description: The currency's offset. + count: + type: number + title: count + description: The currency's count. + currencies: + type: array + description: The currency's currencies. + items: + $ref: '#/components/schemas/StoreCurrency' + StoreCurrencyResponse: + type: object + description: SUMMARY + x-schemaName: StoreCurrencyResponse + required: + - currency + properties: + currency: + $ref: '#/components/schemas/StoreCurrency' + StoreCustomer: + type: object + description: The customer's details. + x-schemaName: StoreCustomer + required: + - id + - email + - default_billing_address_id + - default_shipping_address_id + - company_name + - first_name + - last_name + - addresses + properties: + id: + type: string + title: id + description: The customer's ID. + email: + type: string + title: email + description: The customer's email. + format: email + default_billing_address_id: + type: string + title: default_billing_address_id + description: The customer's default billing address id. + default_shipping_address_id: + type: string + title: default_shipping_address_id + description: The customer's default shipping address id. + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + addresses: + type: array + description: The customer's addresses. + items: + $ref: '#/components/schemas/BaseCustomerAddress' + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + created_by: + type: string + title: created_by + description: The customer's created by. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The customer's deleted at. + created_at: + type: string + format: date-time + title: created_at + description: The customer's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The customer's updated at. + StoreCustomerAddress: + type: object + description: The customer's address. + x-schemaName: StoreCustomerAddress + 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. + StoreCustomerAddressListResponse: + type: object + description: SUMMARY + x-schemaName: StoreCustomerAddressListResponse + required: + - limit + - offset + - count + - addresses + properties: + limit: + type: number + title: limit + description: The customer's limit. + offset: + type: number + title: offset + description: The customer's offset. + count: + type: number + title: count + description: The customer's count. + addresses: + type: array + description: The customer's addresses. + items: + $ref: '#/components/schemas/StoreCustomerAddress' + StoreCustomerAddressResponse: + type: object + description: SUMMARY + x-schemaName: StoreCustomerAddressResponse + required: + - address + properties: + address: + $ref: '#/components/schemas/StoreCustomerAddress' + StoreCustomerResponse: + type: object + description: SUMMARY + x-schemaName: StoreCustomerResponse + required: + - customer + properties: + customer: + $ref: '#/components/schemas/StoreCustomer' + StoreOrder: + type: object + description: The cart's order. + x-schemaName: StoreOrder + required: + - id + - version + - region_id + - customer_id + - sales_channel_id + - email + - currency_code + - items + - shipping_methods + - payment_status + - fulfillment_status + - summary + - metadata + - created_at + - updated_at + - original_item_total + - original_item_subtotal + - original_item_tax_total + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - gift_card_total + - gift_card_tax_total + - shipping_total + - shipping_subtotal + - shipping_tax_total + - original_shipping_total + - original_shipping_subtotal + - original_shipping_tax_total + properties: + id: + type: string + title: id + description: The order's ID. + version: + type: number + title: version + description: The order's version. + region_id: + type: string + title: region_id + description: The order's region id. + customer_id: + type: string + title: customer_id + description: The order's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order's sales channel id. + email: + type: string + title: email + description: The order's email. + format: email + currency_code: + type: string + title: currency_code + description: The order's currency code. + display_id: + type: string + 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. + items: + $ref: '#/components/schemas/BaseOrderLineItem' + shipping_methods: + type: array + description: The order's shipping methods. + items: + $ref: '#/components/schemas/BaseOrderShippingMethod' + payment_collections: + type: array + description: The order's payment collections. + items: + $ref: '#/components/schemas/BasePaymentCollection' + payment_status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The order's fulfillments. + items: + $ref: '#/components/schemas/BaseOrderFulfillment' + fulfillment_status: + type: string + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The order's transactions. + items: + $ref: '#/components/schemas/BaseOrderTransaction' + summary: + $ref: '#/components/schemas/BaseOrderSummary' + metadata: + type: object + description: The order's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The order's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order's updated at. + original_item_total: + type: number + title: original_item_total + description: The order's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The order's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The order's original item tax total. + item_total: + type: number + title: item_total + description: The order's item total. + item_subtotal: + type: number + title: item_subtotal + description: The order's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The order's item tax total. + original_total: + type: number + title: original_total + description: The order's original total. + original_subtotal: + type: number + title: original_subtotal + description: The order's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The order's original tax total. + total: + type: number + title: total + description: The order's total. + subtotal: + type: number + title: subtotal + description: The order's subtotal. + tax_total: + type: number + title: tax_total + description: The order's tax total. + discount_total: + type: number + title: discount_total + description: The order's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The order's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The order's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The order's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The order's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The order's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The order's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The order's original shipping tax total. + StoreOrderResponse: + type: object + description: SUMMARY + x-schemaName: StoreOrderResponse + required: + - order + properties: + order: + $ref: '#/components/schemas/StoreOrder' + StorePaymentCollection: + type: object + description: The payment collection's details. + x-schemaName: StorePaymentCollection + required: + - id + - currency_code + - region_id + - amount + - status + - payment_providers + properties: + id: + type: string + title: id + description: The payment collection's ID. + currency_code: + type: string + title: currency_code + description: The payment collection's currency code. + region_id: + type: string + title: region_id + description: The payment collection's region id. + amount: + oneOf: + - type: string + title: amount + description: The payment collection's amount. + - type: number + title: amount + description: The payment collection's amount. + - type: string + title: amount + description: The payment collection's amount. + - $ref: '#/components/schemas/IBigNumber' + authorized_amount: + oneOf: + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - type: number + title: authorized_amount + description: The payment collection's authorized amount. + - type: string + title: authorized_amount + description: The payment collection's authorized amount. + - $ref: '#/components/schemas/IBigNumber' + captured_amount: + oneOf: + - type: string + title: captured_amount + description: The payment collection's captured amount. + - type: number + title: captured_amount + description: The payment collection's captured amount. + - type: string + title: captured_amount + description: The payment collection's captured amount. + - $ref: '#/components/schemas/IBigNumber' + refunded_amount: + oneOf: + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - type: number + title: refunded_amount + description: The payment collection's refunded amount. + - type: string + title: refunded_amount + description: The payment collection's refunded amount. + - $ref: '#/components/schemas/IBigNumber' + completed_at: + oneOf: + - type: string + title: completed_at + description: The payment collection's completed at. + - type: string + title: completed_at + description: The payment collection's completed at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The payment collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The payment collection's updated at. + metadata: + type: object + description: The payment collection's metadata. + status: + type: string + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + payment_providers: + type: array + description: The payment collection's payment providers. + items: + $ref: '#/components/schemas/BasePaymentProvider' + payment_sessions: + type: array + description: The payment collection's payment sessions. + items: + $ref: '#/components/schemas/BasePaymentSession' + payments: + type: array + description: The payment collection's payments. + items: + $ref: '#/components/schemas/BasePayment' + StorePaymentCollectionResponse: + type: object + description: SUMMARY + x-schemaName: StorePaymentCollectionResponse + required: + - payment_collection + properties: + payment_collection: + $ref: '#/components/schemas/StorePaymentCollection' + StorePaymentProvider: + type: object + description: The payment provider's payment providers. + x-schemaName: StorePaymentProvider + required: + - id + properties: + id: + type: string + title: id + description: The payment provider's ID. StorePostReturnsReqSchema: type: object description: SUMMARY @@ -8714,7 +24660,7 @@ components: description: The return's location id. StoreProduct: type: object - description: The product's products. + description: The product's details. x-schemaName: StoreProduct required: - title @@ -8723,26 +24669,26 @@ components: - options - description - id - - handle - - hs_code - - weight - - height - - width - - origin_country - - mid_code - - material - - thumbnail - created_at - updated_at - - deleted_at - variants + - handle - subtitle - is_giftcard + - thumbnail + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material - collection_id - type_id - images - discountable - external_id + - deleted_at properties: categories: type: array @@ -8782,42 +24728,6 @@ components: metadata: type: object description: The product's metadata. - handle: - type: string - title: handle - description: The product's handle. - hs_code: - type: string - title: hs_code - description: The product's hs code. - weight: - type: number - title: weight - description: The product's weight. - height: - type: number - title: height - description: The product's height. - width: - type: number - title: width - description: The product's width. - origin_country: - type: string - title: origin_country - description: The product's origin country. - mid_code: - type: string - title: mid_code - description: The product's mid code. - material: - type: string - title: material - description: The product's material. - thumbnail: - type: string - title: thumbnail - description: The product's thumbnail. created_at: type: string format: date-time @@ -8828,16 +24738,15 @@ components: format: date-time title: updated_at description: The product's updated at. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The product's deleted at. variants: type: array description: The product's variants. items: $ref: '#/components/schemas/BaseProductVariant' + handle: + type: string + title: handle + description: The product's handle. subtitle: type: string title: subtitle @@ -8846,6 +24755,38 @@ components: type: boolean title: is_giftcard description: The product's is giftcard. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. collection: $ref: '#/components/schemas/BaseCollection' collection_id: @@ -8874,9 +24815,14 @@ components: type: string title: external_id description: The product's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. StoreProductCategory: type: object - description: The product category's details. + description: The category's categories. x-schemaName: StoreProductCategory required: - id @@ -8895,63 +24841,63 @@ components: properties: products: type: array - description: The product category's products. + description: The category's products. items: $ref: '#/components/schemas/StoreProduct' id: type: string title: id - description: The product category's ID. + description: The category's ID. name: type: string title: name - description: The product category's name. + description: The category's name. description: type: string title: description - description: The product category's description. + description: The category's description. handle: type: string title: handle - description: The product category's handle. + description: The category's handle. is_active: type: boolean title: is_active - description: The product category's is active. + description: The category's is active. is_internal: type: boolean title: is_internal - description: The product category's is internal. + description: The category's is internal. rank: type: number title: rank - description: The product category's rank. + description: The category's rank. parent_category_id: type: string title: parent_category_id - description: The product category's parent category id. + description: The category's parent category id. parent_category: $ref: '#/components/schemas/BaseProductCategory' category_children: type: array - description: The product category's category children. + description: The category's category children. items: $ref: '#/components/schemas/BaseProductCategory' created_at: type: string format: date-time title: created_at - description: The product category's created at. + description: The category's created at. updated_at: type: string format: date-time title: updated_at - description: The product category's updated at. + description: The category's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The product category's deleted at. + description: The category's deleted at. StoreProductCategoryListResponse: type: object description: SUMMARY @@ -8988,6 +24934,266 @@ components: properties: product_category: $ref: '#/components/schemas/StoreProductCategory' + StoreProductResponse: + type: object + description: SUMMARY + x-schemaName: StoreProductResponse + required: + - product + properties: + product: + $ref: '#/components/schemas/StoreProduct' + StoreRegion: + type: object + description: The region's details. + x-schemaName: StoreRegion + required: + - id + - name + - currency_code + properties: + id: + type: string + title: id + description: The region's ID. + name: + type: string + title: name + description: The region's name. + currency_code: + type: string + title: currency_code + description: The region's currency code. + automatic_taxes: + type: boolean + title: automatic_taxes + description: The region's automatic taxes. + countries: + type: array + description: The region's countries. + items: + $ref: '#/components/schemas/BaseRegionCountry' + payment_providers: + type: array + description: The region's payment providers. + items: + $ref: '#/components/schemas/AdminPaymentProvider' + metadata: + type: object + description: The region's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The region's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The region's updated at. + StoreReturn: + type: object + description: The return's details. + x-schemaName: StoreReturn + required: + - id + - order_id + - order_version + - display_id + - items + - received_at + - created_at + properties: + id: + type: string + title: id + description: The return's ID. + order_id: + type: string + title: order_id + description: The return's order id. + status: + type: string + title: status + description: The return's status. + exchange_id: + type: string + title: exchange_id + description: The return's exchange id. + location_id: + type: string + title: location_id + description: The return's location id. + claim_id: + type: string + title: claim_id + description: The return's claim id. + order_version: + type: number + title: order_version + description: The return's order version. + display_id: + type: number + title: display_id + description: The return's display id. + no_notification: + type: boolean + title: no_notification + description: The return's no notification. + refund_amount: + type: number + title: refund_amount + description: The return's refund amount. + items: + type: array + description: The return's items. + items: + $ref: '#/components/schemas/BaseReturnItem' + received_at: + type: string + title: received_at + description: The return's received at. + created_at: + type: string + format: date-time + title: created_at + description: The return's created at. + StoreReturnReason: + type: object + description: The return reason's details. + x-schemaName: StoreReturnReason + required: + - id + - value + - label + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The return reason's ID. + value: + type: string + title: value + description: The return reason's value. + label: + type: string + title: label + description: The return reason's label. + description: + type: string + title: description + description: The return reason's description. + metadata: + type: object + description: The return reason's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The return reason's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The return reason's updated at. + StoreReturnReasonResponse: + type: object + description: SUMMARY + x-schemaName: StoreReturnReasonResponse + required: + - return_reason + properties: + return_reason: + $ref: '#/components/schemas/StoreReturnReason' + StoreReturnResponse: + type: object + description: SUMMARY + x-schemaName: StoreReturnResponse + required: + - return + properties: + return: + $ref: '#/components/schemas/StoreReturn' + StoreShippingOption: + type: object + description: The shipping option's shipping options. + x-schemaName: StoreShippingOption + required: + - id + - name + - price_type + - service_zone_id + - provider_id + - provider + - shipping_option_type_id + - type + - shipping_profile_id + - amount + - is_tax_inclusive + - data + - metadata + properties: + id: + type: string + title: id + description: The shipping option's ID. + name: + type: string + title: name + description: The shipping option's name. + price_type: + type: string + enum: + - flat + - calculated + service_zone_id: + type: string + title: service_zone_id + description: The shipping option's service zone id. + provider_id: + type: string + title: provider_id + description: The shipping option's provider id. + provider: + $ref: '#/components/schemas/BaseFulfillmentProvider' + shipping_option_type_id: + type: string + title: shipping_option_type_id + description: The shipping option's shipping option type id. + type: + type: object + shipping_profile_id: + type: string + title: shipping_profile_id + description: The shipping option's shipping profile id. + amount: + type: number + title: amount + description: The shipping option's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping option's is tax inclusive. + data: + type: object + description: The shipping option's data. + metadata: + type: object + description: The shipping option's metadata. + StoreShippingOptionListResponse: + type: object + description: SUMMARY + x-schemaName: StoreShippingOptionListResponse + required: + - shipping_options + properties: + shipping_options: + type: array + description: The shipping option's shipping options. + items: + $ref: '#/components/schemas/StoreShippingOption' StoreUpdateCartLineItem: type: object description: SUMMARY @@ -9087,51 +25293,6 @@ components: metadata: type: object description: The shipping address's metadata. - UpdateCartData: - type: object - description: SUMMARY - x-schemaName: UpdateCartData - properties: - region_id: - type: string - title: region_id - description: The cart's region id. - customer_id: - type: string - title: customer_id - description: The cart's customer id. - sales_channel_id: - type: string - title: sales_channel_id - description: The cart's sales channel id. - email: - type: string - title: email - description: The cart's email. - format: email - currency_code: - type: string - title: currency_code - description: The cart's currency code. - shipping_address_id: - type: string - title: shipping_address_id - description: The cart's shipping address id. - billing_address_id: - type: string - title: billing_address_id - description: The cart's billing address id. - billing_address: - oneOf: - - $ref: '#/components/schemas/CreateAddress' - - $ref: '#/components/schemas/UpdateAddress' - shipping_address: - oneOf: - - $ref: '#/components/schemas/CreateAddress' - - $ref: '#/components/schemas/UpdateAddress' - metadata: - type: object - description: The cart's metadata. UpdateOrderReturnReason: type: object description: SUMMARY @@ -9156,3 +25317,171 @@ components: metadata: type: object description: The return reason's metadata. + responses: + default_error: + description: Default Error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + code: unknown_error + message: An unknown error occurred. + type: unknown_error + invalid_state_error: + description: Invalid State Error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + code: unknown_error + message: The request conflicted with another request. You may retry the request with the provided Idempotency-Key. + type: QueryRunnerAlreadyReleasedError + invalid_request_error: + description: Invalid Request Error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + code: invalid_request_error + message: Discount with code TEST already exists. + type: duplicate_error + not_found_error: + description: Not Found Error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + message: Entity with id 1 was not found + type: not_found + 400_error: + description: Client Error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + not_allowed: + $ref: '#/components/examples/not_allowed_error' + invalid_data: + $ref: '#/components/examples/invalid_data_error' + 500_error: + description: Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + database: + $ref: '#/components/examples/database_error' + unexpected_state: + $ref: '#/components/examples/unexpected_state_error' + invalid_argument: + $ref: '#/components/examples/invalid_argument_error' + default_error: + $ref: '#/components/examples/default_error' + unauthorized: + description: User is not authorized. Must log in first + content: + text/plain: + schema: + type: string + default: Unauthorized + example: Unauthorized + incorrect_credentials: + description: User does not exist or incorrect credentials + content: + text/plain: + schema: + type: string + default: Unauthorized + example: Unauthorized + examples: + not_allowed_error: + summary: Not Allowed Error + value: + message: Discount must be set to dynamic + type: not_allowed + invalid_data_error: + summary: Invalid Data Error + value: + message: first_name must be a string + type: invalid_data + multiple_errors: + summary: Multiple Errors + value: + message: Provided request body contains errors. Please check the data and retry the request + errors: + - message: first_name must be a string + type: invalid_data + - message: Discount must be set to dynamic + type: not_allowed + database_error: + summary: Database Error + value: + code: api_error + message: An error occured while hashing password + type: database_error + unexpected_state_error: + summary: Unexpected State Error + value: + message: cart.total must be defined + type: unexpected_state + invalid_argument_error: + summary: Invalid Argument Error + value: + message: cart.total must be defined + type: unexpected_state + default_error: + summary: Default Error + value: + code: unknown_error + message: An unknown error occurred. + type: unknown_error + securitySchemes: + jwt_token: + type: http + x-displayName: JWT Token + scheme: bearer + cookie_auth: + type: apiKey + x-displayName: Cookie Session ID + in: cookie + name: connect.sid + description: | + Use a cookie session to send authenticated requests. + + ### How to Obtain the Cookie Session + + If you're sending requests through a browser, using JS Client, or using tools like Postman, the cookie session should be automatically set when the customer is logged in. + + If you're sending requests using cURL, you must set the Session ID in the cookie manually. + + To do that, send a request to [authenticate the customer](#tag/Auth/operation/PostAuth) and pass the cURL option `-v`: + + ```bash + curl -v --location --request POST 'https://medusa-url.com/store/auth' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "email": "user@example.com", + "password": "supersecret" + }' + ``` + + The headers will be logged in the terminal as well as the response. You should find in the headers a Cookie header similar to this: + + ```bash + Set-Cookie: connect.sid=s%3A2Bu8BkaP9JUfHu9rG59G16Ma0QZf6Gj1.WT549XqX37PN8n0OecqnMCq798eLjZC5IT7yiDCBHPM; + ``` + + Copy the value after `connect.sid` (without the `;` at the end) and pass it as a cookie in subsequent requests as the following: + + ```bash + curl --location --request GET 'https://medusa-url.com/store/customers/me/orders' \ + --header 'Cookie: connect.sid={sid}' + ``` + + Where `{sid}` is the value of `connect.sid` that you copied. diff --git a/www/apps/api-reference/specs/store/openapi.yaml b/www/apps/api-reference/specs/store/openapi.yaml index 8284fa87c8..0a77a9714d 100644 --- a/www/apps/api-reference/specs/store/openapi.yaml +++ b/www/apps/api-reference/specs/store/openapi.yaml @@ -19,15 +19,29 @@ tags: description: How to implement cart functionality in your storefront url: >- https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart + x-associatedSchema: + $ref: ./components/schemas/StoreCart.yaml - name: Collections + x-associatedSchema: + $ref: ./components/schemas/StoreCollection.yaml - name: Currencies + x-associatedSchema: + $ref: ./components/schemas/StoreCurrency.yaml - name: Customers + x-associatedSchema: + $ref: ./components/schemas/StoreCustomer.yaml - name: Orders + x-associatedSchema: + $ref: ./components/schemas/StoreOrder.yaml - name: Payment Collections description: > A payment collection is useful for managing additional payments, such as for Order Edits, or installment payments. + x-associatedSchema: + $ref: ./components/schemas/StorePaymentCollection.yaml - name: Payment Providers + x-associatedSchema: + $ref: ./components/schemas/StorePaymentProvider.yaml - name: Product Categories x-associatedSchema: $ref: ./components/schemas/StoreProductCategory.yaml @@ -45,9 +59,17 @@ tags: description: How to use regions in a storefront url: >- https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions + x-associatedSchema: + $ref: ./components/schemas/StoreRegion.yaml - name: Return + x-associatedSchema: + $ref: ./components/schemas/StoreReturn.yaml - name: Return Reasons + x-associatedSchema: + $ref: ./components/schemas/StoreReturnReason.yaml - name: Shipping Options + x-associatedSchema: + $ref: ./components/schemas/StoreShippingOption.yaml paths: /store/carts: $ref: paths/store_carts.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_carts.yaml b/www/apps/api-reference/specs/store/paths/store_carts.yaml index f7423095fa..3bbf2826a4 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts.yaml @@ -63,7 +63,64 @@ post: content: application/json: schema: - $ref: ../components/schemas/CreateCartWorkflowInput.yaml + description: SUMMARY + properties: + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address_id: + type: string + title: shipping_address_id + description: The cart's shipping address id. + billing_address_id: + type: string + title: billing_address_id + description: The cart's billing address id. + shipping_address: + oneOf: + - type: string + title: shipping_address + description: The cart's shipping address. + - $ref: ../components/schemas/CreateCartAddress.yaml + billing_address: + oneOf: + - type: string + title: billing_address + description: The cart's billing address. + - $ref: ../components/schemas/CreateCartAddress.yaml + metadata: + type: object + description: The cart's metadata. + items: + type: array + description: The cart's items. + items: + $ref: ../components/schemas/CreateCartCreateLineItem.yaml + promo_codes: + type: array + description: The cart's promo codes. + items: + type: string + title: promo_codes + description: The promo code's promo codes. x-codeSamples: - lang: Shell label: cURL @@ -72,6 +129,12 @@ post: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreCartResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -84,3 +147,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createCartWorkflow diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml index 2dde349777..ad2a63e404 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml @@ -75,6 +75,12 @@ get: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreCartResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -158,7 +164,48 @@ post: content: application/json: schema: - $ref: ../components/schemas/UpdateCartData.yaml + description: SUMMARY + properties: + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address_id: + type: string + title: shipping_address_id + description: The cart's shipping address id. + billing_address_id: + type: string + title: billing_address_id + description: The cart's billing address id. + billing_address: + oneOf: + - $ref: ../components/schemas/CreateAddress.yaml + - $ref: ../components/schemas/UpdateAddress.yaml + shipping_address: + oneOf: + - $ref: ../components/schemas/CreateAddress.yaml + - $ref: ../components/schemas/UpdateAddress.yaml + metadata: + type: object + description: The cart's metadata. x-codeSamples: - lang: Shell label: cURL @@ -167,6 +214,18 @@ post: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - cart + properties: + cart: + $ref: ../components/schemas/StoreCart.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml index 35eb56af85..0833932a29 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml @@ -84,6 +84,57 @@ post: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + oneOf: + - type: object + description: SUMMARY + required: + - type + - cart + - error + properties: + type: + type: string + title: type + description: The cart's type. + cart: + $ref: ../components/schemas/StoreCart.yaml + error: + type: object + description: The cart's error. + required: + - message + - name + - type + properties: + message: + type: string + title: message + description: The error's message. + name: + type: string + title: name + description: The error's name. + type: + type: string + title: type + description: The error's type. + - type: object + description: SUMMARY + required: + - type + - order + properties: + type: + type: string + title: type + description: The cart's type. + order: + $ref: ../components/schemas/StoreOrder.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -96,3 +147,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: completeCartWorkflow diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml index da225a63de..52dba6938f 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml @@ -78,6 +78,12 @@ post: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreCartResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 e8005c9db7..78c9104010 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 @@ -84,6 +84,12 @@ post: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreCartResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml index 21822ae771..2f5fbd2da4 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml @@ -89,6 +89,12 @@ post: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreCartResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -178,6 +184,18 @@ delete: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - cart + properties: + cart: + $ref: ../components/schemas/StoreCart.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml index 6285ba43db..30c8263c00 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml @@ -89,6 +89,12 @@ post: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreCartResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml index 42b97f5fe7..c0de63824f 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml @@ -78,6 +78,12 @@ post: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreCartResponse.yaml '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 1cf1a7347e..cdf92976f2 100644 --- a/www/apps/api-reference/specs/store/paths/store_collections.yaml +++ b/www/apps/api-reference/specs/store/paths/store_collections.yaml @@ -69,6 +69,41 @@ get: tags: - Collections responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The collection's limit. + offset: + type: number + title: offset + description: The collection's offset. + count: + type: number + title: count + description: The collection's count. + - type: object + description: SUMMARY + required: + - collections + properties: + collections: + type: array + description: The collection's collections. + items: + $ref: ../components/schemas/StoreCollection.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml index ee380e04a2..18e9ce07bb 100644 --- a/www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml @@ -75,6 +75,12 @@ get: tags: - Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreCollectionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 1fd56fac29..3c38f49170 100644 --- a/www/apps/api-reference/specs/store/paths/store_currencies.yaml +++ b/www/apps/api-reference/specs/store/paths/store_currencies.yaml @@ -69,6 +69,12 @@ get: tags: - Currencies responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreCurrencyListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_currencies_{code}.yaml b/www/apps/api-reference/specs/store/paths/store_currencies_{code}.yaml index 61a4a20db5..049daacf71 100644 --- a/www/apps/api-reference/specs/store/paths/store_currencies_{code}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_currencies_{code}.yaml @@ -75,6 +75,12 @@ get: tags: - Currencies responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreCurrencyResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_customers.yaml b/www/apps/api-reference/specs/store/paths/store_customers.yaml index 499eb68673..42727bd80a 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers.yaml @@ -72,6 +72,12 @@ post: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreCustomerResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me.yaml index b65342d131..1a6ea0eeab 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers_me.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers_me.yaml @@ -72,6 +72,12 @@ get: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreCustomerResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -161,6 +167,12 @@ post: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreCustomerResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml index 1f8a8f5197..4fa2d76d9b 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml @@ -183,6 +183,12 @@ get: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreCustomerAddressListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -342,6 +348,12 @@ post: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreCustomerResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 c0d620ac05..0861d56f33 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 @@ -78,6 +78,12 @@ get: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreCustomerAddressResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -244,6 +250,12 @@ post: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreCustomerResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -337,6 +349,33 @@ delete: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + 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 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_orders.yaml b/www/apps/api-reference/specs/store/paths/store_orders.yaml index c7c11663d5..5d501a7310 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders.yaml @@ -92,11 +92,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The order's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The order's $or. + items: + type: object + title: $or x-codeSamples: - lang: Shell label: cURL @@ -105,6 +115,41 @@ get: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The order's limit. + offset: + type: number + title: offset + description: The order's offset. + count: + type: number + title: count + description: The order's count. + - type: object + description: SUMMARY + required: + - orders + properties: + orders: + type: array + description: The order's orders. + items: + $ref: ../components/schemas/StoreOrder.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml index f7cb6a772f..d2bcb881df 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml @@ -98,11 +98,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The order's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The order's $or. + items: + type: object + title: $or x-codeSamples: - lang: Shell label: cURL @@ -111,6 +121,12 @@ get: tags: - Orders responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreOrderResponse.yaml '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 a4152e7f04..e154b1d255 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 @@ -67,26 +67,11 @@ post: description: SUMMARY required: - cart_id - - region_id - - currency_code - - amount properties: cart_id: type: string title: cart_id description: The payment collection's cart id. - region_id: - type: string - title: region_id - description: The payment collection's region id. - currency_code: - type: string - title: currency_code - description: The payment collection's currency code. - amount: - type: number - title: amount - description: The payment collection's amount. x-codeSamples: - lang: Shell label: cURL @@ -95,6 +80,12 @@ post: tags: - Payment Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StorePaymentCollectionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml index 6907fce9d1..b7ec4f3200 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml @@ -93,6 +93,12 @@ post: tags: - Payment Collections responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StorePaymentCollectionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 380ff8fbc2..9b636d127f 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 @@ -95,11 +95,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The payment provider's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The payment provider's $or. + items: + type: object + title: $or x-codeSamples: - lang: Shell label: cURL @@ -108,6 +118,41 @@ get: tags: - Payment Providers responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The payment provider's limit. + offset: + type: number + title: offset + description: The payment provider's offset. + count: + type: number + title: count + description: The payment provider's count. + - type: object + description: SUMMARY + required: + - payment_providers + properties: + payment_providers: + type: array + description: The payment provider's payment providers. + items: + $ref: ../components/schemas/StorePaymentProvider.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 ca34c4ef63..b344ef0582 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 @@ -247,11 +247,21 @@ get: - name: $and in: query required: false - schema: {} + schema: + type: array + description: The product category's $and. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The product category's $or. + items: + type: object + title: $or 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 68efd5f1ed..32673b9f6d 100644 --- a/www/apps/api-reference/specs/store/paths/store_products.yaml +++ b/www/apps/api-reference/specs/store/paths/store_products.yaml @@ -61,22 +61,30 @@ 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: 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: $and in: query required: false - schema: {} + schema: + type: array + description: The product's $and. + items: + type: array + description: The $and's details. + items: + type: object + title: $and - name: $or in: query required: false - schema: {} + schema: + type: array + description: The product's $or. + items: + type: array + description: The $or's details. + items: + type: object + title: $or - name: variants in: query description: The product's variants. @@ -85,16 +93,6 @@ get: type: object description: The product's variants. properties: - status: - type: array - description: The variant's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected options: type: object description: The variant's options. @@ -110,8 +108,6 @@ get: type: string title: option_id description: The option's option id. - $and: {} - $or: {} - name: q in: query description: The product's q. @@ -137,51 +133,45 @@ get: - name: title in: query description: The product's title. - required: true + required: false schema: - type: string - title: title - description: The product's title. + oneOf: + - type: string + title: title + description: The product's title. + - type: array + description: The product's title. + items: + type: string + title: title + description: The title's details. - name: handle in: query description: The product's handle. - required: true + required: false schema: - type: string - title: handle - description: The product's handle. + oneOf: + - type: string + title: handle + description: The product's handle. + - type: array + description: The product's handle. + items: + type: string + title: handle + description: The handle's details. - name: is_giftcard in: query description: The product's is giftcard. - required: true + required: false schema: type: boolean title: is_giftcard description: The product's is giftcard. - - name: category_id - in: query - description: The product's category id. - required: true - schema: - description: The product's category id. - items: - type: string - title: category_id - description: The category id's details. - - name: sales_channel_id - in: query - description: The product's sales channel id. - required: true - schema: - description: The product's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - name: collection_id in: query description: The product's collection id. - required: true + required: false schema: description: The product's collection id. items: @@ -193,11 +183,16 @@ get: description: The product's tags. required: false schema: + type: object description: The product's tags. - items: - type: string - title: tags - description: The tag's tags. + properties: + id: + type: array + description: The tag's ID. + items: + type: string + title: id + description: The id's ID. - name: type_id in: query description: The product's type id. @@ -213,127 +208,6230 @@ get: description: The product's created at. required: false schema: - type: string + type: object description: The product's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + $and: + type: array + description: The created at's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1165: + type: object + description: The $and's @match@1165. + __@replace@1167: + type: object + description: The $and's @replace@1167. + __@search@1170: + type: object + description: The $and's @search@1170. + __@split@1172: + type: object + description: The $and's @split@1172. + __@matchAll@1174: + type: object + description: The $and's @matchall@1174. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $and's $eq. + - type: object + description: The $and's $eq. + x-schemaName: RegExp + - type: array + description: The $and's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $and's $ne. + - type: object + description: The $and's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $and's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $and's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $and's $not. + - type: object + description: The $and's $not. + x-schemaName: RegExp + - type: object + description: The $and's $not. + - type: array + description: The $and's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $and's $gt. + - type: object + description: The $and's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $and's $gte. + - type: object + description: The $and's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $and's $lt. + - type: object + description: The $and's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $and's $lte. + - type: object + description: The $and's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $and's $like. + $re: + type: string + title: $re + description: The $and's $re. + $ilike: + type: string + title: $ilike + description: The $and's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $and's $fulltext. + $overlap: + type: array + description: The $and's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $and's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $and's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $and's $exists. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1165: + type: object + description: The $and's @match@1165. + __@replace@1167: + type: object + description: The $and's @replace@1167. + __@search@1170: + type: object + description: The $and's @search@1170. + __@split@1172: + type: object + description: The $and's @split@1172. + __@matchAll@1174: + type: object + description: The $and's @matchall@1174. + $or: + type: array + description: The created at's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1165: + type: object + description: The $or's @match@1165. + __@replace@1167: + type: object + description: The $or's @replace@1167. + __@search@1170: + type: object + description: The $or's @search@1170. + __@split@1172: + type: object + description: The $or's @split@1172. + __@matchAll@1174: + type: object + description: The $or's @matchall@1174. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $or's $eq. + - type: object + description: The $or's $eq. + x-schemaName: RegExp + - type: array + description: The $or's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $or's $ne. + - type: object + description: The $or's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $or's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $or's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $or's $not. + - type: object + description: The $or's $not. + x-schemaName: RegExp + - type: object + description: The $or's $not. + - type: array + description: The $or's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $or's $gt. + - type: object + description: The $or's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $or's $gte. + - type: object + description: The $or's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $or's $lt. + - type: object + description: The $or's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $or's $lte. + - type: object + description: The $or's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $or's $like. + $re: + type: string + title: $re + description: The $or's $re. + $ilike: + type: string + title: $ilike + description: The $or's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $or's $fulltext. + $overlap: + type: array + description: The $or's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $or's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $or's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $or's $exists. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1165: + type: object + description: The $or's @match@1165. + __@replace@1167: + type: object + description: The $or's @replace@1167. + __@search@1170: + type: object + description: The $or's @search@1170. + __@split@1172: + type: object + description: The $or's @split@1172. + __@matchAll@1174: + type: object + description: The $or's @matchall@1174. + $eq: + oneOf: + - type: string + title: $eq + description: The created at's $eq. + - type: object + description: The created at's $eq. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1165: + type: object + description: The $eq's @match@1165. + __@replace@1167: + type: object + description: The $eq's @replace@1167. + __@search@1170: + type: object + description: The $eq's @search@1170. + __@split@1172: + type: object + description: The $eq's @split@1172. + __@matchAll@1174: + type: object + description: The $eq's @matchall@1174. + - type: array + description: The created at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1165: + type: object + description: The $eq's @match@1165. + __@replace@1167: + type: object + description: The $eq's @replace@1167. + __@search@1170: + type: object + description: The $eq's @search@1170. + __@split@1172: + type: object + description: The $eq's @split@1172. + __@matchAll@1174: + type: object + description: The $eq's @matchall@1174. + $ne: + oneOf: + - type: string + title: $ne + description: The created at's $ne. + - type: object + description: The created at's $ne. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $ne's exec. + test: + type: object + description: The $ne's test. + source: + type: string + title: source + description: The $ne's source. + global: + type: boolean + title: global + description: The $ne's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $ne's ignorecase. + multiline: + type: boolean + title: multiline + description: The $ne's multiline. + lastIndex: + type: number + title: lastIndex + description: The $ne's lastindex. + compile: + type: object + description: The $ne's compile. + flags: + type: string + title: flags + description: The $ne's flags. + sticky: + type: boolean + title: sticky + description: The $ne's sticky. + unicode: + type: boolean + title: unicode + description: The $ne's unicode. + dotAll: + type: boolean + title: dotAll + description: The $ne's dotall. + __@match@1165: + type: object + description: The $ne's @match@1165. + __@replace@1167: + type: object + description: The $ne's @replace@1167. + __@search@1170: + type: object + description: The $ne's @search@1170. + __@split@1172: + type: object + description: The $ne's @split@1172. + __@matchAll@1174: + type: object + description: The $ne's @matchall@1174. + $in: + type: array + description: The created at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $in's exec. + test: + type: object + description: The $in's test. + source: + type: string + title: source + description: The $in's source. + global: + type: boolean + title: global + description: The $in's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $in's ignorecase. + multiline: + type: boolean + title: multiline + description: The $in's multiline. + lastIndex: + type: number + title: lastIndex + description: The $in's lastindex. + compile: + type: object + description: The $in's compile. + flags: + type: string + title: flags + description: The $in's flags. + sticky: + type: boolean + title: sticky + description: The $in's sticky. + unicode: + type: boolean + title: unicode + description: The $in's unicode. + dotAll: + type: boolean + title: dotAll + description: The $in's dotall. + __@match@1165: + type: object + description: The $in's @match@1165. + __@replace@1167: + type: object + description: The $in's @replace@1167. + __@search@1170: + type: object + description: The $in's @search@1170. + __@split@1172: + type: object + description: The $in's @split@1172. + __@matchAll@1174: + type: object + description: The $in's @matchall@1174. + $nin: + type: array + description: The created at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $nin's exec. + test: + type: object + description: The $nin's test. + source: + type: string + title: source + description: The $nin's source. + global: + type: boolean + title: global + description: The $nin's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $nin's ignorecase. + multiline: + type: boolean + title: multiline + description: The $nin's multiline. + lastIndex: + type: number + title: lastIndex + description: The $nin's lastindex. + compile: + type: object + description: The $nin's compile. + flags: + type: string + title: flags + description: The $nin's flags. + sticky: + type: boolean + title: sticky + description: The $nin's sticky. + unicode: + type: boolean + title: unicode + description: The $nin's unicode. + dotAll: + type: boolean + title: dotAll + description: The $nin's dotall. + __@match@1165: + type: object + description: The $nin's @match@1165. + __@replace@1167: + type: object + description: The $nin's @replace@1167. + __@search@1170: + type: object + description: The $nin's @search@1170. + __@split@1172: + type: object + description: The $nin's @split@1172. + __@matchAll@1174: + type: object + description: The $nin's @matchall@1174. + $not: + oneOf: + - type: string + title: $not + description: The created at's $not. + - type: object + description: The created at's $not. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1165: + type: object + description: The $not's @match@1165. + __@replace@1167: + type: object + description: The $not's @replace@1167. + __@search@1170: + type: object + description: The $not's @search@1170. + __@split@1172: + type: object + description: The $not's @split@1172. + __@matchAll@1174: + type: object + description: The $not's @matchall@1174. + - type: object + description: The created at's $not. + properties: + $and: + type: array + description: The $not's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $not's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $not's $eq. + - type: object + description: The $not's $eq. + x-schemaName: RegExp + - type: array + description: The $not's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $not's $ne. + - type: object + description: The $not's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $not's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $not's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + - type: object + description: The $not's details. + - type: array + description: The $not's details. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $not's $gt. + - type: object + description: The $not's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $not's $gte. + - type: object + description: The $not's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $not's $lt. + - type: object + description: The $not's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $not's $lte. + - type: object + description: The $not's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $not's $like. + $re: + type: string + title: $re + description: The $not's $re. + $ilike: + type: string + title: $ilike + description: The $not's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $not's $fulltext. + $overlap: + type: array + description: The $not's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $not's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $not's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $not's $exists. + - type: array + description: The created at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1165: + type: object + description: The $not's @match@1165. + __@replace@1167: + type: object + description: The $not's @replace@1167. + __@search@1170: + type: object + description: The $not's @search@1170. + __@split@1172: + type: object + description: The $not's @split@1172. + __@matchAll@1174: + type: object + description: The $not's @matchall@1174. + $gt: + oneOf: + - type: string + title: $gt + description: The created at's $gt. + - type: object + description: The created at's $gt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $gt's exec. + test: + type: object + description: The $gt's test. + source: + type: string + title: source + description: The $gt's source. + global: + type: boolean + title: global + description: The $gt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gt's lastindex. + compile: + type: object + description: The $gt's compile. + flags: + type: string + title: flags + description: The $gt's flags. + sticky: + type: boolean + title: sticky + description: The $gt's sticky. + unicode: + type: boolean + title: unicode + description: The $gt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gt's dotall. + __@match@1165: + type: object + description: The $gt's @match@1165. + __@replace@1167: + type: object + description: The $gt's @replace@1167. + __@search@1170: + type: object + description: The $gt's @search@1170. + __@split@1172: + type: object + description: The $gt's @split@1172. + __@matchAll@1174: + type: object + description: The $gt's @matchall@1174. + $gte: + oneOf: + - type: string + title: $gte + description: The created at's $gte. + - type: object + description: The created at's $gte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $gte's exec. + test: + type: object + description: The $gte's test. + source: + type: string + title: source + description: The $gte's source. + global: + type: boolean + title: global + description: The $gte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gte's lastindex. + compile: + type: object + description: The $gte's compile. + flags: + type: string + title: flags + description: The $gte's flags. + sticky: + type: boolean + title: sticky + description: The $gte's sticky. + unicode: + type: boolean + title: unicode + description: The $gte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gte's dotall. + __@match@1165: + type: object + description: The $gte's @match@1165. + __@replace@1167: + type: object + description: The $gte's @replace@1167. + __@search@1170: + type: object + description: The $gte's @search@1170. + __@split@1172: + type: object + description: The $gte's @split@1172. + __@matchAll@1174: + type: object + description: The $gte's @matchall@1174. + $lt: + oneOf: + - type: string + title: $lt + description: The created at's $lt. + - type: object + description: The created at's $lt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $lt's exec. + test: + type: object + description: The $lt's test. + source: + type: string + title: source + description: The $lt's source. + global: + type: boolean + title: global + description: The $lt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lt's lastindex. + compile: + type: object + description: The $lt's compile. + flags: + type: string + title: flags + description: The $lt's flags. + sticky: + type: boolean + title: sticky + description: The $lt's sticky. + unicode: + type: boolean + title: unicode + description: The $lt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lt's dotall. + __@match@1165: + type: object + description: The $lt's @match@1165. + __@replace@1167: + type: object + description: The $lt's @replace@1167. + __@search@1170: + type: object + description: The $lt's @search@1170. + __@split@1172: + type: object + description: The $lt's @split@1172. + __@matchAll@1174: + type: object + description: The $lt's @matchall@1174. + $lte: + oneOf: + - type: string + title: $lte + description: The created at's $lte. + - type: object + description: The created at's $lte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $lte's exec. + test: + type: object + description: The $lte's test. + source: + type: string + title: source + description: The $lte's source. + global: + type: boolean + title: global + description: The $lte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lte's lastindex. + compile: + type: object + description: The $lte's compile. + flags: + type: string + title: flags + description: The $lte's flags. + sticky: + type: boolean + title: sticky + description: The $lte's sticky. + unicode: + type: boolean + title: unicode + description: The $lte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lte's dotall. + __@match@1165: + type: object + description: The $lte's @match@1165. + __@replace@1167: + type: object + description: The $lte's @replace@1167. + __@search@1170: + type: object + description: The $lte's @search@1170. + __@split@1172: + type: object + description: The $lte's @split@1172. + __@matchAll@1174: + type: object + description: The $lte's @matchall@1174. + $like: + type: string + title: $like + description: The created at's $like. + $re: + type: string + title: $re + description: The created at's $re. + $ilike: + type: string + title: $ilike + description: The created at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The created at's $fulltext. + $overlap: + type: array + description: The created at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The created at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The created at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The created at's $exists. - name: updated_at in: query description: The product's updated at. required: false schema: - type: string + type: object description: The product's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + $and: + type: array + description: The updated at's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1165: + type: object + description: The $and's @match@1165. + __@replace@1167: + type: object + description: The $and's @replace@1167. + __@search@1170: + type: object + description: The $and's @search@1170. + __@split@1172: + type: object + description: The $and's @split@1172. + __@matchAll@1174: + type: object + description: The $and's @matchall@1174. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $and's $eq. + - type: object + description: The $and's $eq. + x-schemaName: RegExp + - type: array + description: The $and's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $and's $ne. + - type: object + description: The $and's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $and's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $and's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $and's $not. + - type: object + description: The $and's $not. + x-schemaName: RegExp + - type: object + description: The $and's $not. + - type: array + description: The $and's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $and's $gt. + - type: object + description: The $and's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $and's $gte. + - type: object + description: The $and's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $and's $lt. + - type: object + description: The $and's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $and's $lte. + - type: object + description: The $and's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $and's $like. + $re: + type: string + title: $re + description: The $and's $re. + $ilike: + type: string + title: $ilike + description: The $and's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $and's $fulltext. + $overlap: + type: array + description: The $and's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $and's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $and's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $and's $exists. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1165: + type: object + description: The $and's @match@1165. + __@replace@1167: + type: object + description: The $and's @replace@1167. + __@search@1170: + type: object + description: The $and's @search@1170. + __@split@1172: + type: object + description: The $and's @split@1172. + __@matchAll@1174: + type: object + description: The $and's @matchall@1174. + $or: + type: array + description: The updated at's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1165: + type: object + description: The $or's @match@1165. + __@replace@1167: + type: object + description: The $or's @replace@1167. + __@search@1170: + type: object + description: The $or's @search@1170. + __@split@1172: + type: object + description: The $or's @split@1172. + __@matchAll@1174: + type: object + description: The $or's @matchall@1174. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $or's $eq. + - type: object + description: The $or's $eq. + x-schemaName: RegExp + - type: array + description: The $or's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $or's $ne. + - type: object + description: The $or's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $or's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $or's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $or's $not. + - type: object + description: The $or's $not. + x-schemaName: RegExp + - type: object + description: The $or's $not. + - type: array + description: The $or's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $or's $gt. + - type: object + description: The $or's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $or's $gte. + - type: object + description: The $or's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $or's $lt. + - type: object + description: The $or's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $or's $lte. + - type: object + description: The $or's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $or's $like. + $re: + type: string + title: $re + description: The $or's $re. + $ilike: + type: string + title: $ilike + description: The $or's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $or's $fulltext. + $overlap: + type: array + description: The $or's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $or's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $or's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $or's $exists. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1165: + type: object + description: The $or's @match@1165. + __@replace@1167: + type: object + description: The $or's @replace@1167. + __@search@1170: + type: object + description: The $or's @search@1170. + __@split@1172: + type: object + description: The $or's @split@1172. + __@matchAll@1174: + type: object + description: The $or's @matchall@1174. + $eq: + oneOf: + - type: string + title: $eq + description: The updated at's $eq. + - type: object + description: The updated at's $eq. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1165: + type: object + description: The $eq's @match@1165. + __@replace@1167: + type: object + description: The $eq's @replace@1167. + __@search@1170: + type: object + description: The $eq's @search@1170. + __@split@1172: + type: object + description: The $eq's @split@1172. + __@matchAll@1174: + type: object + description: The $eq's @matchall@1174. + - type: array + description: The updated at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1165: + type: object + description: The $eq's @match@1165. + __@replace@1167: + type: object + description: The $eq's @replace@1167. + __@search@1170: + type: object + description: The $eq's @search@1170. + __@split@1172: + type: object + description: The $eq's @split@1172. + __@matchAll@1174: + type: object + description: The $eq's @matchall@1174. + $ne: + oneOf: + - type: string + title: $ne + description: The updated at's $ne. + - type: object + description: The updated at's $ne. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $ne's exec. + test: + type: object + description: The $ne's test. + source: + type: string + title: source + description: The $ne's source. + global: + type: boolean + title: global + description: The $ne's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $ne's ignorecase. + multiline: + type: boolean + title: multiline + description: The $ne's multiline. + lastIndex: + type: number + title: lastIndex + description: The $ne's lastindex. + compile: + type: object + description: The $ne's compile. + flags: + type: string + title: flags + description: The $ne's flags. + sticky: + type: boolean + title: sticky + description: The $ne's sticky. + unicode: + type: boolean + title: unicode + description: The $ne's unicode. + dotAll: + type: boolean + title: dotAll + description: The $ne's dotall. + __@match@1165: + type: object + description: The $ne's @match@1165. + __@replace@1167: + type: object + description: The $ne's @replace@1167. + __@search@1170: + type: object + description: The $ne's @search@1170. + __@split@1172: + type: object + description: The $ne's @split@1172. + __@matchAll@1174: + type: object + description: The $ne's @matchall@1174. + $in: + type: array + description: The updated at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $in's exec. + test: + type: object + description: The $in's test. + source: + type: string + title: source + description: The $in's source. + global: + type: boolean + title: global + description: The $in's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $in's ignorecase. + multiline: + type: boolean + title: multiline + description: The $in's multiline. + lastIndex: + type: number + title: lastIndex + description: The $in's lastindex. + compile: + type: object + description: The $in's compile. + flags: + type: string + title: flags + description: The $in's flags. + sticky: + type: boolean + title: sticky + description: The $in's sticky. + unicode: + type: boolean + title: unicode + description: The $in's unicode. + dotAll: + type: boolean + title: dotAll + description: The $in's dotall. + __@match@1165: + type: object + description: The $in's @match@1165. + __@replace@1167: + type: object + description: The $in's @replace@1167. + __@search@1170: + type: object + description: The $in's @search@1170. + __@split@1172: + type: object + description: The $in's @split@1172. + __@matchAll@1174: + type: object + description: The $in's @matchall@1174. + $nin: + type: array + description: The updated at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $nin's exec. + test: + type: object + description: The $nin's test. + source: + type: string + title: source + description: The $nin's source. + global: + type: boolean + title: global + description: The $nin's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $nin's ignorecase. + multiline: + type: boolean + title: multiline + description: The $nin's multiline. + lastIndex: + type: number + title: lastIndex + description: The $nin's lastindex. + compile: + type: object + description: The $nin's compile. + flags: + type: string + title: flags + description: The $nin's flags. + sticky: + type: boolean + title: sticky + description: The $nin's sticky. + unicode: + type: boolean + title: unicode + description: The $nin's unicode. + dotAll: + type: boolean + title: dotAll + description: The $nin's dotall. + __@match@1165: + type: object + description: The $nin's @match@1165. + __@replace@1167: + type: object + description: The $nin's @replace@1167. + __@search@1170: + type: object + description: The $nin's @search@1170. + __@split@1172: + type: object + description: The $nin's @split@1172. + __@matchAll@1174: + type: object + description: The $nin's @matchall@1174. + $not: + oneOf: + - type: string + title: $not + description: The updated at's $not. + - type: object + description: The updated at's $not. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1165: + type: object + description: The $not's @match@1165. + __@replace@1167: + type: object + description: The $not's @replace@1167. + __@search@1170: + type: object + description: The $not's @search@1170. + __@split@1172: + type: object + description: The $not's @split@1172. + __@matchAll@1174: + type: object + description: The $not's @matchall@1174. + - type: object + description: The updated at's $not. + properties: + $and: + type: array + description: The $not's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $not's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $not's $eq. + - type: object + description: The $not's $eq. + x-schemaName: RegExp + - type: array + description: The $not's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $not's $ne. + - type: object + description: The $not's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $not's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $not's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + - type: object + description: The $not's details. + - type: array + description: The $not's details. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $not's $gt. + - type: object + description: The $not's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $not's $gte. + - type: object + description: The $not's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $not's $lt. + - type: object + description: The $not's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $not's $lte. + - type: object + description: The $not's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $not's $like. + $re: + type: string + title: $re + description: The $not's $re. + $ilike: + type: string + title: $ilike + description: The $not's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $not's $fulltext. + $overlap: + type: array + description: The $not's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $not's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $not's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $not's $exists. + - type: array + description: The updated at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1165: + type: object + description: The $not's @match@1165. + __@replace@1167: + type: object + description: The $not's @replace@1167. + __@search@1170: + type: object + description: The $not's @search@1170. + __@split@1172: + type: object + description: The $not's @split@1172. + __@matchAll@1174: + type: object + description: The $not's @matchall@1174. + $gt: + oneOf: + - type: string + title: $gt + description: The updated at's $gt. + - type: object + description: The updated at's $gt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $gt's exec. + test: + type: object + description: The $gt's test. + source: + type: string + title: source + description: The $gt's source. + global: + type: boolean + title: global + description: The $gt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gt's lastindex. + compile: + type: object + description: The $gt's compile. + flags: + type: string + title: flags + description: The $gt's flags. + sticky: + type: boolean + title: sticky + description: The $gt's sticky. + unicode: + type: boolean + title: unicode + description: The $gt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gt's dotall. + __@match@1165: + type: object + description: The $gt's @match@1165. + __@replace@1167: + type: object + description: The $gt's @replace@1167. + __@search@1170: + type: object + description: The $gt's @search@1170. + __@split@1172: + type: object + description: The $gt's @split@1172. + __@matchAll@1174: + type: object + description: The $gt's @matchall@1174. + $gte: + oneOf: + - type: string + title: $gte + description: The updated at's $gte. + - type: object + description: The updated at's $gte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $gte's exec. + test: + type: object + description: The $gte's test. + source: + type: string + title: source + description: The $gte's source. + global: + type: boolean + title: global + description: The $gte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gte's lastindex. + compile: + type: object + description: The $gte's compile. + flags: + type: string + title: flags + description: The $gte's flags. + sticky: + type: boolean + title: sticky + description: The $gte's sticky. + unicode: + type: boolean + title: unicode + description: The $gte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gte's dotall. + __@match@1165: + type: object + description: The $gte's @match@1165. + __@replace@1167: + type: object + description: The $gte's @replace@1167. + __@search@1170: + type: object + description: The $gte's @search@1170. + __@split@1172: + type: object + description: The $gte's @split@1172. + __@matchAll@1174: + type: object + description: The $gte's @matchall@1174. + $lt: + oneOf: + - type: string + title: $lt + description: The updated at's $lt. + - type: object + description: The updated at's $lt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $lt's exec. + test: + type: object + description: The $lt's test. + source: + type: string + title: source + description: The $lt's source. + global: + type: boolean + title: global + description: The $lt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lt's lastindex. + compile: + type: object + description: The $lt's compile. + flags: + type: string + title: flags + description: The $lt's flags. + sticky: + type: boolean + title: sticky + description: The $lt's sticky. + unicode: + type: boolean + title: unicode + description: The $lt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lt's dotall. + __@match@1165: + type: object + description: The $lt's @match@1165. + __@replace@1167: + type: object + description: The $lt's @replace@1167. + __@search@1170: + type: object + description: The $lt's @search@1170. + __@split@1172: + type: object + description: The $lt's @split@1172. + __@matchAll@1174: + type: object + description: The $lt's @matchall@1174. + $lte: + oneOf: + - type: string + title: $lte + description: The updated at's $lte. + - type: object + description: The updated at's $lte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $lte's exec. + test: + type: object + description: The $lte's test. + source: + type: string + title: source + description: The $lte's source. + global: + type: boolean + title: global + description: The $lte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lte's lastindex. + compile: + type: object + description: The $lte's compile. + flags: + type: string + title: flags + description: The $lte's flags. + sticky: + type: boolean + title: sticky + description: The $lte's sticky. + unicode: + type: boolean + title: unicode + description: The $lte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lte's dotall. + __@match@1165: + type: object + description: The $lte's @match@1165. + __@replace@1167: + type: object + description: The $lte's @replace@1167. + __@search@1170: + type: object + description: The $lte's @search@1170. + __@split@1172: + type: object + description: The $lte's @split@1172. + __@matchAll@1174: + type: object + description: The $lte's @matchall@1174. + $like: + type: string + title: $like + description: The updated at's $like. + $re: + type: string + title: $re + description: The updated at's $re. + $ilike: + type: string + title: $ilike + description: The updated at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The updated at's $fulltext. + $overlap: + type: array + description: The updated at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The updated at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The updated at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The updated at's $exists. - name: deleted_at in: query description: The product's deleted at. required: false schema: - type: string + type: object description: The product's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at - - name: country_code + $and: + type: array + description: The deleted at's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1165: + type: object + description: The $and's @match@1165. + __@replace@1167: + type: object + description: The $and's @replace@1167. + __@search@1170: + type: object + description: The $and's @search@1170. + __@split@1172: + type: object + description: The $and's @split@1172. + __@matchAll@1174: + type: object + description: The $and's @matchall@1174. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $and's $eq. + - type: object + description: The $and's $eq. + x-schemaName: RegExp + - type: array + description: The $and's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $and's $ne. + - type: object + description: The $and's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $and's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $and's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $and's $not. + - type: object + description: The $and's $not. + x-schemaName: RegExp + - type: object + description: The $and's $not. + - type: array + description: The $and's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $and's $gt. + - type: object + description: The $and's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $and's $gte. + - type: object + description: The $and's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $and's $lt. + - type: object + description: The $and's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $and's $lte. + - type: object + description: The $and's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $and's $like. + $re: + type: string + title: $re + description: The $and's $re. + $ilike: + type: string + title: $ilike + description: The $and's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $and's $fulltext. + $overlap: + type: array + description: The $and's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $and's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $and's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $and's $exists. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1165: + type: object + description: The $and's @match@1165. + __@replace@1167: + type: object + description: The $and's @replace@1167. + __@search@1170: + type: object + description: The $and's @search@1170. + __@split@1172: + type: object + description: The $and's @split@1172. + __@matchAll@1174: + type: object + description: The $and's @matchall@1174. + $or: + type: array + description: The deleted at's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1165: + type: object + description: The $or's @match@1165. + __@replace@1167: + type: object + description: The $or's @replace@1167. + __@search@1170: + type: object + description: The $or's @search@1170. + __@split@1172: + type: object + description: The $or's @split@1172. + __@matchAll@1174: + type: object + description: The $or's @matchall@1174. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $or's $eq. + - type: object + description: The $or's $eq. + x-schemaName: RegExp + - type: array + description: The $or's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $or's $ne. + - type: object + description: The $or's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $or's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $or's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $or's $not. + - type: object + description: The $or's $not. + x-schemaName: RegExp + - type: object + description: The $or's $not. + - type: array + description: The $or's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $or's $gt. + - type: object + description: The $or's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $or's $gte. + - type: object + description: The $or's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $or's $lt. + - type: object + description: The $or's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $or's $lte. + - type: object + description: The $or's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $or's $like. + $re: + type: string + title: $re + description: The $or's $re. + $ilike: + type: string + title: $ilike + description: The $or's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $or's $fulltext. + $overlap: + type: array + description: The $or's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $or's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $or's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $or's $exists. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1165: + type: object + description: The $or's @match@1165. + __@replace@1167: + type: object + description: The $or's @replace@1167. + __@search@1170: + type: object + description: The $or's @search@1170. + __@split@1172: + type: object + description: The $or's @split@1172. + __@matchAll@1174: + type: object + description: The $or's @matchall@1174. + $eq: + oneOf: + - type: string + title: $eq + description: The deleted at's $eq. + - type: object + description: The deleted at's $eq. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1165: + type: object + description: The $eq's @match@1165. + __@replace@1167: + type: object + description: The $eq's @replace@1167. + __@search@1170: + type: object + description: The $eq's @search@1170. + __@split@1172: + type: object + description: The $eq's @split@1172. + __@matchAll@1174: + type: object + description: The $eq's @matchall@1174. + - type: array + description: The deleted at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1165: + type: object + description: The $eq's @match@1165. + __@replace@1167: + type: object + description: The $eq's @replace@1167. + __@search@1170: + type: object + description: The $eq's @search@1170. + __@split@1172: + type: object + description: The $eq's @split@1172. + __@matchAll@1174: + type: object + description: The $eq's @matchall@1174. + $ne: + oneOf: + - type: string + title: $ne + description: The deleted at's $ne. + - type: object + description: The deleted at's $ne. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $ne's exec. + test: + type: object + description: The $ne's test. + source: + type: string + title: source + description: The $ne's source. + global: + type: boolean + title: global + description: The $ne's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $ne's ignorecase. + multiline: + type: boolean + title: multiline + description: The $ne's multiline. + lastIndex: + type: number + title: lastIndex + description: The $ne's lastindex. + compile: + type: object + description: The $ne's compile. + flags: + type: string + title: flags + description: The $ne's flags. + sticky: + type: boolean + title: sticky + description: The $ne's sticky. + unicode: + type: boolean + title: unicode + description: The $ne's unicode. + dotAll: + type: boolean + title: dotAll + description: The $ne's dotall. + __@match@1165: + type: object + description: The $ne's @match@1165. + __@replace@1167: + type: object + description: The $ne's @replace@1167. + __@search@1170: + type: object + description: The $ne's @search@1170. + __@split@1172: + type: object + description: The $ne's @split@1172. + __@matchAll@1174: + type: object + description: The $ne's @matchall@1174. + $in: + type: array + description: The deleted at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $in's exec. + test: + type: object + description: The $in's test. + source: + type: string + title: source + description: The $in's source. + global: + type: boolean + title: global + description: The $in's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $in's ignorecase. + multiline: + type: boolean + title: multiline + description: The $in's multiline. + lastIndex: + type: number + title: lastIndex + description: The $in's lastindex. + compile: + type: object + description: The $in's compile. + flags: + type: string + title: flags + description: The $in's flags. + sticky: + type: boolean + title: sticky + description: The $in's sticky. + unicode: + type: boolean + title: unicode + description: The $in's unicode. + dotAll: + type: boolean + title: dotAll + description: The $in's dotall. + __@match@1165: + type: object + description: The $in's @match@1165. + __@replace@1167: + type: object + description: The $in's @replace@1167. + __@search@1170: + type: object + description: The $in's @search@1170. + __@split@1172: + type: object + description: The $in's @split@1172. + __@matchAll@1174: + type: object + description: The $in's @matchall@1174. + $nin: + type: array + description: The deleted at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $nin's exec. + test: + type: object + description: The $nin's test. + source: + type: string + title: source + description: The $nin's source. + global: + type: boolean + title: global + description: The $nin's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $nin's ignorecase. + multiline: + type: boolean + title: multiline + description: The $nin's multiline. + lastIndex: + type: number + title: lastIndex + description: The $nin's lastindex. + compile: + type: object + description: The $nin's compile. + flags: + type: string + title: flags + description: The $nin's flags. + sticky: + type: boolean + title: sticky + description: The $nin's sticky. + unicode: + type: boolean + title: unicode + description: The $nin's unicode. + dotAll: + type: boolean + title: dotAll + description: The $nin's dotall. + __@match@1165: + type: object + description: The $nin's @match@1165. + __@replace@1167: + type: object + description: The $nin's @replace@1167. + __@search@1170: + type: object + description: The $nin's @search@1170. + __@split@1172: + type: object + description: The $nin's @split@1172. + __@matchAll@1174: + type: object + description: The $nin's @matchall@1174. + $not: + oneOf: + - type: string + title: $not + description: The deleted at's $not. + - type: object + description: The deleted at's $not. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1165: + type: object + description: The $not's @match@1165. + __@replace@1167: + type: object + description: The $not's @replace@1167. + __@search@1170: + type: object + description: The $not's @search@1170. + __@split@1172: + type: object + description: The $not's @split@1172. + __@matchAll@1174: + type: object + description: The $not's @matchall@1174. + - type: object + description: The deleted at's $not. + properties: + $and: + type: array + description: The $not's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $not's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $not's $eq. + - type: object + description: The $not's $eq. + x-schemaName: RegExp + - type: array + description: The $not's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $not's $ne. + - type: object + description: The $not's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $not's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $not's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + - type: object + description: The $not's details. + - type: array + description: The $not's details. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $not's $gt. + - type: object + description: The $not's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $not's $gte. + - type: object + description: The $not's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $not's $lt. + - type: object + description: The $not's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $not's $lte. + - type: object + description: The $not's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $not's $like. + $re: + type: string + title: $re + description: The $not's $re. + $ilike: + type: string + title: $ilike + description: The $not's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $not's $fulltext. + $overlap: + type: array + description: The $not's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $not's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $not's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $not's $exists. + - type: array + description: The deleted at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1165: + type: object + description: The $not's @match@1165. + __@replace@1167: + type: object + description: The $not's @replace@1167. + __@search@1170: + type: object + description: The $not's @search@1170. + __@split@1172: + type: object + description: The $not's @split@1172. + __@matchAll@1174: + type: object + description: The $not's @matchall@1174. + $gt: + oneOf: + - type: string + title: $gt + description: The deleted at's $gt. + - type: object + description: The deleted at's $gt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $gt's exec. + test: + type: object + description: The $gt's test. + source: + type: string + title: source + description: The $gt's source. + global: + type: boolean + title: global + description: The $gt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gt's lastindex. + compile: + type: object + description: The $gt's compile. + flags: + type: string + title: flags + description: The $gt's flags. + sticky: + type: boolean + title: sticky + description: The $gt's sticky. + unicode: + type: boolean + title: unicode + description: The $gt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gt's dotall. + __@match@1165: + type: object + description: The $gt's @match@1165. + __@replace@1167: + type: object + description: The $gt's @replace@1167. + __@search@1170: + type: object + description: The $gt's @search@1170. + __@split@1172: + type: object + description: The $gt's @split@1172. + __@matchAll@1174: + type: object + description: The $gt's @matchall@1174. + $gte: + oneOf: + - type: string + title: $gte + description: The deleted at's $gte. + - type: object + description: The deleted at's $gte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $gte's exec. + test: + type: object + description: The $gte's test. + source: + type: string + title: source + description: The $gte's source. + global: + type: boolean + title: global + description: The $gte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gte's lastindex. + compile: + type: object + description: The $gte's compile. + flags: + type: string + title: flags + description: The $gte's flags. + sticky: + type: boolean + title: sticky + description: The $gte's sticky. + unicode: + type: boolean + title: unicode + description: The $gte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gte's dotall. + __@match@1165: + type: object + description: The $gte's @match@1165. + __@replace@1167: + type: object + description: The $gte's @replace@1167. + __@search@1170: + type: object + description: The $gte's @search@1170. + __@split@1172: + type: object + description: The $gte's @split@1172. + __@matchAll@1174: + type: object + description: The $gte's @matchall@1174. + $lt: + oneOf: + - type: string + title: $lt + description: The deleted at's $lt. + - type: object + description: The deleted at's $lt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $lt's exec. + test: + type: object + description: The $lt's test. + source: + type: string + title: source + description: The $lt's source. + global: + type: boolean + title: global + description: The $lt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lt's lastindex. + compile: + type: object + description: The $lt's compile. + flags: + type: string + title: flags + description: The $lt's flags. + sticky: + type: boolean + title: sticky + description: The $lt's sticky. + unicode: + type: boolean + title: unicode + description: The $lt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lt's dotall. + __@match@1165: + type: object + description: The $lt's @match@1165. + __@replace@1167: + type: object + description: The $lt's @replace@1167. + __@search@1170: + type: object + description: The $lt's @search@1170. + __@split@1172: + type: object + description: The $lt's @split@1172. + __@matchAll@1174: + type: object + description: The $lt's @matchall@1174. + $lte: + oneOf: + - type: string + title: $lte + description: The deleted at's $lte. + - type: object + description: The deleted at's $lte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1165 + - __@replace@1167 + - __@search@1170 + - __@matchAll@1174 + properties: + exec: + type: object + description: The $lte's exec. + test: + type: object + description: The $lte's test. + source: + type: string + title: source + description: The $lte's source. + global: + type: boolean + title: global + description: The $lte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lte's lastindex. + compile: + type: object + description: The $lte's compile. + flags: + type: string + title: flags + description: The $lte's flags. + sticky: + type: boolean + title: sticky + description: The $lte's sticky. + unicode: + type: boolean + title: unicode + description: The $lte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lte's dotall. + __@match@1165: + type: object + description: The $lte's @match@1165. + __@replace@1167: + type: object + description: The $lte's @replace@1167. + __@search@1170: + type: object + description: The $lte's @search@1170. + __@split@1172: + type: object + description: The $lte's @split@1172. + __@matchAll@1174: + type: object + description: The $lte's @matchall@1174. + $like: + type: string + title: $like + description: The deleted at's $like. + $re: + type: string + title: $re + description: The deleted at's $re. + $ilike: + type: string + title: $ilike + description: The deleted at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The deleted at's $fulltext. + $overlap: + type: array + description: The deleted at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The deleted at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The deleted at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The deleted at's $exists. + - name: status in: query - description: The product's country code. required: false schema: - type: string - title: country_code - description: The product's country code. - - name: province + oneOf: + - type: string + title: status + description: The product's status. + - type: string + title: status + description: The product's status. + - type: string + title: status + description: The product's status. + - type: string + title: status + description: The product's status. + - type: array + description: The product's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + - name: categories in: query - description: The product's province. required: false schema: - type: string - title: province - description: The product's province. - - name: cart_id - in: query - description: The product's cart id. - required: false - schema: - type: string - title: cart_id - description: The product's cart id. + oneOf: + - type: object + description: The product's categories. + required: + - id + properties: + id: + type: object + description: The category's ID. + properties: + $and: + type: array + description: The id's $and. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: array + description: The $and's details. + items: + type: object + title: $and + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The id's $or. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: array + description: The $or's details. + items: + type: object + title: $or + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The id's $eq. + - type: object + description: The id's $eq. + x-schemaName: RegExp + - type: array + description: The id's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The id's $ne. + - type: object + description: The id's $ne. + x-schemaName: RegExp + $in: + type: array + description: The id's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The id's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The id's $not. + - type: object + description: The id's $not. + x-schemaName: RegExp + - type: object + description: The id's $not. + - type: array + description: The id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The id's $gt. + - type: object + description: The id's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The id's $gte. + - type: object + description: The id's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The id's $lt. + - type: object + description: The id's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The id's $lte. + - type: object + description: The id's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The id's $like. + $re: + type: string + title: $re + description: The id's $re. + $ilike: + type: string + title: $ilike + description: The id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The id's $fulltext. + $overlap: + type: array + description: The id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The id's $exists. + - type: object + description: The product's categories. + required: + - id + properties: + id: + type: object + description: The category's ID. + properties: + $and: + type: array + description: The id's $and. + items: + type: array + description: The $and's details. + items: + type: array + description: The $and's details. + items: + type: object + title: $and + $or: + type: array + description: The id's $or. + items: + type: array + description: The $or's details. + items: + type: array + description: The $or's details. + items: + type: object + title: $or + $eq: + oneOf: + - type: array + description: The id's $eq. + items: + type: string + title: $eq + description: The $eq's details. + - type: array + description: The id's $eq. + items: + type: array + description: The $eq's details. + items: + type: string + title: $eq + description: The $eq's details. + $ne: + type: array + description: The id's $ne. + items: + type: string + title: $ne + description: The $ne's details. + $in: + type: array + description: The id's $in. + items: + type: array + description: The $in's details. + items: + type: string + title: $in + description: The $in's details. + $nin: + type: array + description: The id's $nin. + items: + type: array + description: The $nin's details. + items: + type: string + title: $nin + description: The $nin's details. + $not: + type: array + description: The id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + $gt: + type: array + description: The id's $gt. + items: + type: string + title: $gt + description: The $gt's details. + $gte: + type: array + description: The id's $gte. + items: + type: string + title: $gte + description: The $gte's details. + $lt: + type: array + description: The id's $lt. + items: + type: string + title: $lt + description: The $lt's details. + $lte: + type: array + description: The id's $lte. + items: + type: string + title: $lte + description: The $lte's details. + $like: + type: string + title: $like + description: The id's $like. + $re: + type: string + title: $re + description: The id's $re. + $ilike: + type: string + title: $ilike + description: The id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The id's $fulltext. + $overlap: + type: array + description: The id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The id's $exists. x-codeSamples: - lang: Shell label: cURL @@ -342,6 +6440,41 @@ get: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The product's limit. + offset: + type: number + title: offset + description: The product's offset. + count: + type: number + title: count + description: The product's count. + - type: object + description: SUMMARY + required: + - products + properties: + products: + type: array + description: The product's products. + items: + type: object '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml index ac500e87c3..4d2c6b1f4c 100644 --- a/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml @@ -107,6 +107,12 @@ get: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreProductResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 1d0f5ba54b..03bcb0d5f6 100644 --- a/www/apps/api-reference/specs/store/paths/store_regions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_regions.yaml @@ -69,6 +69,41 @@ get: tags: - Regions responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The region's limit. + offset: + type: number + title: offset + description: The region's offset. + count: + type: number + title: count + description: The region's count. + - type: object + description: SUMMARY + required: + - regions + properties: + regions: + type: array + description: The region's regions. + items: + $ref: ../components/schemas/StoreRegion.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml index 0ab88606d4..cdc9b887de 100644 --- a/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml @@ -75,6 +75,18 @@ get: tags: - Regions responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - region + properties: + region: + $ref: ../components/schemas/StoreRegion.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml b/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml index 30a016a779..41ab0368ac 100644 --- a/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml +++ b/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml @@ -69,6 +69,41 @@ get: tags: - Return Reasons responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The return reason's limit. + offset: + type: number + title: offset + description: The return reason's offset. + count: + type: number + title: count + description: The return reason's count. + - type: object + description: SUMMARY + required: + - return_reasons + properties: + return_reasons: + type: array + description: The return reason's return reasons. + items: + $ref: ../components/schemas/StoreReturnReason.yaml '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml index e01c5bb877..5ea63a57fc 100644 --- a/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml @@ -75,6 +75,12 @@ get: tags: - Return Reasons responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreReturnReasonResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 86ccb20e0d..41714127f7 100644 --- a/www/apps/api-reference/specs/store/paths/store_return.yaml +++ b/www/apps/api-reference/specs/store/paths/store_return.yaml @@ -72,6 +72,12 @@ post: tags: - Return responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreReturnResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': 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 203b46a5a0..4444203886 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 @@ -69,6 +69,12 @@ get: tags: - Shipping Options responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreShippingOptionListResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -81,3 +87,4 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: listShippingOptionsForCartWorkflow diff --git a/www/utils/generated/oas-output/base/admin.oas.base.yaml b/www/utils/generated/oas-output/base/admin.oas.base.yaml index 461f1ffae8..790484aa8d 100644 --- a/www/utils/generated/oas-output/base/admin.oas.base.yaml +++ b/www/utils/generated/oas-output/base/admin.oas.base.yaml @@ -9,6 +9,8 @@ tags: - name: Api Keys - name: Campaigns - name: Claims + x-associatedSchema: + $ref: "#/components/schemas/AdminClaim" - name: Collections x-associatedSchema: $ref: "#/components/schemas/AdminCollection" @@ -21,6 +23,8 @@ tags: externalDocs: description: How to manage currencies url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-currencies + x-associatedSchema: + $ref: "#/components/schemas/AdminCurrency" - name: Customer Groups x-associatedSchema: $ref: "#/components/schemas/AdminCustomerGroup" @@ -34,6 +38,9 @@ tags: x-associatedSchema: $ref: "#/components/schemas/AdminCustomer" - name: Draft Orders + - name: Exchanges + x-associatedSchema: + $ref: "#/components/schemas/AdminExchange" - name: Fulfillment Providers x-associatedSchema: $ref: "#/components/schemas/AdminFulfillmentProvider" @@ -41,7 +48,11 @@ tags: x-associatedSchema: $ref: "#/components/schemas/AdminFulfillmentSet" - name: Fulfillments + x-associatedSchema: + $ref: "#/components/schemas/AdminFulfillment" - name: Inventory Items + x-associatedSchema: + $ref: "#/components/schemas/AdminInventoryItem" - name: Invites description: > An admin can invite new users to manage their team. This would allow new @@ -49,11 +60,23 @@ tags: externalDocs: description: How to manage invites url: https://docs.medusajs.com/modules/users/admin/manage-invites + x-associatedSchema: + $ref: "#/components/schemas/AdminInvite" - name: Notifications + x-associatedSchema: + $ref: "#/components/schemas/AdminNotification" - name: Orders + x-associatedSchema: + $ref: "#/components/schemas/AdminOrder" - name: Payments + x-associatedSchema: + $ref: "#/components/schemas/AdminPayment" - name: Price Lists + x-associatedSchema: + $ref: "#/components/schemas/AdminPriceList" - name: Price Preferences + x-associatedSchema: + $ref: "#/components/schemas/AdminPricePreference" - name: Product Categories x-associatedSchema: $ref: "#/components/schemas/AdminProductCategory" @@ -61,10 +84,18 @@ tags: x-associatedSchema: $ref: "#/components/schemas/AdminProductTag" - name: Product Types + - name: Product Variants + x-associatedSchema: + $ref: "#/components/schemas/AdminProductVariant" - name: Products x-associatedSchema: $ref: "#/components/schemas/AdminProduct" - name: Promotions + x-associatedSchema: + $ref: "#/components/schemas/AdminPromotion" + - name: Refund Reasons + x-associatedSchema: + $ref: "#/components/schemas/AdminRefundReason" - name: Regions description: > Regions are different countries or geographical regions that the commerce @@ -74,9 +105,15 @@ tags: externalDocs: description: How to manage regions url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions + x-associatedSchema: + $ref: "#/components/schemas/AdminRegion" - name: Reservations - name: Return Reasons + x-associatedSchema: + $ref: "#/components/schemas/AdminReturnReason" - name: Returns + x-associatedSchema: + $ref: "#/components/schemas/AdminReturn" - name: Sales Channels description: > A sales channel indicates a channel where products can be sold in. For @@ -95,11 +132,21 @@ tags: x-associatedSchema: $ref: "#/components/schemas/AdminShippingProfile" - name: Stock Locations + x-associatedSchema: + $ref: "#/components/schemas/AdminStockLocation" - name: Stores + x-associatedSchema: + $ref: "#/components/schemas/AdminStore" - name: Tax Rates + x-associatedSchema: + $ref: "#/components/schemas/AdminTaxRate" - name: Tax Regions + x-associatedSchema: + $ref: "#/components/schemas/AdminTaxRegion" - name: Uploads - name: Users + x-associatedSchema: + $ref: "#/components/schemas/AdminUser" - name: Workflows Executions servers: - url: http://localhost:9000 @@ -108,21 +155,39 @@ paths: {} components: schemas: Error: - title: "Response Error" + title: Response Error type: object properties: code: type: string description: A slug code to indicate the type of the error. - enum: [invalid_state_error, invalid_request_error, api_error, unknown_error] + enum: + - invalid_state_error + - invalid_request_error + - api_error + - unknown_error message: type: string description: Description of the error that occurred. - example: "first_name must be a string" + example: first_name must be a string type: type: string description: A slug indicating the type of the error. - enum: [QueryRunnerAlreadyReleasedError, TransactionAlreadyStartedError, TransactionNotStartedError, conflict, unauthorized, payment_authorization_error, duplicate_error, not_allowed, invalid_data, not_found, database_error, unexpected_state, invalid_argument, unknown_error] + enum: + - QueryRunnerAlreadyReleasedError + - TransactionAlreadyStartedError + - TransactionNotStartedError + - conflict + - unauthorized + - payment_authorization_error + - duplicate_error + - not_allowed + - invalid_data + - not_found + - database_error + - unexpected_state + - invalid_argument + - unknown_error responses: default_error: description: Default Error @@ -263,4 +328,4 @@ components: type: apiKey in: cookie name: connect.sid - x-displayName: Cookie Session ID \ No newline at end of file + x-displayName: Cookie Session ID diff --git a/www/utils/generated/oas-output/base/store.oas.base.yaml b/www/utils/generated/oas-output/base/store.oas.base.yaml index 7239203b4e..eda711c043 100644 --- a/www/utils/generated/oas-output/base/store.oas.base.yaml +++ b/www/utils/generated/oas-output/base/store.oas.base.yaml @@ -15,15 +15,29 @@ tags: externalDocs: description: How to implement cart functionality in your storefront url: https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart + x-associatedSchema: + $ref: "#/components/schemas/StoreCart" - name: Collections + x-associatedSchema: + $ref: "#/components/schemas/StoreCollection" - name: Currencies + x-associatedSchema: + $ref: "#/components/schemas/StoreCurrency" - name: Customers + x-associatedSchema: + $ref: "#/components/schemas/StoreCustomer" - name: Orders + x-associatedSchema: + $ref: "#/components/schemas/StoreOrder" - name: Payment Collections description: > A payment collection is useful for managing additional payments, such as for Order Edits, or installment payments. + x-associatedSchema: + $ref: "#/components/schemas/StorePaymentCollection" - name: Payment Providers + x-associatedSchema: + $ref: "#/components/schemas/StorePaymentProvider" - name: Product Categories x-associatedSchema: $ref: "#/components/schemas/StoreProductCategory" @@ -39,9 +53,17 @@ tags: externalDocs: description: How to use regions in a storefront url: https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions + x-associatedSchema: + $ref: "#/components/schemas/StoreRegion" - name: Return + x-associatedSchema: + $ref: "#/components/schemas/StoreReturn" - name: Return Reasons + x-associatedSchema: + $ref: "#/components/schemas/StoreReturnReason" - name: Shipping Options + x-associatedSchema: + $ref: "#/components/schemas/StoreShippingOption" servers: - url: http://localhost:9000 - url: https://api.medusa-commerce.com @@ -49,21 +71,39 @@ paths: {} components: schemas: Error: - title: "Response Error" + title: Response Error type: object properties: code: type: string description: A slug code to indicate the type of the error. - enum: [invalid_state_error, invalid_request_error, api_error, unknown_error] + enum: + - invalid_state_error + - invalid_request_error + - api_error + - unknown_error message: type: string description: Description of the error that occurred. - example: "first_name must be a string" + example: first_name must be a string type: type: string description: A slug indicating the type of the error. - enum: [QueryRunnerAlreadyReleasedError, TransactionAlreadyStartedError, TransactionNotStartedError, conflict, unauthorized, payment_authorization_error, duplicate_error, not_allowed, invalid_data, not_found, database_error, unexpected_state, invalid_argument, unknown_error] + enum: + - QueryRunnerAlreadyReleasedError + - TransactionAlreadyStartedError + - TransactionNotStartedError + - conflict + - unauthorized + - payment_authorization_error + - duplicate_error + - not_allowed + - invalid_data + - not_found + - database_error + - unexpected_state + - invalid_argument + - unknown_error responses: default_error: description: Default Error 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 3e2d6cd803..913ae279c0 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 @@ -74,6 +74,33 @@ * tags: * - Api Keys * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The api key's ID. + * object: + * type: string + * title: object + * description: The api key's object. + * deleted: + * type: boolean + * title: deleted + * description: The api key's 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 62fd287a8c..b554971b05 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 @@ -74,6 +74,33 @@ * tags: * - Campaigns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The campaign's ID. + * object: + * type: string + * title: object + * description: The campaign's object. + * deleted: + * type: boolean + * title: deleted + * description: The campaign's 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_claims_[id]_claim-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts index 243c919859..95b6d95bc4 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts @@ -81,6 +81,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -93,6 +99,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: removeItemClaimActionWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts index f7e4238d32..538bc31e0c 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts @@ -83,6 +83,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -95,6 +101,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: removeItemReturnActionWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts index 443ed016db..2f1c38340e 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts @@ -84,6 +84,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -96,6 +102,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: removeClaimShippingMethodWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts index cae38ff503..c084e9ed9f 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts @@ -83,6 +83,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -95,6 +101,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: removeAddItemClaimActionWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts index ea073db9d5..78dd06cf75 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts @@ -84,6 +84,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -96,6 +102,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: removeClaimShippingMethodWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_request.ts index 4de54079a2..a42f2663b0 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_request.ts @@ -75,6 +75,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts index 1c7c73af72..d239f4c2eb 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts @@ -74,6 +74,12 @@ * tags: * - Collections * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCollectionDeleteResponse" * "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 575088960d..9a0de3828a 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 @@ -74,6 +74,33 @@ * tags: * - Customer Groups * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The customer group's ID. + * object: + * type: string + * title: object + * description: The customer group's object. + * deleted: + * 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 37d06a0740..6244914505 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 @@ -74,6 +74,33 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * 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 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_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts index b6d40aec6f..2b1b952e85 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 @@ -83,6 +83,33 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * 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 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]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts new file mode 100644 index 0000000000..702c9f7125 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts @@ -0,0 +1,107 @@ +/** + * @oas [delete] /admin/exchanges/{id}/inbound/items/{action_id} + * operationId: DeleteExchangesIdInboundItemsAction_id + * summary: Remove Items from Exchange + * description: Remove a list of items from a exchange. This doesn't delete the + * Item, only the association between the Item and the exchange. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The exchange's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The exchange's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X DELETE + * '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExchangeReturnResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: removeItemReturnActionWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts new file mode 100644 index 0000000000..891b945e6c --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts @@ -0,0 +1,108 @@ +/** + * @oas [delete] /admin/exchanges/{id}/inbound/shipping-method/{action_id} + * operationId: DeleteExchangesIdInboundShippingMethodAction_id + * summary: Remove Shipping Methods from Exchange + * description: Remove a list of shipping methods from a exchange. This doesn't + * delete the Shipping Method, only the association between the Shipping Method + * and the exchange. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The exchange's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The exchange's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X DELETE + * '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExchangeReturnResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: removeReturnShippingMethodWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts new file mode 100644 index 0000000000..afa5fff1c7 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts @@ -0,0 +1,107 @@ +/** + * @oas [delete] /admin/exchanges/{id}/outbound/items/{action_id} + * operationId: DeleteExchangesIdOutboundItemsAction_id + * summary: Remove Items from Exchange + * description: Remove a list of items from a exchange. This doesn't delete the + * Item, only the association between the Item and the exchange. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The exchange's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The exchange's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X DELETE + * '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExchangePreviewResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: removeItemExchangeActionWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts new file mode 100644 index 0000000000..0f6dbc80b7 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts @@ -0,0 +1,109 @@ +/** + * @oas [delete] /admin/exchanges/{id}/outbound/shipping-method/{action_id} + * operationId: DeleteExchangesIdOutboundShippingMethodAction_id + * summary: Remove Shipping Methods from Exchange + * description: Remove a list of shipping methods from a exchange. This doesn't + * delete the Shipping Method, only the association between the Shipping Method + * and the exchange. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The exchange's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The exchange's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X DELETE + * '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}' + * \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExchangePreviewResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: removeExchangeShippingMethodWorkflow + * +*/ + 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 new file mode 100644 index 0000000000..9ab6427d3a --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts @@ -0,0 +1,119 @@ +/** + * @oas [delete] /admin/exchanges/{id}/request + * operationId: DeleteExchangesIdRequest + * summary: Remove Requests from Exchange + * description: Remove a list of requests from a exchange. This doesn't delete the + * Request, only the association between the Request and the exchange. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The exchange's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/exchanges/{id}/request' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * 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 exchange's object. + * deleted: + * type: boolean + * title: deleted + * description: The exchange's deleted. + * parent: + * type: object + * description: The exchange's parent. + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + 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 13e7dcfa81..1518dead9e 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 @@ -84,6 +84,33 @@ * tags: * - Fulfillment Sets * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The fulfillment set's ID. + * object: + * type: string + * title: object + * description: The fulfillment set's object. + * deleted: + * type: boolean + * title: deleted + * description: The fulfillment set's deleted. + * parent: + * type: object + * description: The fulfillment set's parent. * "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 53803859fc..ec0b8796d7 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 @@ -74,6 +74,33 @@ * tags: * - Inventory Items * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * 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 inventory item's object. + * deleted: + * type: boolean + * title: deleted + * description: The inventory item's 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 08ec4a9d7a..dd611a894a 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 @@ -84,6 +84,33 @@ * tags: * - Inventory Items * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * 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 inventory item's object. + * deleted: + * type: boolean + * title: deleted + * description: The inventory item's 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_invites_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts index 06ccd273d7..16d6e1aeee 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 @@ -68,6 +68,33 @@ * tags: * - Invites * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The invite's ID. + * object: + * type: string + * title: object + * description: The invite's object. + * deleted: + * type: boolean + * title: deleted + * description: The invite's 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_price-lists_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_price-lists_[id].ts index 60cb55e49c..0a35498989 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_price-lists_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_price-lists_[id].ts @@ -74,6 +74,12 @@ * tags: * - Price Lists * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPriceListDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_price-preferences_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_price-preferences_[id].ts index 3d7c7f4084..16036691e8 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_price-preferences_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_price-preferences_[id].ts @@ -74,6 +74,12 @@ * tags: * - Price Preferences * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPricePreferenceDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts index 9415ad6a39..13efef832c 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts @@ -74,6 +74,12 @@ * tags: * - Product Categories * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductCategoryDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts index 0f46feb42c..c3bcbd9416 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts @@ -74,6 +74,12 @@ * tags: * - Product Tags * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductTagDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts index 2c8111a914..0c80b8f36e 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts @@ -74,6 +74,12 @@ * tags: * - Product Types * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductTypeDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts index 323609cc39..a4361414d6 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts @@ -91,6 +91,12 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductVariantInventoryLinkDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -103,6 +109,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: dismissLinksWorkflow * */ 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 4878c15ff9..ece9b2e00c 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 @@ -74,6 +74,33 @@ * tags: * - Promotions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The promotion's ID. + * object: + * type: string + * title: object + * description: The promotion's object. + * deleted: + * type: boolean + * title: deleted + * description: The promotion's 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 new file mode 100644 index 0000000000..5eadfec590 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts @@ -0,0 +1,118 @@ +/** + * @oas [delete] /admin/refund-reasons/{id} + * operationId: DeleteRefundReasonsId + * summary: Delete a Refund Reason + * description: Delete a refund reason. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The refund reason's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/refund-reasons/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Refund Reasons + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The refund reason's ID. + * object: + * type: string + * title: object + * description: The refund reason's object. + * deleted: + * type: boolean + * title: deleted + * description: The refund reason's deleted. + * parent: + * type: object + * description: The refund reason's parent. + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + 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 1e6fdd04b4..1663fee620 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 @@ -74,6 +74,33 @@ * tags: * - Regions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The region's ID. + * object: + * type: string + * title: object + * description: The region's object. + * deleted: + * type: boolean + * title: deleted + * description: The region's 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 6deb836777..f21d17bf4b 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 @@ -74,6 +74,33 @@ * tags: * - Reservations * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The reservation's ID. + * object: + * type: string + * title: object + * description: The reservation's object. + * deleted: + * type: boolean + * title: deleted + * description: The reservation's 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 fd30a64e47..ecd93feeb8 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 @@ -74,6 +74,33 @@ * tags: * - Return Reasons * responses: + * "200": + * description: OK + * 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 return reason's object. + * deleted: + * type: boolean + * title: deleted + * description: The return reason's deleted. + * parent: + * type: object + * description: The return reason's parent. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts index 5e77d27adc..b4585119f0 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts @@ -84,6 +84,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -96,6 +102,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: removeItemReturnActionWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts index 7518e0f371..dbb2680405 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts @@ -84,6 +84,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -96,6 +102,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: removeItemReceiveReturnActionWorkflow * */ 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 5fb9becb8f..78fd501b5e 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 @@ -75,6 +75,33 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The return's ID. + * object: + * type: string + * title: object + * description: The return's object. + * deleted: + * type: boolean + * title: deleted + * description: The return's 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-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts index c7fc069a05..19968f2aaf 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts @@ -84,6 +84,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -96,6 +102,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: removeItemReturnActionWorkflow * */ 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 c9e5534f5d..51cb966381 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 @@ -75,6 +75,33 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The return's ID. + * object: + * type: string + * title: object + * description: The return's object. + * deleted: + * type: boolean + * title: deleted + * description: The return's 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 42d595aeab..010d377636 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 @@ -84,6 +84,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -96,6 +102,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: removeReturnShippingMethodWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_sales-channels_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_sales-channels_[id].ts index 3822cc60ef..89de824de5 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_sales-channels_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_sales-channels_[id].ts @@ -74,6 +74,12 @@ * tags: * - Sales Channels * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminSalesChannelDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_stock-locations_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_stock-locations_[id].ts index 8600eefa07..39e7937150 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_stock-locations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_stock-locations_[id].ts @@ -74,6 +74,12 @@ * tags: * - Stock Locations * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminStockLocationDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id].ts index 849e7b9ee9..c01a2b1fbc 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id].ts @@ -74,6 +74,12 @@ * tags: * - Tax Rates * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminTaxRateDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": 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 4e8e87609c..998589ede1 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 @@ -81,6 +81,33 @@ * tags: * - Tax Rates * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * 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 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": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-regions_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-regions_[id].ts index db0a3edcaa..01d3c461e5 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-regions_[id].ts @@ -74,6 +74,12 @@ * tags: * - Tax Regions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminTaxRegionDeleteResponse" * "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 413b9b98e7..e66b6b0dbf 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 @@ -74,6 +74,33 @@ * tags: * - Uploads * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The upload's ID. + * object: + * type: string + * title: object + * description: The upload's object. + * deleted: + * type: boolean + * title: deleted + * description: The upload's 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/delete_admin_users_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts index cfe1891e61..87ed7ba83d 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts @@ -68,6 +68,12 @@ * tags: * - Users * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminUserDeleteResponse" * "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 3adab89634..d67024cdb5 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 @@ -69,6 +69,41 @@ * tags: * - Api Keys * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The api key's limit. + * offset: + * type: number + * title: offset + * description: The api key's offset. + * count: + * type: number + * title: count + * description: The api key's count. + * - type: object + * description: SUMMARY + * required: + * - api_keys + * properties: + * api_keys: + * type: array + * description: The api key's api keys. + * items: + * $ref: "#/components/schemas/ApiKeyResponse" * "400": * $ref: "#/components/responses/400_error" * "401": 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 30cf8d59c6..89358cf82c 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 @@ -75,6 +75,12 @@ * tags: * - Api Keys * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminApiKeyResponse" * "400": * $ref: "#/components/responses/400_error" * "401": 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 80ec5911f3..14666f3bb1 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 @@ -69,6 +69,41 @@ * tags: * - Campaigns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The campaign's limit. + * offset: + * type: number + * title: offset + * description: The campaign's offset. + * count: + * type: number + * title: count + * description: The campaign's count. + * - type: object + * description: SUMMARY + * required: + * - campaigns + * properties: + * campaigns: + * type: array + * description: The campaign's campaigns. + * items: + * $ref: "#/components/schemas/CampaignResponse" * "400": * $ref: "#/components/responses/400_error" * "401": 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 11dfd71a59..49da297f7e 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 @@ -75,6 +75,12 @@ * tags: * - Campaigns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCampaignResponse" * "400": * $ref: "#/components/responses/400_error" * "401": 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 00143afb07..90b0899b65 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 @@ -69,6 +69,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": 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 new file mode 100644 index 0000000000..c46771ab39 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts @@ -0,0 +1,98 @@ +/** + * @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. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The claim's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/claims/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Claims + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts b/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts index 9dda60bc54..1f23aa208d 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts @@ -69,6 +69,12 @@ * tags: * - Collections * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCollectionListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": 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 3faf37cb68..d43942f30a 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 @@ -75,6 +75,12 @@ * tags: * - Collections * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCollectionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts b/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts index 8fe016cef7..a23087fc13 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts @@ -69,6 +69,12 @@ * tags: * - Currencies * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCurrencyListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": 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 0b015ae051..a85236e6b8 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 @@ -75,6 +75,12 @@ * tags: * - Currencies * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCurrencyResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts index 13959511f2..9e30b30d94 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts @@ -70,6 +70,41 @@ * tags: * - Customer Groups * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The customer group's limit. + * offset: + * type: number + * title: offset + * description: The customer group's offset. + * count: + * type: number + * title: count + * description: The customer group's count. + * - type: object + * description: SUMMARY + * required: + * - customer_groups + * properties: + * customer_groups: + * type: array + * description: The customer group's customer groups. + * items: + * $ref: "#/components/schemas/AdminCustomerGroup" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups_[id].ts index 0090aab0e5..a2e024f20a 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups_[id].ts @@ -75,6 +75,12 @@ * tags: * - Customer Groups * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCustomerGroupResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts index 912c89e573..1c017d9e99 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts @@ -80,13 +80,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - customer - * properties: - * customer: - * $ref: "#/components/schemas/AdminCustomer" + * $ref: "#/components/schemas/AdminCustomerResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts index 5914c28fd5..cbf44e21ff 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts @@ -75,6 +75,41 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The customer's limit. + * offset: + * type: number + * title: offset + * description: The customer's offset. + * count: + * type: number + * title: count + * description: The customer's count. + * - type: object + * description: SUMMARY + * required: + * - addresses + * properties: + * addresses: + * type: array + * description: The customer's addresses. + * items: + * $ref: "#/components/schemas/AdminCustomerAddress" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts index 86454aec42..ba86b223eb 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts @@ -81,6 +81,12 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCustomerAddressResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts index 8f3a54ed83..c6e5ac91dc 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts @@ -69,6 +69,38 @@ * tags: * - Draft Orders * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The draft order's limit. + * offset: + * type: number + * title: offset + * description: The draft order's offset. + * count: + * type: number + * title: count + * description: The draft order's count. + * - type: object + * description: SUMMARY + * required: + * - draft_orders + * properties: + * draft_orders: + * $ref: "#/components/schemas/AdminOrder" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts index a6a8758f29..8b5fe8a79c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts @@ -75,6 +75,12 @@ * tags: * - Draft Orders * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminDraftOrderResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts new file mode 100644 index 0000000000..4a2345ad32 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts @@ -0,0 +1,118 @@ +/** + * @oas [get] /admin/exchanges + * operationId: GetExchanges + * summary: List Exchanges + * description: Retrieve a list of exchanges. The exchanges can be filtered by + * fields such as `id`. The exchanges can also be sorted or paginated. + * x-authenticated: true + * parameters: + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/exchanges' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The exchange's limit. + * offset: + * type: number + * title: offset + * description: The exchange's offset. + * count: + * type: number + * title: count + * description: The exchange's count. + * - type: object + * description: SUMMARY + * required: + * - exchanges + * properties: + * exchanges: + * $ref: "#/components/schemas/AdminExchange" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts index 0ae1d54e23..ae74c3fdbb 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts @@ -114,6 +114,12 @@ * tags: * - Fulfillment Providers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminFulfillmentProviderListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts index bd32d4b623..253c229e96 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts @@ -307,11 +307,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The inventory item's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The inventory item's $or. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] @@ -325,6 +335,41 @@ * tags: * - Inventory Items * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The inventory item's limit. + * offset: + * type: number + * title: offset + * description: The inventory item's offset. + * count: + * type: number + * title: count + * description: The inventory item's count. + * - type: object + * description: SUMMARY + * required: + * - inventory_items + * properties: + * inventory_items: + * type: array + * description: The inventory item's inventory items. + * items: + * $ref: "#/components/schemas/AdminInventoryItem" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id].ts index f7365bf18f..fbddf8654b 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id].ts @@ -75,6 +75,12 @@ * tags: * - Inventory Items * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminInventoryItemResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts index a780c0462b..d7a61c4b26 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts @@ -80,11 +80,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The inventory item's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The inventory item's $or. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] @@ -98,6 +108,41 @@ * tags: * - Inventory Items * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The inventory item's limit. + * offset: + * type: number + * title: offset + * description: The inventory item's offset. + * count: + * type: number + * title: count + * description: The inventory item's count. + * - type: object + * description: SUMMARY + * required: + * - inventory_levels + * properties: + * inventory_levels: + * type: array + * description: The inventory item's inventory levels. + * items: + * $ref: "#/components/schemas/InventoryLevel" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts b/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts index 9709f0bcb8..a7c2974349 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts @@ -199,11 +199,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The invite's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The invite's $or. + * items: + * type: object + * title: $or * x-codeSamples: * - lang: Shell * label: cURL @@ -211,6 +221,41 @@ * tags: * - Invites * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The invite's limit. + * offset: + * type: number + * title: offset + * description: The invite's offset. + * count: + * type: number + * title: count + * description: The invite's count. + * - type: object + * description: SUMMARY + * required: + * - invites + * properties: + * invites: + * type: array + * description: The invite's invites. + * items: + * $ref: "#/components/schemas/AdminInvite" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts index 1a067ea09d..89a8a243be 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts @@ -69,6 +69,12 @@ * tags: * - Invites * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminInviteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts b/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts index d19cffce38..c22d22d136 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts @@ -95,11 +95,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The notification's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The notification's $or. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] @@ -113,6 +123,12 @@ * tags: * - Notifications * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminNotificationListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts index f054ecfa6c..edf01c5058 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts @@ -75,6 +75,12 @@ * tags: * - Notifications * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminNotificationResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts index ae2c891c05..ac26077642 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts @@ -69,6 +69,41 @@ * tags: * - Orders * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The order's limit. + * offset: + * type: number + * title: offset + * description: The order's offset. + * count: + * type: number + * title: count + * description: The order's count. + * - type: object + * description: SUMMARY + * required: + * - orders + * properties: + * orders: + * type: array + * description: The order's orders. + * items: + * $ref: "#/components/schemas/AdminOrder" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts index 44e747b855..86136c31c1 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts @@ -75,6 +75,12 @@ * tags: * - Orders * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_preview.ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_preview.ts index 1d0575d8b8..0e5cc2c118 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_preview.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_preview.ts @@ -75,6 +75,12 @@ * tags: * - Orders * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts b/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts index 131127b635..3601928815 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts @@ -197,11 +197,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The payment's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The payment's $or. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] @@ -215,6 +225,41 @@ * tags: * - Payments * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The payment's limit. + * offset: + * type: number + * title: offset + * description: The payment's offset. + * count: + * type: number + * title: count + * description: The payment's count. + * - type: object + * description: SUMMARY + * required: + * - payments + * properties: + * payments: + * type: array + * description: The payment's payments. + * items: + * $ref: "#/components/schemas/AdminPayment" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_payments_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_payments_[id].ts index d807427b16..6e84968918 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_payments_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_payments_[id].ts @@ -75,6 +75,12 @@ * tags: * - Payments * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPaymentResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts index 59b100dc31..aed86f7031 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts @@ -81,11 +81,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The payment's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The payment's $or. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] @@ -99,6 +109,41 @@ * tags: * - Payments * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The payment's limit. + * offset: + * type: number + * title: offset + * description: The payment's offset. + * count: + * type: number + * title: count + * description: The payment's count. + * - type: object + * description: SUMMARY + * required: + * - payment_providers + * properties: + * payment_providers: + * type: array + * description: The payment's payment providers. + * items: + * $ref: "#/components/schemas/AdminPaymentProvider" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts index 8d0d663a96..567cc02e12 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts @@ -69,6 +69,12 @@ * tags: * - Price Lists * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPriceListListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists_[id].ts index 8697456397..9db000413f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists_[id].ts @@ -75,6 +75,12 @@ * tags: * - Price Lists * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPriceListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences.ts b/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences.ts index abe2a396d0..e11e46729d 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences.ts @@ -70,6 +70,12 @@ * tags: * - Price Preferences * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPricePreferenceListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences_[id].ts index 5016b477ea..0136f50e15 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences_[id].ts @@ -75,6 +75,12 @@ * tags: * - Price Preferences * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPricePreferenceResponse" * "400": * $ref: "#/components/responses/400_error" * "401": 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 5aab636a96..d180f84a4b 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 @@ -258,11 +258,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The product category's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The product category's $or. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts index d994d96548..b8519b86e1 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts @@ -197,11 +197,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The product tag's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The product tag's $or. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] @@ -215,6 +225,12 @@ * tags: * - Product Tags * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductTagListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags_[id].ts index 8f4eb0dda1..f63ba8dd6a 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags_[id].ts @@ -75,6 +75,12 @@ * tags: * - Product Tags * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductTagResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts index e4472efca6..02b7bdf2ad 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts @@ -197,11 +197,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The product type's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The product type's $or. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] @@ -215,6 +225,12 @@ * tags: * - Product Types * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductTypeListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-types_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-types_[id].ts index c9245016c8..5c11db722b 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-types_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-types_[id].ts @@ -75,6 +75,12 @@ * tags: * - Product Types * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductTypeResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts new file mode 100644 index 0000000000..d117a5f176 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts @@ -0,0 +1,122 @@ +/** + * @oas [get] /admin/product-variants + * operationId: GetProductVariants + * summary: List Product Variants + * description: Retrieve a list of product variants. The product variants can be + * filtered by fields such as `id`. The product variants can also be sorted or + * paginated. + * x-authenticated: true + * parameters: + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/product-variants' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Product Variants + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The product variant's limit. + * offset: + * type: number + * title: offset + * description: The product variant's offset. + * count: + * type: number + * title: count + * description: The product variant's count. + * - type: object + * description: SUMMARY + * required: + * - variants + * properties: + * variants: + * type: array + * description: The product variant's variants. + * items: + * $ref: "#/components/schemas/AdminProductVariant" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products.ts index ed8151f6a8..810005c372 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products.ts @@ -12057,6 +12057,9 @@ * x-schemaName: BaseProductListParams * - type: object * description: The $or's details. + * type: array + * items: + * type: object * - name: $or * in: query * description: The product's $or. @@ -13971,6 +13974,9 @@ * x-schemaName: BaseProductListParams * - type: object * description: The $or's details. + * type: array + * items: + * type: object * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts index da368ac4f4..9cc6602f3d 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts @@ -601,6 +601,9 @@ * x-schemaName: BaseProductOptionParams * - type: object * description: The $or's details. + * type: array + * items: + * type: object * - name: $or * in: query * description: The product's $or. @@ -1090,6 +1093,9 @@ * x-schemaName: BaseProductOptionParams * - type: object * description: The $or's details. + * type: array + * items: + * type: object * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts index 985a060603..4ee7ec7d0c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts @@ -216,11 +216,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The promotion's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The promotion's $or. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] @@ -234,6 +244,41 @@ * tags: * - Promotions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The promotion's limit. + * offset: + * type: number + * title: offset + * description: The promotion's offset. + * count: + * type: number + * title: count + * description: The promotion's count. + * - type: object + * description: SUMMARY + * required: + * - promotions + * properties: + * promotions: + * type: array + * description: The promotion's promotions. + * items: + * $ref: "#/components/schemas/AdminPromotion" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id].ts index 133c74881b..4acbd9139b 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id].ts @@ -75,6 +75,12 @@ * tags: * - Promotions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPromotionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts index 2d0df8dca4..4b74d282c0 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts @@ -81,6 +81,21 @@ * tags: * - Promotions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - rules + * properties: + * rules: + * type: array + * description: The promotion's rules. + * items: + * $ref: "#/components/schemas/AdminPromotionRule" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts index f619a293b6..c4b9d19b4c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts @@ -92,6 +92,21 @@ * tags: * - Promotions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - attributes + * properties: + * attributes: + * type: array + * description: The promotion's attributes. + * items: + * $ref: "#/components/schemas/AdminRuleAttributeOption" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts index feda2bd619..e40078191e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts @@ -100,6 +100,21 @@ * tags: * - Promotions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - values + * properties: + * values: + * type: array + * description: The promotion's values. + * items: + * $ref: "#/components/schemas/AdminRuleValueOption" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts new file mode 100644 index 0000000000..03b3f3f852 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts @@ -0,0 +1,122 @@ +/** + * @oas [get] /admin/refund-reasons + * operationId: GetRefundReasons + * summary: List Refund Reasons + * description: Retrieve a list of refund reasons. The refund reasons can be + * filtered by fields such as `id`. The refund reasons can also be sorted or + * paginated. + * x-authenticated: true + * parameters: + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/refund-reasons' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Refund Reasons + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The refund reason's limit. + * offset: + * type: number + * title: offset + * description: The refund reason's offset. + * count: + * type: number + * title: count + * description: The refund reason's count. + * - type: object + * description: SUMMARY + * required: + * - refund_reasons + * properties: + * refund_reasons: + * type: array + * description: The refund reason's refund reasons. + * items: + * $ref: "#/components/schemas/AdminRefundReason" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons_[id].ts new file mode 100644 index 0000000000..1105afddd9 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons_[id].ts @@ -0,0 +1,98 @@ +/** + * @oas [get] /admin/refund-reasons/{id} + * operationId: GetRefundReasonsId + * summary: Get a Refund Reason + * description: Retrieve a refund reason by its ID. You can expand the refund + * reason's relations or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The refund reason's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/refund-reasons/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Refund Reasons + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/RefundReasonResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts index b9232545bf..d510a686aa 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts @@ -211,11 +211,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The region's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The region's $or. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] @@ -229,6 +239,41 @@ * tags: * - Regions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The region's limit. + * offset: + * type: number + * title: offset + * description: The region's offset. + * count: + * type: number + * title: count + * description: The region's count. + * - type: object + * description: SUMMARY + * required: + * - regions + * properties: + * regions: + * type: array + * description: The region's regions. + * items: + * $ref: "#/components/schemas/AdminRegion" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_regions_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_regions_[id].ts index ef07fc6bff..3f0c75ab58 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_regions_[id].ts @@ -75,6 +75,12 @@ * tags: * - Regions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminRegionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts b/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts index 8a660ed0c3..e6dbbb35ab 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts @@ -295,6 +295,41 @@ * tags: * - Reservations * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The reservation's limit. + * offset: + * type: number + * title: offset + * description: The reservation's offset. + * count: + * type: number + * title: count + * description: The reservation's count. + * - type: object + * description: SUMMARY + * required: + * - reservations + * properties: + * reservations: + * type: array + * description: The reservation's reservations. + * items: + * $ref: "#/components/schemas/ReservationResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_reservations_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_reservations_[id].ts index 8d67ef8834..28463623b8 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_reservations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_reservations_[id].ts @@ -75,6 +75,12 @@ * tags: * - Reservations * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReservationResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts index 7ffbfd2511..0999aff61b 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts @@ -57,6 +57,131 @@ * description: The field to sort the data by. By default, the sort order is * ascending. To change the order to descending, prefix the field name with * `-`. + * - name: q + * in: query + * description: The return reason's q. + * required: false + * schema: + * type: string + * title: q + * description: The return reason's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The return reason's ID. + * - type: array + * description: The return reason's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: value + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: value + * description: The return reason's value. + * - type: array + * description: The return reason's value. + * items: + * type: string + * title: value + * description: The value's details. + * - name: label + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: label + * description: The return reason's label. + * - type: array + * description: The return reason's label. + * items: + * type: string + * title: label + * description: The label's details. + * - name: description + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: description + * description: The return reason's description. + * - type: array + * description: The return reason's description. + * items: + * type: string + * title: description + * description: The description's details. + * - name: parent_return_reason_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: parent_return_reason_id + * description: The return reason's parent return reason id. + * - type: array + * description: The return reason's parent return reason id. + * items: + * type: string + * title: parent_return_reason_id + * description: The parent return reason id's details. + * - name: created_at + * in: query + * description: The return reason's created at. + * required: false + * schema: + * type: string + * format: date-time + * title: created_at + * description: The return reason's created at. + * - name: updated_at + * in: query + * description: The return reason's updated at. + * required: false + * schema: + * type: string + * format: date-time + * title: updated_at + * description: The return reason's updated at. + * - name: deleted_at + * in: query + * description: The return reason's deleted at. + * required: false + * schema: + * type: string + * format: date-time + * title: deleted_at + * description: The return reason's deleted at. + * - name: $and + * in: query + * description: The return reason's $and. + * required: false + * schema: + * type: array + * description: The return reason's $and. + * items: + * type: object + * title: $and + * - name: $or + * in: query + * description: The return reason's $or. + * required: false + * schema: + * type: array + * description: The return reason's $or. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] @@ -70,6 +195,12 @@ * tags: * - Return Reasons * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnReasonListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons_[id].ts index ab9f467fe3..951c7b5854 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons_[id].ts @@ -75,6 +75,12 @@ * tags: * - Return Reasons * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnReasonResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts b/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts index 55da803987..e10da246aa 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts @@ -69,6 +69,41 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The return's limit. + * offset: + * type: number + * title: offset + * description: The return's offset. + * count: + * type: number + * title: count + * description: The return's count. + * - type: object + * description: SUMMARY + * required: + * - returns + * properties: + * returns: + * type: array + * description: The return's returns. + * items: + * $ref: "#/components/schemas/AdminReturn" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_returns_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_returns_[id].ts index 7111030409..5c4ff2f972 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_returns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_returns_[id].ts @@ -75,6 +75,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts index 5dea5e21ac..c9483a7e91 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts @@ -242,11 +242,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The sales channel's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The sales channel's $or. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] @@ -260,6 +270,41 @@ * tags: * - Sales Channels * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The sales channel's limit. + * offset: + * type: number + * title: offset + * description: The sales channel's offset. + * count: + * type: number + * title: count + * description: The sales channel's count. + * - type: object + * description: SUMMARY + * required: + * - sales_channels + * properties: + * sales_channels: + * type: array + * description: The sales channel's sales channels. + * items: + * $ref: "#/components/schemas/AdminSalesChannel" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels_[id].ts index bf12447174..f639a5af30 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels_[id].ts @@ -75,6 +75,12 @@ * tags: * - Sales Channels * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminSalesChannelResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts index 8273fab98e..818982bd03 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts @@ -237,6 +237,20 @@ * $lt: {} * $lte: {} * title: deleted_at + * - name: stock_location_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: stock_location_id + * description: The shipping option's stock location id. + * - type: array + * description: The shipping option's stock location id. + * items: + * type: string + * title: stock_location_id + * description: The stock location id's details. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts index b44e011af4..685ade7a06 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts @@ -200,11 +200,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The shipping profile's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The shipping profile's $or. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts index cec32cb8ea..df6aebae34 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts @@ -226,11 +226,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The stock location's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The stock location's $or. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] @@ -244,6 +254,12 @@ * tags: * - Stock Locations * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminStockLocationListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations_[id].ts index d789b4371d..a1bd263bfb 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations_[id].ts @@ -75,6 +75,12 @@ * tags: * - Stock Locations * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminStockLocationResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts b/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts index 3538f0c5c5..dce54b5bfa 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts @@ -95,11 +95,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The store's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The store's $or. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] @@ -113,6 +123,12 @@ * tags: * - Stores * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminStoreListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stores_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_stores_[id].ts index 6b4355d419..3209f7d7c7 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stores_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stores_[id].ts @@ -75,6 +75,12 @@ * tags: * - Stores * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminStoreResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts index 10748fd8e4..5cdcaa8abb 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts @@ -219,11 +219,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The tax rate's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The tax rate's $or. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] @@ -237,6 +247,41 @@ * tags: * - Tax Rates * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The tax rate's limit. + * offset: + * type: number + * title: offset + * description: The tax rate's offset. + * count: + * type: number + * title: count + * description: The tax rate's count. + * - type: object + * description: SUMMARY + * required: + * - tax_rates + * properties: + * tax_rates: + * type: array + * description: The tax rate's tax rates. + * items: + * $ref: "#/components/schemas/AdminTaxRate" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates_[id].ts index 96efc4df38..6041b92adf 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates_[id].ts @@ -75,6 +75,12 @@ * tags: * - Tax Rates * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminTaxRateResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts index 73aa15247e..bf3f38c013 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts @@ -323,11 +323,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The tax region's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The tax region's $or. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] @@ -341,6 +351,41 @@ * tags: * - Tax Regions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The tax region's limit. + * offset: + * type: number + * title: offset + * description: The tax region's offset. + * count: + * type: number + * title: count + * description: The tax region's count. + * - type: object + * description: SUMMARY + * required: + * - tax_regions + * properties: + * tax_regions: + * type: array + * description: The tax region's tax regions. + * items: + * $ref: "#/components/schemas/AdminTaxRegion" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts index 43757d2928..95d71d5662 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts @@ -75,6 +75,12 @@ * tags: * - Tax Regions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminTaxRegionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_uploads_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_uploads_[id].ts index a5b7915a05..a9f25bbeae 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_uploads_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_uploads_[id].ts @@ -75,6 +75,12 @@ * tags: * - Uploads * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminFileResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_users.ts b/www/utils/generated/oas-output/operations/admin/get_admin_users.ts index 10f266c651..9856a12991 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_users.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_users.ts @@ -63,6 +63,12 @@ * tags: * - Users * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminUserListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts index d8b2e24d90..b8d75c1f41 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts @@ -69,6 +69,12 @@ * tags: * - Users * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminUserResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts b/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts index 772bacf4f1..3bb4222eda 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts @@ -63,6 +63,12 @@ * tags: * - Users * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminUserResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts index a920206fdd..2346aa4d74 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts @@ -98,6 +98,41 @@ * tags: * - Workflows Executions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The workflows execution's limit. + * offset: + * type: number + * title: offset + * description: The workflows execution's offset. + * count: + * type: number + * title: count + * description: The workflows execution's count. + * - type: object + * description: SUMMARY + * required: + * - workflow_executions + * properties: + * workflow_executions: + * type: array + * description: The workflows execution's workflow executions. + * items: + * $ref: "#/components/schemas/AdminWorkflowExecution" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[id].ts index a28bfadf71..0c18ecc91f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[id].ts @@ -75,6 +75,12 @@ * tags: * - Workflows Executions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminWorkflowExecutionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts index 9e0265ae7f..98ea56f276 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts @@ -84,6 +84,12 @@ * tags: * - Workflows Executions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminWorkflowExecutionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts index 6c4b78f1f0..b8bb3bf520 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts @@ -78,6 +78,12 @@ * tags: * - Api Keys * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminApiKeyResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -90,6 +96,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createApiKeysWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts index 90f4a6cbb0..6dc1ef2543 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts @@ -83,6 +83,12 @@ * tags: * - Api Keys * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminApiKeyResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts index ef8bfbb463..8828d6cc7a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts @@ -79,6 +79,12 @@ * tags: * - Api Keys * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminApiKeyResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts index bd7b4c30bc..5411d0ccdc 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts @@ -95,6 +95,12 @@ * tags: * - Api Keys * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminApiKeyResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts index 5e1ab618d5..0bbbc93391 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts @@ -63,15 +63,7 @@ * content: * application/json: * schema: - * type: object * description: SUMMARY - * required: - * - name - * - campaign_identifier - * - description - * - budget - * - starts_at - * - ends_at * properties: * name: * type: string @@ -146,6 +138,12 @@ * tags: * - Campaigns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCampaignResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts index 7cda0ec5e5..b842a5c430 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts @@ -69,7 +69,53 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminUpdateCampaign" + * description: SUMMARY + * properties: + * name: + * type: string + * title: name + * description: The campaign's name. + * campaign_identifier: + * type: string + * title: campaign_identifier + * description: The campaign's campaign identifier. + * description: + * type: string + * title: description + * description: The campaign's description. + * budget: + * type: object + * description: The campaign's budget. + * required: + * - limit + * properties: + * limit: + * type: number + * title: limit + * description: The budget's limit. + * 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 + * promotions: + * type: array + * description: The campaign's promotions. + * items: + * type: object + * description: The promotion's promotions. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The promotion's ID. * x-codeSamples: * - lang: Shell * label: cURL @@ -85,6 +131,12 @@ * tags: * - Campaigns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCampaignResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts index 8d47e13273..9546a6d028 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts @@ -95,6 +95,12 @@ * tags: * - Campaigns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCampaignResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts index 0b4341223c..45aec2794c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts @@ -79,6 +79,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimOrderResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_cancel.ts index c58a6fb5d6..700b0b38bf 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_cancel.ts @@ -79,6 +79,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts index ec65e9ad80..7e77946f1e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts @@ -79,6 +79,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -91,6 +97,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: orderClaimItemWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts index 560b95a73a..f672b7679b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts @@ -85,6 +85,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -97,6 +103,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateClaimItemWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts index 3155529a17..ea1eeeacd5 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts @@ -79,6 +79,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -91,6 +97,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: orderClaimRequestItemReturnWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts index d468f5e645..1c212aa225 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts @@ -85,6 +85,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -97,6 +103,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateRequestItemReturnWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts index 6deb2af2bd..47da9c3104 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts @@ -83,6 +83,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -95,6 +101,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createClaimShippingMethodWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts index f3ca62139a..de428c0372 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts @@ -87,6 +87,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -99,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateReturnShippingMethodWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts index a9dda60966..79391bb6b7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts @@ -79,6 +79,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -91,6 +97,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: orderClaimAddNewItemWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts index 7009d51948..72312b8d82 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts @@ -87,6 +87,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -99,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateClaimAddItemWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts index 765fdffdfd..c23f6f1311 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts @@ -83,6 +83,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -95,6 +101,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createClaimShippingMethodWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts index 7f566361b2..74fad929a9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts @@ -87,6 +87,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -99,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateClaimShippingMethodWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_request.ts index dd70601d16..cd1ffabc38 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_request.ts @@ -74,6 +74,12 @@ * tags: * - Claims * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminClaimRequestResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -90,6 +96,7 @@ * content: * application/json: * schema: {} + * x-workflow: confirmClaimRequestWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts b/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts index 5adb7b1bf1..a9c79d8585 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts @@ -78,6 +78,12 @@ * tags: * - Collections * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCollectionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -90,6 +96,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createCollectionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts index 31336e9676..66bfbeccdf 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts @@ -83,6 +83,12 @@ * tags: * - Collections * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCollectionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts index a73ec23b87..ea6788cafa 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts @@ -95,6 +95,12 @@ * tags: * - Collections * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCollectionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts index 9fd693ab26..95b6715c41 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts @@ -78,6 +78,12 @@ * tags: * - Customer Groups * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCustomerGroupResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts index 68b268293f..0e0e63cc7c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts @@ -84,6 +84,12 @@ * tags: * - Customer Groups * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCustomerGroupResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts index 59bcef0231..84ddc4b19b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts @@ -95,6 +95,12 @@ * tags: * - Customer Groups * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCustomerGroupResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts index 10d650ffe2..55d5524c4f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts @@ -63,7 +63,32 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCreateCustomer" + * description: SUMMARY + * properties: + * email: + * type: string + * title: email + * description: The customer's email. + * format: email + * company_name: + * type: string + * title: company_name + * description: The customer's company name. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * metadata: + * type: object + * description: The customer's metadata. * x-codeSamples: * - lang: Shell * label: cURL @@ -87,13 +112,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - customer - * properties: - * customer: - * $ref: "#/components/schemas/AdminCustomer" + * $ref: "#/components/schemas/AdminCustomerResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts index 25ed9162ed..4b2d460be3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts @@ -69,7 +69,32 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminUpdateCustomer" + * description: SUMMARY + * properties: + * email: + * type: string + * title: email + * description: The customer's email. + * format: email + * company_name: + * type: string + * title: company_name + * description: The customer's company name. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * metadata: + * type: object + * description: The customer's metadata. * x-codeSamples: * - lang: Shell * label: cURL @@ -93,13 +118,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - customer - * properties: - * customer: - * $ref: "#/components/schemas/AdminCustomer" + * $ref: "#/components/schemas/AdminCustomerResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts index c43b52e246..bb2af1c77c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts @@ -69,7 +69,63 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCreateCustomerAddress" + * description: SUMMARY + * properties: + * address_name: + * type: string + * title: address_name + * description: The customer's address name. + * is_default_shipping: + * type: boolean + * title: is_default_shipping + * description: The customer's is default shipping. + * is_default_billing: + * type: boolean + * title: is_default_billing + * description: The customer's is default billing. + * company: + * type: string + * title: company + * description: The customer's company. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * address_1: + * type: string + * title: address_1 + * description: The customer's address 1. + * address_2: + * type: string + * title: address_2 + * description: The customer's address 2. + * city: + * type: string + * title: city + * description: The customer's city. + * country_code: + * type: string + * title: country_code + * description: The customer's country code. + * province: + * type: string + * title: province + * description: The customer's province. + * postal_code: + * type: string + * title: postal_code + * description: The customer's postal code. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * metadata: + * type: object + * description: The customer's metadata. * x-codeSamples: * - lang: Shell * label: cURL @@ -94,6 +150,12 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCustomerResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts index c41cdefe88..15bd78340d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts @@ -75,7 +75,63 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCreateCustomerAddress" + * description: SUMMARY + * properties: + * address_name: + * type: string + * title: address_name + * description: The customer's address name. + * is_default_shipping: + * type: boolean + * title: is_default_shipping + * description: The customer's is default shipping. + * is_default_billing: + * type: boolean + * title: is_default_billing + * description: The customer's is default billing. + * company: + * type: string + * title: company + * description: The customer's company. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * address_1: + * type: string + * title: address_1 + * description: The customer's address 1. + * address_2: + * type: string + * title: address_2 + * description: The customer's address 2. + * city: + * type: string + * title: city + * description: The customer's city. + * country_code: + * type: string + * title: country_code + * description: The customer's country code. + * province: + * type: string + * title: province + * description: The customer's province. + * postal_code: + * type: string + * title: postal_code + * description: The customer's postal code. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * metadata: + * type: object + * description: The customer's metadata. * x-codeSamples: * - lang: Shell * label: cURL @@ -100,6 +156,12 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCustomerResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts index 96709c5437..379d12eae3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts @@ -63,16 +63,7 @@ * content: * application/json: * schema: - * type: object * description: SUMMARY - * required: - * - sales_channel_id - * - email - * - customer_id - * - region_id - * - currency_code - * - shipping_methods - * - metadata * properties: * status: * type: boolean @@ -371,6 +362,12 @@ * tags: * - Draft Orders * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminDraftOrderResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -383,6 +380,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createOrdersWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts new file mode 100644 index 0000000000..77c6ded748 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts @@ -0,0 +1,101 @@ +/** + * @oas [post] /admin/exchanges + * operationId: PostExchanges + * summary: Create Exchange + * description: Create a exchange. + * x-authenticated: true + * parameters: + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostOrderExchangesReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/exchanges' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "order_id": "{value}", + * "metadata": {} + * }' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExchangeOrderResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts new file mode 100644 index 0000000000..260e35f73c --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts @@ -0,0 +1,102 @@ +/** + * @oas [post] /admin/exchanges/{id}/cancel + * operationId: PostExchangesIdCancel + * summary: Add Cancels to Exchange + * description: Add a list of cancels to a exchange. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The exchange's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostCancelExchangeReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/exchanges/{id}/cancel' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExchangeResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts new file mode 100644 index 0000000000..4ed06634e9 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts @@ -0,0 +1,103 @@ +/** + * @oas [post] /admin/exchanges/{id}/inbound/items + * operationId: PostExchangesIdInboundItems + * summary: Add Items to Exchange + * description: Add a list of items to a exchange. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The exchange's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/items' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExchangeReturnResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: orderExchangeRequestItemReturnWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts new file mode 100644 index 0000000000..e61a9e1c1a --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts @@ -0,0 +1,111 @@ +/** + * @oas [post] /admin/exchanges/{id}/inbound/items/{action_id} + * operationId: PostExchangesIdInboundItemsAction_id + * summary: Add Items to Exchange + * description: Add a list of items to a exchange. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The exchange's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The exchange's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExchangeReturnResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: updateRequestItemReturnWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts new file mode 100644 index 0000000000..df000b76a8 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts @@ -0,0 +1,111 @@ +/** + * @oas [post] /admin/exchanges/{id}/inbound/shipping-method + * operationId: PostExchangesIdInboundShippingMethod + * summary: Add Shipping Methods to Exchange + * description: Add a list of shipping methods to a exchange. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The exchange's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostReturnsShippingReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/shipping-method' + * \ + * + * -H 'x-medusa-access-token: {api_token}' \ + * + * -H 'Content-Type: application/json' \ + * + * --data-raw '{ + * "shipping_option_id": "{value}" + * }' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExchangeReturnResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: createExchangeShippingMethodWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts new file mode 100644 index 0000000000..fcc8582cee --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts @@ -0,0 +1,111 @@ +/** + * @oas [post] /admin/exchanges/{id}/inbound/shipping-method/{action_id} + * operationId: PostExchangesIdInboundShippingMethodAction_id + * summary: Add Shipping Methods to Exchange + * description: Add a list of shipping methods to a exchange. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The exchange's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The exchange's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostExchangesShippingActionReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExchangePreviewResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: updateReturnShippingMethodWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts new file mode 100644 index 0000000000..88d7a0908a --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts @@ -0,0 +1,103 @@ +/** + * @oas [post] /admin/exchanges/{id}/outbound/items + * operationId: PostExchangesIdOutboundItems + * summary: Add Items to Exchange + * description: Add a list of items to a exchange. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The exchange's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostExchangesAddItemsReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/items' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExchangePreviewResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: orderExchangeAddNewItemWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts new file mode 100644 index 0000000000..46cec37e0b --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts @@ -0,0 +1,111 @@ +/** + * @oas [post] /admin/exchanges/{id}/outbound/items/{action_id} + * operationId: PostExchangesIdOutboundItemsAction_id + * summary: Add Items to Exchange + * description: Add a list of items to a exchange. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The exchange's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The exchange's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostExhangesItemsActionReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExchangePreviewResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: updateExchangeAddItemWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts new file mode 100644 index 0000000000..44e5bcfe04 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts @@ -0,0 +1,111 @@ +/** + * @oas [post] /admin/exchanges/{id}/outbound/shipping-method + * operationId: PostExchangesIdOutboundShippingMethod + * summary: Add Shipping Methods to Exchange + * description: Add a list of shipping methods to a exchange. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The exchange's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostExchangesShippingReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/shipping-method' + * \ + * + * -H 'x-medusa-access-token: {api_token}' \ + * + * -H 'Content-Type: application/json' \ + * + * --data-raw '{ + * "shipping_option_id": "{value}" + * }' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExchangePreviewResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: createExchangeShippingMethodWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts new file mode 100644 index 0000000000..15c07ce7ad --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts @@ -0,0 +1,112 @@ +/** + * @oas [post] /admin/exchanges/{id}/outbound/shipping-method/{action_id} + * operationId: PostExchangesIdOutboundShippingMethodAction_id + * summary: Add Shipping Methods to Exchange + * description: Add a list of shipping methods to a exchange. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The exchange's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The exchange's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostExchangesShippingActionReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}' + * \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExchangePreviewResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: updateExchangeShippingMethodWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts new file mode 100644 index 0000000000..0abc2b7d23 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts @@ -0,0 +1,98 @@ +/** + * @oas [post] /admin/exchanges/{id}/request + * operationId: PostExchangesIdRequest + * summary: Add Requests to Exchange + * description: Add a list of requests to a exchange. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The exchange's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/exchanges/{id}/request' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExchangeRequestResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: confirmExchangeRequestWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts index 348bfb00b1..d7958db8cc 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts @@ -197,6 +197,12 @@ * tags: * - Fulfillment Sets * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminFulfillmentSetResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts index b9ad7c5c85..371d2e21ce 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts @@ -117,6 +117,12 @@ * tags: * - Fulfillments * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminFulfillmentResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -129,6 +135,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createFulfillmentWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts index 96d67e0b40..9d44d07d98 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts @@ -79,6 +79,12 @@ * tags: * - Fulfillments * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminFulfillmentResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts index b7efbd5196..e71067408a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts @@ -89,6 +89,12 @@ * tags: * - Fulfillments * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminFulfillmentResponse" * "400": * $ref: "#/components/responses/400_error" * "401": 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 691c5e4572..bbd236c027 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 @@ -181,6 +181,12 @@ * tags: * - Inventory Items * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminInventoryItemResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -193,6 +199,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createInventoryItemsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts index 2c2e368a6c..8ed04ec46f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts @@ -166,6 +166,12 @@ * tags: * - Inventory Items * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminInventoryItemResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts index 8517742864..cbfe7f0c0f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts @@ -99,6 +99,12 @@ * tags: * - Inventory Items * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminInventoryItemResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts index f46f352517..a790fdefa6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts @@ -97,6 +97,12 @@ * tags: * - Inventory Items * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminInventoryItemResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts index 0593675503..22a31ce2d7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts @@ -126,6 +126,19 @@ * tags: * - Inventory Items * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - inventory_item + * properties: + * inventory_item: + * type: object + * description: The inventory item's details. * "400": * $ref: "#/components/responses/400_error" * "401": 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 827399c64b..da8fb27c1b 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 @@ -81,6 +81,12 @@ * tags: * - Invites * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminInviteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts b/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts index 692bd274ba..f1cf11a1a2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts @@ -68,6 +68,12 @@ * tags: * - Invites * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminInviteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts b/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts index dd46d497ca..5b60bc170b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts @@ -93,6 +93,28 @@ * tags: * - Invites * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * oneOf: + * - type: object + * description: SUMMARY + * required: + * - user + * properties: + * user: + * $ref: "#/components/schemas/AdminUser" + * - type: object + * description: SUMMARY + * required: + * - message + * properties: + * message: + * type: string + * title: message + * description: The invite's message. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts index 1051130ee9..0bd0a2bd36 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts @@ -74,6 +74,12 @@ * tags: * - Orders * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_archive.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_archive.ts index 36de487d9e..21dd6f81cb 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_archive.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_archive.ts @@ -83,6 +83,12 @@ * tags: * - Orders * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_cancel.ts index a4c15c810e..9246ce26bf 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_cancel.ts @@ -74,6 +74,12 @@ * tags: * - Orders * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts index c67f57ee34..45eeb32d39 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts @@ -69,7 +69,12 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCompleteOrder" + * description: SUMMARY + * properties: + * order_id: + * type: string + * title: order_id + * description: The order's order id. * x-codeSamples: * - lang: Shell * label: cURL @@ -83,6 +88,12 @@ * tags: * - Orders * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts index a7334c8377..e8ceba35ad 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts @@ -69,7 +69,37 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminOrderCreateFulfillment" + * description: SUMMARY + * properties: + * items: + * type: array + * description: The order's items. + * items: + * 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. + * location_id: + * type: string + * title: location_id + * description: The order's location id. + * no_notification: + * type: boolean + * title: no_notification + * description: The order's no notification. + * metadata: + * type: object + * description: The order's metadata. * x-codeSamples: * - lang: Shell * label: cURL @@ -90,6 +120,12 @@ * tags: * - Orders * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts index 03143e9e4a..72673064f8 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts @@ -75,7 +75,12 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminOrderCancelFulfillment" + * description: SUMMARY + * properties: + * no_notification: + * type: boolean + * title: no_notification + * description: The order's no notification. * x-codeSamples: * - lang: Shell * label: cURL @@ -87,6 +92,12 @@ * tags: * - Orders * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts index 05acafbc9d..8648751760 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts @@ -75,7 +75,56 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminOrderCreateShipment" + * description: SUMMARY + * properties: + * items: + * type: array + * description: The order's items. + * items: + * 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. + * labels: + * type: array + * description: The order's labels. + * items: + * type: object + * description: The label's labels. + * required: + * - tracking_number + * - tracking_url + * - label_url + * properties: + * tracking_number: + * type: string + * title: tracking_number + * description: The label's tracking number. + * tracking_url: + * type: string + * title: tracking_url + * description: The label's tracking url. + * label_url: + * type: string + * title: label_url + * description: The label's label url. + * no_notification: + * type: boolean + * title: no_notification + * description: The order's no notification. + * metadata: + * type: object + * description: The order's metadata. * x-codeSamples: * - lang: Shell * label: cURL @@ -100,6 +149,12 @@ * tags: * - Orders * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts index 4622fcb6e1..dc19861417 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts @@ -85,6 +85,12 @@ * tags: * - Payments * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPaymentResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts index 2241177275..3b702f9193 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts @@ -76,6 +76,14 @@ * type: number * title: amount * description: The payment's amount. + * refund_reason_id: + * type: string + * title: refund_reason_id + * description: The payment's refund reason id. + * note: + * type: string + * title: note + * description: The payment's note. * x-codeSamples: * - lang: Shell * label: cURL @@ -85,6 +93,12 @@ * tags: * - Payments * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPaymentResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts index db72ff60b0..888c69a1e9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts @@ -80,6 +80,12 @@ * tags: * - Price Lists * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPriceListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts index 09317cc80e..38d0b9fdaa 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts @@ -85,6 +85,12 @@ * tags: * - Price Lists * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPriceListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts index 3782d2c628..3409d4b9b6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts @@ -163,6 +163,12 @@ * tags: * - Price Lists * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPriceListBatchResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts index 1f5480ebd0..c5504a182e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts @@ -95,6 +95,12 @@ * tags: * - Price Lists * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPriceListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences.ts index 3ba117d3da..9947f1bbe2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences.ts @@ -73,6 +73,12 @@ * tags: * - Price Preferences * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPricePreferenceResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences_[id].ts index be96a8e197..0e4ab7a2dd 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences_[id].ts @@ -79,6 +79,12 @@ * tags: * - Price Preferences * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPricePreferenceResponse" * "400": * $ref: "#/components/responses/400_error" * "401": 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 58e38e1e9c..0b32f0e3cd 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 @@ -134,6 +134,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createProductCategoriesWorkflow * */ 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 738d778a34..8a6f0f9a2a 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 @@ -90,6 +90,12 @@ * tags: * - Product Tags * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductTagResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -102,6 +108,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createProductTagsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts index e0b7b86ffd..65791fe6d7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts @@ -94,6 +94,12 @@ * tags: * - Product Tags * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductTagResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -106,6 +112,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateProductTagsWorkflow * */ 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 5b2b160d35..36a94cd54b 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 @@ -90,6 +90,12 @@ * tags: * - Product Types * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductTypeResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -102,6 +108,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createProductTypesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts index 995df57353..ff0700217d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts @@ -94,6 +94,12 @@ * tags: * - Product Types * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductTypeResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -106,6 +112,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateProductTypesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products.ts index eb02008a74..caaae14791 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products.ts @@ -63,7 +63,148 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCreateProduct" + * description: SUMMARY + * properties: + * title: + * type: string + * title: title + * description: The product's title. + * subtitle: + * type: string + * title: subtitle + * description: The product's subtitle. + * description: + * type: string + * title: description + * description: The product's description. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The product's is giftcard. + * discountable: + * type: boolean + * title: discountable + * description: The product's discountable. + * images: + * type: array + * description: The product's images. + * items: + * type: object + * description: The image's images. + * required: + * - url + * properties: + * url: + * type: string + * title: url + * description: The image's url. + * thumbnail: + * type: string + * title: thumbnail + * description: The product's thumbnail. + * handle: + * type: string + * title: handle + * description: The product's handle. + * status: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * type_id: + * type: string + * title: type_id + * description: The product's type id. + * collection_id: + * type: string + * title: collection_id + * description: The product's collection id. + * categories: + * type: array + * description: The product's categories. + * items: + * type: object + * description: The category's categories. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The category's ID. + * tags: + * type: array + * description: The product's tags. + * items: + * type: object + * description: The tag's tags. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The tag's ID. + * options: + * type: array + * description: The product's options. + * items: + * $ref: "#/components/schemas/AdminCreateProductOption" + * variants: + * type: array + * description: The product's variants. + * items: + * $ref: "#/components/schemas/AdminCreateProductVariant" + * sales_channels: + * type: array + * description: The product's sales channels. + * items: + * type: object + * description: The sales channel's sales channels. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The sales channel's ID. + * weight: + * type: number + * title: weight + * description: The product's weight. + * length: + * type: number + * title: length + * description: The product's length. + * height: + * type: number + * title: height + * description: The product's height. + * width: + * type: number + * title: width + * description: The product's width. + * hs_code: + * type: string + * title: hs_code + * description: The product's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The product's mid code. + * origin_country: + * type: string + * title: origin_country + * description: The product's origin country. + * material: + * type: string + * title: material + * description: The product's material. + * metadata: + * type: object + * description: The product's metadata. * x-codeSamples: * - lang: Shell * label: cURL @@ -95,6 +236,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createProductsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts index a6ea942baa..bb2a1de3cc 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts @@ -69,7 +69,150 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminUpdateProduct" + * description: SUMMARY + * properties: + * title: + * type: string + * title: title + * description: The product's title. + * subtitle: + * type: string + * title: subtitle + * description: The product's subtitle. + * description: + * type: string + * title: description + * description: The product's description. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The product's is giftcard. + * discountable: + * type: boolean + * title: discountable + * description: The product's discountable. + * images: + * type: array + * description: The product's images. + * items: + * type: object + * description: The image's images. + * required: + * - url + * properties: + * url: + * type: string + * title: url + * description: The image's url. + * thumbnail: + * type: string + * title: thumbnail + * description: The product's thumbnail. + * handle: + * type: string + * title: handle + * description: The product's handle. + * status: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * type_id: + * type: string + * title: type_id + * description: The product's type id. + * collection_id: + * type: string + * title: collection_id + * description: The product's collection id. + * categories: + * type: array + * description: The product's categories. + * items: + * type: object + * description: The category's categories. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The category's ID. + * tags: + * type: array + * description: The product's tags. + * items: + * type: object + * description: The tag's tags. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The tag's ID. + * options: + * type: array + * description: The product's options. + * items: + * $ref: "#/components/schemas/AdminUpdateProductOption" + * variants: + * type: array + * description: The product's variants. + * items: + * oneOf: + * - $ref: "#/components/schemas/AdminCreateProductVariant" + * - $ref: "#/components/schemas/AdminUpdateProductVariant" + * sales_channels: + * type: array + * description: The product's sales channels. + * items: + * type: object + * description: The sales channel's sales channels. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The sales channel's ID. + * weight: + * type: number + * title: weight + * description: The product's weight. + * length: + * type: number + * title: length + * description: The product's length. + * height: + * type: number + * title: height + * description: The product's height. + * width: + * type: number + * title: width + * description: The product's width. + * hs_code: + * type: string + * title: hs_code + * description: The product's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The product's mid code. + * origin_country: + * type: string + * title: origin_country + * description: The product's origin country. + * material: + * type: string + * title: material + * description: The product's material. + * metadata: + * type: object + * description: The product's metadata. * x-codeSamples: * - lang: Shell * label: cURL @@ -97,6 +240,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateProductsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts index 36e21eca09..f36bf8fad2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts @@ -69,7 +69,19 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCreateProductOption" + * description: SUMMARY + * properties: + * title: + * type: string + * title: title + * description: The product's title. + * values: + * type: array + * description: The product's values. + * items: + * type: string + * title: values + * description: The value's values. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts index 1d67ddd248..afee93dc04 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts @@ -75,7 +75,19 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminUpdateProductOption" + * description: SUMMARY + * properties: + * title: + * type: string + * title: title + * description: The product's title. + * values: + * type: array + * description: The product's values. + * items: + * type: string + * title: values + * description: The value's values. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts index b6e759c830..17d0f5d922 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts @@ -69,7 +69,83 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCreateProductVariant" + * description: SUMMARY + * properties: + * title: + * type: string + * title: title + * description: The product's title. + * sku: + * type: string + * title: sku + * description: The product's sku. + * ean: + * type: string + * title: ean + * description: The product's ean. + * upc: + * type: string + * title: upc + * description: The product's upc. + * barcode: + * type: string + * title: barcode + * description: The product's barcode. + * hs_code: + * type: string + * title: hs_code + * description: The product's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The product's mid code. + * allow_backorder: + * type: boolean + * title: allow_backorder + * description: The product's allow backorder. + * manage_inventory: + * type: boolean + * title: manage_inventory + * description: The product's manage inventory. + * variant_rank: + * type: number + * title: variant_rank + * description: The product's variant rank. + * weight: + * type: number + * title: weight + * description: The product's weight. + * length: + * type: number + * title: length + * description: The product's length. + * height: + * type: number + * title: height + * description: The product's height. + * width: + * type: number + * title: width + * description: The product's width. + * origin_country: + * type: string + * title: origin_country + * description: The product's origin country. + * material: + * type: string + * title: material + * description: The product's material. + * metadata: + * type: object + * description: The product's metadata. + * prices: + * type: array + * description: The product's prices. + * items: + * $ref: "#/components/schemas/AdminCreateProductVariantPrice" + * options: + * type: object + * description: The product's options. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts index 595f7c9248..b5f85c34b6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts @@ -75,7 +75,83 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminUpdateProductVariant" + * description: SUMMARY + * properties: + * title: + * type: string + * title: title + * description: The product's title. + * sku: + * type: string + * title: sku + * description: The product's sku. + * ean: + * type: string + * title: ean + * description: The product's ean. + * upc: + * type: string + * title: upc + * description: The product's upc. + * barcode: + * type: string + * title: barcode + * description: The product's barcode. + * hs_code: + * type: string + * title: hs_code + * description: The product's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The product's mid code. + * allow_backorder: + * type: boolean + * title: allow_backorder + * description: The product's allow backorder. + * manage_inventory: + * type: boolean + * title: manage_inventory + * description: The product's manage inventory. + * variant_rank: + * type: number + * title: variant_rank + * description: The product's variant rank. + * weight: + * type: number + * title: weight + * description: The product's weight. + * length: + * type: number + * title: length + * description: The product's length. + * height: + * type: number + * title: height + * description: The product's height. + * width: + * type: number + * title: width + * description: The product's width. + * origin_country: + * type: string + * title: origin_country + * description: The product's origin country. + * material: + * type: string + * title: material + * description: The product's material. + * metadata: + * type: object + * description: The product's metadata. + * prices: + * type: array + * description: The product's prices. + * items: + * $ref: "#/components/schemas/AdminCreateProductVariantPrice" + * options: + * type: object + * description: The product's options. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts index 739094291f..f46c72bd67 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts @@ -95,6 +95,12 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductVariantResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts index d6695347b0..5fd80d8b7b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts @@ -100,6 +100,12 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductVariantResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts index 33ee9d2d1d..d2d881b5d3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts @@ -97,6 +97,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: batchProductVariantsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts index 7beb3175e3..6617d37e58 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts @@ -147,6 +147,12 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductVariantInventoryBatchResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -159,6 +165,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: batchLinksWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts index ee49a9e604..106fb62308 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts @@ -91,6 +91,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: batchProductsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts index 75d3abe39e..4bebe70f3e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts @@ -91,6 +91,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: exportProductsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts index 661d1bd185..239081f8f1 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts @@ -91,6 +91,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: importProductsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts index e4151d3fb0..a637cf08ae 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts @@ -63,13 +63,7 @@ * content: * application/json: * schema: - * type: object * description: SUMMARY - * required: - * - code - * - type - * - campaign_id - * - application_method * properties: * code: * type: string @@ -359,6 +353,12 @@ * tags: * - Promotions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPromotionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts index a984b2b5ff..89bd15f39c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts @@ -69,10 +69,7 @@ * content: * application/json: * schema: - * type: object * description: SUMMARY - * required: - * - campaign_id * properties: * code: * type: string @@ -344,6 +341,12 @@ * tags: * - Promotions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPromotionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts index 0996fa435b..6ad756fdfa 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts @@ -173,6 +173,51 @@ * tags: * - Promotions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - created + * - updated + * - deleted + * properties: + * created: + * type: array + * description: The promotion's created. + * items: + * $ref: "#/components/schemas/AdminPromotionRule" + * updated: + * type: array + * description: The promotion's updated. + * items: + * $ref: "#/components/schemas/AdminPromotionRule" + * deleted: + * type: object + * description: The promotion's deleted. + * required: + * - ids + * - object + * - deleted + * properties: + * ids: + * type: array + * description: The deleted's ids. + * items: + * type: string + * title: ids + * description: The id's ids. + * object: + * type: string + * title: object + * description: The deleted's object. + * deleted: + * type: boolean + * title: deleted + * description: The deleted's details. * "400": * $ref: "#/components/responses/400_error" * "401": @@ -185,6 +230,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: batchPromotionRulesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts index 6d84043193..da78a2913b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts @@ -173,6 +173,51 @@ * tags: * - Promotions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - created + * - updated + * - deleted + * properties: + * created: + * type: array + * description: The promotion's created. + * items: + * $ref: "#/components/schemas/AdminPromotionRule" + * updated: + * type: array + * description: The promotion's updated. + * items: + * $ref: "#/components/schemas/AdminPromotionRule" + * deleted: + * type: object + * description: The promotion's deleted. + * required: + * - ids + * - object + * - deleted + * properties: + * ids: + * type: array + * description: The deleted's ids. + * items: + * type: string + * title: ids + * description: The id's ids. + * object: + * type: string + * title: object + * description: The deleted's object. + * deleted: + * type: boolean + * title: deleted + * description: The deleted's details. * "400": * $ref: "#/components/responses/400_error" * "401": @@ -185,6 +230,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: batchPromotionRulesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts index 13a125105d..b6b4a7a795 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts @@ -173,6 +173,51 @@ * tags: * - Promotions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - created + * - updated + * - deleted + * properties: + * created: + * type: array + * description: The promotion's created. + * items: + * $ref: "#/components/schemas/AdminPromotionRule" + * updated: + * type: array + * description: The promotion's updated. + * items: + * $ref: "#/components/schemas/AdminPromotionRule" + * deleted: + * type: object + * description: The promotion's deleted. + * required: + * - ids + * - object + * - deleted + * properties: + * ids: + * type: array + * description: The deleted's ids. + * items: + * type: string + * title: ids + * description: The id's ids. + * object: + * type: string + * title: object + * description: The deleted's object. + * deleted: + * type: boolean + * title: deleted + * description: The deleted's details. * "400": * $ref: "#/components/responses/400_error" * "401": @@ -185,6 +230,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: batchPromotionRulesWorkflow * */ 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 new file mode 100644 index 0000000000..b0e358fde6 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts @@ -0,0 +1,115 @@ +/** + * @oas [post] /admin/refund-reasons + * operationId: PostRefundReasons + * summary: Create Refund Reason + * description: Create a refund reason. + * x-authenticated: true + * parameters: + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * 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. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/refund-reasons' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "label": "{value}", + * "description": "{value}" + * }' + * tags: + * - Refund Reasons + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/RefundReasonResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: createRefundReasonsWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts new file mode 100644 index 0000000000..47b0a6f28f --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts @@ -0,0 +1,118 @@ +/** + * @oas [post] /admin/refund-reasons/{id} + * operationId: PostRefundReasonsId + * summary: Update a Refund Reason + * description: Update a refund reason's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The refund reason's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - description + * properties: + * label: + * type: string + * title: label + * description: The refund reason's label. + * description: + * type: string + * title: description + * description: The refund reason's description. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/refund-reasons/{id}' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "description": "{value}" + * }' + * tags: + * - Refund Reasons + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/RefundReasonResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + 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 b97abcb911..72ca9ddf44 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 @@ -118,6 +118,12 @@ * tags: * - Regions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminRegionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -130,6 +136,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createRegionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts index 9dcb8cf312..2d7e62a08f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts @@ -120,6 +120,12 @@ * tags: * - Regions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminRegionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -132,6 +138,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateRegionsWorkflow * */ 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 94763ce7b2..bb903bc394 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 @@ -114,6 +114,12 @@ * tags: * - Reservations * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReservationResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -126,6 +132,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createReservationsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts index ef027f86e6..3accd3208d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts @@ -104,6 +104,12 @@ * tags: * - Reservations * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReservationResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons.ts b/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons.ts index e6cd4363ad..d184d93a88 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons.ts @@ -78,6 +78,12 @@ * tags: * - Return Reasons * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnReasonResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons_[id].ts index f632d7f8cf..5ae40aa4b2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons_[id].ts @@ -79,6 +79,12 @@ * tags: * - Return Reasons * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnReasonResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts index 004cf655fa..54e97adb57 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts @@ -91,6 +91,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderReturnResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts index 1b0c4831ad..801b94204f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts @@ -83,6 +83,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -95,6 +101,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateReturnWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts index 37c4dd4d8d..d0046fd0cc 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts @@ -74,6 +74,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts index 70f8f87b99..24c4e07910 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts @@ -79,6 +79,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -91,6 +97,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: dismissItemReturnRequestWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts index 34e7aa1c17..4f06a2d609 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts @@ -87,6 +87,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -99,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateReceiveItemReturnRequestWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts index adde722603..63b936950e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts @@ -79,6 +79,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -91,6 +97,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: receiveItemReturnRequestWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts index dd07098d73..e8d58bcb39 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts @@ -87,6 +87,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -99,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateReceiveItemReturnRequestWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts index 5bc43d35b2..dfbb9c7e6b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts @@ -92,6 +92,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderReturnResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts index a476e3ec81..d6e975ceda 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts @@ -79,6 +79,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -91,6 +97,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: confirmReturnReceiveWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts index 73e5181612..cac4a5d19b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts @@ -79,6 +79,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -91,6 +97,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: requestItemReturnWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts index f51c6de407..7128caf3a9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts @@ -87,6 +87,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -99,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateRequestItemReturnWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts index 3d7c9b9f81..3ece8deb6e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts @@ -79,6 +79,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -91,6 +97,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: confirmReturnRequestWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts index 662882b63a..cc89e06a11 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts @@ -83,6 +83,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -95,6 +101,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createReturnShippingMethodWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts index 4005d2c76a..d18f73c078 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts @@ -87,6 +87,12 @@ * tags: * - Returns * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminReturnPreviewResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -99,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateReturnShippingMethodWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts index 10beb1ca65..4de13004c7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts @@ -79,6 +79,12 @@ * tags: * - Sales Channels * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminSalesChannelResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -91,6 +97,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createSalesChannelsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts index be06989be1..5dc81f2170 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts @@ -84,6 +84,12 @@ * tags: * - Sales Channels * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminSalesChannelResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts index 94a7dad161..229b5f0b62 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts @@ -95,6 +95,12 @@ * tags: * - Sales Channels * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminSalesChannelResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts index 9dbb2d5449..f547cb64d4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts @@ -167,6 +167,51 @@ * tags: * - Shipping Options * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - created + * - updated + * - deleted + * properties: + * created: + * type: array + * description: The shipping option's created. + * items: + * $ref: "#/components/schemas/AdminShippingOptionRule" + * updated: + * type: array + * description: The shipping option's updated. + * items: + * $ref: "#/components/schemas/AdminShippingOptionRule" + * deleted: + * type: object + * description: The shipping option's deleted. + * required: + * - ids + * - object + * - deleted + * properties: + * ids: + * type: array + * description: The deleted's ids. + * items: + * type: string + * title: ids + * description: The id's ids. + * object: + * type: string + * title: object + * description: The deleted's object. + * deleted: + * type: boolean + * title: deleted + * description: The deleted's details. * "400": * $ref: "#/components/responses/400_error" * "401": @@ -179,6 +224,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: batchShippingOptionRulesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts index 226cd54fdc..10ac6f76bc 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts @@ -114,6 +114,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createShippingProfilesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts index f7f821c180..5d5b025a9d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts @@ -79,6 +79,12 @@ * tags: * - Stock Locations * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminStockLocationResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -91,6 +97,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createStockLocationsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts index 476c441680..ef85424321 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts @@ -84,6 +84,12 @@ * tags: * - Stock Locations * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminStockLocationResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts index 1cbf29942f..cb69f04b89 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts @@ -97,6 +97,12 @@ * tags: * - Stock Locations * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminStockLocationResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts index 49930ecc41..7e9c69868e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts @@ -97,6 +97,12 @@ * tags: * - Stock Locations * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminStockLocationResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts index ea556251d0..3e4410f018 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts @@ -95,6 +95,12 @@ * tags: * - Stock Locations * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminStockLocationResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts index 43f1b7597f..f211969a32 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts @@ -87,6 +87,12 @@ * tags: * - Stores * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminStoreResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -99,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateStoresWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts index 819f16c226..158d0f8e1d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts @@ -79,6 +79,12 @@ * tags: * - Tax Rates * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminTaxRateResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -91,6 +97,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createTaxRatesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts index d5b1085632..1437ee1102 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts @@ -83,6 +83,12 @@ * tags: * - Tax Rates * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminTaxRateResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts index d18955b9dd..90be53e9c8 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts @@ -84,6 +84,12 @@ * tags: * - Tax Rates * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminTaxRateResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts index 23dc6feffd..62b7f192fd 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts @@ -80,6 +80,12 @@ * tags: * - Tax Regions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminTaxRegionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -92,6 +98,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createTaxRegionsWorkflow * */ 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 a38ba25d05..08ae7a9008 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 @@ -73,6 +73,12 @@ * tags: * - Uploads * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminFileListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -85,6 +91,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: uploadFilesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_users.ts b/www/utils/generated/oas-output/operations/admin/post_admin_users.ts index 4493f8b078..8f9c8d2a07 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_users.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_users.ts @@ -72,6 +72,12 @@ * tags: * - Users * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminUserResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -84,6 +90,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createUserAccountWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts index b1c10ac9fc..62571f973c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts @@ -80,6 +80,12 @@ * tags: * - Users * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminUserResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts index 56d9cb44ec..e82d2ca715 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts @@ -81,6 +81,17 @@ * tags: * - Workflows Executions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - acknowledgement + * properties: + * acknowledgement: {} * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts index 4817ad9a9a..3e45ff47e1 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts @@ -88,6 +88,20 @@ * tags: * - Workflows Executions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - success + * properties: + * success: + * type: boolean + * title: success + * description: The workflows execution's success. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts index ed13d9d9a3..0df89484df 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts @@ -88,6 +88,20 @@ * tags: * - Workflows Executions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - success + * properties: + * success: + * type: boolean + * title: success + * description: The workflows execution's success. * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts index 39da0291c3..dbcc301ee3 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts @@ -69,6 +69,18 @@ * tags: * - Carts * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - cart + * properties: + * cart: + * $ref: "#/components/schemas/StoreCart" * "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 9ad42054ef..e1161c34f4 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 @@ -74,6 +74,33 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * 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 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_carts_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_carts_[id].ts index c7ac8e5aba..f9da20f418 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_carts_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_carts_[id].ts @@ -69,6 +69,12 @@ * tags: * - Carts * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCartResponse" * "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 244089a667..3f7ec46c4e 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 @@ -63,6 +63,41 @@ * tags: * - Collections * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The collection's limit. + * offset: + * type: number + * title: offset + * description: The collection's offset. + * count: + * type: number + * title: count + * description: The collection's count. + * - type: object + * description: SUMMARY + * required: + * - collections + * properties: + * collections: + * type: array + * description: The collection's collections. + * items: + * $ref: "#/components/schemas/StoreCollection" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts index 789e1d8142..f8482af738 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts @@ -69,6 +69,12 @@ * tags: * - Collections * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCollectionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": 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 b83e252891..b0b2a3bc86 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 @@ -63,6 +63,12 @@ * tags: * - Currencies * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCurrencyListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts b/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts index 3dfc2dade3..8400d335df 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts @@ -69,6 +69,12 @@ * tags: * - Currencies * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCurrencyResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts index 856d3702d7..26c9dffca8 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts @@ -68,6 +68,12 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCustomerResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts index 6f5d0a8aa5..c12116a44d 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts @@ -179,6 +179,12 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCustomerAddressListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts index 4819f20df7..f3c31d9394 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts @@ -74,6 +74,12 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCustomerAddressResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/get_store_orders.ts b/www/utils/generated/oas-output/operations/store/get_store_orders.ts index 3389a01276..78e12ec717 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_orders.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_orders.ts @@ -87,11 +87,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The order's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The order's $or. + * items: + * type: object + * title: $or * x-codeSamples: * - lang: Shell * label: cURL @@ -99,6 +109,41 @@ * tags: * - Orders * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The order's limit. + * offset: + * type: number + * title: offset + * description: The order's offset. + * count: + * type: number + * title: count + * description: The order's count. + * - type: object + * description: SUMMARY + * required: + * - orders + * properties: + * orders: + * type: array + * description: The order's orders. + * items: + * $ref: "#/components/schemas/StoreOrder" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts index 6cde0d6d15..bea746b415 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts @@ -93,11 +93,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The order's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The order's $or. + * items: + * type: object + * title: $or * x-codeSamples: * - lang: Shell * label: cURL @@ -105,6 +115,12 @@ * tags: * - Orders * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreOrderResponse" * "400": * $ref: "#/components/responses/400_error" * "401": 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 f04c9374d7..d35e0e2402 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 @@ -90,11 +90,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The payment provider's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The payment provider's $or. + * items: + * type: object + * title: $or * x-codeSamples: * - lang: Shell * label: cURL @@ -102,6 +112,41 @@ * tags: * - Payment Providers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The payment provider's limit. + * offset: + * type: number + * title: offset + * description: The payment provider's offset. + * count: + * type: number + * title: count + * description: The payment provider's count. + * - type: object + * description: SUMMARY + * required: + * - payment_providers + * properties: + * payment_providers: + * type: array + * description: The payment provider's payment providers. + * items: + * $ref: "#/components/schemas/StorePaymentProvider" * "400": * $ref: "#/components/responses/400_error" * "401": 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 49a915e31d..d2b3335258 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 @@ -242,11 +242,21 @@ * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The product category's $and. + * items: + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The product category's $or. + * items: + * type: object + * title: $or * 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 de1010630a..aca2290521 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 @@ -56,22 +56,30 @@ * description: The field to sort the data by. By default, the sort order is * ascending. To change the order to descending, prefix the field name with * `-`. - * - name: region_id - * in: query - * description: The product's region id. - * required: false - * schema: - * type: string - * title: region_id - * description: The product's region id. * - name: $and * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The product's $and. + * items: + * type: array + * description: The $and's details. + * items: &a1 + * type: object + * title: $and * - name: $or * in: query * required: false - * schema: {} + * schema: + * type: array + * description: The product's $or. + * items: + * type: array + * description: The $or's details. + * items: &a2 + * type: object + * title: $or * - name: variants * in: query * description: The product's variants. @@ -80,16 +88,6 @@ * type: object * description: The product's variants. * properties: - * status: - * type: array - * description: The variant's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected * options: * type: object * description: The variant's options. @@ -105,8 +103,6 @@ * type: string * title: option_id * description: The option's option id. - * $and: {} - * $or: {} * - name: q * in: query * description: The product's q. @@ -132,51 +128,45 @@ * - name: title * in: query * description: The product's title. - * required: true + * required: false * schema: - * type: string - * title: title - * description: The product's title. + * oneOf: + * - type: string + * title: title + * description: The product's title. + * - type: array + * description: The product's title. + * items: + * type: string + * title: title + * description: The title's details. * - name: handle * in: query * description: The product's handle. - * required: true + * required: false * schema: - * type: string - * title: handle - * description: The product's handle. + * oneOf: + * - type: string + * title: handle + * description: The product's handle. + * - type: array + * description: The product's handle. + * items: + * type: string + * title: handle + * description: The handle's details. * - name: is_giftcard * in: query * description: The product's is giftcard. - * required: true + * required: false * schema: * type: boolean * title: is_giftcard * description: The product's is giftcard. - * - name: category_id - * in: query - * description: The product's category id. - * required: true - * schema: - * description: The product's category id. - * items: - * type: string - * title: category_id - * description: The category id's details. - * - name: sales_channel_id - * in: query - * description: The product's sales channel id. - * required: true - * schema: - * description: The product's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. * - name: collection_id * in: query * description: The product's collection id. - * required: true + * required: false * schema: * description: The product's collection id. * items: @@ -188,11 +178,16 @@ * description: The product's tags. * required: false * schema: + * type: object * description: The product's tags. - * items: - * type: string - * title: tags - * description: The tag's tags. + * properties: + * id: + * type: array + * description: The tag's ID. + * items: + * type: string + * title: id + * description: The id's ID. * - name: type_id * in: query * description: The product's type id. @@ -208,127 +203,6176 @@ * description: The product's created at. * required: false * schema: - * type: string + * type: object * description: The product's created at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: created_at + * $and: + * type: array + * description: The created at's $and. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $and's exec. + * test: + * type: object + * description: The $and's test. + * source: + * type: string + * title: source + * description: The $and's source. + * global: + * type: boolean + * title: global + * description: The $and's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $and's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $and's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $and's lastindex. + * compile: + * type: object + * description: The $and's compile. + * flags: + * type: string + * title: flags + * description: The $and's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $and's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $and's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $and's dotall. + * __@match@1165: + * type: object + * description: The $and's @match@1165. + * __@replace@1167: + * type: object + * description: The $and's @replace@1167. + * __@search@1170: + * type: object + * description: The $and's @search@1170. + * __@split@1172: + * type: object + * description: The $and's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $and's @matchall@1174. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $and's $eq. + * - type: object + * description: The $and's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $and's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $and's $ne. + * - type: object + * description: The $and's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $and's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $and's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $and's $not. + * - type: object + * description: The $and's $not. + * x-schemaName: RegExp + * - type: object + * description: The $and's $not. + * - type: array + * description: The $and's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $and's $gt. + * - type: object + * description: The $and's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $and's $gte. + * - type: object + * description: The $and's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $and's $lt. + * - type: object + * description: The $and's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $and's $lte. + * - type: object + * description: The $and's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $and's $like. + * $re: + * type: string + * title: $re + * description: The $and's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $and's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $and's $fulltext. + * $overlap: + * type: array + * description: The $and's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $and's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $and's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $and's $exists. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $and's exec. + * test: + * type: object + * description: The $and's test. + * source: + * type: string + * title: source + * description: The $and's source. + * global: + * type: boolean + * title: global + * description: The $and's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $and's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $and's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $and's lastindex. + * compile: + * type: object + * description: The $and's compile. + * flags: + * type: string + * title: flags + * description: The $and's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $and's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $and's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $and's dotall. + * __@match@1165: + * type: object + * description: The $and's @match@1165. + * __@replace@1167: + * type: object + * description: The $and's @replace@1167. + * __@search@1170: + * type: object + * description: The $and's @search@1170. + * __@split@1172: + * type: object + * description: The $and's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $and's @matchall@1174. + * $or: + * type: array + * description: The created at's $or. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $or's exec. + * test: + * type: object + * description: The $or's test. + * source: + * type: string + * title: source + * description: The $or's source. + * global: + * type: boolean + * title: global + * description: The $or's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $or's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $or's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $or's lastindex. + * compile: + * type: object + * description: The $or's compile. + * flags: + * type: string + * title: flags + * description: The $or's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $or's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $or's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $or's dotall. + * __@match@1165: + * type: object + * description: The $or's @match@1165. + * __@replace@1167: + * type: object + * description: The $or's @replace@1167. + * __@search@1170: + * type: object + * description: The $or's @search@1170. + * __@split@1172: + * type: object + * description: The $or's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $or's @matchall@1174. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $or's $eq. + * - type: object + * description: The $or's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $or's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $or's $ne. + * - type: object + * description: The $or's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $or's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $or's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $or's $not. + * - type: object + * description: The $or's $not. + * x-schemaName: RegExp + * - type: object + * description: The $or's $not. + * - type: array + * description: The $or's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $or's $gt. + * - type: object + * description: The $or's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $or's $gte. + * - type: object + * description: The $or's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $or's $lt. + * - type: object + * description: The $or's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $or's $lte. + * - type: object + * description: The $or's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $or's $like. + * $re: + * type: string + * title: $re + * description: The $or's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $or's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $or's $fulltext. + * $overlap: + * type: array + * description: The $or's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $or's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $or's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $or's $exists. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $or's exec. + * test: + * type: object + * description: The $or's test. + * source: + * type: string + * title: source + * description: The $or's source. + * global: + * type: boolean + * title: global + * description: The $or's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $or's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $or's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $or's lastindex. + * compile: + * type: object + * description: The $or's compile. + * flags: + * type: string + * title: flags + * description: The $or's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $or's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $or's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $or's dotall. + * __@match@1165: + * type: object + * description: The $or's @match@1165. + * __@replace@1167: + * type: object + * description: The $or's @replace@1167. + * __@search@1170: + * type: object + * description: The $or's @search@1170. + * __@split@1172: + * type: object + * description: The $or's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $or's @matchall@1174. + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The created at's $eq. + * - type: object + * description: The created at's $eq. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * test: + * type: object + * description: The $eq's test. + * source: + * type: string + * title: source + * description: The $eq's source. + * global: + * type: boolean + * title: global + * description: The $eq's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $eq's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $eq's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $eq's lastindex. + * compile: + * type: object + * description: The $eq's compile. + * flags: + * type: string + * title: flags + * description: The $eq's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $eq's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $eq's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $eq's dotall. + * __@match@1165: + * type: object + * description: The $eq's @match@1165. + * __@replace@1167: + * type: object + * description: The $eq's @replace@1167. + * __@search@1170: + * type: object + * description: The $eq's @search@1170. + * __@split@1172: + * type: object + * description: The $eq's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $eq's @matchall@1174. + * - type: array + * description: The created at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * test: + * type: object + * description: The $eq's test. + * source: + * type: string + * title: source + * description: The $eq's source. + * global: + * type: boolean + * title: global + * description: The $eq's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $eq's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $eq's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $eq's lastindex. + * compile: + * type: object + * description: The $eq's compile. + * flags: + * type: string + * title: flags + * description: The $eq's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $eq's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $eq's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $eq's dotall. + * __@match@1165: + * type: object + * description: The $eq's @match@1165. + * __@replace@1167: + * type: object + * description: The $eq's @replace@1167. + * __@search@1170: + * type: object + * description: The $eq's @search@1170. + * __@split@1172: + * type: object + * description: The $eq's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $eq's @matchall@1174. + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The created at's $ne. + * - type: object + * description: The created at's $ne. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $ne's exec. + * test: + * type: object + * description: The $ne's test. + * source: + * type: string + * title: source + * description: The $ne's source. + * global: + * type: boolean + * title: global + * description: The $ne's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $ne's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $ne's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $ne's lastindex. + * compile: + * type: object + * description: The $ne's compile. + * flags: + * type: string + * title: flags + * description: The $ne's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $ne's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $ne's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $ne's dotall. + * __@match@1165: + * type: object + * description: The $ne's @match@1165. + * __@replace@1167: + * type: object + * description: The $ne's @replace@1167. + * __@search@1170: + * type: object + * description: The $ne's @search@1170. + * __@split@1172: + * type: object + * description: The $ne's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $ne's @matchall@1174. + * $in: + * type: array + * description: The created at's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $in's exec. + * test: + * type: object + * description: The $in's test. + * source: + * type: string + * title: source + * description: The $in's source. + * global: + * type: boolean + * title: global + * description: The $in's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $in's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $in's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $in's lastindex. + * compile: + * type: object + * description: The $in's compile. + * flags: + * type: string + * title: flags + * description: The $in's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $in's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $in's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $in's dotall. + * __@match@1165: + * type: object + * description: The $in's @match@1165. + * __@replace@1167: + * type: object + * description: The $in's @replace@1167. + * __@search@1170: + * type: object + * description: The $in's @search@1170. + * __@split@1172: + * type: object + * description: The $in's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $in's @matchall@1174. + * $nin: + * type: array + * description: The created at's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $nin's exec. + * test: + * type: object + * description: The $nin's test. + * source: + * type: string + * title: source + * description: The $nin's source. + * global: + * type: boolean + * title: global + * description: The $nin's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $nin's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $nin's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $nin's lastindex. + * compile: + * type: object + * description: The $nin's compile. + * flags: + * type: string + * title: flags + * description: The $nin's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $nin's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $nin's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $nin's dotall. + * __@match@1165: + * type: object + * description: The $nin's @match@1165. + * __@replace@1167: + * type: object + * description: The $nin's @replace@1167. + * __@search@1170: + * type: object + * description: The $nin's @search@1170. + * __@split@1172: + * type: object + * description: The $nin's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $nin's @matchall@1174. + * $not: + * oneOf: + * - type: string + * title: $not + * description: The created at's $not. + * - type: object + * description: The created at's $not. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $not's exec. + * test: + * type: object + * description: The $not's test. + * source: + * type: string + * title: source + * description: The $not's source. + * global: + * type: boolean + * title: global + * description: The $not's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $not's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $not's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $not's lastindex. + * compile: + * type: object + * description: The $not's compile. + * flags: + * type: string + * title: flags + * description: The $not's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $not's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $not's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $not's dotall. + * __@match@1165: + * type: object + * description: The $not's @match@1165. + * __@replace@1167: + * type: object + * description: The $not's @replace@1167. + * __@search@1170: + * type: object + * description: The $not's @search@1170. + * __@split@1172: + * type: object + * description: The $not's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $not's @matchall@1174. + * - type: object + * description: The created at's $not. + * properties: + * $and: + * type: array + * description: The $not's $and. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $not's $or. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $not's $eq. + * - type: object + * description: The $not's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $not's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $not's $ne. + * - type: object + * description: The $not's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $not's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $not's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * - type: object + * description: The $not's details. + * - type: array + * description: The $not's details. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $not's $gt. + * - type: object + * description: The $not's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $not's $gte. + * - type: object + * description: The $not's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $not's $lt. + * - type: object + * description: The $not's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $not's $lte. + * - type: object + * description: The $not's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $not's $like. + * $re: + * type: string + * title: $re + * description: The $not's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $not's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $not's $fulltext. + * $overlap: + * type: array + * description: The $not's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $not's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $not's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $not's $exists. + * - type: array + * description: The created at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $not's exec. + * test: + * type: object + * description: The $not's test. + * source: + * type: string + * title: source + * description: The $not's source. + * global: + * type: boolean + * title: global + * description: The $not's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $not's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $not's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $not's lastindex. + * compile: + * type: object + * description: The $not's compile. + * flags: + * type: string + * title: flags + * description: The $not's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $not's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $not's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $not's dotall. + * __@match@1165: + * type: object + * description: The $not's @match@1165. + * __@replace@1167: + * type: object + * description: The $not's @replace@1167. + * __@search@1170: + * type: object + * description: The $not's @search@1170. + * __@split@1172: + * type: object + * description: The $not's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $not's @matchall@1174. + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The created at's $gt. + * - type: object + * description: The created at's $gt. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $gt's exec. + * test: + * type: object + * description: The $gt's test. + * source: + * type: string + * title: source + * description: The $gt's source. + * global: + * type: boolean + * title: global + * description: The $gt's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $gt's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $gt's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $gt's lastindex. + * compile: + * type: object + * description: The $gt's compile. + * flags: + * type: string + * title: flags + * description: The $gt's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $gt's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $gt's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $gt's dotall. + * __@match@1165: + * type: object + * description: The $gt's @match@1165. + * __@replace@1167: + * type: object + * description: The $gt's @replace@1167. + * __@search@1170: + * type: object + * description: The $gt's @search@1170. + * __@split@1172: + * type: object + * description: The $gt's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $gt's @matchall@1174. + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The created at's $gte. + * - type: object + * description: The created at's $gte. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $gte's exec. + * test: + * type: object + * description: The $gte's test. + * source: + * type: string + * title: source + * description: The $gte's source. + * global: + * type: boolean + * title: global + * description: The $gte's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $gte's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $gte's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $gte's lastindex. + * compile: + * type: object + * description: The $gte's compile. + * flags: + * type: string + * title: flags + * description: The $gte's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $gte's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $gte's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $gte's dotall. + * __@match@1165: + * type: object + * description: The $gte's @match@1165. + * __@replace@1167: + * type: object + * description: The $gte's @replace@1167. + * __@search@1170: + * type: object + * description: The $gte's @search@1170. + * __@split@1172: + * type: object + * description: The $gte's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $gte's @matchall@1174. + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The created at's $lt. + * - type: object + * description: The created at's $lt. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $lt's exec. + * test: + * type: object + * description: The $lt's test. + * source: + * type: string + * title: source + * description: The $lt's source. + * global: + * type: boolean + * title: global + * description: The $lt's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $lt's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $lt's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $lt's lastindex. + * compile: + * type: object + * description: The $lt's compile. + * flags: + * type: string + * title: flags + * description: The $lt's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $lt's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $lt's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $lt's dotall. + * __@match@1165: + * type: object + * description: The $lt's @match@1165. + * __@replace@1167: + * type: object + * description: The $lt's @replace@1167. + * __@search@1170: + * type: object + * description: The $lt's @search@1170. + * __@split@1172: + * type: object + * description: The $lt's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $lt's @matchall@1174. + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The created at's $lte. + * - type: object + * description: The created at's $lte. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $lte's exec. + * test: + * type: object + * description: The $lte's test. + * source: + * type: string + * title: source + * description: The $lte's source. + * global: + * type: boolean + * title: global + * description: The $lte's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $lte's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $lte's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $lte's lastindex. + * compile: + * type: object + * description: The $lte's compile. + * flags: + * type: string + * title: flags + * description: The $lte's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $lte's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $lte's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $lte's dotall. + * __@match@1165: + * type: object + * description: The $lte's @match@1165. + * __@replace@1167: + * type: object + * description: The $lte's @replace@1167. + * __@search@1170: + * type: object + * description: The $lte's @search@1170. + * __@split@1172: + * type: object + * description: The $lte's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $lte's @matchall@1174. + * $like: + * type: string + * title: $like + * description: The created at's $like. + * $re: + * type: string + * title: $re + * description: The created at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The created at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The created at's $fulltext. + * $overlap: + * type: array + * description: The created at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The created at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The created at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The created at's $exists. * - name: updated_at * in: query * description: The product's updated at. * required: false * schema: - * type: string + * type: object * description: The product's updated at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: updated_at + * $and: + * type: array + * description: The updated at's $and. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $and's exec. + * test: + * type: object + * description: The $and's test. + * source: + * type: string + * title: source + * description: The $and's source. + * global: + * type: boolean + * title: global + * description: The $and's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $and's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $and's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $and's lastindex. + * compile: + * type: object + * description: The $and's compile. + * flags: + * type: string + * title: flags + * description: The $and's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $and's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $and's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $and's dotall. + * __@match@1165: + * type: object + * description: The $and's @match@1165. + * __@replace@1167: + * type: object + * description: The $and's @replace@1167. + * __@search@1170: + * type: object + * description: The $and's @search@1170. + * __@split@1172: + * type: object + * description: The $and's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $and's @matchall@1174. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $and's $eq. + * - type: object + * description: The $and's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $and's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $and's $ne. + * - type: object + * description: The $and's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $and's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $and's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $and's $not. + * - type: object + * description: The $and's $not. + * x-schemaName: RegExp + * - type: object + * description: The $and's $not. + * - type: array + * description: The $and's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $and's $gt. + * - type: object + * description: The $and's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $and's $gte. + * - type: object + * description: The $and's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $and's $lt. + * - type: object + * description: The $and's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $and's $lte. + * - type: object + * description: The $and's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $and's $like. + * $re: + * type: string + * title: $re + * description: The $and's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $and's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $and's $fulltext. + * $overlap: + * type: array + * description: The $and's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $and's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $and's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $and's $exists. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $and's exec. + * test: + * type: object + * description: The $and's test. + * source: + * type: string + * title: source + * description: The $and's source. + * global: + * type: boolean + * title: global + * description: The $and's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $and's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $and's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $and's lastindex. + * compile: + * type: object + * description: The $and's compile. + * flags: + * type: string + * title: flags + * description: The $and's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $and's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $and's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $and's dotall. + * __@match@1165: + * type: object + * description: The $and's @match@1165. + * __@replace@1167: + * type: object + * description: The $and's @replace@1167. + * __@search@1170: + * type: object + * description: The $and's @search@1170. + * __@split@1172: + * type: object + * description: The $and's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $and's @matchall@1174. + * $or: + * type: array + * description: The updated at's $or. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $or's exec. + * test: + * type: object + * description: The $or's test. + * source: + * type: string + * title: source + * description: The $or's source. + * global: + * type: boolean + * title: global + * description: The $or's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $or's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $or's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $or's lastindex. + * compile: + * type: object + * description: The $or's compile. + * flags: + * type: string + * title: flags + * description: The $or's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $or's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $or's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $or's dotall. + * __@match@1165: + * type: object + * description: The $or's @match@1165. + * __@replace@1167: + * type: object + * description: The $or's @replace@1167. + * __@search@1170: + * type: object + * description: The $or's @search@1170. + * __@split@1172: + * type: object + * description: The $or's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $or's @matchall@1174. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $or's $eq. + * - type: object + * description: The $or's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $or's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $or's $ne. + * - type: object + * description: The $or's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $or's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $or's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $or's $not. + * - type: object + * description: The $or's $not. + * x-schemaName: RegExp + * - type: object + * description: The $or's $not. + * - type: array + * description: The $or's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $or's $gt. + * - type: object + * description: The $or's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $or's $gte. + * - type: object + * description: The $or's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $or's $lt. + * - type: object + * description: The $or's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $or's $lte. + * - type: object + * description: The $or's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $or's $like. + * $re: + * type: string + * title: $re + * description: The $or's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $or's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $or's $fulltext. + * $overlap: + * type: array + * description: The $or's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $or's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $or's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $or's $exists. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $or's exec. + * test: + * type: object + * description: The $or's test. + * source: + * type: string + * title: source + * description: The $or's source. + * global: + * type: boolean + * title: global + * description: The $or's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $or's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $or's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $or's lastindex. + * compile: + * type: object + * description: The $or's compile. + * flags: + * type: string + * title: flags + * description: The $or's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $or's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $or's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $or's dotall. + * __@match@1165: + * type: object + * description: The $or's @match@1165. + * __@replace@1167: + * type: object + * description: The $or's @replace@1167. + * __@search@1170: + * type: object + * description: The $or's @search@1170. + * __@split@1172: + * type: object + * description: The $or's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $or's @matchall@1174. + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The updated at's $eq. + * - type: object + * description: The updated at's $eq. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * test: + * type: object + * description: The $eq's test. + * source: + * type: string + * title: source + * description: The $eq's source. + * global: + * type: boolean + * title: global + * description: The $eq's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $eq's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $eq's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $eq's lastindex. + * compile: + * type: object + * description: The $eq's compile. + * flags: + * type: string + * title: flags + * description: The $eq's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $eq's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $eq's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $eq's dotall. + * __@match@1165: + * type: object + * description: The $eq's @match@1165. + * __@replace@1167: + * type: object + * description: The $eq's @replace@1167. + * __@search@1170: + * type: object + * description: The $eq's @search@1170. + * __@split@1172: + * type: object + * description: The $eq's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $eq's @matchall@1174. + * - type: array + * description: The updated at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * test: + * type: object + * description: The $eq's test. + * source: + * type: string + * title: source + * description: The $eq's source. + * global: + * type: boolean + * title: global + * description: The $eq's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $eq's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $eq's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $eq's lastindex. + * compile: + * type: object + * description: The $eq's compile. + * flags: + * type: string + * title: flags + * description: The $eq's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $eq's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $eq's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $eq's dotall. + * __@match@1165: + * type: object + * description: The $eq's @match@1165. + * __@replace@1167: + * type: object + * description: The $eq's @replace@1167. + * __@search@1170: + * type: object + * description: The $eq's @search@1170. + * __@split@1172: + * type: object + * description: The $eq's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $eq's @matchall@1174. + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The updated at's $ne. + * - type: object + * description: The updated at's $ne. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $ne's exec. + * test: + * type: object + * description: The $ne's test. + * source: + * type: string + * title: source + * description: The $ne's source. + * global: + * type: boolean + * title: global + * description: The $ne's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $ne's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $ne's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $ne's lastindex. + * compile: + * type: object + * description: The $ne's compile. + * flags: + * type: string + * title: flags + * description: The $ne's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $ne's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $ne's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $ne's dotall. + * __@match@1165: + * type: object + * description: The $ne's @match@1165. + * __@replace@1167: + * type: object + * description: The $ne's @replace@1167. + * __@search@1170: + * type: object + * description: The $ne's @search@1170. + * __@split@1172: + * type: object + * description: The $ne's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $ne's @matchall@1174. + * $in: + * type: array + * description: The updated at's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $in's exec. + * test: + * type: object + * description: The $in's test. + * source: + * type: string + * title: source + * description: The $in's source. + * global: + * type: boolean + * title: global + * description: The $in's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $in's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $in's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $in's lastindex. + * compile: + * type: object + * description: The $in's compile. + * flags: + * type: string + * title: flags + * description: The $in's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $in's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $in's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $in's dotall. + * __@match@1165: + * type: object + * description: The $in's @match@1165. + * __@replace@1167: + * type: object + * description: The $in's @replace@1167. + * __@search@1170: + * type: object + * description: The $in's @search@1170. + * __@split@1172: + * type: object + * description: The $in's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $in's @matchall@1174. + * $nin: + * type: array + * description: The updated at's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $nin's exec. + * test: + * type: object + * description: The $nin's test. + * source: + * type: string + * title: source + * description: The $nin's source. + * global: + * type: boolean + * title: global + * description: The $nin's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $nin's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $nin's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $nin's lastindex. + * compile: + * type: object + * description: The $nin's compile. + * flags: + * type: string + * title: flags + * description: The $nin's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $nin's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $nin's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $nin's dotall. + * __@match@1165: + * type: object + * description: The $nin's @match@1165. + * __@replace@1167: + * type: object + * description: The $nin's @replace@1167. + * __@search@1170: + * type: object + * description: The $nin's @search@1170. + * __@split@1172: + * type: object + * description: The $nin's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $nin's @matchall@1174. + * $not: + * oneOf: + * - type: string + * title: $not + * description: The updated at's $not. + * - type: object + * description: The updated at's $not. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $not's exec. + * test: + * type: object + * description: The $not's test. + * source: + * type: string + * title: source + * description: The $not's source. + * global: + * type: boolean + * title: global + * description: The $not's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $not's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $not's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $not's lastindex. + * compile: + * type: object + * description: The $not's compile. + * flags: + * type: string + * title: flags + * description: The $not's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $not's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $not's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $not's dotall. + * __@match@1165: + * type: object + * description: The $not's @match@1165. + * __@replace@1167: + * type: object + * description: The $not's @replace@1167. + * __@search@1170: + * type: object + * description: The $not's @search@1170. + * __@split@1172: + * type: object + * description: The $not's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $not's @matchall@1174. + * - type: object + * description: The updated at's $not. + * properties: + * $and: + * type: array + * description: The $not's $and. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $not's $or. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $not's $eq. + * - type: object + * description: The $not's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $not's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $not's $ne. + * - type: object + * description: The $not's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $not's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $not's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * - type: object + * description: The $not's details. + * - type: array + * description: The $not's details. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $not's $gt. + * - type: object + * description: The $not's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $not's $gte. + * - type: object + * description: The $not's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $not's $lt. + * - type: object + * description: The $not's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $not's $lte. + * - type: object + * description: The $not's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $not's $like. + * $re: + * type: string + * title: $re + * description: The $not's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $not's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $not's $fulltext. + * $overlap: + * type: array + * description: The $not's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $not's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $not's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $not's $exists. + * - type: array + * description: The updated at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $not's exec. + * test: + * type: object + * description: The $not's test. + * source: + * type: string + * title: source + * description: The $not's source. + * global: + * type: boolean + * title: global + * description: The $not's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $not's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $not's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $not's lastindex. + * compile: + * type: object + * description: The $not's compile. + * flags: + * type: string + * title: flags + * description: The $not's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $not's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $not's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $not's dotall. + * __@match@1165: + * type: object + * description: The $not's @match@1165. + * __@replace@1167: + * type: object + * description: The $not's @replace@1167. + * __@search@1170: + * type: object + * description: The $not's @search@1170. + * __@split@1172: + * type: object + * description: The $not's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $not's @matchall@1174. + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The updated at's $gt. + * - type: object + * description: The updated at's $gt. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $gt's exec. + * test: + * type: object + * description: The $gt's test. + * source: + * type: string + * title: source + * description: The $gt's source. + * global: + * type: boolean + * title: global + * description: The $gt's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $gt's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $gt's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $gt's lastindex. + * compile: + * type: object + * description: The $gt's compile. + * flags: + * type: string + * title: flags + * description: The $gt's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $gt's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $gt's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $gt's dotall. + * __@match@1165: + * type: object + * description: The $gt's @match@1165. + * __@replace@1167: + * type: object + * description: The $gt's @replace@1167. + * __@search@1170: + * type: object + * description: The $gt's @search@1170. + * __@split@1172: + * type: object + * description: The $gt's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $gt's @matchall@1174. + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The updated at's $gte. + * - type: object + * description: The updated at's $gte. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $gte's exec. + * test: + * type: object + * description: The $gte's test. + * source: + * type: string + * title: source + * description: The $gte's source. + * global: + * type: boolean + * title: global + * description: The $gte's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $gte's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $gte's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $gte's lastindex. + * compile: + * type: object + * description: The $gte's compile. + * flags: + * type: string + * title: flags + * description: The $gte's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $gte's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $gte's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $gte's dotall. + * __@match@1165: + * type: object + * description: The $gte's @match@1165. + * __@replace@1167: + * type: object + * description: The $gte's @replace@1167. + * __@search@1170: + * type: object + * description: The $gte's @search@1170. + * __@split@1172: + * type: object + * description: The $gte's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $gte's @matchall@1174. + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The updated at's $lt. + * - type: object + * description: The updated at's $lt. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $lt's exec. + * test: + * type: object + * description: The $lt's test. + * source: + * type: string + * title: source + * description: The $lt's source. + * global: + * type: boolean + * title: global + * description: The $lt's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $lt's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $lt's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $lt's lastindex. + * compile: + * type: object + * description: The $lt's compile. + * flags: + * type: string + * title: flags + * description: The $lt's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $lt's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $lt's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $lt's dotall. + * __@match@1165: + * type: object + * description: The $lt's @match@1165. + * __@replace@1167: + * type: object + * description: The $lt's @replace@1167. + * __@search@1170: + * type: object + * description: The $lt's @search@1170. + * __@split@1172: + * type: object + * description: The $lt's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $lt's @matchall@1174. + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The updated at's $lte. + * - type: object + * description: The updated at's $lte. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $lte's exec. + * test: + * type: object + * description: The $lte's test. + * source: + * type: string + * title: source + * description: The $lte's source. + * global: + * type: boolean + * title: global + * description: The $lte's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $lte's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $lte's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $lte's lastindex. + * compile: + * type: object + * description: The $lte's compile. + * flags: + * type: string + * title: flags + * description: The $lte's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $lte's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $lte's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $lte's dotall. + * __@match@1165: + * type: object + * description: The $lte's @match@1165. + * __@replace@1167: + * type: object + * description: The $lte's @replace@1167. + * __@search@1170: + * type: object + * description: The $lte's @search@1170. + * __@split@1172: + * type: object + * description: The $lte's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $lte's @matchall@1174. + * $like: + * type: string + * title: $like + * description: The updated at's $like. + * $re: + * type: string + * title: $re + * description: The updated at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The updated at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The updated at's $fulltext. + * $overlap: + * type: array + * description: The updated at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The updated at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The updated at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The updated at's $exists. * - name: deleted_at * in: query * description: The product's deleted at. * required: false * schema: - * type: string + * type: object * description: The product's deleted at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: deleted_at - * - name: country_code + * $and: + * type: array + * description: The deleted at's $and. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $and's exec. + * test: + * type: object + * description: The $and's test. + * source: + * type: string + * title: source + * description: The $and's source. + * global: + * type: boolean + * title: global + * description: The $and's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $and's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $and's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $and's lastindex. + * compile: + * type: object + * description: The $and's compile. + * flags: + * type: string + * title: flags + * description: The $and's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $and's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $and's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $and's dotall. + * __@match@1165: + * type: object + * description: The $and's @match@1165. + * __@replace@1167: + * type: object + * description: The $and's @replace@1167. + * __@search@1170: + * type: object + * description: The $and's @search@1170. + * __@split@1172: + * type: object + * description: The $and's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $and's @matchall@1174. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $and's $eq. + * - type: object + * description: The $and's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $and's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $and's $ne. + * - type: object + * description: The $and's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $and's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $and's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $and's $not. + * - type: object + * description: The $and's $not. + * x-schemaName: RegExp + * - type: object + * description: The $and's $not. + * - type: array + * description: The $and's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $and's $gt. + * - type: object + * description: The $and's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $and's $gte. + * - type: object + * description: The $and's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $and's $lt. + * - type: object + * description: The $and's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $and's $lte. + * - type: object + * description: The $and's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $and's $like. + * $re: + * type: string + * title: $re + * description: The $and's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $and's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $and's $fulltext. + * $overlap: + * type: array + * description: The $and's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $and's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $and's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $and's $exists. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $and's exec. + * test: + * type: object + * description: The $and's test. + * source: + * type: string + * title: source + * description: The $and's source. + * global: + * type: boolean + * title: global + * description: The $and's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $and's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $and's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $and's lastindex. + * compile: + * type: object + * description: The $and's compile. + * flags: + * type: string + * title: flags + * description: The $and's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $and's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $and's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $and's dotall. + * __@match@1165: + * type: object + * description: The $and's @match@1165. + * __@replace@1167: + * type: object + * description: The $and's @replace@1167. + * __@search@1170: + * type: object + * description: The $and's @search@1170. + * __@split@1172: + * type: object + * description: The $and's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $and's @matchall@1174. + * $or: + * type: array + * description: The deleted at's $or. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $or's exec. + * test: + * type: object + * description: The $or's test. + * source: + * type: string + * title: source + * description: The $or's source. + * global: + * type: boolean + * title: global + * description: The $or's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $or's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $or's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $or's lastindex. + * compile: + * type: object + * description: The $or's compile. + * flags: + * type: string + * title: flags + * description: The $or's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $or's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $or's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $or's dotall. + * __@match@1165: + * type: object + * description: The $or's @match@1165. + * __@replace@1167: + * type: object + * description: The $or's @replace@1167. + * __@search@1170: + * type: object + * description: The $or's @search@1170. + * __@split@1172: + * type: object + * description: The $or's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $or's @matchall@1174. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $or's $eq. + * - type: object + * description: The $or's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $or's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $or's $ne. + * - type: object + * description: The $or's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $or's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $or's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $or's $not. + * - type: object + * description: The $or's $not. + * x-schemaName: RegExp + * - type: object + * description: The $or's $not. + * - type: array + * description: The $or's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $or's $gt. + * - type: object + * description: The $or's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $or's $gte. + * - type: object + * description: The $or's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $or's $lt. + * - type: object + * description: The $or's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $or's $lte. + * - type: object + * description: The $or's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $or's $like. + * $re: + * type: string + * title: $re + * description: The $or's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $or's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $or's $fulltext. + * $overlap: + * type: array + * description: The $or's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $or's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $or's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $or's $exists. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $or's exec. + * test: + * type: object + * description: The $or's test. + * source: + * type: string + * title: source + * description: The $or's source. + * global: + * type: boolean + * title: global + * description: The $or's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $or's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $or's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $or's lastindex. + * compile: + * type: object + * description: The $or's compile. + * flags: + * type: string + * title: flags + * description: The $or's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $or's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $or's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $or's dotall. + * __@match@1165: + * type: object + * description: The $or's @match@1165. + * __@replace@1167: + * type: object + * description: The $or's @replace@1167. + * __@search@1170: + * type: object + * description: The $or's @search@1170. + * __@split@1172: + * type: object + * description: The $or's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $or's @matchall@1174. + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The deleted at's $eq. + * - type: object + * description: The deleted at's $eq. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * test: + * type: object + * description: The $eq's test. + * source: + * type: string + * title: source + * description: The $eq's source. + * global: + * type: boolean + * title: global + * description: The $eq's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $eq's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $eq's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $eq's lastindex. + * compile: + * type: object + * description: The $eq's compile. + * flags: + * type: string + * title: flags + * description: The $eq's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $eq's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $eq's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $eq's dotall. + * __@match@1165: + * type: object + * description: The $eq's @match@1165. + * __@replace@1167: + * type: object + * description: The $eq's @replace@1167. + * __@search@1170: + * type: object + * description: The $eq's @search@1170. + * __@split@1172: + * type: object + * description: The $eq's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $eq's @matchall@1174. + * - type: array + * description: The deleted at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * test: + * type: object + * description: The $eq's test. + * source: + * type: string + * title: source + * description: The $eq's source. + * global: + * type: boolean + * title: global + * description: The $eq's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $eq's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $eq's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $eq's lastindex. + * compile: + * type: object + * description: The $eq's compile. + * flags: + * type: string + * title: flags + * description: The $eq's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $eq's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $eq's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $eq's dotall. + * __@match@1165: + * type: object + * description: The $eq's @match@1165. + * __@replace@1167: + * type: object + * description: The $eq's @replace@1167. + * __@search@1170: + * type: object + * description: The $eq's @search@1170. + * __@split@1172: + * type: object + * description: The $eq's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $eq's @matchall@1174. + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The deleted at's $ne. + * - type: object + * description: The deleted at's $ne. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $ne's exec. + * test: + * type: object + * description: The $ne's test. + * source: + * type: string + * title: source + * description: The $ne's source. + * global: + * type: boolean + * title: global + * description: The $ne's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $ne's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $ne's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $ne's lastindex. + * compile: + * type: object + * description: The $ne's compile. + * flags: + * type: string + * title: flags + * description: The $ne's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $ne's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $ne's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $ne's dotall. + * __@match@1165: + * type: object + * description: The $ne's @match@1165. + * __@replace@1167: + * type: object + * description: The $ne's @replace@1167. + * __@search@1170: + * type: object + * description: The $ne's @search@1170. + * __@split@1172: + * type: object + * description: The $ne's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $ne's @matchall@1174. + * $in: + * type: array + * description: The deleted at's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $in's exec. + * test: + * type: object + * description: The $in's test. + * source: + * type: string + * title: source + * description: The $in's source. + * global: + * type: boolean + * title: global + * description: The $in's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $in's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $in's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $in's lastindex. + * compile: + * type: object + * description: The $in's compile. + * flags: + * type: string + * title: flags + * description: The $in's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $in's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $in's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $in's dotall. + * __@match@1165: + * type: object + * description: The $in's @match@1165. + * __@replace@1167: + * type: object + * description: The $in's @replace@1167. + * __@search@1170: + * type: object + * description: The $in's @search@1170. + * __@split@1172: + * type: object + * description: The $in's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $in's @matchall@1174. + * $nin: + * type: array + * description: The deleted at's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $nin's exec. + * test: + * type: object + * description: The $nin's test. + * source: + * type: string + * title: source + * description: The $nin's source. + * global: + * type: boolean + * title: global + * description: The $nin's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $nin's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $nin's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $nin's lastindex. + * compile: + * type: object + * description: The $nin's compile. + * flags: + * type: string + * title: flags + * description: The $nin's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $nin's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $nin's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $nin's dotall. + * __@match@1165: + * type: object + * description: The $nin's @match@1165. + * __@replace@1167: + * type: object + * description: The $nin's @replace@1167. + * __@search@1170: + * type: object + * description: The $nin's @search@1170. + * __@split@1172: + * type: object + * description: The $nin's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $nin's @matchall@1174. + * $not: + * oneOf: + * - type: string + * title: $not + * description: The deleted at's $not. + * - type: object + * description: The deleted at's $not. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $not's exec. + * test: + * type: object + * description: The $not's test. + * source: + * type: string + * title: source + * description: The $not's source. + * global: + * type: boolean + * title: global + * description: The $not's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $not's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $not's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $not's lastindex. + * compile: + * type: object + * description: The $not's compile. + * flags: + * type: string + * title: flags + * description: The $not's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $not's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $not's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $not's dotall. + * __@match@1165: + * type: object + * description: The $not's @match@1165. + * __@replace@1167: + * type: object + * description: The $not's @replace@1167. + * __@search@1170: + * type: object + * description: The $not's @search@1170. + * __@split@1172: + * type: object + * description: The $not's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $not's @matchall@1174. + * - type: object + * description: The deleted at's $not. + * properties: + * $and: + * type: array + * description: The $not's $and. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $not's $or. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $not's $eq. + * - type: object + * description: The $not's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $not's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $not's $ne. + * - type: object + * description: The $not's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $not's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $not's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * - type: object + * description: The $not's details. + * - type: array + * description: The $not's details. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $not's $gt. + * - type: object + * description: The $not's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $not's $gte. + * - type: object + * description: The $not's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $not's $lt. + * - type: object + * description: The $not's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $not's $lte. + * - type: object + * description: The $not's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $not's $like. + * $re: + * type: string + * title: $re + * description: The $not's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $not's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $not's $fulltext. + * $overlap: + * type: array + * description: The $not's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $not's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $not's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $not's $exists. + * - type: array + * description: The deleted at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $not's exec. + * test: + * type: object + * description: The $not's test. + * source: + * type: string + * title: source + * description: The $not's source. + * global: + * type: boolean + * title: global + * description: The $not's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $not's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $not's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $not's lastindex. + * compile: + * type: object + * description: The $not's compile. + * flags: + * type: string + * title: flags + * description: The $not's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $not's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $not's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $not's dotall. + * __@match@1165: + * type: object + * description: The $not's @match@1165. + * __@replace@1167: + * type: object + * description: The $not's @replace@1167. + * __@search@1170: + * type: object + * description: The $not's @search@1170. + * __@split@1172: + * type: object + * description: The $not's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $not's @matchall@1174. + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The deleted at's $gt. + * - type: object + * description: The deleted at's $gt. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $gt's exec. + * test: + * type: object + * description: The $gt's test. + * source: + * type: string + * title: source + * description: The $gt's source. + * global: + * type: boolean + * title: global + * description: The $gt's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $gt's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $gt's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $gt's lastindex. + * compile: + * type: object + * description: The $gt's compile. + * flags: + * type: string + * title: flags + * description: The $gt's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $gt's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $gt's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $gt's dotall. + * __@match@1165: + * type: object + * description: The $gt's @match@1165. + * __@replace@1167: + * type: object + * description: The $gt's @replace@1167. + * __@search@1170: + * type: object + * description: The $gt's @search@1170. + * __@split@1172: + * type: object + * description: The $gt's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $gt's @matchall@1174. + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The deleted at's $gte. + * - type: object + * description: The deleted at's $gte. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $gte's exec. + * test: + * type: object + * description: The $gte's test. + * source: + * type: string + * title: source + * description: The $gte's source. + * global: + * type: boolean + * title: global + * description: The $gte's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $gte's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $gte's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $gte's lastindex. + * compile: + * type: object + * description: The $gte's compile. + * flags: + * type: string + * title: flags + * description: The $gte's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $gte's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $gte's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $gte's dotall. + * __@match@1165: + * type: object + * description: The $gte's @match@1165. + * __@replace@1167: + * type: object + * description: The $gte's @replace@1167. + * __@search@1170: + * type: object + * description: The $gte's @search@1170. + * __@split@1172: + * type: object + * description: The $gte's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $gte's @matchall@1174. + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The deleted at's $lt. + * - type: object + * description: The deleted at's $lt. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $lt's exec. + * test: + * type: object + * description: The $lt's test. + * source: + * type: string + * title: source + * description: The $lt's source. + * global: + * type: boolean + * title: global + * description: The $lt's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $lt's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $lt's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $lt's lastindex. + * compile: + * type: object + * description: The $lt's compile. + * flags: + * type: string + * title: flags + * description: The $lt's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $lt's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $lt's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $lt's dotall. + * __@match@1165: + * type: object + * description: The $lt's @match@1165. + * __@replace@1167: + * type: object + * description: The $lt's @replace@1167. + * __@search@1170: + * type: object + * description: The $lt's @search@1170. + * __@split@1172: + * type: object + * description: The $lt's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $lt's @matchall@1174. + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The deleted at's $lte. + * - type: object + * description: The deleted at's $lte. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1165 + * - __@replace@1167 + * - __@search@1170 + * - __@matchAll@1174 + * properties: + * exec: + * type: object + * description: The $lte's exec. + * test: + * type: object + * description: The $lte's test. + * source: + * type: string + * title: source + * description: The $lte's source. + * global: + * type: boolean + * title: global + * description: The $lte's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $lte's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $lte's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $lte's lastindex. + * compile: + * type: object + * description: The $lte's compile. + * flags: + * type: string + * title: flags + * description: The $lte's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $lte's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $lte's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $lte's dotall. + * __@match@1165: + * type: object + * description: The $lte's @match@1165. + * __@replace@1167: + * type: object + * description: The $lte's @replace@1167. + * __@search@1170: + * type: object + * description: The $lte's @search@1170. + * __@split@1172: + * type: object + * description: The $lte's @split@1172. + * __@matchAll@1174: + * type: object + * description: The $lte's @matchall@1174. + * $like: + * type: string + * title: $like + * description: The deleted at's $like. + * $re: + * type: string + * title: $re + * description: The deleted at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The deleted at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The deleted at's $fulltext. + * $overlap: + * type: array + * description: The deleted at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The deleted at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The deleted at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The deleted at's $exists. + * - name: status * in: query - * description: The product's country code. * required: false * schema: - * type: string - * title: country_code - * description: The product's country code. - * - name: province + * oneOf: + * - type: string + * title: status + * description: The product's status. + * - type: string + * title: status + * description: The product's status. + * - type: string + * title: status + * description: The product's status. + * - type: string + * title: status + * description: The product's status. + * - type: array + * description: The product's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * - name: categories * in: query - * description: The product's province. * required: false * schema: - * type: string - * title: province - * description: The product's province. - * - name: cart_id - * in: query - * description: The product's cart id. - * required: false - * schema: - * type: string - * title: cart_id - * description: The product's cart id. + * oneOf: + * - type: object + * description: The product's categories. + * required: + * - id + * properties: + * id: + * type: object + * description: The category's ID. + * properties: + * $and: + * type: array + * description: The id's $and. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: array + * description: The $and's details. + * items: *a1 + * title: $and + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The id's $or. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: array + * description: The $or's details. + * items: *a2 + * title: $or + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The id's $eq. + * - type: object + * description: The id's $eq. + * x-schemaName: RegExp + * - type: array + * description: The id's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The id's $ne. + * - type: object + * description: The id's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The id's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The id's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The id's $not. + * - type: object + * description: The id's $not. + * x-schemaName: RegExp + * - type: object + * description: The id's $not. + * - type: array + * description: The id's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The id's $gt. + * - type: object + * description: The id's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The id's $gte. + * - type: object + * description: The id's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The id's $lt. + * - type: object + * description: The id's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The id's $lte. + * - type: object + * description: The id's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The id's $like. + * $re: + * type: string + * title: $re + * description: The id's $re. + * $ilike: + * type: string + * title: $ilike + * description: The id's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The id's $fulltext. + * $overlap: + * type: array + * description: The id's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The id's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The id's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The id's $exists. + * - type: object + * description: The product's categories. + * required: + * - id + * properties: + * id: + * type: object + * description: The category's ID. + * properties: + * $and: + * type: array + * description: The id's $and. + * items: + * type: array + * description: The $and's details. + * items: + * type: array + * description: The $and's details. + * items: *a1 + * title: $and + * $or: + * type: array + * description: The id's $or. + * items: + * type: array + * description: The $or's details. + * items: + * type: array + * description: The $or's details. + * items: *a2 + * title: $or + * $eq: + * oneOf: + * - type: array + * description: The id's $eq. + * items: + * type: string + * title: $eq + * description: The $eq's details. + * - type: array + * description: The id's $eq. + * items: + * type: array + * description: The $eq's details. + * items: + * type: string + * title: $eq + * description: The $eq's details. + * $ne: + * type: array + * description: The id's $ne. + * items: + * type: string + * title: $ne + * description: The $ne's details. + * $in: + * type: array + * description: The id's $in. + * items: + * type: array + * description: The $in's details. + * items: + * type: string + * title: $in + * description: The $in's details. + * $nin: + * type: array + * description: The id's $nin. + * items: + * type: array + * description: The $nin's details. + * items: + * type: string + * title: $nin + * description: The $nin's details. + * $not: + * type: array + * description: The id's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * $gt: + * type: array + * description: The id's $gt. + * items: + * type: string + * title: $gt + * description: The $gt's details. + * $gte: + * type: array + * description: The id's $gte. + * items: + * type: string + * title: $gte + * description: The $gte's details. + * $lt: + * type: array + * description: The id's $lt. + * items: + * type: string + * title: $lt + * description: The $lt's details. + * $lte: + * type: array + * description: The id's $lte. + * items: + * type: string + * title: $lte + * description: The $lte's details. + * $like: + * type: string + * title: $like + * description: The id's $like. + * $re: + * type: string + * title: $re + * description: The id's $re. + * $ilike: + * type: string + * title: $ilike + * description: The id's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The id's $fulltext. + * $overlap: + * type: array + * description: The id's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The id's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The id's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The id's $exists. * x-codeSamples: * - lang: Shell * label: cURL @@ -336,6 +6380,41 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The product's limit. + * offset: + * type: number + * title: offset + * description: The product's offset. + * count: + * type: number + * title: count + * description: The product's count. + * - type: object + * description: SUMMARY + * required: + * - products + * properties: + * products: + * type: array + * description: The product's products. + * items: + * $ref: "#/components/schemas/StoreProduct" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts index cbfd645e28..237f998fbd 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts @@ -101,6 +101,12 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreProductResponse" * "400": * $ref: "#/components/responses/400_error" * "401": 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 f4b603c943..09b66770a1 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 @@ -63,6 +63,41 @@ * tags: * - Regions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The region's limit. + * offset: + * type: number + * title: offset + * description: The region's offset. + * count: + * type: number + * title: count + * description: The region's count. + * - type: object + * description: SUMMARY + * required: + * - regions + * properties: + * regions: + * type: array + * description: The region's regions. + * items: + * $ref: "#/components/schemas/StoreRegion" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/get_store_regions_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_regions_[id].ts index 5fc7c65905..91a8b570f2 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_regions_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_regions_[id].ts @@ -69,6 +69,18 @@ * tags: * - Regions * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - region + * properties: + * region: + * $ref: "#/components/schemas/StoreRegion" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts b/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts index aecde7381d..1f378d401d 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts @@ -64,6 +64,41 @@ * tags: * - Return Reasons * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The return reason's limit. + * offset: + * type: number + * title: offset + * description: The return reason's offset. + * count: + * type: number + * title: count + * description: The return reason's count. + * - type: object + * description: SUMMARY + * required: + * - return_reasons + * properties: + * return_reasons: + * type: array + * description: The return reason's return reasons. + * items: + * $ref: "#/components/schemas/StoreReturnReason" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/get_store_return-reasons_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_return-reasons_[id].ts index 623ce8f06f..fe255aec11 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_return-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_return-reasons_[id].ts @@ -69,6 +69,12 @@ * tags: * - Return Reasons * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreReturnReasonResponse" * "400": * $ref: "#/components/responses/400_error" * "401": 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 6a0edd5db9..fac6680a69 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 @@ -64,6 +64,12 @@ * tags: * - Shipping Options * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreShippingOptionListResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,6 +82,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: listShippingOptionsForCartWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts.ts b/www/utils/generated/oas-output/operations/store/post_store_carts.ts index 9dc4360c9b..f53ca49f55 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts.ts @@ -59,7 +59,64 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/CreateCartWorkflowInput" + * description: SUMMARY + * properties: + * region_id: + * type: string + * title: region_id + * description: The cart's region id. + * customer_id: + * type: string + * title: customer_id + * description: The cart's customer id. + * sales_channel_id: + * type: string + * title: sales_channel_id + * description: The cart's sales channel id. + * email: + * type: string + * title: email + * description: The cart's email. + * format: email + * currency_code: + * type: string + * title: currency_code + * description: The cart's currency code. + * shipping_address_id: + * type: string + * title: shipping_address_id + * description: The cart's shipping address id. + * billing_address_id: + * type: string + * title: billing_address_id + * description: The cart's billing address id. + * shipping_address: + * oneOf: + * - type: string + * title: shipping_address + * description: The cart's shipping address. + * - $ref: "#/components/schemas/CreateCartAddress" + * billing_address: + * oneOf: + * - type: string + * title: billing_address + * description: The cart's billing address. + * - $ref: "#/components/schemas/CreateCartAddress" + * metadata: + * type: object + * description: The cart's metadata. + * items: + * type: array + * description: The cart's items. + * items: + * $ref: "#/components/schemas/CreateCartCreateLineItem" + * promo_codes: + * type: array + * description: The cart's promo codes. + * items: + * type: string + * title: promo_codes + * description: The promo code's promo codes. * x-codeSamples: * - lang: Shell * label: cURL @@ -67,6 +124,12 @@ * tags: * - Carts * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCartResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -79,6 +142,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createCartWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts index f2016e5a1f..d06deda5fa 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts @@ -65,7 +65,48 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/UpdateCartData" + * description: SUMMARY + * properties: + * region_id: + * type: string + * title: region_id + * description: The cart's region id. + * customer_id: + * type: string + * title: customer_id + * description: The cart's customer id. + * sales_channel_id: + * type: string + * title: sales_channel_id + * description: The cart's sales channel id. + * email: + * type: string + * title: email + * description: The cart's email. + * format: email + * currency_code: + * type: string + * title: currency_code + * description: The cart's currency code. + * shipping_address_id: + * type: string + * title: shipping_address_id + * description: The cart's shipping address id. + * billing_address_id: + * type: string + * title: billing_address_id + * description: The cart's billing address id. + * billing_address: + * oneOf: + * - $ref: "#/components/schemas/CreateAddress" + * - $ref: "#/components/schemas/UpdateAddress" + * shipping_address: + * oneOf: + * - $ref: "#/components/schemas/CreateAddress" + * - $ref: "#/components/schemas/UpdateAddress" + * metadata: + * type: object + * description: The cart's metadata. * x-codeSamples: * - lang: Shell * label: cURL @@ -73,6 +114,18 @@ * tags: * - Carts * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - cart + * properties: + * cart: + * $ref: "#/components/schemas/StoreCart" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts index 276c6427cd..adefa33fad 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts @@ -79,6 +79,57 @@ * tags: * - Carts * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * oneOf: + * - type: object + * description: SUMMARY + * required: + * - type + * - cart + * - error + * properties: + * type: + * type: string + * title: type + * description: The cart's type. + * cart: + * $ref: "#/components/schemas/StoreCart" + * error: + * type: object + * description: The cart's error. + * required: + * - message + * - name + * - type + * properties: + * message: + * type: string + * title: message + * description: The error's message. + * name: + * type: string + * title: name + * description: The error's name. + * type: + * type: string + * title: type + * description: The error's type. + * - type: object + * description: SUMMARY + * required: + * - type + * - order + * properties: + * type: + * type: string + * title: type + * description: The cart's type. + * order: + * $ref: "#/components/schemas/StoreOrder" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -91,6 +142,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: completeCartWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts index c6c92747f3..6099cb3af2 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts @@ -80,6 +80,12 @@ * tags: * - Carts * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCartResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts index 91f8b7b11d..26c86cb598 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts @@ -85,6 +85,12 @@ * tags: * - Carts * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCartResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts index 37f95172f8..3de4d50123 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts @@ -91,6 +91,12 @@ * tags: * - Carts * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCartResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts index bedb9e856c..1cefa74bf5 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts @@ -89,6 +89,12 @@ * tags: * - Carts * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCartResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts index d8216947ed..b3b1c4ef2b 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts @@ -73,6 +73,12 @@ * tags: * - Carts * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCartResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers.ts b/www/utils/generated/oas-output/operations/store/post_store_customers.ts index dfe254a5d5..c466cc9345 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers.ts @@ -76,6 +76,12 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCustomerResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts index 51bd4c4b4e..3ab4910cd4 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts @@ -79,6 +79,12 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCustomerResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts index b06ffadd75..c431a54e7b 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts @@ -157,6 +157,12 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCustomerResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts index 5071e5c04d..541eab73b9 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts @@ -163,6 +163,12 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCustomerResponse" * "400": * $ref: "#/components/responses/400_error" * "401": 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 5e35500aee..4f25a674a0 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 @@ -63,26 +63,11 @@ * description: SUMMARY * required: * - cart_id - * - region_id - * - currency_code - * - amount * properties: * cart_id: * type: string * title: cart_id * description: The payment collection's cart id. - * region_id: - * type: string - * title: region_id - * description: The payment collection's region id. - * currency_code: - * type: string - * title: currency_code - * description: The payment collection's currency code. - * amount: - * type: number - * title: amount - * description: The payment collection's amount. * x-codeSamples: * - lang: Shell * label: cURL @@ -98,6 +83,12 @@ * tags: * - Payment Collections * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StorePaymentCollectionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts b/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts index 887f01366a..71688a71e7 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts @@ -95,6 +95,12 @@ * tags: * - Payment Collections * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StorePaymentCollectionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": 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 9d44ae86b3..5f94446090 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 @@ -86,6 +86,12 @@ * tags: * - Return * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreReturnResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/schemas/AdminApiKeyResponse.ts b/www/utils/generated/oas-output/schemas/AdminApiKeyResponse.ts new file mode 100644 index 0000000000..7a4927d446 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminApiKeyResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminApiKeyResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminApiKeyResponse + * required: + * - api_key + * properties: + * api_key: + * $ref: "#/components/schemas/ApiKeyResponse" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCampaignResponse.ts b/www/utils/generated/oas-output/schemas/AdminCampaignResponse.ts new file mode 100644 index 0000000000..20e33d8fcb --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCampaignResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminCampaignResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminCampaignResponse + * required: + * - campaign + * properties: + * campaign: + * $ref: "#/components/schemas/CampaignResponse" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminClaim.ts b/www/utils/generated/oas-output/schemas/AdminClaim.ts new file mode 100644 index 0000000000..aedcc95f41 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminClaim.ts @@ -0,0 +1,255 @@ +/** + * @schema AdminClaim + * type: object + * description: The claim's details. + * x-schemaName: AdminClaim + * required: + * - order_id + * - claim_items + * - additional_items + * - currency_code + * - id + * - region_id + * - customer_id + * - sales_channel_id + * - email + * - shipping_methods + * - payment_status + * - fulfillment_status + * - summary + * - metadata + * - created_at + * - updated_at + * - original_item_total + * - original_item_subtotal + * - original_item_tax_total + * - item_total + * - item_subtotal + * - item_tax_total + * - original_total + * - original_subtotal + * - original_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - gift_card_total + * - gift_card_tax_total + * - shipping_total + * - shipping_subtotal + * - shipping_tax_total + * - original_shipping_total + * - original_shipping_subtotal + * - original_shipping_tax_total + * properties: + * order_id: + * type: string + * title: order_id + * description: The claim's order id. + * claim_items: + * type: array + * description: The claim's claim items. + * items: + * $ref: "#/components/schemas/BaseClaimItem" + * additional_items: + * type: array + * description: The claim's additional items. + * items: {} + * return: + * $ref: "#/components/schemas/Return" + * return_id: + * type: string + * title: return_id + * description: The claim's return id. + * no_notification: + * type: boolean + * title: no_notification + * description: The claim's no notification. + * refund_amount: + * type: number + * title: refund_amount + * description: The claim's refund amount. + * currency_code: + * type: string + * title: currency_code + * description: The claim's currency code. + * id: + * type: string + * title: id + * description: The claim's ID. + * region_id: + * type: string + * title: region_id + * description: The claim's region id. + * customer_id: + * type: string + * title: customer_id + * description: The claim's customer id. + * sales_channel_id: + * type: string + * title: sales_channel_id + * description: The claim's sales channel id. + * email: + * type: string + * title: email + * description: The claim's email. + * format: email + * display_id: + * type: string + * title: display_id + * description: The claim's display id. + * shipping_address: + * $ref: "#/components/schemas/BaseOrderAddress" + * billing_address: + * $ref: "#/components/schemas/BaseOrderAddress" + * shipping_methods: + * type: array + * description: The claim's shipping methods. + * items: + * $ref: "#/components/schemas/BaseOrderShippingMethod" + * payment_collections: + * type: array + * description: The claim's payment collections. + * items: + * $ref: "#/components/schemas/BasePaymentCollection" + * payment_status: + * type: string + * enum: + * - canceled + * - not_paid + * - awaiting + * - authorized + * - partially_authorized + * - captured + * - partially_captured + * - partially_refunded + * - refunded + * - requires_action + * fulfillments: + * type: array + * description: The claim's fulfillments. + * items: + * $ref: "#/components/schemas/BaseOrderFulfillment" + * fulfillment_status: + * type: string + * enum: + * - canceled + * - not_fulfilled + * - partially_fulfilled + * - fulfilled + * - partially_shipped + * - shipped + * - partially_delivered + * - delivered + * transactions: + * type: array + * description: The claim's transactions. + * items: + * $ref: "#/components/schemas/BaseOrderTransaction" + * summary: + * $ref: "#/components/schemas/BaseOrderSummary" + * metadata: + * type: object + * description: The claim's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The claim's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The claim's updated at. + * original_item_total: + * type: number + * title: original_item_total + * description: The claim's original item total. + * original_item_subtotal: + * type: number + * title: original_item_subtotal + * description: The claim's original item subtotal. + * original_item_tax_total: + * type: number + * title: original_item_tax_total + * description: The claim's original item tax total. + * item_total: + * type: number + * title: item_total + * description: The claim's item total. + * item_subtotal: + * type: number + * title: item_subtotal + * description: The claim's item subtotal. + * item_tax_total: + * type: number + * title: item_tax_total + * description: The claim's item tax total. + * original_total: + * type: number + * title: original_total + * description: The claim's original total. + * original_subtotal: + * type: number + * title: original_subtotal + * description: The claim's original subtotal. + * original_tax_total: + * type: number + * title: original_tax_total + * description: The claim's original tax total. + * total: + * type: number + * title: total + * description: The claim's total. + * subtotal: + * type: number + * title: subtotal + * description: The claim's subtotal. + * tax_total: + * type: number + * title: tax_total + * description: The claim's tax total. + * discount_total: + * type: number + * title: discount_total + * description: The claim's discount total. + * discount_tax_total: + * type: number + * title: discount_tax_total + * description: The claim's discount tax total. + * gift_card_total: + * type: number + * title: gift_card_total + * description: The claim's gift card total. + * gift_card_tax_total: + * type: number + * title: gift_card_tax_total + * description: The claim's gift card tax total. + * shipping_total: + * type: number + * title: shipping_total + * description: The claim's shipping total. + * shipping_subtotal: + * type: number + * title: shipping_subtotal + * description: The claim's shipping subtotal. + * shipping_tax_total: + * type: number + * title: shipping_tax_total + * description: The claim's shipping tax total. + * original_shipping_total: + * type: number + * title: original_shipping_total + * description: The claim's original shipping total. + * original_shipping_subtotal: + * type: number + * title: original_shipping_subtotal + * description: The claim's original shipping subtotal. + * original_shipping_tax_total: + * type: number + * title: original_shipping_tax_total + * description: The claim's original shipping tax total. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminClaimDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminClaimDeleteResponse.ts new file mode 100644 index 0000000000..da42c81d2c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminClaimDeleteResponse.ts @@ -0,0 +1,29 @@ +/** + * @schema AdminClaimDeleteResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminClaimDeleteResponse + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The claim's ID. + * object: + * type: string + * title: object + * description: The claim's object. + * default: claim + * deleted: + * type: boolean + * title: deleted + * description: The claim's deleted. + * parent: + * type: object + * description: The claim's parent. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminClaimListResponse.ts b/www/utils/generated/oas-output/schemas/AdminClaimListResponse.ts new file mode 100644 index 0000000000..454a6848a2 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminClaimListResponse.ts @@ -0,0 +1,31 @@ +/** + * @schema AdminClaimListResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminClaimListResponse + * required: + * - limit + * - offset + * - count + * - claims + * properties: + * limit: + * type: number + * title: limit + * description: The claim's limit. + * offset: + * type: number + * title: offset + * description: The claim's offset. + * count: + * type: number + * title: count + * description: The claim's count. + * claims: + * type: array + * description: The claim's claims. + * items: + * $ref: "#/components/schemas/AdminClaim" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminClaimOrderResponse.ts b/www/utils/generated/oas-output/schemas/AdminClaimOrderResponse.ts new file mode 100644 index 0000000000..b466172b84 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminClaimOrderResponse.ts @@ -0,0 +1,16 @@ +/** + * @schema AdminClaimOrderResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminClaimOrderResponse + * required: + * - order + * - claim + * properties: + * order: + * $ref: "#/components/schemas/Order" + * claim: + * $ref: "#/components/schemas/AdminClaim" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminClaimPreviewResponse.ts b/www/utils/generated/oas-output/schemas/AdminClaimPreviewResponse.ts new file mode 100644 index 0000000000..38f52c17b8 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminClaimPreviewResponse.ts @@ -0,0 +1,16 @@ +/** + * @schema AdminClaimPreviewResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminClaimPreviewResponse + * required: + * - order_preview + * - claim + * properties: + * order_preview: + * $ref: "#/components/schemas/Order" + * claim: + * $ref: "#/components/schemas/AdminClaim" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminClaimRequestResponse.ts b/www/utils/generated/oas-output/schemas/AdminClaimRequestResponse.ts new file mode 100644 index 0000000000..a0fdf8de85 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminClaimRequestResponse.ts @@ -0,0 +1,19 @@ +/** + * @schema AdminClaimRequestResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminClaimRequestResponse + * required: + * - return + * - order_preview + * - claim + * properties: + * return: + * $ref: "#/components/schemas/AdminReturn" + * order_preview: + * $ref: "#/components/schemas/Order" + * claim: + * $ref: "#/components/schemas/AdminClaim" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminClaimResponse.ts b/www/utils/generated/oas-output/schemas/AdminClaimResponse.ts new file mode 100644 index 0000000000..a45c30dea2 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminClaimResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminClaimResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminClaimResponse + * required: + * - claim + * properties: + * claim: + * $ref: "#/components/schemas/AdminClaim" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminClaimReturnPreviewResponse.ts b/www/utils/generated/oas-output/schemas/AdminClaimReturnPreviewResponse.ts new file mode 100644 index 0000000000..07af224d3c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminClaimReturnPreviewResponse.ts @@ -0,0 +1,16 @@ +/** + * @schema AdminClaimReturnPreviewResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminClaimReturnPreviewResponse + * required: + * - order_preview + * - return + * properties: + * order_preview: + * $ref: "#/components/schemas/Order" + * return: + * $ref: "#/components/schemas/AdminReturn" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCollectionDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminCollectionDeleteResponse.ts new file mode 100644 index 0000000000..65e6ccb7e8 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCollectionDeleteResponse.ts @@ -0,0 +1,29 @@ +/** + * @schema AdminCollectionDeleteResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminCollectionDeleteResponse + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The collection's ID. + * object: + * type: string + * title: object + * description: The collection's object. + * default: collection + * deleted: + * type: boolean + * title: deleted + * description: The collection's deleted. + * parent: + * type: object + * description: The collection's parent. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCollectionListResponse.ts b/www/utils/generated/oas-output/schemas/AdminCollectionListResponse.ts new file mode 100644 index 0000000000..fa764d65d6 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCollectionListResponse.ts @@ -0,0 +1,31 @@ +/** + * @schema AdminCollectionListResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminCollectionListResponse + * required: + * - limit + * - offset + * - count + * - collections + * properties: + * limit: + * type: number + * title: limit + * description: The collection's limit. + * offset: + * type: number + * title: offset + * description: The collection's offset. + * count: + * type: number + * title: count + * description: The collection's count. + * collections: + * type: array + * description: The collection's collections. + * items: + * $ref: "#/components/schemas/AdminCollection" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCollectionResponse.ts b/www/utils/generated/oas-output/schemas/AdminCollectionResponse.ts new file mode 100644 index 0000000000..5769be51db --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCollectionResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminCollectionResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminCollectionResponse + * required: + * - collection + * properties: + * collection: + * $ref: "#/components/schemas/AdminCollection" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCompleteOrder.ts b/www/utils/generated/oas-output/schemas/AdminCompleteOrder.ts deleted file mode 100644 index 85a478d97e..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminCompleteOrder.ts +++ /dev/null @@ -1,15 +0,0 @@ -/** - * @schema AdminCompleteOrder - * type: object - * description: SUMMARY - * x-schemaName: AdminCompleteOrder - * required: - * - order_id - * properties: - * order_id: - * type: string - * title: order_id - * description: The order's order id. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminCreateCustomer.ts b/www/utils/generated/oas-output/schemas/AdminCreateCustomer.ts deleted file mode 100644 index 5a8e9a2ab7..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminCreateCustomer.ts +++ /dev/null @@ -1,40 +0,0 @@ -/** - * @schema AdminCreateCustomer - * type: object - * description: SUMMARY - * x-schemaName: AdminCreateCustomer - * required: - * - email - * - company_name - * - first_name - * - last_name - * - phone - * - metadata - * properties: - * email: - * type: string - * title: email - * description: The customer's email. - * format: email - * company_name: - * type: string - * title: company_name - * description: The customer's company name. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * phone: - * 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/AdminCreateCustomerAddress.ts b/www/utils/generated/oas-output/schemas/AdminCreateCustomerAddress.ts deleted file mode 100644 index 0c8c996e31..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminCreateCustomerAddress.ts +++ /dev/null @@ -1,77 +0,0 @@ -/** - * @schema AdminCreateCustomerAddress - * type: object - * description: SUMMARY - * x-schemaName: AdminCreateCustomerAddress - * required: - * - address_name - * - company - * - first_name - * - last_name - * - address_1 - * - address_2 - * - city - * - country_code - * - province - * - postal_code - * - phone - * - metadata - * properties: - * address_name: - * type: string - * title: address_name - * description: The customer's address name. - * is_default_shipping: - * type: boolean - * title: is_default_shipping - * description: The customer's is default shipping. - * is_default_billing: - * type: boolean - * title: is_default_billing - * description: The customer's is default billing. - * company: - * type: string - * title: company - * description: The customer's company. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * address_1: - * type: string - * title: address_1 - * description: The customer's address 1. - * address_2: - * type: string - * title: address_2 - * description: The customer's address 2. - * city: - * type: string - * title: city - * description: The customer's city. - * country_code: - * type: string - * title: country_code - * description: The customer's country code. - * province: - * type: string - * title: province - * description: The customer's province. - * postal_code: - * type: string - * title: postal_code - * description: The customer's postal code. - * phone: - * 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/AdminCreateProduct.ts b/www/utils/generated/oas-output/schemas/AdminCreateProduct.ts index e7fa541d14..c061b4ecdf 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateProduct.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateProduct.ts @@ -81,15 +81,13 @@ * items: * type: object * description: The tag's tags. + * required: + * - id * properties: * id: * type: string * title: id * description: The tag's ID. - * value: - * type: string - * title: value - * description: The tag's value. * options: * type: array * description: The create's options. diff --git a/www/utils/generated/oas-output/schemas/AdminCurrency.ts b/www/utils/generated/oas-output/schemas/AdminCurrency.ts new file mode 100644 index 0000000000..8fcfe47e7a --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCurrency.ts @@ -0,0 +1,8 @@ +/** + * @schema AdminCurrency + * type: object + * description: The supported currency's currency. + * x-schemaName: AdminCurrency + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCurrencyListResponse.ts b/www/utils/generated/oas-output/schemas/AdminCurrencyListResponse.ts new file mode 100644 index 0000000000..5c9f0427d0 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCurrencyListResponse.ts @@ -0,0 +1,31 @@ +/** + * @schema AdminCurrencyListResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminCurrencyListResponse + * required: + * - limit + * - offset + * - count + * - currencies + * properties: + * limit: + * type: number + * title: limit + * description: The currency's limit. + * offset: + * type: number + * title: offset + * description: The currency's offset. + * count: + * type: number + * title: count + * description: The currency's count. + * currencies: + * type: array + * description: The currency's currencies. + * items: + * $ref: "#/components/schemas/AdminCurrency" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCurrencyResponse.ts b/www/utils/generated/oas-output/schemas/AdminCurrencyResponse.ts new file mode 100644 index 0000000000..af4dd8d8a8 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCurrencyResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminCurrencyResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminCurrencyResponse + * required: + * - currency + * properties: + * currency: + * $ref: "#/components/schemas/AdminCurrency" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCustomerAddress.ts b/www/utils/generated/oas-output/schemas/AdminCustomerAddress.ts new file mode 100644 index 0000000000..428c7337c6 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCustomerAddress.ts @@ -0,0 +1,101 @@ +/** + * @schema AdminCustomerAddress + * type: object + * description: The customer's address. + * x-schemaName: AdminCustomerAddress + * 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/AdminCustomerAddressResponse.ts b/www/utils/generated/oas-output/schemas/AdminCustomerAddressResponse.ts new file mode 100644 index 0000000000..78e2413016 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCustomerAddressResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminCustomerAddressResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminCustomerAddressResponse + * required: + * - address + * properties: + * address: + * $ref: "#/components/schemas/AdminCustomerAddress" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCustomerGroupResponse.ts b/www/utils/generated/oas-output/schemas/AdminCustomerGroupResponse.ts new file mode 100644 index 0000000000..9c36e2b4b3 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCustomerGroupResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminCustomerGroupResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminCustomerGroupResponse + * required: + * - customer_group + * properties: + * customer_group: + * $ref: "#/components/schemas/AdminCustomerGroup" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCustomerResponse.ts b/www/utils/generated/oas-output/schemas/AdminCustomerResponse.ts new file mode 100644 index 0000000000..fa6aaca13d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCustomerResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminCustomerResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminCustomerResponse + * required: + * - customer + * properties: + * customer: + * $ref: "#/components/schemas/AdminCustomer" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminDraftOrderResponse.ts b/www/utils/generated/oas-output/schemas/AdminDraftOrderResponse.ts new file mode 100644 index 0000000000..b4bc875d8d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminDraftOrderResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminDraftOrderResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminDraftOrderResponse + * required: + * - draft_order + * properties: + * draft_order: + * $ref: "#/components/schemas/AdminOrder" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminExchange.ts b/www/utils/generated/oas-output/schemas/AdminExchange.ts new file mode 100644 index 0000000000..8f9929e558 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminExchange.ts @@ -0,0 +1,256 @@ +/** + * @schema AdminExchange + * type: object + * description: The exchange's details. + * x-schemaName: AdminExchange + * required: + * - order_id + * - return_items + * - additional_items + * - currency_code + * - id + * - region_id + * - customer_id + * - sales_channel_id + * - email + * - shipping_methods + * - payment_status + * - fulfillment_status + * - summary + * - metadata + * - created_at + * - updated_at + * - original_item_total + * - original_item_subtotal + * - original_item_tax_total + * - item_total + * - item_subtotal + * - item_tax_total + * - original_total + * - original_subtotal + * - original_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - gift_card_total + * - gift_card_tax_total + * - shipping_total + * - shipping_subtotal + * - shipping_tax_total + * - original_shipping_total + * - original_shipping_subtotal + * - original_shipping_tax_total + * properties: + * order_id: + * type: string + * title: order_id + * description: The exchange's order id. + * return_items: + * type: array + * description: The exchange's return items. + * items: + * $ref: "#/components/schemas/AdminReturnItem" + * additional_items: + * type: array + * description: The exchange's additional items. + * items: + * $ref: "#/components/schemas/BaseExchangeItem" + * no_notification: + * type: boolean + * title: no_notification + * description: The exchange's no notification. + * difference_due: + * type: number + * title: difference_due + * description: The exchange's difference due. + * return: + * $ref: "#/components/schemas/AdminReturn" + * return_id: + * type: string + * title: return_id + * description: The exchange's return id. + * currency_code: + * type: string + * title: currency_code + * description: The exchange's currency code. + * id: + * type: string + * title: id + * description: The exchange's ID. + * region_id: + * type: string + * title: region_id + * description: The exchange's region id. + * customer_id: + * type: string + * title: customer_id + * description: The exchange's customer id. + * sales_channel_id: + * type: string + * title: sales_channel_id + * description: The exchange's sales channel id. + * email: + * type: string + * title: email + * description: The exchange's email. + * format: email + * display_id: + * type: string + * title: display_id + * description: The exchange's display id. + * shipping_address: + * $ref: "#/components/schemas/BaseOrderAddress" + * billing_address: + * $ref: "#/components/schemas/BaseOrderAddress" + * shipping_methods: + * type: array + * description: The exchange's shipping methods. + * items: + * $ref: "#/components/schemas/BaseOrderShippingMethod" + * payment_collections: + * type: array + * description: The exchange's payment collections. + * items: + * $ref: "#/components/schemas/BasePaymentCollection" + * payment_status: + * type: string + * enum: + * - canceled + * - not_paid + * - awaiting + * - authorized + * - partially_authorized + * - captured + * - partially_captured + * - partially_refunded + * - refunded + * - requires_action + * fulfillments: + * type: array + * description: The exchange's fulfillments. + * items: + * $ref: "#/components/schemas/BaseOrderFulfillment" + * fulfillment_status: + * type: string + * enum: + * - canceled + * - not_fulfilled + * - partially_fulfilled + * - fulfilled + * - partially_shipped + * - shipped + * - partially_delivered + * - delivered + * transactions: + * type: array + * description: The exchange's transactions. + * items: + * $ref: "#/components/schemas/BaseOrderTransaction" + * summary: + * $ref: "#/components/schemas/BaseOrderSummary" + * metadata: + * type: object + * description: The exchange's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The exchange's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The exchange's updated at. + * original_item_total: + * type: number + * title: original_item_total + * description: The exchange's original item total. + * original_item_subtotal: + * type: number + * title: original_item_subtotal + * description: The exchange's original item subtotal. + * original_item_tax_total: + * type: number + * title: original_item_tax_total + * description: The exchange's original item tax total. + * item_total: + * type: number + * title: item_total + * description: The exchange's item total. + * item_subtotal: + * type: number + * title: item_subtotal + * description: The exchange's item subtotal. + * item_tax_total: + * type: number + * title: item_tax_total + * description: The exchange's item tax total. + * original_total: + * type: number + * title: original_total + * description: The exchange's original total. + * original_subtotal: + * type: number + * title: original_subtotal + * description: The exchange's original subtotal. + * original_tax_total: + * type: number + * title: original_tax_total + * description: The exchange's original tax total. + * total: + * type: number + * title: total + * description: The exchange's total. + * subtotal: + * type: number + * title: subtotal + * description: The exchange's subtotal. + * tax_total: + * type: number + * title: tax_total + * description: The exchange's tax total. + * discount_total: + * type: number + * title: discount_total + * description: The exchange's discount total. + * discount_tax_total: + * type: number + * title: discount_tax_total + * description: The exchange's discount tax total. + * gift_card_total: + * type: number + * title: gift_card_total + * description: The exchange's gift card total. + * gift_card_tax_total: + * type: number + * title: gift_card_tax_total + * description: The exchange's gift card tax total. + * shipping_total: + * type: number + * title: shipping_total + * description: The exchange's shipping total. + * shipping_subtotal: + * type: number + * title: shipping_subtotal + * description: The exchange's shipping subtotal. + * shipping_tax_total: + * type: number + * title: shipping_tax_total + * description: The exchange's shipping tax total. + * original_shipping_total: + * type: number + * title: original_shipping_total + * description: The exchange's original shipping total. + * original_shipping_subtotal: + * type: number + * title: original_shipping_subtotal + * description: The exchange's original shipping subtotal. + * original_shipping_tax_total: + * type: number + * title: original_shipping_tax_total + * description: The exchange's original shipping tax total. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminExchangeOrderResponse.ts b/www/utils/generated/oas-output/schemas/AdminExchangeOrderResponse.ts new file mode 100644 index 0000000000..517ccc6223 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminExchangeOrderResponse.ts @@ -0,0 +1,16 @@ +/** + * @schema AdminExchangeOrderResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminExchangeOrderResponse + * required: + * - order + * - exchange + * properties: + * order: + * $ref: "#/components/schemas/Order" + * exchange: + * $ref: "#/components/schemas/AdminExchange" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminExchangePreviewResponse.ts b/www/utils/generated/oas-output/schemas/AdminExchangePreviewResponse.ts new file mode 100644 index 0000000000..ee6e954501 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminExchangePreviewResponse.ts @@ -0,0 +1,16 @@ +/** + * @schema AdminExchangePreviewResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminExchangePreviewResponse + * required: + * - order_preview + * - exchange + * properties: + * order_preview: + * $ref: "#/components/schemas/Order" + * exchange: + * $ref: "#/components/schemas/AdminExchange" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminExchangeRequestResponse.ts b/www/utils/generated/oas-output/schemas/AdminExchangeRequestResponse.ts new file mode 100644 index 0000000000..86007dddd2 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminExchangeRequestResponse.ts @@ -0,0 +1,19 @@ +/** + * @schema AdminExchangeRequestResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminExchangeRequestResponse + * required: + * - return + * - order_preview + * - exchange + * properties: + * return: + * $ref: "#/components/schemas/AdminReturn" + * order_preview: + * $ref: "#/components/schemas/Order" + * exchange: + * $ref: "#/components/schemas/AdminExchange" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminExchangeResponse.ts b/www/utils/generated/oas-output/schemas/AdminExchangeResponse.ts new file mode 100644 index 0000000000..a6766ef544 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminExchangeResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminExchangeResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminExchangeResponse + * required: + * - exchange + * properties: + * exchange: + * $ref: "#/components/schemas/AdminExchange" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminExchangeReturnResponse.ts b/www/utils/generated/oas-output/schemas/AdminExchangeReturnResponse.ts new file mode 100644 index 0000000000..6c3dfb87ea --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminExchangeReturnResponse.ts @@ -0,0 +1,16 @@ +/** + * @schema AdminExchangeReturnResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminExchangeReturnResponse + * required: + * - order_preview + * - return + * properties: + * order_preview: + * $ref: "#/components/schemas/Order" + * return: + * $ref: "#/components/schemas/AdminReturn" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminFile.ts b/www/utils/generated/oas-output/schemas/AdminFile.ts new file mode 100644 index 0000000000..1ab96093ff --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminFile.ts @@ -0,0 +1,20 @@ +/** + * @schema AdminFile + * type: object + * description: The upload's file. + * x-schemaName: AdminFile + * required: + * - id + * - url + * properties: + * id: + * type: string + * title: id + * description: The file's ID. + * url: + * type: string + * title: url + * description: The file's url. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminFileListResponse.ts b/www/utils/generated/oas-output/schemas/AdminFileListResponse.ts new file mode 100644 index 0000000000..35fd540fb0 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminFileListResponse.ts @@ -0,0 +1,16 @@ +/** + * @schema AdminFileListResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminFileListResponse + * required: + * - files + * properties: + * files: + * type: array + * description: The upload's files. + * items: + * $ref: "#/components/schemas/AdminFile" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminFileResponse.ts b/www/utils/generated/oas-output/schemas/AdminFileResponse.ts new file mode 100644 index 0000000000..526856e9c5 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminFileResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminFileResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminFileResponse + * required: + * - file + * properties: + * file: + * $ref: "#/components/schemas/AdminFile" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillment.ts b/www/utils/generated/oas-output/schemas/AdminFulfillment.ts new file mode 100644 index 0000000000..ce56495cb0 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminFulfillment.ts @@ -0,0 +1,94 @@ +/** + * @schema AdminFulfillment + * type: object + * description: The fulfillment's details. + * x-schemaName: AdminFulfillment + * required: + * - id + * - location_id + * - provider_id + * - shipping_option_id + * - provider + * - delivery_address + * - items + * - labels + * - packed_at + * - shipped_at + * - delivered_at + * - canceled_at + * - data + * - metadata + * - created_at + * - updated_at + * - deleted_at + * properties: + * id: + * type: string + * title: id + * description: The fulfillment's ID. + * location_id: + * type: string + * title: location_id + * description: The fulfillment's location id. + * provider_id: + * type: string + * title: provider_id + * description: The fulfillment's provider id. + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The fulfillment's shipping option id. + * provider: + * $ref: "#/components/schemas/AdminFulfillmentProvider" + * delivery_address: + * $ref: "#/components/schemas/AdminFulfillmentAddress" + * items: + * type: array + * description: The fulfillment's items. + * items: + * $ref: "#/components/schemas/AdminFulfillmentItem" + * labels: + * type: array + * description: The fulfillment's labels. + * items: + * $ref: "#/components/schemas/AdminFulfillmentLabel" + * packed_at: + * type: string + * title: packed_at + * description: The fulfillment's packed at. + * shipped_at: + * type: string + * title: shipped_at + * description: The fulfillment's shipped at. + * delivered_at: + * type: string + * title: delivered_at + * description: The fulfillment's delivered at. + * canceled_at: + * type: string + * title: canceled_at + * description: The fulfillment's canceled at. + * data: + * type: object + * description: The fulfillment's data. + * metadata: + * type: object + * description: The fulfillment's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The fulfillment's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The fulfillment's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The fulfillment's deleted at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentAddress.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentAddress.ts new file mode 100644 index 0000000000..2d7f5ef4c1 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentAddress.ts @@ -0,0 +1,92 @@ +/** + * @schema AdminFulfillmentAddress + * type: object + * description: The fulfillment's delivery address. + * x-schemaName: AdminFulfillmentAddress + * required: + * - id + * - fulfillment_id + * - company + * - first_name + * - last_name + * - address_1 + * - address_2 + * - city + * - country_code + * - province + * - postal_code + * - phone + * - metadata + * - created_at + * - updated_at + * - deleted_at + * properties: + * id: + * type: string + * title: id + * description: The delivery address's ID. + * fulfillment_id: + * type: string + * title: fulfillment_id + * description: The delivery address's fulfillment id. + * company: + * type: string + * title: company + * description: The delivery address's company. + * first_name: + * type: string + * title: first_name + * description: The delivery address's first name. + * last_name: + * type: string + * title: last_name + * description: The delivery address's last name. + * address_1: + * type: string + * title: address_1 + * description: The delivery address's address 1. + * address_2: + * type: string + * title: address_2 + * description: The delivery address's address 2. + * city: + * type: string + * title: city + * description: The delivery address's city. + * country_code: + * type: string + * title: country_code + * description: The delivery address's country code. + * province: + * type: string + * title: province + * description: The delivery address's province. + * postal_code: + * type: string + * title: postal_code + * description: The delivery address's postal code. + * phone: + * type: string + * title: phone + * description: The delivery address's phone. + * metadata: + * type: object + * description: The delivery address's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The delivery address's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The delivery address's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The delivery address's deleted at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentItem.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentItem.ts new file mode 100644 index 0000000000..d1d1cb45fa --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentItem.ts @@ -0,0 +1,68 @@ +/** + * @schema AdminFulfillmentItem + * type: object + * description: The item's items. + * x-schemaName: AdminFulfillmentItem + * required: + * - id + * - title + * - quantity + * - sku + * - barcode + * - line_item_id + * - inventory_item_id + * - fulfillment_id + * - created_at + * - updated_at + * - deleted_at + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * title: + * type: string + * title: title + * description: The item's title. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * sku: + * type: string + * title: sku + * description: The item's sku. + * barcode: + * type: string + * title: barcode + * description: The item's barcode. + * line_item_id: + * type: string + * title: line_item_id + * description: The item's line item id. + * inventory_item_id: + * type: string + * title: inventory_item_id + * description: The item's inventory item id. + * fulfillment_id: + * type: string + * title: fulfillment_id + * description: The item's fulfillment id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The item's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The item's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The item's deleted at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentLabel.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentLabel.ts new file mode 100644 index 0000000000..557508335d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentLabel.ts @@ -0,0 +1,53 @@ +/** + * @schema AdminFulfillmentLabel + * type: object + * description: The label's labels. + * x-schemaName: AdminFulfillmentLabel + * required: + * - id + * - tracking_number + * - tracking_url + * - label_url + * - fulfillment_id + * - created_at + * - updated_at + * - deleted_at + * properties: + * id: + * type: string + * title: id + * description: The label's ID. + * tracking_number: + * type: string + * title: tracking_number + * description: The label's tracking number. + * tracking_url: + * type: string + * title: tracking_url + * description: The label's tracking url. + * label_url: + * type: string + * title: label_url + * description: The label's label url. + * fulfillment_id: + * type: string + * title: fulfillment_id + * description: The label's fulfillment id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The label's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The label's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The label's deleted at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentProvider.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentProvider.ts index 5df4ed9f41..4d41c1d47a 100644 --- a/www/utils/generated/oas-output/schemas/AdminFulfillmentProvider.ts +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentProvider.ts @@ -1,7 +1,7 @@ /** * @schema AdminFulfillmentProvider * type: object - * description: The shipping option's provider. + * description: The fulfillment provider's fulfillment providers. * x-schemaName: AdminFulfillmentProvider * */ diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentProviderListResponse.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentProviderListResponse.ts new file mode 100644 index 0000000000..db0e74d778 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentProviderListResponse.ts @@ -0,0 +1,31 @@ +/** + * @schema AdminFulfillmentProviderListResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminFulfillmentProviderListResponse + * required: + * - limit + * - offset + * - count + * - fulfillment_providers + * properties: + * limit: + * type: number + * title: limit + * description: The fulfillment provider's limit. + * offset: + * type: number + * title: offset + * description: The fulfillment provider's offset. + * count: + * type: number + * title: count + * description: The fulfillment provider's count. + * fulfillment_providers: + * type: array + * description: The fulfillment provider's fulfillment providers. + * items: + * $ref: "#/components/schemas/AdminFulfillmentProvider" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentResponse.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentResponse.ts new file mode 100644 index 0000000000..2dfa81d964 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminFulfillmentResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminFulfillmentResponse + * required: + * - fulfillment + * properties: + * fulfillment: + * $ref: "#/components/schemas/AdminFulfillment" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentSet.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentSet.ts index 18a1a52518..c960988eca 100644 --- a/www/utils/generated/oas-output/schemas/AdminFulfillmentSet.ts +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentSet.ts @@ -7,6 +7,7 @@ * - id * - name * - type + * - location * - service_zones * - created_at * - updated_at @@ -24,6 +25,8 @@ * 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. diff --git a/www/utils/generated/oas-output/schemas/AdminInventoryItem.ts b/www/utils/generated/oas-output/schemas/AdminInventoryItem.ts new file mode 100644 index 0000000000..2b698103de --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminInventoryItem.ts @@ -0,0 +1,71 @@ +/** + * @schema AdminInventoryItem + * type: object + * description: The inventory item's details. + * x-schemaName: AdminInventoryItem + * required: + * - id + * - requires_shipping + * properties: + * id: + * type: string + * title: id + * description: The inventory item's ID. + * sku: + * type: string + * title: sku + * description: The inventory item's sku. + * origin_country: + * type: string + * title: origin_country + * description: The inventory item's origin country. + * hs_code: + * type: string + * title: hs_code + * description: The inventory item's hs code. + * requires_shipping: + * type: boolean + * title: requires_shipping + * description: The inventory item's requires shipping. + * 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. + * 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. + * title: + * type: string + * title: title + * description: The inventory item's title. + * description: + * type: string + * title: description + * description: The inventory item's description. + * thumbnail: + * type: string + * title: thumbnail + * description: The inventory item's thumbnail. + * metadata: + * type: object + * description: The inventory item's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminInventoryItemResponse.ts b/www/utils/generated/oas-output/schemas/AdminInventoryItemResponse.ts new file mode 100644 index 0000000000..c024741d57 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminInventoryItemResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminInventoryItemResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminInventoryItemResponse + * required: + * - inventory_item + * properties: + * inventory_item: + * $ref: "#/components/schemas/AdminInventoryItem" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminInvite.ts b/www/utils/generated/oas-output/schemas/AdminInvite.ts new file mode 100644 index 0000000000..bd3d3ef00e --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminInvite.ts @@ -0,0 +1,49 @@ +/** + * @schema AdminInvite + * type: object + * description: The invite's details. + * x-schemaName: AdminInvite + * required: + * - id + * - email + * - accepted + * - token + * properties: + * id: + * type: string + * title: id + * description: The invite's ID. + * email: + * type: string + * title: email + * description: The invite's email. + * format: email + * accepted: + * type: boolean + * title: accepted + * description: The invite's accepted. + * token: + * type: string + * title: token + * description: The invite's token. + * expires_at: + * type: string + * title: expires_at + * description: The invite's expires at. + * format: date-time + * metadata: + * type: object + * description: The invite's metadata. + * created_at: + * type: string + * title: created_at + * description: The invite's created at. + * format: date-time + * updated_at: + * type: string + * title: updated_at + * description: The invite's updated at. + * format: date-time + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminInviteResponse.ts b/www/utils/generated/oas-output/schemas/AdminInviteResponse.ts new file mode 100644 index 0000000000..3d6b9f5e90 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminInviteResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminInviteResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminInviteResponse + * required: + * - invite + * properties: + * invite: + * $ref: "#/components/schemas/AdminInvite" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminNotification.ts b/www/utils/generated/oas-output/schemas/AdminNotification.ts new file mode 100644 index 0000000000..247862ceef --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminNotification.ts @@ -0,0 +1,68 @@ +/** + * @schema AdminNotification + * type: object + * description: The notification's details. + * x-schemaName: AdminNotification + * required: + * - id + * - to + * - channel + * - template + * - provider_id + * - created_at + * properties: + * id: + * type: string + * title: id + * description: The notification's ID. + * to: + * type: string + * title: to + * description: The notification's to. + * channel: + * type: string + * title: channel + * description: The notification's channel. + * template: + * type: string + * title: template + * description: The notification's template. + * data: + * type: object + * description: The notification's data. + * trigger_type: + * type: string + * title: trigger_type + * description: The notification's trigger type. + * resource_id: + * type: string + * title: resource_id + * description: The notification's resource id. + * resource_type: + * type: string + * title: resource_type + * description: The notification's resource type. + * receiver_id: + * type: string + * title: receiver_id + * description: The notification's receiver id. + * original_notification_id: + * type: string + * title: original_notification_id + * description: The notification's original notification id. + * external_id: + * type: string + * title: external_id + * description: The notification's external id. + * provider_id: + * type: string + * title: provider_id + * description: The notification's provider id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The notification's created at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminNotificationListResponse.ts b/www/utils/generated/oas-output/schemas/AdminNotificationListResponse.ts new file mode 100644 index 0000000000..47410d488b --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminNotificationListResponse.ts @@ -0,0 +1,31 @@ +/** + * @schema AdminNotificationListResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminNotificationListResponse + * required: + * - limit + * - offset + * - count + * - notifications + * properties: + * limit: + * type: number + * title: limit + * description: The notification's limit. + * offset: + * type: number + * title: offset + * description: The notification's offset. + * count: + * type: number + * title: count + * description: The notification's count. + * notifications: + * type: array + * description: The notification's notifications. + * items: + * $ref: "#/components/schemas/AdminNotification" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminNotificationResponse.ts b/www/utils/generated/oas-output/schemas/AdminNotificationResponse.ts new file mode 100644 index 0000000000..f824ce5c52 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminNotificationResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminNotificationResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminNotificationResponse + * required: + * - notification + * properties: + * notification: + * $ref: "#/components/schemas/AdminNotification" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminOrder.ts b/www/utils/generated/oas-output/schemas/AdminOrder.ts new file mode 100644 index 0000000000..7a9ae617ab --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminOrder.ts @@ -0,0 +1,237 @@ +/** + * @schema AdminOrder + * type: object + * description: The order's details. + * x-schemaName: AdminOrder + * required: + * - payment_collections + * - id + * - version + * - region_id + * - customer_id + * - sales_channel_id + * - email + * - currency_code + * - items + * - shipping_methods + * - payment_status + * - fulfillment_status + * - summary + * - metadata + * - created_at + * - updated_at + * - original_item_total + * - original_item_subtotal + * - original_item_tax_total + * - item_total + * - item_subtotal + * - item_tax_total + * - original_total + * - original_subtotal + * - original_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - gift_card_total + * - gift_card_tax_total + * - shipping_total + * - shipping_subtotal + * - shipping_tax_total + * - original_shipping_total + * - original_shipping_subtotal + * - original_shipping_tax_total + * properties: + * payment_collections: + * type: array + * description: The order's payment collections. + * items: + * $ref: "#/components/schemas/AdminPaymentCollection" + * id: + * type: string + * title: id + * description: The order's ID. + * version: + * type: number + * title: version + * description: The order's version. + * region_id: + * type: string + * title: region_id + * description: The order's region id. + * customer_id: + * type: string + * title: customer_id + * description: The order's customer id. + * sales_channel_id: + * type: string + * title: sales_channel_id + * description: The order's sales channel id. + * email: + * type: string + * title: email + * description: The order's email. + * format: email + * currency_code: + * type: string + * title: currency_code + * description: The order's currency code. + * display_id: + * type: string + * 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. + * items: + * $ref: "#/components/schemas/BaseOrderLineItem" + * shipping_methods: + * type: array + * description: The order's shipping methods. + * items: + * $ref: "#/components/schemas/BaseOrderShippingMethod" + * payment_status: + * type: string + * enum: + * - canceled + * - not_paid + * - awaiting + * - authorized + * - partially_authorized + * - captured + * - partially_captured + * - partially_refunded + * - refunded + * - requires_action + * fulfillments: + * type: array + * description: The order's fulfillments. + * items: + * $ref: "#/components/schemas/BaseOrderFulfillment" + * fulfillment_status: + * type: string + * enum: + * - canceled + * - not_fulfilled + * - partially_fulfilled + * - fulfilled + * - partially_shipped + * - shipped + * - partially_delivered + * - delivered + * transactions: + * type: array + * description: The order's transactions. + * items: + * $ref: "#/components/schemas/BaseOrderTransaction" + * summary: + * $ref: "#/components/schemas/BaseOrderSummary" + * metadata: + * type: object + * description: The order's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The order's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The order's updated at. + * original_item_total: + * type: number + * title: original_item_total + * description: The order's original item total. + * original_item_subtotal: + * type: number + * title: original_item_subtotal + * description: The order's original item subtotal. + * original_item_tax_total: + * type: number + * title: original_item_tax_total + * description: The order's original item tax total. + * item_total: + * type: number + * title: item_total + * description: The order's item total. + * item_subtotal: + * type: number + * title: item_subtotal + * description: The order's item subtotal. + * item_tax_total: + * type: number + * title: item_tax_total + * description: The order's item tax total. + * original_total: + * type: number + * title: original_total + * description: The order's original total. + * original_subtotal: + * type: number + * title: original_subtotal + * description: The order's original subtotal. + * original_tax_total: + * type: number + * title: original_tax_total + * description: The order's original tax total. + * total: + * type: number + * title: total + * description: The order's total. + * subtotal: + * type: number + * title: subtotal + * description: The order's subtotal. + * tax_total: + * type: number + * title: tax_total + * description: The order's tax total. + * discount_total: + * type: number + * title: discount_total + * description: The order's discount total. + * discount_tax_total: + * type: number + * title: discount_tax_total + * description: The order's discount tax total. + * gift_card_total: + * type: number + * title: gift_card_total + * description: The order's gift card total. + * gift_card_tax_total: + * type: number + * title: gift_card_tax_total + * description: The order's gift card tax total. + * shipping_total: + * type: number + * title: shipping_total + * description: The order's shipping total. + * shipping_subtotal: + * type: number + * title: shipping_subtotal + * description: The order's shipping subtotal. + * shipping_tax_total: + * type: number + * title: shipping_tax_total + * description: The order's shipping tax total. + * original_shipping_total: + * type: number + * title: original_shipping_total + * description: The order's original shipping total. + * original_shipping_subtotal: + * type: number + * title: original_shipping_subtotal + * description: The order's original shipping subtotal. + * original_shipping_tax_total: + * type: number + * title: original_shipping_tax_total + * description: The order's original shipping tax total. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminOrderCancelFulfillment.ts b/www/utils/generated/oas-output/schemas/AdminOrderCancelFulfillment.ts deleted file mode 100644 index e4b099eddd..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminOrderCancelFulfillment.ts +++ /dev/null @@ -1,13 +0,0 @@ -/** - * @schema AdminOrderCancelFulfillment - * type: object - * description: SUMMARY - * x-schemaName: AdminOrderCancelFulfillment - * properties: - * no_notification: - * type: boolean - * title: no_notification - * description: The order's no notification. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminOrderCreateFulfillment.ts b/www/utils/generated/oas-output/schemas/AdminOrderCreateFulfillment.ts deleted file mode 100644 index 1206bef698..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminOrderCreateFulfillment.ts +++ /dev/null @@ -1,42 +0,0 @@ -/** - * @schema AdminOrderCreateFulfillment - * type: object - * description: SUMMARY - * x-schemaName: AdminOrderCreateFulfillment - * required: - * - items - * - location_id - * - metadata - * properties: - * items: - * type: array - * description: The order's items. - * items: - * 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. - * location_id: - * type: string - * title: location_id - * description: The order's location id. - * no_notification: - * type: boolean - * title: no_notification - * description: The order's no notification. - * metadata: - * type: object - * description: The order's metadata. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminOrderCreateShipment.ts b/www/utils/generated/oas-output/schemas/AdminOrderCreateShipment.ts deleted file mode 100644 index 4e7be782a1..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminOrderCreateShipment.ts +++ /dev/null @@ -1,60 +0,0 @@ -/** - * @schema AdminOrderCreateShipment - * type: object - * description: SUMMARY - * x-schemaName: AdminOrderCreateShipment - * required: - * - items - * - metadata - * properties: - * items: - * type: array - * description: The order's items. - * items: - * 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. - * labels: - * type: array - * description: The order's labels. - * items: - * type: object - * description: The label's labels. - * required: - * - tracking_number - * - tracking_url - * - label_url - * properties: - * tracking_number: - * type: string - * title: tracking_number - * description: The label's tracking number. - * tracking_url: - * type: string - * title: tracking_url - * description: The label's tracking url. - * label_url: - * type: string - * title: label_url - * description: The label's label url. - * no_notification: - * type: boolean - * title: no_notification - * description: The order's no notification. - * metadata: - * type: object - * description: The order's metadata. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts new file mode 100644 index 0000000000..9931ba716e --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts @@ -0,0 +1,647 @@ +/** + * @schema AdminOrderPreview + * type: object + * description: The return's order preview. + * x-schemaName: AdminOrderPreview + * required: + * - return_requested_total + * - order_change + * - currency_code + * - id + * - version + * - region_id + * - customer_id + * - sales_channel_id + * - email + * - payment_collections + * - payment_status + * - fulfillment_status + * - summary + * - metadata + * - created_at + * - updated_at + * - original_item_total + * - original_item_subtotal + * - original_item_tax_total + * - item_total + * - item_subtotal + * - item_tax_total + * - original_total + * - original_subtotal + * - original_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - gift_card_total + * - gift_card_tax_total + * - shipping_total + * - shipping_subtotal + * - shipping_tax_total + * - original_shipping_total + * - original_shipping_subtotal + * - original_shipping_tax_total + * properties: + * return_requested_total: + * type: number + * title: return_requested_total + * description: The order preview's return requested total. + * order_change: + * $ref: "#/components/schemas/BaseOrderChange" + * items: + * type: array + * description: The order preview's items. + * items: + * allOf: + * - type: object + * description: The item's items. + * x-schemaName: BaseOrderLineItem + * required: + * - id + * - title + * - subtitle + * - thumbnail + * - variant_id + * - product_id + * - product_title + * - product_description + * - product_subtitle + * - product_type + * - product_collection + * - product_handle + * - variant_sku + * - variant_barcode + * - variant_title + * - variant_option_values + * - requires_shipping + * - is_discountable + * - is_tax_inclusive + * - unit_price + * - quantity + * - detail + * - created_at + * - updated_at + * - metadata + * - original_total + * - original_subtotal + * - original_tax_total + * - item_total + * - item_subtotal + * - item_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - refundable_total + * - refundable_total_per_unit + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * title: + * type: string + * title: title + * description: The item's title. + * subtitle: + * type: string + * title: subtitle + * description: The item's subtitle. + * thumbnail: + * type: string + * title: thumbnail + * description: The item's thumbnail. + * variant: + * $ref: "#/components/schemas/BaseProductVariant" + * variant_id: + * type: string + * title: variant_id + * description: The item's variant id. + * product: + * $ref: "#/components/schemas/BaseProduct" + * product_id: + * type: string + * title: product_id + * description: The item's product id. + * product_title: + * type: string + * title: product_title + * description: The item's product title. + * product_description: + * type: string + * title: product_description + * description: The item's product description. + * product_subtitle: + * type: string + * title: product_subtitle + * description: The item's product subtitle. + * product_type: + * type: string + * title: product_type + * description: The item's product type. + * product_collection: + * type: string + * title: product_collection + * description: The item's product collection. + * product_handle: + * type: string + * title: product_handle + * description: The item's product handle. + * variant_sku: + * type: string + * title: variant_sku + * description: The item's variant sku. + * variant_barcode: + * type: string + * title: variant_barcode + * description: The item's variant barcode. + * variant_title: + * type: string + * title: variant_title + * description: The item's variant title. + * variant_option_values: + * type: object + * description: The item's variant option values. + * requires_shipping: + * type: boolean + * title: requires_shipping + * description: The item's requires shipping. + * is_discountable: + * type: boolean + * title: is_discountable + * description: The item's is discountable. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The item's is tax inclusive. + * compare_at_unit_price: + * type: number + * title: compare_at_unit_price + * description: The item's compare at unit price. + * unit_price: + * type: number + * title: unit_price + * description: The item's unit price. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * tax_lines: + * type: array + * description: The item's tax lines. + * items: + * $ref: "#/components/schemas/BaseOrderLineItemTaxLine" + * adjustments: + * type: array + * description: The item's adjustments. + * items: + * $ref: "#/components/schemas/BaseOrderLineItemAdjustment" + * detail: + * $ref: "#/components/schemas/BaseOrderItemDetail" + * created_at: + * type: string + * title: created_at + * description: The item's created at. + * format: date-time + * updated_at: + * type: string + * title: updated_at + * description: The item's updated at. + * format: date-time + * metadata: + * type: object + * description: The item's metadata. + * original_total: + * type: number + * title: original_total + * description: The item's original total. + * original_subtotal: + * type: number + * title: original_subtotal + * description: The item's original subtotal. + * original_tax_total: + * type: number + * title: original_tax_total + * description: The item's original tax total. + * item_total: + * type: number + * title: item_total + * description: The item's item total. + * item_subtotal: + * type: number + * title: item_subtotal + * description: The item's item subtotal. + * item_tax_total: + * type: number + * title: item_tax_total + * description: The item's item tax total. + * total: + * type: number + * title: total + * description: The item's total. + * subtotal: + * type: number + * title: subtotal + * description: The item's subtotal. + * tax_total: + * type: number + * title: tax_total + * description: The item's tax total. + * discount_total: + * type: number + * title: discount_total + * description: The item's discount total. + * discount_tax_total: + * type: number + * title: discount_tax_total + * description: The item's discount tax total. + * refundable_total: + * type: number + * title: refundable_total + * description: The item's refundable total. + * refundable_total_per_unit: + * type: number + * title: refundable_total_per_unit + * description: The item's refundable total per unit. + * - type: object + * description: The item's items. + * properties: + * actions: + * type: array + * description: The item's actions. + * items: + * type: object + * description: The action's actions. + * x-schemaName: BaseOrderChangeAction + * shipping_methods: + * type: array + * description: The order preview's shipping methods. + * items: + * allOf: + * - type: object + * description: The shipping method's shipping methods. + * x-schemaName: BaseOrderShippingMethod + * required: + * - id + * - order_id + * - name + * - amount + * - is_tax_inclusive + * - shipping_option_id + * - data + * - metadata + * - original_total + * - original_subtotal + * - original_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The shipping method's ID. + * order_id: + * type: string + * title: order_id + * description: The shipping method's order id. + * name: + * type: string + * title: name + * description: The shipping method's name. + * description: + * type: string + * title: description + * description: The shipping method's description. + * amount: + * type: number + * title: amount + * description: The shipping method's amount. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The shipping method's is tax inclusive. + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The shipping method's shipping option id. + * data: + * type: object + * description: The shipping method's data. + * metadata: + * type: object + * description: The shipping method's metadata. + * tax_lines: + * type: array + * description: The shipping method's tax lines. + * items: + * $ref: "#/components/schemas/BaseOrderShippingMethodTaxLine" + * adjustments: + * type: array + * description: The shipping method's adjustments. + * items: + * $ref: "#/components/schemas/BaseOrderShippingMethodAdjustment" + * original_total: + * oneOf: + * - type: string + * title: original_total + * description: The shipping method's original total. + * - type: number + * title: original_total + * description: The shipping method's original total. + * - type: string + * title: original_total + * description: The shipping method's original total. + * - $ref: "#/components/schemas/IBigNumber" + * original_subtotal: + * oneOf: + * - type: string + * title: original_subtotal + * description: The shipping method's original subtotal. + * - type: number + * title: original_subtotal + * description: The shipping method's original subtotal. + * - type: string + * title: original_subtotal + * description: The shipping method's original subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * original_tax_total: + * oneOf: + * - type: string + * title: original_tax_total + * description: The shipping method's original tax total. + * - type: number + * title: original_tax_total + * description: The shipping method's original tax total. + * - type: string + * title: original_tax_total + * description: The shipping method's original tax total. + * - $ref: "#/components/schemas/IBigNumber" + * total: + * oneOf: + * - type: string + * title: total + * description: The shipping method's total. + * - type: number + * title: total + * description: The shipping method's total. + * - type: string + * title: total + * description: The shipping method's total. + * - $ref: "#/components/schemas/IBigNumber" + * subtotal: + * oneOf: + * - type: string + * title: subtotal + * description: The shipping method's subtotal. + * - type: number + * title: subtotal + * description: The shipping method's subtotal. + * - type: string + * title: subtotal + * description: The shipping method's subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * tax_total: + * oneOf: + * - type: string + * title: tax_total + * description: The shipping method's tax total. + * - type: number + * title: tax_total + * description: The shipping method's tax total. + * - type: string + * title: tax_total + * description: The shipping method's tax total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_total: + * oneOf: + * - type: string + * title: discount_total + * description: The shipping method's discount total. + * - type: number + * title: discount_total + * description: The shipping method's discount total. + * - type: string + * title: discount_total + * description: The shipping method's discount total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_tax_total: + * oneOf: + * - type: string + * title: discount_tax_total + * description: The shipping method's discount tax total. + * - type: number + * title: discount_tax_total + * description: The shipping method's discount tax total. + * - type: string + * title: discount_tax_total + * description: The shipping method's discount tax total. + * - $ref: "#/components/schemas/IBigNumber" + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The shipping method's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The shipping method's updated at. + * - type: object + * description: The shipping method's shipping methods. + * properties: + * actions: + * type: array + * description: The shipping method's actions. + * items: + * type: object + * description: The action's actions. + * x-schemaName: BaseOrderChangeAction + * currency_code: + * type: string + * title: currency_code + * description: The order preview's currency code. + * id: + * type: string + * title: id + * description: The order preview's ID. + * version: + * type: number + * title: version + * description: The order preview's version. + * region_id: + * type: string + * title: region_id + * description: The order preview's region id. + * customer_id: + * type: string + * title: customer_id + * description: The order preview's customer id. + * sales_channel_id: + * type: string + * title: sales_channel_id + * description: The order preview's sales channel id. + * email: + * type: string + * title: email + * description: The order preview's email. + * format: email + * display_id: + * type: string + * title: display_id + * description: The order preview's display id. + * shipping_address: + * $ref: "#/components/schemas/BaseOrderAddress" + * billing_address: + * $ref: "#/components/schemas/BaseOrderAddress" + * payment_collections: + * type: array + * description: The order preview's payment collections. + * items: + * $ref: "#/components/schemas/AdminPaymentCollection" + * payment_status: + * type: string + * enum: + * - canceled + * - not_paid + * - awaiting + * - authorized + * - partially_authorized + * - captured + * - partially_captured + * - partially_refunded + * - refunded + * - requires_action + * fulfillments: + * type: array + * description: The order preview's fulfillments. + * items: + * $ref: "#/components/schemas/BaseOrderFulfillment" + * fulfillment_status: + * type: string + * enum: + * - canceled + * - not_fulfilled + * - partially_fulfilled + * - fulfilled + * - partially_shipped + * - shipped + * - partially_delivered + * - delivered + * transactions: + * type: array + * description: The order preview's transactions. + * items: + * $ref: "#/components/schemas/BaseOrderTransaction" + * summary: + * $ref: "#/components/schemas/BaseOrderSummary" + * metadata: + * type: object + * description: The order preview's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The order preview's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The order preview's updated at. + * original_item_total: + * type: number + * title: original_item_total + * description: The order preview's original item total. + * original_item_subtotal: + * type: number + * title: original_item_subtotal + * description: The order preview's original item subtotal. + * original_item_tax_total: + * type: number + * title: original_item_tax_total + * description: The order preview's original item tax total. + * item_total: + * type: number + * title: item_total + * description: The order preview's item total. + * item_subtotal: + * type: number + * title: item_subtotal + * description: The order preview's item subtotal. + * item_tax_total: + * type: number + * title: item_tax_total + * description: The order preview's item tax total. + * original_total: + * type: number + * title: original_total + * description: The order preview's original total. + * original_subtotal: + * type: number + * title: original_subtotal + * description: The order preview's original subtotal. + * original_tax_total: + * type: number + * title: original_tax_total + * description: The order preview's original tax total. + * total: + * type: number + * title: total + * description: The order preview's total. + * subtotal: + * type: number + * title: subtotal + * description: The order preview's subtotal. + * tax_total: + * type: number + * title: tax_total + * description: The order preview's tax total. + * discount_total: + * type: number + * title: discount_total + * description: The order preview's discount total. + * discount_tax_total: + * type: number + * title: discount_tax_total + * description: The order preview's discount tax total. + * gift_card_total: + * type: number + * title: gift_card_total + * description: The order preview's gift card total. + * gift_card_tax_total: + * type: number + * title: gift_card_tax_total + * description: The order preview's gift card tax total. + * shipping_total: + * type: number + * title: shipping_total + * description: The order preview's shipping total. + * shipping_subtotal: + * type: number + * title: shipping_subtotal + * description: The order preview's shipping subtotal. + * shipping_tax_total: + * type: number + * title: shipping_tax_total + * description: The order preview's shipping tax total. + * original_shipping_total: + * type: number + * title: original_shipping_total + * description: The order preview's original shipping total. + * original_shipping_subtotal: + * type: number + * title: original_shipping_subtotal + * description: The order preview's original shipping subtotal. + * original_shipping_tax_total: + * type: number + * title: original_shipping_tax_total + * description: The order preview's original shipping tax total. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminOrderPreviewResponse.ts b/www/utils/generated/oas-output/schemas/AdminOrderPreviewResponse.ts new file mode 100644 index 0000000000..e1cfcda5c8 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminOrderPreviewResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminOrderPreviewResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminOrderPreviewResponse + * required: + * - order + * properties: + * order: + * $ref: "#/components/schemas/AdminOrderPreview" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminOrderResponse.ts b/www/utils/generated/oas-output/schemas/AdminOrderResponse.ts new file mode 100644 index 0000000000..dba0194408 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminOrderResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminOrderResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminOrderResponse + * required: + * - order + * properties: + * order: + * $ref: "#/components/schemas/AdminOrder" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminOrderReturnResponse.ts b/www/utils/generated/oas-output/schemas/AdminOrderReturnResponse.ts new file mode 100644 index 0000000000..fadb8e4439 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminOrderReturnResponse.ts @@ -0,0 +1,16 @@ +/** + * @schema AdminOrderReturnResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminOrderReturnResponse + * required: + * - order + * - return + * properties: + * order: + * $ref: "#/components/schemas/Order" + * return: + * $ref: "#/components/schemas/AdminReturn" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPayment.ts b/www/utils/generated/oas-output/schemas/AdminPayment.ts new file mode 100644 index 0000000000..15d136e156 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPayment.ts @@ -0,0 +1,135 @@ +/** + * @schema AdminPayment + * type: object + * description: The payment's details. + * x-schemaName: AdminPayment + * required: + * - id + * - amount + * - currency_code + * - provider_id + * properties: + * id: + * type: string + * title: id + * description: The payment's ID. + * amount: + * oneOf: + * - type: string + * title: amount + * description: The payment's amount. + * - type: number + * title: amount + * description: The payment's amount. + * - type: string + * title: amount + * description: The payment's amount. + * - $ref: "#/components/schemas/IBigNumber" + * authorized_amount: + * oneOf: + * - type: string + * title: authorized_amount + * description: The payment's authorized amount. + * - type: number + * title: authorized_amount + * description: The payment's authorized amount. + * - type: string + * title: authorized_amount + * description: The payment's authorized amount. + * - $ref: "#/components/schemas/IBigNumber" + * currency_code: + * type: string + * title: currency_code + * description: The payment's currency code. + * provider_id: + * type: string + * title: provider_id + * description: The payment's provider id. + * cart_id: + * type: string + * title: cart_id + * description: The payment's cart id. + * order_id: + * type: string + * title: order_id + * description: The payment's order id. + * order_edit_id: + * type: string + * title: order_edit_id + * description: The payment's order edit id. + * customer_id: + * type: string + * title: customer_id + * description: The payment's customer id. + * data: + * type: object + * description: The payment's data. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The payment's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The payment's updated at. + * captured_at: + * oneOf: + * - type: string + * title: captured_at + * description: The payment's captured at. + * - type: string + * title: captured_at + * description: The payment's captured at. + * format: date-time + * canceled_at: + * oneOf: + * - type: string + * title: canceled_at + * description: The payment's canceled at. + * - type: string + * title: canceled_at + * description: The payment's canceled at. + * format: date-time + * captured_amount: + * oneOf: + * - type: string + * title: captured_amount + * description: The payment's captured amount. + * - type: number + * title: captured_amount + * description: The payment's captured amount. + * - type: string + * title: captured_amount + * description: The payment's captured amount. + * - $ref: "#/components/schemas/IBigNumber" + * refunded_amount: + * oneOf: + * - type: string + * title: refunded_amount + * description: The payment's refunded amount. + * - type: number + * title: refunded_amount + * description: The payment's refunded amount. + * - type: string + * title: refunded_amount + * description: The payment's refunded amount. + * - $ref: "#/components/schemas/IBigNumber" + * captures: + * type: array + * description: The payment's captures. + * items: + * $ref: "#/components/schemas/BaseCapture" + * refunds: + * type: array + * description: The payment's refunds. + * items: + * $ref: "#/components/schemas/BaseRefund" + * payment_collection: + * $ref: "#/components/schemas/BasePaymentCollection" + * payment_session: + * $ref: "#/components/schemas/BasePaymentSession" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts b/www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts new file mode 100644 index 0000000000..d6a3990f4c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts @@ -0,0 +1,121 @@ +/** + * @schema AdminPaymentCollection + * type: object + * description: The payment collection's payment collections. + * x-schemaName: AdminPaymentCollection + * required: + * - id + * - currency_code + * - region_id + * - amount + * - status + * - payment_providers + * properties: + * id: + * type: string + * title: id + * description: The payment collection's ID. + * currency_code: + * type: string + * title: currency_code + * description: The payment collection's currency code. + * region_id: + * type: string + * title: region_id + * description: The payment collection's region id. + * amount: + * oneOf: + * - type: string + * title: amount + * description: The payment collection's amount. + * - type: number + * title: amount + * description: The payment collection's amount. + * - type: string + * title: amount + * description: The payment collection's amount. + * - $ref: "#/components/schemas/IBigNumber" + * authorized_amount: + * oneOf: + * - type: string + * title: authorized_amount + * description: The payment collection's authorized amount. + * - type: number + * title: authorized_amount + * description: The payment collection's authorized amount. + * - type: string + * title: authorized_amount + * description: The payment collection's authorized amount. + * - $ref: "#/components/schemas/IBigNumber" + * captured_amount: + * oneOf: + * - type: string + * title: captured_amount + * description: The payment collection's captured amount. + * - type: number + * title: captured_amount + * description: The payment collection's captured amount. + * - type: string + * title: captured_amount + * description: The payment collection's captured amount. + * - $ref: "#/components/schemas/IBigNumber" + * refunded_amount: + * oneOf: + * - type: string + * title: refunded_amount + * description: The payment collection's refunded amount. + * - type: number + * title: refunded_amount + * description: The payment collection's refunded amount. + * - type: string + * title: refunded_amount + * description: The payment collection's refunded amount. + * - $ref: "#/components/schemas/IBigNumber" + * completed_at: + * oneOf: + * - type: string + * title: completed_at + * description: The payment collection's completed at. + * - type: string + * title: completed_at + * description: The payment collection's completed at. + * format: date-time + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The payment collection's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The payment collection's updated at. + * metadata: + * type: object + * description: The payment collection's metadata. + * status: + * type: string + * enum: + * - canceled + * - not_paid + * - awaiting + * - authorized + * - partially_authorized + * payment_providers: + * type: array + * description: The payment collection's payment providers. + * items: + * $ref: "#/components/schemas/BasePaymentProvider" + * payment_sessions: + * type: array + * description: The payment collection's payment sessions. + * items: + * $ref: "#/components/schemas/BasePaymentSession" + * payments: + * type: array + * description: The payment collection's payments. + * items: + * $ref: "#/components/schemas/BasePayment" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPaymentProvider.ts b/www/utils/generated/oas-output/schemas/AdminPaymentProvider.ts new file mode 100644 index 0000000000..c4b1086516 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPaymentProvider.ts @@ -0,0 +1,8 @@ +/** + * @schema AdminPaymentProvider + * type: object + * description: The payment provider's payment providers. + * x-schemaName: AdminPaymentProvider + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPaymentResponse.ts b/www/utils/generated/oas-output/schemas/AdminPaymentResponse.ts new file mode 100644 index 0000000000..fbe47ed5e8 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPaymentResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminPaymentResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminPaymentResponse + * required: + * - payment + * properties: + * payment: + * $ref: "#/components/schemas/AdminPayment" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostCancelExchangeReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostCancelExchangeReqSchema.ts new file mode 100644 index 0000000000..8fb770f99e --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostCancelExchangeReqSchema.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminPostCancelExchangeReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostCancelExchangeReqSchema + * properties: + * no_notification: + * type: boolean + * title: no_notification + * description: The exchange's no notification. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimsItemsActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostClaimsItemsActionReqSchema.ts index 9cb4042984..b2b0227da4 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostClaimsItemsActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostClaimsItemsActionReqSchema.ts @@ -3,18 +3,17 @@ * type: object * description: SUMMARY * x-schemaName: AdminPostClaimsItemsActionReqSchema + * required: + * - reason_id * properties: * quantity: * type: number * title: quantity * description: The claim's quantity. - * reason: + * reason_id: * type: string - * enum: - * - missing_item - * - wrong_item - * - production_failure - * - other + * title: reason_id + * description: The claim's reason id. * internal_note: * type: string * title: internal_note diff --git a/www/utils/generated/oas-output/schemas/AdminPostExchangesAddItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostExchangesAddItemsReqSchema.ts new file mode 100644 index 0000000000..44735632ab --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostExchangesAddItemsReqSchema.ts @@ -0,0 +1,42 @@ +/** + * @schema AdminPostExchangesAddItemsReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostExchangesAddItemsReqSchema + * properties: + * items: + * type: array + * description: The exchange's items. + * items: + * type: object + * description: The item's items. + * required: + * - variant_id + * - quantity + * properties: + * variant_id: + * type: string + * title: variant_id + * description: The item's variant id. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * unit_price: + * type: number + * title: unit_price + * description: The item's unit price. + * internal_note: + * type: string + * title: internal_note + * description: The item's internal note. + * allow_backorder: + * type: boolean + * title: allow_backorder + * description: The item's allow backorder. + * metadata: + * type: object + * description: The item's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.ts new file mode 100644 index 0000000000..1f84820b47 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostExchangesRequestItemsReturnActionReqSchema.ts @@ -0,0 +1,24 @@ +/** + * @schema AdminPostExchangesRequestItemsReturnActionReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostExchangesRequestItemsReturnActionReqSchema + * properties: + * quantity: + * type: number + * title: quantity + * description: The exchange's quantity. + * internal_note: + * type: string + * title: internal_note + * description: The exchange's internal note. + * reason_id: + * type: string + * title: reason_id + * description: The exchange's reason id. + * metadata: + * type: object + * description: The exchange's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostExchangesReturnRequestItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostExchangesReturnRequestItemsReqSchema.ts new file mode 100644 index 0000000000..fb726284ca --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostExchangesReturnRequestItemsReqSchema.ts @@ -0,0 +1,42 @@ +/** + * @schema AdminPostExchangesReturnRequestItemsReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema + * properties: + * items: + * type: array + * description: The exchange's items. + * items: + * 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. + * description: + * type: string + * title: description + * description: The item's description. + * internal_note: + * type: string + * title: internal_note + * description: The item's internal note. + * reason_id: + * type: string + * title: reason_id + * description: The item's reason id. + * metadata: + * type: object + * description: The item's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingActionReqSchema.ts new file mode 100644 index 0000000000..1a0729aa16 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingActionReqSchema.ts @@ -0,0 +1,20 @@ +/** + * @schema AdminPostExchangesShippingActionReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostExchangesShippingActionReqSchema + * properties: + * custom_price: + * type: number + * title: custom_price + * description: The exchange's custom price. + * internal_note: + * type: string + * title: internal_note + * description: The exchange's internal note. + * metadata: + * type: object + * description: The exchange's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingReqSchema.ts new file mode 100644 index 0000000000..40f97d56c4 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingReqSchema.ts @@ -0,0 +1,30 @@ +/** + * @schema AdminPostExchangesShippingReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostExchangesShippingReqSchema + * required: + * - shipping_option_id + * properties: + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The exchange's shipping option id. + * custom_price: + * type: number + * title: custom_price + * description: The exchange's custom price. + * description: + * type: string + * title: description + * description: The exchange's description. + * internal_note: + * type: string + * title: internal_note + * description: The exchange's internal note. + * metadata: + * type: object + * description: The exchange's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostExhangesItemsActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostExhangesItemsActionReqSchema.ts new file mode 100644 index 0000000000..7f7b493ef2 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostExhangesItemsActionReqSchema.ts @@ -0,0 +1,17 @@ +/** + * @schema AdminPostExhangesItemsActionReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostExhangesItemsActionReqSchema + * properties: + * quantity: + * type: number + * title: quantity + * description: The exchange's quantity. + * internal_note: + * type: string + * title: internal_note + * description: The exchange's internal note. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts index 2c38d2b0e0..714c77e5a0 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts @@ -6,6 +6,7 @@ * required: * - type * - order_id + * - reason_id * - metadata * properties: * type: @@ -25,6 +26,10 @@ * type: string * title: internal_note * description: The claim's internal note. + * reason_id: + * type: string + * title: reason_id + * description: The claim's reason id. * metadata: * type: object * description: The claim's metadata. diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderExchangesReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderExchangesReqSchema.ts new file mode 100644 index 0000000000..d0cac217f4 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderExchangesReqSchema.ts @@ -0,0 +1,27 @@ +/** + * @schema AdminPostOrderExchangesReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostOrderExchangesReqSchema + * required: + * - order_id + * - metadata + * properties: + * order_id: + * type: string + * title: order_id + * description: The exchange's order id. + * description: + * type: string + * title: description + * description: The exchange's description. + * internal_note: + * type: string + * title: internal_note + * description: The exchange's internal note. + * metadata: + * type: object + * description: The exchange's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts index a6ed864213..862ff6c101 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts @@ -9,22 +9,22 @@ * shipping_option_id: * type: string * title: shipping_option_id - * description: The claim's shipping option id. + * description: The exchange's shipping option id. * custom_price: * type: number * title: custom_price - * description: The claim's custom price. + * description: The exchange's custom price. * description: * type: string * title: description - * description: The claim's description. + * description: The exchange's description. * internal_note: * type: string * title: internal_note - * description: The claim's internal note. + * description: The exchange's internal note. * metadata: * type: object - * description: The claim's metadata. + * description: The exchange's metadata. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPriceList.ts b/www/utils/generated/oas-output/schemas/AdminPriceList.ts new file mode 100644 index 0000000000..c5c79b8848 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPriceList.ts @@ -0,0 +1,75 @@ +/** + * @schema AdminPriceList + * type: object + * description: The price list's details. + * x-schemaName: AdminPriceList + * required: + * - id + * - title + * - description + * - rules + * - starts_at + * - ends_at + * - status + * - type + * - prices + * - created_at + * - updated_at + * - deleted_at + * properties: + * id: + * type: string + * title: id + * description: The price list's ID. + * title: + * type: string + * title: title + * description: The price list's title. + * description: + * type: string + * title: description + * description: The price list's description. + * rules: + * type: object + * description: The price list's rules. + * starts_at: + * type: string + * title: starts_at + * description: The price list's starts at. + * ends_at: + * type: string + * title: ends_at + * description: The price list's ends at. + * status: + * type: string + * enum: + * - draft + * - active + * type: + * type: string + * enum: + * - sale + * - override + * prices: + * type: array + * description: The price list's prices. + * items: + * $ref: "#/components/schemas/AdminPriceListPrice" + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The price list's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The price list's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The price list's deleted at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPriceListBatchResponse.ts b/www/utils/generated/oas-output/schemas/AdminPriceListBatchResponse.ts new file mode 100644 index 0000000000..c072f2c0e1 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPriceListBatchResponse.ts @@ -0,0 +1,46 @@ +/** + * @schema AdminPriceListBatchResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminPriceListBatchResponse + * required: + * - created + * - updated + * - deleted + * properties: + * created: + * type: array + * description: The price list's created. + * items: + * $ref: "#/components/schemas/AdminPrice" + * updated: + * type: array + * description: The price list's updated. + * items: + * $ref: "#/components/schemas/AdminPrice" + * deleted: + * type: object + * description: The price list's deleted. + * required: + * - ids + * - object + * - deleted + * properties: + * ids: + * type: array + * description: The deleted's ids. + * items: + * type: string + * title: ids + * description: The id's ids. + * object: + * type: string + * title: object + * description: The deleted's object. + * deleted: + * type: boolean + * title: deleted + * description: The deleted's details. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPriceListDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminPriceListDeleteResponse.ts new file mode 100644 index 0000000000..86af71105b --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPriceListDeleteResponse.ts @@ -0,0 +1,29 @@ +/** + * @schema AdminPriceListDeleteResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminPriceListDeleteResponse + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The price list's ID. + * object: + * type: string + * title: object + * description: The price list's object. + * default: price_list + * deleted: + * type: boolean + * title: deleted + * description: The price list's deleted. + * parent: + * type: object + * description: The price list's parent. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPriceListListResponse.ts b/www/utils/generated/oas-output/schemas/AdminPriceListListResponse.ts new file mode 100644 index 0000000000..d6f8168dfa --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPriceListListResponse.ts @@ -0,0 +1,31 @@ +/** + * @schema AdminPriceListListResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminPriceListListResponse + * required: + * - limit + * - offset + * - count + * - price_lists + * properties: + * limit: + * type: number + * title: limit + * description: The price list's limit. + * offset: + * type: number + * title: offset + * description: The price list's offset. + * count: + * type: number + * title: count + * description: The price list's count. + * price_lists: + * type: array + * description: The price list's price lists. + * items: + * $ref: "#/components/schemas/AdminPriceList" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPriceListPrice.ts b/www/utils/generated/oas-output/schemas/AdminPriceListPrice.ts new file mode 100644 index 0000000000..5b8c55dc40 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPriceListPrice.ts @@ -0,0 +1,76 @@ +/** + * @schema AdminPriceListPrice + * type: object + * description: The price's prices. + * x-schemaName: AdminPriceListPrice + * required: + * - variant_id + * - rules + * - id + * - title + * - currency_code + * - amount + * - raw_amount + * - min_quantity + * - max_quantity + * - price_set_id + * - created_at + * - updated_at + * - deleted_at + * properties: + * variant_id: + * type: string + * title: variant_id + * description: The price's variant id. + * rules: + * type: object + * description: The price's rules. + * id: + * type: string + * title: id + * description: The price's ID. + * title: + * type: string + * title: title + * description: The price's title. + * currency_code: + * type: string + * title: currency_code + * description: The price's currency code. + * amount: + * type: number + * title: amount + * description: The price's amount. + * raw_amount: + * type: object + * description: The price's raw amount. + * min_quantity: + * type: number + * title: min_quantity + * description: The price's min quantity. + * max_quantity: + * type: number + * title: max_quantity + * description: The price's max quantity. + * price_set_id: + * type: string + * title: price_set_id + * description: The price's price set id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The price's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The price's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The price's deleted at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPriceListResponse.ts b/www/utils/generated/oas-output/schemas/AdminPriceListResponse.ts new file mode 100644 index 0000000000..11b0fb3f7a --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPriceListResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminPriceListResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminPriceListResponse + * required: + * - price_list + * properties: + * price_list: + * $ref: "#/components/schemas/AdminPriceList" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPricePreference.ts b/www/utils/generated/oas-output/schemas/AdminPricePreference.ts new file mode 100644 index 0000000000..27ad7cfff9 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPricePreference.ts @@ -0,0 +1,48 @@ +/** + * @schema AdminPricePreference + * type: object + * description: The price preference's details. + * x-schemaName: AdminPricePreference + * required: + * - id + * - attribute + * - value + * - is_tax_inclusive + * - created_at + * - updated_at + * - deleted_at + * properties: + * id: + * type: string + * title: id + * description: The price preference's ID. + * attribute: + * type: string + * title: attribute + * description: The price preference's attribute. + * value: + * type: string + * title: value + * description: The price preference's value. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The price preference's is tax inclusive. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The price preference's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The price preference's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The price preference's deleted at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPricePreferenceDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminPricePreferenceDeleteResponse.ts new file mode 100644 index 0000000000..ab94d62720 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPricePreferenceDeleteResponse.ts @@ -0,0 +1,29 @@ +/** + * @schema AdminPricePreferenceDeleteResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminPricePreferenceDeleteResponse + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The price preference's ID. + * object: + * type: string + * title: object + * description: The price preference's object. + * default: price_preference + * deleted: + * type: boolean + * title: deleted + * description: The price preference's deleted. + * parent: + * type: object + * description: The price preference's parent. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPricePreferenceListResponse.ts b/www/utils/generated/oas-output/schemas/AdminPricePreferenceListResponse.ts new file mode 100644 index 0000000000..3f749ca8d7 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPricePreferenceListResponse.ts @@ -0,0 +1,31 @@ +/** + * @schema AdminPricePreferenceListResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminPricePreferenceListResponse + * required: + * - limit + * - offset + * - count + * - price_preferences + * properties: + * limit: + * type: number + * title: limit + * description: The price preference's limit. + * offset: + * type: number + * title: offset + * description: The price preference's offset. + * count: + * type: number + * title: count + * description: The price preference's count. + * price_preferences: + * type: array + * description: The price preference's price preferences. + * items: + * $ref: "#/components/schemas/AdminPricePreference" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPricePreferenceResponse.ts b/www/utils/generated/oas-output/schemas/AdminPricePreferenceResponse.ts new file mode 100644 index 0000000000..b36ce7c2fe --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPricePreferenceResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminPricePreferenceResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminPricePreferenceResponse + * required: + * - price_preference + * properties: + * price_preference: + * $ref: "#/components/schemas/AdminPricePreference" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProduct.ts b/www/utils/generated/oas-output/schemas/AdminProduct.ts index 0c9a536359..01e8b0d573 100644 --- a/www/utils/generated/oas-output/schemas/AdminProduct.ts +++ b/www/utils/generated/oas-output/schemas/AdminProduct.ts @@ -11,25 +11,25 @@ * - options * - description * - id - * - handle - * - hs_code - * - weight - * - height - * - width - * - origin_country - * - mid_code - * - material - * - thumbnail * - created_at * - updated_at - * - deleted_at + * - handle * - subtitle * - is_giftcard + * - thumbnail + * - width + * - weight + * - height + * - origin_country + * - hs_code + * - mid_code + * - material * - collection_id * - type_id * - images * - discountable * - external_id + * - deleted_at * properties: * collection: * $ref: "#/components/schemas/AdminCollection" @@ -86,42 +86,6 @@ * metadata: * type: object * description: The parent's metadata. - * handle: - * type: string - * title: handle - * description: The parent's handle. - * hs_code: - * type: string - * title: hs_code - * description: The parent's hs code. - * weight: - * type: number - * title: weight - * description: The parent's weight. - * height: - * type: number - * title: height - * description: The parent's height. - * width: - * type: number - * title: width - * description: The parent's width. - * origin_country: - * type: string - * title: origin_country - * description: The parent's origin country. - * mid_code: - * type: string - * title: mid_code - * description: The parent's mid code. - * material: - * type: string - * title: material - * description: The parent's material. - * thumbnail: - * type: string - * title: thumbnail - * description: The parent's thumbnail. * created_at: * type: string * format: date-time @@ -132,11 +96,10 @@ * format: date-time * title: updated_at * description: The parent's updated at. - * deleted_at: + * handle: * type: string - * format: date-time - * title: deleted_at - * description: The parent's deleted at. + * title: handle + * description: The parent's handle. * subtitle: * type: string * title: subtitle @@ -145,6 +108,38 @@ * type: boolean * title: is_giftcard * description: The parent's is giftcard. + * thumbnail: + * type: string + * title: thumbnail + * description: The parent's thumbnail. + * width: + * type: number + * title: width + * description: The parent's width. + * weight: + * type: number + * title: weight + * description: The parent's weight. + * height: + * type: number + * title: height + * description: The parent's height. + * origin_country: + * type: string + * title: origin_country + * description: The parent's origin country. + * hs_code: + * type: string + * title: hs_code + * description: The parent's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The parent's mid code. + * material: + * type: string + * title: material + * description: The parent's material. * collection_id: * type: string * title: collection_id @@ -166,6 +161,11 @@ * type: string * title: external_id * description: The parent's external id. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The parent's deleted at. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProductCategory.ts b/www/utils/generated/oas-output/schemas/AdminProductCategory.ts index 14ab051148..7b5ebe0b75 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductCategory.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductCategory.ts @@ -9,14 +9,14 @@ * - name * - description * - id - * - handle * - created_at * - updated_at + * - handle * - deleted_at - * - parent_category_id - * - is_internal * - is_active + * - is_internal * - rank + * - parent_category_id * properties: * category_children: * type: array @@ -42,10 +42,6 @@ * type: string * title: id * description: The category's ID. - * handle: - * type: string - * title: handle - * description: The category's handle. * created_at: * type: string * format: date-time @@ -56,27 +52,31 @@ * format: date-time * title: updated_at * description: The category's updated at. + * handle: + * type: string + * title: handle + * description: The category's handle. * deleted_at: * type: string * format: date-time * title: deleted_at * description: The category's deleted at. - * parent_category_id: - * type: string - * title: parent_category_id - * description: The category's parent category id. - * is_internal: - * type: boolean - * title: is_internal - * description: The category's is internal. * is_active: * type: boolean * title: is_active * description: The category's is active. + * is_internal: + * type: boolean + * title: is_internal + * description: The category's is internal. * rank: * type: number * title: rank * description: The category's rank. + * parent_category_id: + * type: string + * title: parent_category_id + * description: The category's parent category id. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProductCategoryDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductCategoryDeleteResponse.ts new file mode 100644 index 0000000000..4d6c4dd957 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductCategoryDeleteResponse.ts @@ -0,0 +1,29 @@ +/** + * @schema AdminProductCategoryDeleteResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminProductCategoryDeleteResponse + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The product category's ID. + * object: + * type: string + * title: object + * description: The product category's object. + * default: product_category + * deleted: + * type: boolean + * title: deleted + * description: The product category's deleted. + * parent: + * type: object + * description: The product category's parent. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductTagDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductTagDeleteResponse.ts new file mode 100644 index 0000000000..3d05f405de --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductTagDeleteResponse.ts @@ -0,0 +1,29 @@ +/** + * @schema AdminProductTagDeleteResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminProductTagDeleteResponse + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The product tag's ID. + * object: + * type: string + * title: object + * description: The product tag's object. + * default: product_tag + * deleted: + * type: boolean + * title: deleted + * description: The product tag's deleted. + * parent: + * type: object + * description: The product tag's parent. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductTagListResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductTagListResponse.ts new file mode 100644 index 0000000000..cc90912d2d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductTagListResponse.ts @@ -0,0 +1,31 @@ +/** + * @schema AdminProductTagListResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminProductTagListResponse + * required: + * - limit + * - offset + * - count + * - product_tags + * properties: + * limit: + * type: number + * title: limit + * description: The product tag's limit. + * offset: + * type: number + * title: offset + * description: The product tag's offset. + * count: + * type: number + * title: count + * description: The product tag's count. + * product_tags: + * type: array + * description: The product tag's product tags. + * items: + * $ref: "#/components/schemas/AdminProductTag" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductTagResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductTagResponse.ts new file mode 100644 index 0000000000..da9488bddb --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductTagResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminProductTagResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminProductTagResponse + * required: + * - product_tag + * properties: + * product_tag: + * $ref: "#/components/schemas/AdminProductTag" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductTypeDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductTypeDeleteResponse.ts new file mode 100644 index 0000000000..61a21e8e0b --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductTypeDeleteResponse.ts @@ -0,0 +1,29 @@ +/** + * @schema AdminProductTypeDeleteResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminProductTypeDeleteResponse + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The product type's ID. + * object: + * type: string + * title: object + * description: The product type's object. + * default: product_type + * deleted: + * type: boolean + * title: deleted + * description: The product type's deleted. + * parent: + * type: object + * description: The product type's parent. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductTypeListResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductTypeListResponse.ts new file mode 100644 index 0000000000..2b67c1ca65 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductTypeListResponse.ts @@ -0,0 +1,31 @@ +/** + * @schema AdminProductTypeListResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminProductTypeListResponse + * required: + * - limit + * - offset + * - count + * - product_types + * properties: + * limit: + * type: number + * title: limit + * description: The product type's limit. + * offset: + * type: number + * title: offset + * description: The product type's offset. + * count: + * type: number + * title: count + * description: The product type's count. + * product_types: + * type: array + * description: The product type's product types. + * items: + * $ref: "#/components/schemas/AdminProduct" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductTypeResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductTypeResponse.ts new file mode 100644 index 0000000000..41e1e92226 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductTypeResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminProductTypeResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminProductTypeResponse + * required: + * - product_type + * properties: + * product_type: + * $ref: "#/components/schemas/AdminProduct" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariant.ts b/www/utils/generated/oas-output/schemas/AdminProductVariant.ts index 99fa33c3cb..35e871610a 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductVariant.ts @@ -1,7 +1,7 @@ /** * @schema AdminProductVariant * type: object - * description: The updated's details. + * description: The product's parent. * x-schemaName: AdminProductVariant * required: * - prices @@ -28,80 +28,80 @@ * properties: * prices: * type: array - * description: The updated's prices. + * description: The parent's prices. * items: * $ref: "#/components/schemas/AdminPrice" * id: * type: string * title: id - * description: The updated's ID. + * description: The parent's ID. * title: * type: string * title: title - * description: The updated's title. + * description: The parent's title. * sku: * type: string * title: sku - * description: The updated's sku. + * description: The parent's sku. * barcode: * type: string * title: barcode - * description: The updated's barcode. + * description: The parent's barcode. * ean: * type: string * title: ean - * description: The updated's ean. + * description: The parent's ean. * upc: * type: string * title: upc - * description: The updated's upc. + * description: The parent's upc. * allow_backorder: * type: boolean * title: allow_backorder - * description: The updated's allow backorder. + * description: The parent's allow backorder. * manage_inventory: * type: boolean * title: manage_inventory - * description: The updated's manage inventory. + * description: The parent's manage inventory. * hs_code: * type: string * title: hs_code - * description: The updated's hs code. + * description: The parent's hs code. * origin_country: * type: string * title: origin_country - * description: The updated's origin country. + * description: The parent's origin country. * mid_code: * type: string * title: mid_code - * description: The updated's mid code. + * description: The parent's mid code. * material: * type: string * title: material - * description: The updated's material. + * description: The parent's material. * weight: * type: number * title: weight - * description: The updated's weight. + * description: The parent's weight. * length: * type: number * title: length - * description: The updated's length. + * description: The parent's length. * height: * type: number * title: height - * description: The updated's height. + * description: The parent's height. * width: * type: number * title: width - * description: The updated's width. + * description: The parent's width. * variant_rank: * type: number * title: variant_rank - * description: The updated's variant rank. + * description: The parent's variant rank. * options: * type: array - * description: The updated's options. + * description: The parent's options. * items: * $ref: "#/components/schemas/BaseProductOptionValue" * product: @@ -109,27 +109,27 @@ * product_id: * type: string * title: product_id - * description: The updated's product id. + * description: The parent's product id. * calculated_price: * $ref: "#/components/schemas/BaseCalculatedPriceSet" * created_at: * type: string * format: date-time * title: created_at - * description: The updated's created at. + * description: The parent's created at. * updated_at: * type: string * format: date-time * title: updated_at - * description: The updated's updated at. + * description: The parent's updated at. * deleted_at: * type: string * format: date-time * title: deleted_at - * description: The updated's deleted at. + * description: The parent's deleted at. * metadata: * type: object - * description: The updated's metadata. + * description: The parent's metadata. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryBatchResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryBatchResponse.ts new file mode 100644 index 0000000000..9772ba0ced --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryBatchResponse.ts @@ -0,0 +1,112 @@ +/** + * @schema AdminProductVariantInventoryBatchResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminProductVariantInventoryBatchResponse + * required: + * - created + * - updated + * - deleted + * properties: + * created: + * oneOf: + * - $ref: "#/components/schemas/AdminProductVariantInventoryLink" + * - type: array + * description: The product's created. + * items: + * type: object + * description: The created's details. + * x-schemaName: AdminProductVariantInventoryLink + * required: + * - productService + * - inventoryService + * properties: + * productService: + * type: object + * description: The created's productservice. + * required: + * - variant_id + * properties: + * variant_id: + * type: string + * title: variant_id + * description: The productservice's variant id. + * inventoryService: + * type: object + * description: The created's inventoryservice. + * required: + * - inventory_item_id + * properties: + * inventory_item_id: + * type: string + * title: inventory_item_id + * description: The inventoryservice's inventory item id. + * updated: + * oneOf: + * - $ref: "#/components/schemas/AdminProductVariantInventoryLink" + * - type: array + * description: The product's updated. + * items: + * type: object + * description: The updated's details. + * x-schemaName: AdminProductVariantInventoryLink + * required: + * - productService + * - inventoryService + * properties: + * productService: + * type: object + * description: The updated's productservice. + * required: + * - variant_id + * properties: + * variant_id: + * type: string + * title: variant_id + * description: The productservice's variant id. + * inventoryService: + * type: object + * description: The updated's inventoryservice. + * required: + * - inventory_item_id + * properties: + * inventory_item_id: + * type: string + * title: inventory_item_id + * description: The inventoryservice's inventory item id. + * deleted: + * oneOf: + * - $ref: "#/components/schemas/AdminProductVariantInventoryLink" + * - type: array + * description: The product's deleted. + * items: + * type: object + * description: The deleted's details. + * x-schemaName: AdminProductVariantInventoryLink + * required: + * - productService + * - inventoryService + * properties: + * productService: + * type: object + * description: The deleted's productservice. + * required: + * - variant_id + * properties: + * variant_id: + * type: string + * title: variant_id + * description: The productservice's variant id. + * inventoryService: + * type: object + * description: The deleted's inventoryservice. + * required: + * - inventory_item_id + * properties: + * inventory_item_id: + * type: string + * title: inventory_item_id + * description: The inventoryservice's inventory item id. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLink.ts b/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLink.ts new file mode 100644 index 0000000000..d07905b532 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLink.ts @@ -0,0 +1,32 @@ +/** + * @schema AdminProductVariantInventoryLink + * type: object + * description: The product's ID. + * x-schemaName: AdminProductVariantInventoryLink + * required: + * - productService + * - inventoryService + * properties: + * productService: + * type: object + * description: The id's productservice. + * required: + * - variant_id + * properties: + * variant_id: + * type: string + * title: variant_id + * description: The productservice's variant id. + * inventoryService: + * type: object + * description: The id's inventoryservice. + * required: + * - inventory_item_id + * properties: + * inventory_item_id: + * type: string + * title: inventory_item_id + * description: The inventoryservice's inventory item id. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLinkDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLinkDeleteResponse.ts new file mode 100644 index 0000000000..a827a21163 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLinkDeleteResponse.ts @@ -0,0 +1,26 @@ +/** + * @schema AdminProductVariantInventoryLinkDeleteResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminProductVariantInventoryLinkDeleteResponse + * required: + * - id + * - object + * - deleted + * - parent + * properties: + * id: + * $ref: "#/components/schemas/AdminProductVariantInventoryLink" + * object: + * type: string + * title: object + * description: The product's object. + * deleted: + * type: boolean + * title: deleted + * description: The product's deleted. + * parent: + * $ref: "#/components/schemas/AdminProductVariant" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts b/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts index 4d28c1d1dd..28b3498d8b 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts @@ -64,218 +64,20 @@ * type: array * description: The variant's $and. * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductVariantParams - * properties: - * q: - * type: string - * title: q - * description: The $and's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $and's ID. - * - type: array - * description: The $and's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * sku: - * oneOf: - * - type: string - * title: sku - * description: The $and's sku. - * - type: array - * description: The $and's sku. - * items: - * type: string - * title: sku - * description: The sku's details. - * product_id: - * oneOf: - * - type: string - * title: product_id - * description: The $and's product id. - * - type: array - * description: The $and's product id. - * items: - * type: string - * title: product_id - * description: The product id's details. - * options: - * type: object - * description: The $and's options. - * limit: - * type: number - * title: limit - * description: The $and's limit. - * offset: - * type: number - * title: offset - * description: The $and's offset. - * order: - * type: string - * title: order - * description: The $and's order. - * fields: - * type: string - * title: fields - * description: The $and's fields. - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductVariantParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductVariantParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $and's details. - * properties: - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductVariantParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductVariantParams - * - type: object - * description: The $or's details. + * type: array + * description: The $and's details. + * items: + * type: object + * title: $and * $or: * type: array * description: The variant's $or. * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductVariantParams - * properties: - * q: - * type: string - * title: q - * description: The $or's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $or's ID. - * - type: array - * description: The $or's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * sku: - * oneOf: - * - type: string - * title: sku - * description: The $or's sku. - * - type: array - * description: The $or's sku. - * items: - * type: string - * title: sku - * description: The sku's details. - * product_id: - * oneOf: - * - type: string - * title: product_id - * description: The $or's product id. - * - type: array - * description: The $or's product id. - * items: - * type: string - * title: product_id - * description: The product id's details. - * options: - * type: object - * description: The $or's options. - * limit: - * type: number - * title: limit - * description: The $or's limit. - * offset: - * type: number - * title: offset - * description: The $or's offset. - * order: - * type: string - * title: order - * description: The $or's order. - * fields: - * type: string - * title: fields - * description: The $or's fields. - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductVariantParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductVariantParams - * - type: object - * description: The $or's details. - * - type: object - * description: The $or's details. - * properties: - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: object - * description: The $and's details. - * x-schemaName: BaseProductVariantParams - * - type: object - * description: The $and's details. - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: object - * description: The $or's details. - * x-schemaName: BaseProductVariantParams - * - type: object - * description: The $or's details. + * type: array + * description: The $or's details. + * items: + * type: object + * title: $or * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPromotion.ts b/www/utils/generated/oas-output/schemas/AdminPromotion.ts new file mode 100644 index 0000000000..484390bde9 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPromotion.ts @@ -0,0 +1,41 @@ +/** + * @schema AdminPromotion + * type: object + * description: The promotion's details. + * x-schemaName: AdminPromotion + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The promotion's ID. + * code: + * type: string + * title: code + * description: The promotion's code. + * type: + * type: string + * enum: + * - standard + * - buyget + * is_automatic: + * type: boolean + * title: is_automatic + * description: The promotion's is automatic. + * application_method: + * $ref: "#/components/schemas/BaseApplicationMethod" + * rules: + * type: array + * description: The promotion's rules. + * items: + * $ref: "#/components/schemas/BasePromotionRule" + * campaign_id: + * type: string + * title: campaign_id + * description: The promotion's campaign id. + * campaign: + * $ref: "#/components/schemas/CampaignResponse" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPromotionResponse.ts b/www/utils/generated/oas-output/schemas/AdminPromotionResponse.ts new file mode 100644 index 0000000000..935970a177 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPromotionResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminPromotionResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminPromotionResponse + * required: + * - promotion + * properties: + * promotion: + * $ref: "#/components/schemas/AdminPromotion" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPromotionRule.ts b/www/utils/generated/oas-output/schemas/AdminPromotionRule.ts new file mode 100644 index 0000000000..608c5dc845 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPromotionRule.ts @@ -0,0 +1,39 @@ +/** + * @schema AdminPromotionRule + * type: object + * description: The updated's details. + * x-schemaName: AdminPromotionRule + * required: + * - id + * - values + * properties: + * id: + * type: string + * title: id + * description: The updated's ID. + * description: + * type: string + * title: description + * description: The updated's description. + * attribute: + * type: string + * title: attribute + * description: The updated's attribute. + * operator: + * type: string + * enum: + * - gt + * - lt + * - eq + * - ne + * - in + * - lte + * - gte + * values: + * type: array + * description: The updated's values. + * items: + * $ref: "#/components/schemas/BasePromotionRuleValue" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminRefundReason.ts b/www/utils/generated/oas-output/schemas/AdminRefundReason.ts new file mode 100644 index 0000000000..6069e4edf2 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminRefundReason.ts @@ -0,0 +1,40 @@ +/** + * @schema AdminRefundReason + * type: object + * description: The refund reason's details. + * x-schemaName: AdminRefundReason + * required: + * - id + * - label + * - metadata + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The refund reason's ID. + * label: + * type: string + * title: label + * description: The refund reason's label. + * description: + * type: string + * title: description + * description: The refund reason's description. + * metadata: + * type: object + * description: The refund reason's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The refund reason's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The refund reason's updated at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminRegion.ts b/www/utils/generated/oas-output/schemas/AdminRegion.ts new file mode 100644 index 0000000000..c78efe2930 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminRegion.ts @@ -0,0 +1,52 @@ +/** + * @schema AdminRegion + * type: object + * description: The region's details. + * x-schemaName: AdminRegion + * required: + * - id + * - name + * - currency_code + * properties: + * id: + * type: string + * title: id + * description: The region's ID. + * name: + * type: string + * title: name + * description: The region's name. + * currency_code: + * type: string + * title: currency_code + * description: The region's currency code. + * automatic_taxes: + * type: boolean + * title: automatic_taxes + * description: The region's automatic taxes. + * countries: + * type: array + * description: The region's countries. + * items: + * $ref: "#/components/schemas/BaseRegionCountry" + * payment_providers: + * type: array + * description: The region's payment providers. + * items: + * $ref: "#/components/schemas/AdminPaymentProvider" + * metadata: + * type: object + * description: The region's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The region's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The region's updated at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminRegionResponse.ts b/www/utils/generated/oas-output/schemas/AdminRegionResponse.ts new file mode 100644 index 0000000000..6273436e76 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminRegionResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminRegionResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminRegionResponse + * required: + * - region + * properties: + * region: + * $ref: "#/components/schemas/AdminRegion" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminReservationResponse.ts b/www/utils/generated/oas-output/schemas/AdminReservationResponse.ts new file mode 100644 index 0000000000..334c53328e --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminReservationResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminReservationResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminReservationResponse + * required: + * - reservation + * properties: + * reservation: + * $ref: "#/components/schemas/ReservationResponse" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminReturn.ts b/www/utils/generated/oas-output/schemas/AdminReturn.ts new file mode 100644 index 0000000000..f5f8c42fff --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminReturn.ts @@ -0,0 +1,71 @@ +/** + * @schema AdminReturn + * type: object + * description: The exchange's return. + * x-schemaName: AdminReturn + * required: + * - id + * - order_id + * - order_version + * - display_id + * - items + * - received_at + * - created_at + * properties: + * id: + * type: string + * title: id + * description: The return's ID. + * order_id: + * type: string + * title: order_id + * description: The return's order id. + * status: + * type: string + * title: status + * description: The return's status. + * exchange_id: + * type: string + * title: exchange_id + * description: The return's exchange id. + * location_id: + * type: string + * title: location_id + * description: The return's location id. + * claim_id: + * type: string + * title: claim_id + * description: The return's claim id. + * order_version: + * type: number + * title: order_version + * description: The return's order version. + * display_id: + * type: number + * title: display_id + * description: The return's display id. + * no_notification: + * type: boolean + * title: no_notification + * description: The return's no notification. + * refund_amount: + * type: number + * title: refund_amount + * description: The return's refund amount. + * items: + * type: array + * description: The return's items. + * items: + * $ref: "#/components/schemas/BaseReturnItem" + * received_at: + * type: string + * title: received_at + * description: The return's received at. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The return's created at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminReturnItem.ts b/www/utils/generated/oas-output/schemas/AdminReturnItem.ts new file mode 100644 index 0000000000..6f04c950b4 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminReturnItem.ts @@ -0,0 +1,46 @@ +/** + * @schema AdminReturnItem + * type: object + * description: The return item's return items. + * x-schemaName: AdminReturnItem + * required: + * - id + * - quantity + * - received_quantity + * - item_id + * - return_id + * properties: + * id: + * type: string + * title: id + * description: The return item's ID. + * quantity: + * type: number + * title: quantity + * description: The return item's quantity. + * received_quantity: + * type: number + * title: received_quantity + * description: The return item's received quantity. + * reason_id: + * type: string + * title: reason_id + * description: The return item's reason id. + * note: + * type: string + * title: note + * description: The return item's note. + * item_id: + * type: string + * title: item_id + * description: The return item's item id. + * return_id: + * type: string + * title: return_id + * description: The return item's return id. + * metadata: + * type: object + * description: The return item's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminReturnPreviewResponse.ts b/www/utils/generated/oas-output/schemas/AdminReturnPreviewResponse.ts new file mode 100644 index 0000000000..d81c9beaa6 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminReturnPreviewResponse.ts @@ -0,0 +1,16 @@ +/** + * @schema AdminReturnPreviewResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminReturnPreviewResponse + * required: + * - order_preview + * - return + * properties: + * order_preview: + * $ref: "#/components/schemas/AdminOrderPreview" + * return: + * $ref: "#/components/schemas/AdminReturn" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminReturnReason.ts b/www/utils/generated/oas-output/schemas/AdminReturnReason.ts new file mode 100644 index 0000000000..478db38f50 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminReturnReason.ts @@ -0,0 +1,44 @@ +/** + * @schema AdminReturnReason + * type: object + * description: The return reason's details. + * x-schemaName: AdminReturnReason + * required: + * - id + * - value + * - label + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The return reason's ID. + * value: + * type: string + * title: value + * description: The return reason's value. + * label: + * type: string + * title: label + * description: The return reason's label. + * description: + * type: string + * title: description + * description: The return reason's description. + * metadata: + * type: object + * description: The return reason's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The return reason's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The return reason's updated at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminReturnReasonListResponse.ts b/www/utils/generated/oas-output/schemas/AdminReturnReasonListResponse.ts new file mode 100644 index 0000000000..b3ace02bab --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminReturnReasonListResponse.ts @@ -0,0 +1,31 @@ +/** + * @schema AdminReturnReasonListResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminReturnReasonListResponse + * required: + * - limit + * - offset + * - count + * - return_reasons + * properties: + * limit: + * type: number + * title: limit + * description: The return reason's limit. + * offset: + * type: number + * title: offset + * description: The return reason's offset. + * count: + * type: number + * title: count + * description: The return reason's count. + * return_reasons: + * type: array + * description: The return reason's return reasons. + * items: + * $ref: "#/components/schemas/AdminReturnReason" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminReturnReasonResponse.ts b/www/utils/generated/oas-output/schemas/AdminReturnReasonResponse.ts new file mode 100644 index 0000000000..14b182e709 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminReturnReasonResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminReturnReasonResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminReturnReasonResponse + * required: + * - return_reason + * properties: + * return_reason: + * $ref: "#/components/schemas/AdminReturnReason" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminReturnResponse.ts b/www/utils/generated/oas-output/schemas/AdminReturnResponse.ts new file mode 100644 index 0000000000..6930b9be16 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminReturnResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminReturnResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminReturnResponse + * required: + * - return + * properties: + * return: + * $ref: "#/components/schemas/AdminReturn" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminRuleAttributeOption.ts b/www/utils/generated/oas-output/schemas/AdminRuleAttributeOption.ts new file mode 100644 index 0000000000..dff9aa7346 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminRuleAttributeOption.ts @@ -0,0 +1,46 @@ +/** + * @schema AdminRuleAttributeOption + * type: object + * description: The attribute's attributes. + * x-schemaName: AdminRuleAttributeOption + * required: + * - id + * - value + * - label + * - field_type + * - required + * - disguised + * - operators + * properties: + * id: + * type: string + * title: id + * description: The attribute's ID. + * value: + * type: string + * title: value + * description: The attribute's value. + * label: + * type: string + * title: label + * description: The attribute's label. + * field_type: + * type: string + * title: field_type + * description: The attribute's field type. + * required: + * type: boolean + * title: required + * description: The attribute's required. + * disguised: + * type: boolean + * title: disguised + * description: The attribute's disguised. + * operators: + * type: array + * description: The attribute's operators. + * items: + * $ref: "#/components/schemas/BaseRuleOperatorOptions" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminRuleValueOption.ts b/www/utils/generated/oas-output/schemas/AdminRuleValueOption.ts new file mode 100644 index 0000000000..71f8f2caf7 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminRuleValueOption.ts @@ -0,0 +1,25 @@ +/** + * @schema AdminRuleValueOption + * type: object + * description: The value's values. + * x-schemaName: AdminRuleValueOption + * required: + * - id + * - value + * - label + * properties: + * id: + * type: string + * title: id + * description: The value's ID. + * value: + * type: string + * title: value + * description: The value's details. + * label: + * type: string + * title: label + * description: The value's label. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminSalesChannelDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminSalesChannelDeleteResponse.ts new file mode 100644 index 0000000000..e3e3e6c1b7 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminSalesChannelDeleteResponse.ts @@ -0,0 +1,29 @@ +/** + * @schema AdminSalesChannelDeleteResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminSalesChannelDeleteResponse + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The sales channel's ID. + * object: + * type: string + * title: object + * description: The sales channel's object. + * default: sales-channel + * deleted: + * type: boolean + * title: deleted + * description: The sales channel's deleted. + * parent: + * type: object + * description: The sales channel's parent. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminSalesChannelResponse.ts b/www/utils/generated/oas-output/schemas/AdminSalesChannelResponse.ts new file mode 100644 index 0000000000..23b3e96355 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminSalesChannelResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminSalesChannelResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminSalesChannelResponse + * required: + * - sales_channel + * properties: + * sales_channel: + * $ref: "#/components/schemas/AdminSalesChannel" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminServiceZone.ts b/www/utils/generated/oas-output/schemas/AdminServiceZone.ts index e92883d568..5c6e2b6b82 100644 --- a/www/utils/generated/oas-output/schemas/AdminServiceZone.ts +++ b/www/utils/generated/oas-output/schemas/AdminServiceZone.ts @@ -7,6 +7,7 @@ * - id * - name * - fulfillment_set_id + * - fulfillment_set * - geo_zones * - shipping_options * - created_at @@ -25,6 +26,8 @@ * type: string * title: fulfillment_set_id * description: The service zone's fulfillment set id. + * fulfillment_set: + * $ref: "#/components/schemas/AdminFulfillmentSet" * geo_zones: * type: array * description: The service zone's geo zones. diff --git a/www/utils/generated/oas-output/schemas/AdminShippingOptionRule.ts b/www/utils/generated/oas-output/schemas/AdminShippingOptionRule.ts new file mode 100644 index 0000000000..19630fb8af --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminShippingOptionRule.ts @@ -0,0 +1,60 @@ +/** + * @schema AdminShippingOptionRule + * type: object + * description: The updated's details. + * x-schemaName: AdminShippingOptionRule + * required: + * - id + * - attribute + * - operator + * - value + * - shipping_option_id + * - created_at + * - updated_at + * - deleted_at + * properties: + * id: + * type: string + * title: id + * description: The updated's ID. + * attribute: + * type: string + * title: attribute + * description: The updated's attribute. + * operator: + * type: string + * title: operator + * description: The updated's operator. + * value: + * oneOf: + * - type: string + * title: value + * description: The updated's value. + * - type: array + * description: The updated's value. + * items: + * type: string + * title: value + * description: The value's details. + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The updated's shipping option id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The updated's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The updated's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The updated's deleted at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminStockLocation.ts b/www/utils/generated/oas-output/schemas/AdminStockLocation.ts new file mode 100644 index 0000000000..416b6e1fb0 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminStockLocation.ts @@ -0,0 +1,42 @@ +/** + * @schema AdminStockLocation + * type: object + * description: The fulfillment set's location. + * x-schemaName: AdminStockLocation + * required: + * - id + * - name + * - address_id + * properties: + * id: + * type: string + * title: id + * description: The location's ID. + * name: + * type: string + * title: name + * description: The location's name. + * address_id: + * type: string + * title: address_id + * description: The location's address id. + * address: + * $ref: "#/components/schemas/AdminStockLocationAddress" + * sales_channels: + * type: array + * description: The location's sales channels. + * items: + * $ref: "#/components/schemas/AdminSalesChannel" + * fulfillment_providers: + * type: array + * description: The location's fulfillment providers. + * items: + * $ref: "#/components/schemas/AdminFulfillmentProvider" + * fulfillment_sets: + * type: array + * description: The location's fulfillment sets. + * items: + * $ref: "#/components/schemas/AdminFulfillmentSet" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminStockLocationAddress.ts b/www/utils/generated/oas-output/schemas/AdminStockLocationAddress.ts new file mode 100644 index 0000000000..35a5bb6b39 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminStockLocationAddress.ts @@ -0,0 +1,8 @@ +/** + * @schema AdminStockLocationAddress + * type: object + * description: The location's address. + * x-schemaName: AdminStockLocationAddress + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminStockLocationDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminStockLocationDeleteResponse.ts new file mode 100644 index 0000000000..bc4209551d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminStockLocationDeleteResponse.ts @@ -0,0 +1,29 @@ +/** + * @schema AdminStockLocationDeleteResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminStockLocationDeleteResponse + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The stock location's ID. + * object: + * type: string + * title: object + * description: The stock location's object. + * default: stock_location + * deleted: + * type: boolean + * title: deleted + * description: The stock location's deleted. + * parent: + * type: object + * description: The stock location's parent. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminStockLocationListResponse.ts b/www/utils/generated/oas-output/schemas/AdminStockLocationListResponse.ts new file mode 100644 index 0000000000..af12caa18f --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminStockLocationListResponse.ts @@ -0,0 +1,31 @@ +/** + * @schema AdminStockLocationListResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminStockLocationListResponse + * required: + * - limit + * - offset + * - count + * - stock_locations + * properties: + * limit: + * type: number + * title: limit + * description: The stock location's limit. + * offset: + * type: number + * title: offset + * description: The stock location's offset. + * count: + * type: number + * title: count + * description: The stock location's count. + * stock_locations: + * type: array + * description: The stock location's stock locations. + * items: + * $ref: "#/components/schemas/AdminStockLocation" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminStockLocationResponse.ts b/www/utils/generated/oas-output/schemas/AdminStockLocationResponse.ts new file mode 100644 index 0000000000..ae3f2ba1a0 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminStockLocationResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminStockLocationResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminStockLocationResponse + * required: + * - stock_location + * properties: + * stock_location: + * $ref: "#/components/schemas/AdminStockLocation" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminStore.ts b/www/utils/generated/oas-output/schemas/AdminStore.ts new file mode 100644 index 0000000000..0fe1850546 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminStore.ts @@ -0,0 +1,57 @@ +/** + * @schema AdminStore + * type: object + * description: The store's details. + * x-schemaName: AdminStore + * required: + * - id + * - name + * - supported_currencies + * - default_sales_channel_id + * - default_region_id + * - default_location_id + * - metadata + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The store's ID. + * name: + * type: string + * title: name + * description: The store's name. + * supported_currencies: + * type: array + * description: The store's supported currencies. + * items: + * $ref: "#/components/schemas/AdminStoreCurrency" + * default_sales_channel_id: + * type: string + * title: default_sales_channel_id + * description: The store's default sales channel id. + * default_region_id: + * type: string + * title: default_region_id + * description: The store's default region id. + * default_location_id: + * type: string + * title: default_location_id + * description: The store's default location id. + * metadata: + * type: object + * description: The store's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The store's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The store's updated at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminStoreCurrency.ts b/www/utils/generated/oas-output/schemas/AdminStoreCurrency.ts new file mode 100644 index 0000000000..3290080524 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminStoreCurrency.ts @@ -0,0 +1,51 @@ +/** + * @schema AdminStoreCurrency + * type: object + * description: The supported currency's supported currencies. + * x-schemaName: AdminStoreCurrency + * required: + * - id + * - currency_code + * - store_id + * - is_default + * - currency + * - created_at + * - updated_at + * - deleted_at + * properties: + * id: + * type: string + * title: id + * description: The supported currency's ID. + * currency_code: + * type: string + * title: currency_code + * description: The supported currency's currency code. + * store_id: + * type: string + * title: store_id + * description: The supported currency's store id. + * is_default: + * type: boolean + * title: is_default + * description: The supported currency's is default. + * currency: + * $ref: "#/components/schemas/AdminCurrency" + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The supported currency's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The supported currency's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The supported currency's deleted at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminStoreListResponse.ts b/www/utils/generated/oas-output/schemas/AdminStoreListResponse.ts new file mode 100644 index 0000000000..92ec2bf842 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminStoreListResponse.ts @@ -0,0 +1,31 @@ +/** + * @schema AdminStoreListResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminStoreListResponse + * required: + * - limit + * - offset + * - count + * - stores + * properties: + * limit: + * type: number + * title: limit + * description: The store's limit. + * offset: + * type: number + * title: offset + * description: The store's offset. + * count: + * type: number + * title: count + * description: The store's count. + * stores: + * type: array + * description: The store's stores. + * items: + * $ref: "#/components/schemas/AdminStore" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminStoreResponse.ts b/www/utils/generated/oas-output/schemas/AdminStoreResponse.ts new file mode 100644 index 0000000000..0fec32274a --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminStoreResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminStoreResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminStoreResponse + * required: + * - store + * properties: + * store: + * $ref: "#/components/schemas/AdminStore" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminTaxRate.ts b/www/utils/generated/oas-output/schemas/AdminTaxRate.ts new file mode 100644 index 0000000000..f600bcf4f4 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminTaxRate.ts @@ -0,0 +1,81 @@ +/** + * @schema AdminTaxRate + * type: object + * description: The tax rate's details. + * x-schemaName: AdminTaxRate + * required: + * - id + * - rate + * - code + * - name + * - metadata + * - tax_region_id + * - is_combinable + * - is_default + * - created_at + * - updated_at + * - deleted_at + * - created_by + * - tax_region + * - rules + * properties: + * id: + * type: string + * title: id + * description: The tax rate's ID. + * rate: + * type: number + * title: rate + * description: The tax rate's rate. + * code: + * type: string + * title: code + * description: The tax rate's code. + * name: + * type: string + * title: name + * description: The tax rate's name. + * metadata: + * type: object + * description: The tax rate's metadata. + * tax_region_id: + * type: string + * title: tax_region_id + * description: The tax rate's tax region id. + * is_combinable: + * type: boolean + * title: is_combinable + * description: The tax rate's is combinable. + * is_default: + * type: boolean + * title: is_default + * description: The tax rate's is default. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The tax rate's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The tax rate's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The tax rate's deleted at. + * created_by: + * type: string + * title: created_by + * description: The tax rate's created by. + * tax_region: + * $ref: "#/components/schemas/AdminTaxRegion" + * rules: + * type: array + * description: The tax rate'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 new file mode 100644 index 0000000000..060d0a1b88 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminTaxRateDeleteResponse.ts @@ -0,0 +1,29 @@ +/** + * @schema AdminTaxRateDeleteResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminTaxRateDeleteResponse + * 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. + * default: tax_rate + * deleted: + * type: boolean + * title: deleted + * description: The tax rate's deleted. + * parent: + * type: object + * description: The tax rate's parent. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminTaxRateResponse.ts b/www/utils/generated/oas-output/schemas/AdminTaxRateResponse.ts new file mode 100644 index 0000000000..d360d93b09 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminTaxRateResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminTaxRateResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminTaxRateResponse + * required: + * - tax_rate + * properties: + * tax_rate: + * $ref: "#/components/schemas/AdminTaxRate" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminTaxRateRule.ts b/www/utils/generated/oas-output/schemas/AdminTaxRateRule.ts new file mode 100644 index 0000000000..1399a883cb --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminTaxRateRule.ts @@ -0,0 +1,20 @@ +/** + * @schema AdminTaxRateRule + * type: object + * description: The rule's rules. + * x-schemaName: AdminTaxRateRule + * 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. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminTaxRegion.ts b/www/utils/generated/oas-output/schemas/AdminTaxRegion.ts new file mode 100644 index 0000000000..604a353638 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminTaxRegion.ts @@ -0,0 +1,102 @@ +/** + * @schema AdminTaxRegion + * type: object + * description: The tax rate's tax region. + * x-schemaName: AdminTaxRegion + * required: + * - id + * - rate + * - code + * - country_code + * - province_code + * - name + * - metadata + * - tax_region_id + * - is_combinable + * - is_default + * - parent_id + * - created_at + * - updated_at + * - deleted_at + * - created_by + * - tax_rates + * - parent + * - children + * properties: + * id: + * type: string + * title: id + * description: The tax region's ID. + * rate: + * type: number + * title: rate + * description: The tax region's rate. + * code: + * type: string + * title: code + * description: The tax region's code. + * country_code: + * type: string + * title: country_code + * description: The tax region's country code. + * province_code: + * type: string + * title: province_code + * description: The tax region's province code. + * name: + * type: string + * title: name + * description: The tax region's name. + * metadata: + * type: object + * description: The tax region's metadata. + * tax_region_id: + * type: string + * title: tax_region_id + * description: The tax region's tax region id. + * is_combinable: + * type: boolean + * title: is_combinable + * description: The tax region's is combinable. + * is_default: + * type: boolean + * title: is_default + * description: The tax region's is default. + * parent_id: + * type: string + * title: parent_id + * description: The tax region's parent id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The tax region's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The tax region's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The tax region's deleted at. + * created_by: + * type: string + * title: created_by + * description: The tax region's created by. + * tax_rates: + * type: array + * description: The tax region's tax rates. + * items: + * $ref: "#/components/schemas/AdminTaxRate" + * parent: + * $ref: "#/components/schemas/AdminTaxRegion" + * children: + * type: array + * description: The tax region's children. + * items: + * $ref: "#/components/schemas/AdminTaxRegion" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminTaxRegionDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminTaxRegionDeleteResponse.ts new file mode 100644 index 0000000000..1b2e446f72 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminTaxRegionDeleteResponse.ts @@ -0,0 +1,29 @@ +/** + * @schema AdminTaxRegionDeleteResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminTaxRegionDeleteResponse + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The tax region's ID. + * object: + * type: string + * title: object + * description: The tax region's object. + * default: tax_region + * deleted: + * type: boolean + * title: deleted + * description: The tax region's deleted. + * parent: + * type: object + * description: The tax region's parent. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminTaxRegionResponse.ts b/www/utils/generated/oas-output/schemas/AdminTaxRegionResponse.ts new file mode 100644 index 0000000000..a4ad374475 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminTaxRegionResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminTaxRegionResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminTaxRegionResponse + * required: + * - tax_region + * properties: + * tax_region: + * $ref: "#/components/schemas/AdminTaxRegion" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateCustomer.ts b/www/utils/generated/oas-output/schemas/AdminUpdateCustomer.ts deleted file mode 100644 index e2bd3514e2..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminUpdateCustomer.ts +++ /dev/null @@ -1,40 +0,0 @@ -/** - * @schema AdminUpdateCustomer - * type: object - * description: SUMMARY - * x-schemaName: AdminUpdateCustomer - * required: - * - email - * - company_name - * - first_name - * - last_name - * - phone - * - metadata - * properties: - * email: - * type: string - * title: email - * description: The customer's email. - * format: email - * company_name: - * type: string - * title: company_name - * description: The customer's company name. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * phone: - * 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/AdminUpdateProduct.ts b/www/utils/generated/oas-output/schemas/AdminUpdateProduct.ts index a84078f2ad..3cb22c68a4 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateProduct.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateProduct.ts @@ -79,15 +79,13 @@ * items: * type: object * description: The tag's tags. + * required: + * - id * properties: * id: * type: string * title: id * description: The tag's ID. - * value: - * type: string - * title: value - * description: The tag's value. * options: * type: array * description: The update's options. @@ -97,7 +95,168 @@ * type: array * description: The update's variants. * items: - * $ref: "#/components/schemas/AdminCreateProductVariant" + * oneOf: + * - type: object + * description: The variant's variants. + * x-schemaName: AdminCreateProductVariant + * required: + * - title + * - prices + * properties: + * title: + * type: string + * title: title + * description: The variant's title. + * sku: + * type: string + * title: sku + * description: The variant's sku. + * ean: + * type: string + * title: ean + * description: The variant's ean. + * upc: + * type: string + * title: upc + * description: The variant's upc. + * barcode: + * type: string + * title: barcode + * description: The variant's barcode. + * hs_code: + * type: string + * title: hs_code + * description: The variant's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The variant's mid code. + * allow_backorder: + * type: boolean + * title: allow_backorder + * description: The variant's allow backorder. + * manage_inventory: + * type: boolean + * title: manage_inventory + * description: The variant's manage inventory. + * variant_rank: + * type: number + * title: variant_rank + * description: The variant's variant rank. + * weight: + * type: number + * title: weight + * description: The variant's weight. + * length: + * type: number + * title: length + * description: The variant's length. + * height: + * type: number + * title: height + * description: The variant's height. + * width: + * type: number + * title: width + * description: The variant's width. + * origin_country: + * type: string + * title: origin_country + * description: The variant's origin country. + * material: + * type: string + * title: material + * description: The variant's material. + * metadata: + * type: object + * description: The variant's metadata. + * prices: + * type: array + * description: The variant's prices. + * items: + * $ref: "#/components/schemas/AdminCreateProductVariantPrice" + * options: + * type: object + * description: The variant's options. + * - type: object + * description: The variant's variants. + * x-schemaName: AdminUpdateProductVariant + * properties: + * title: + * type: string + * title: title + * description: The variant's title. + * sku: + * type: string + * title: sku + * description: The variant's sku. + * ean: + * type: string + * title: ean + * description: The variant's ean. + * upc: + * type: string + * title: upc + * description: The variant's upc. + * barcode: + * type: string + * title: barcode + * description: The variant's barcode. + * hs_code: + * type: string + * title: hs_code + * description: The variant's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The variant's mid code. + * allow_backorder: + * type: boolean + * title: allow_backorder + * description: The variant's allow backorder. + * manage_inventory: + * type: boolean + * title: manage_inventory + * description: The variant's manage inventory. + * variant_rank: + * type: number + * title: variant_rank + * description: The variant's variant rank. + * weight: + * type: number + * title: weight + * description: The variant's weight. + * length: + * type: number + * title: length + * description: The variant's length. + * height: + * type: number + * title: height + * description: The variant's height. + * width: + * type: number + * title: width + * description: The variant's width. + * origin_country: + * type: string + * title: origin_country + * description: The variant's origin country. + * material: + * type: string + * title: material + * description: The variant's material. + * metadata: + * type: object + * description: The variant's metadata. + * prices: + * type: array + * description: The variant's prices. + * items: + * $ref: "#/components/schemas/AdminCreateProductVariantPrice" + * options: + * type: object + * description: The variant's options. * sales_channels: * type: array * description: The update's sales channels. diff --git a/www/utils/generated/oas-output/schemas/AdminUser.ts b/www/utils/generated/oas-output/schemas/AdminUser.ts new file mode 100644 index 0000000000..113e076e19 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUser.ts @@ -0,0 +1,58 @@ +/** + * @schema AdminUser + * type: object + * description: The user's details. + * x-schemaName: AdminUser + * required: + * - id + * - email + * - first_name + * - last_name + * - avatar_url + * - metadata + * - created_at + * - updated_at + * - deleted_at + * properties: + * id: + * type: string + * title: id + * description: The user's ID. + * email: + * type: string + * title: email + * description: The user's email. + * format: email + * first_name: + * type: string + * title: first_name + * description: The user's first name. + * last_name: + * type: string + * title: last_name + * description: The user's last name. + * avatar_url: + * type: string + * title: avatar_url + * description: The user's avatar url. + * metadata: + * type: object + * description: The user's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The user's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The user's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The user's deleted at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUserDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminUserDeleteResponse.ts new file mode 100644 index 0000000000..250e24c82a --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUserDeleteResponse.ts @@ -0,0 +1,29 @@ +/** + * @schema AdminUserDeleteResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminUserDeleteResponse + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The user's ID. + * object: + * type: string + * title: object + * description: The user's object. + * default: user + * deleted: + * type: boolean + * title: deleted + * description: The user's deleted. + * parent: + * type: object + * description: The user's parent. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUserListResponse.ts b/www/utils/generated/oas-output/schemas/AdminUserListResponse.ts new file mode 100644 index 0000000000..8b13f830fa --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUserListResponse.ts @@ -0,0 +1,31 @@ +/** + * @schema AdminUserListResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminUserListResponse + * required: + * - limit + * - offset + * - count + * - users + * properties: + * limit: + * type: number + * title: limit + * description: The user's limit. + * offset: + * type: number + * title: offset + * description: The user's offset. + * count: + * type: number + * title: count + * description: The user's count. + * users: + * type: array + * description: The user's users. + * items: + * $ref: "#/components/schemas/AdminUser" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUserResponse.ts b/www/utils/generated/oas-output/schemas/AdminUserResponse.ts new file mode 100644 index 0000000000..372c21bbfb --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUserResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminUserResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminUserResponse + * required: + * - user + * properties: + * user: + * $ref: "#/components/schemas/AdminUser" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminWorkflowExecution.ts b/www/utils/generated/oas-output/schemas/AdminWorkflowExecution.ts new file mode 100644 index 0000000000..77765f24f2 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminWorkflowExecution.ts @@ -0,0 +1,55 @@ +/** + * @schema AdminWorkflowExecution + * type: object + * description: The workflows execution's workflow execution. + * x-schemaName: AdminWorkflowExecution + * required: + * - id + * - workflow_id + * - transaction_id + * - execution + * - context + * - state + * - created_at + * - updated_at + * - deleted_at + * properties: + * id: + * type: string + * title: id + * description: The workflow execution's ID. + * workflow_id: + * type: string + * title: workflow_id + * description: The workflow execution's workflow id. + * transaction_id: + * type: string + * title: transaction_id + * description: The workflow execution's transaction id. + * execution: + * type: string + * title: execution + * description: The workflow execution's execution. + * context: + * type: string + * title: context + * description: The workflow execution's context. + * state: {} + * created_at: + * type: string + * title: created_at + * description: The workflow execution's created at. + * format: date-time + * updated_at: + * type: string + * title: updated_at + * description: The workflow execution's updated at. + * format: date-time + * deleted_at: + * type: string + * title: deleted_at + * description: The workflow execution's deleted at. + * format: date-time + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminWorkflowExecutionResponse.ts b/www/utils/generated/oas-output/schemas/AdminWorkflowExecutionResponse.ts new file mode 100644 index 0000000000..0436d3b49f --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminWorkflowExecutionResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminWorkflowExecutionResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminWorkflowExecutionResponse + * required: + * - workflow_execution + * properties: + * workflow_execution: + * $ref: "#/components/schemas/AdminWorkflowExecution" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/ApiKeyResponse.ts b/www/utils/generated/oas-output/schemas/ApiKeyResponse.ts new file mode 100644 index 0000000000..9a2a273c09 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/ApiKeyResponse.ts @@ -0,0 +1,64 @@ +/** + * @schema ApiKeyResponse + * type: object + * description: The api key's details. + * x-schemaName: ApiKeyResponse + * required: + * - id + * - token + * - redacted + * - title + * - type + * - last_used_at + * - created_by + * - created_at + * - revoked_by + * - revoked_at + * properties: + * id: + * type: string + * title: id + * description: The api key's ID. + * token: + * type: string + * title: token + * description: The api key's token. + * redacted: + * type: string + * title: redacted + * description: The api key's redacted. + * title: + * type: string + * title: title + * description: The api key's title. + * type: + * type: string + * enum: + * - secret + * - publishable + * last_used_at: + * type: string + * title: last_used_at + * description: The api key's last used at. + * format: date-time + * created_by: + * type: string + * title: created_by + * description: The api key's created by. + * created_at: + * type: string + * title: created_at + * description: The api key's created at. + * format: date-time + * revoked_by: + * type: string + * title: revoked_by + * description: The api key's revoked by. + * revoked_at: + * type: string + * title: revoked_at + * description: The api key's revoked at. + * format: date-time + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseApplicationMethod.ts b/www/utils/generated/oas-output/schemas/BaseApplicationMethod.ts new file mode 100644 index 0000000000..80acc3f30e --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseApplicationMethod.ts @@ -0,0 +1,63 @@ +/** + * @schema BaseApplicationMethod + * type: object + * description: The promotion's application method. + * x-schemaName: BaseApplicationMethod + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The application method's ID. + * type: + * type: string + * enum: + * - fixed + * - percentage + * target_type: + * type: string + * enum: + * - items + * - shipping_methods + * - order + * allocation: + * type: string + * enum: + * - each + * - across + * 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. + * buy_rules_min_quantity: + * type: number + * title: buy_rules_min_quantity + * description: The application method's buy rules min quantity. + * apply_to_quantity: + * type: number + * title: apply_to_quantity + * description: The application method's apply to quantity. + * promotion: + * $ref: "#/components/schemas/BasePromotion" + * target_rules: + * type: array + * description: The application method's target rules. + * items: + * $ref: "#/components/schemas/BasePromotionRule" + * buy_rules: + * type: array + * description: The application method's buy rules. + * items: + * $ref: "#/components/schemas/BasePromotionRule" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts b/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts index 9c889a07fb..9e5fa413ef 100644 --- a/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts +++ b/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts @@ -1,7 +1,7 @@ /** * @schema BaseCalculatedPriceSet * type: object - * description: The updated's calculated price. + * description: The parent's calculated price. * x-schemaName: BaseCalculatedPriceSet * required: * - id diff --git a/www/utils/generated/oas-output/schemas/BaseCapture.ts b/www/utils/generated/oas-output/schemas/BaseCapture.ts new file mode 100644 index 0000000000..e29d3f62cd --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseCapture.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseCapture + * type: object + * description: The capture's captures. + * x-schemaName: BaseCapture + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseCart.ts b/www/utils/generated/oas-output/schemas/BaseCart.ts new file mode 100644 index 0000000000..8a803c5b48 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseCart.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseCart + * type: object + * description: The item's cart. + * x-schemaName: BaseCart + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseCartAddress.ts b/www/utils/generated/oas-output/schemas/BaseCartAddress.ts new file mode 100644 index 0000000000..4fff43dbda --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseCartAddress.ts @@ -0,0 +1,74 @@ +/** + * @schema BaseCartAddress + * type: object + * description: The cart's billing address. + * x-schemaName: BaseCartAddress + * required: + * - id + * - created_at + * - updated_at + * properties: + * 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/BaseCartLineItem.ts b/www/utils/generated/oas-output/schemas/BaseCartLineItem.ts new file mode 100644 index 0000000000..7e63caa9d2 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseCartLineItem.ts @@ -0,0 +1,311 @@ +/** + * @schema BaseCartLineItem + * type: object + * description: The item's items. + * x-schemaName: BaseCartLineItem + * required: + * - id + * - title + * - quantity + * - requires_shipping + * - is_discountable + * - is_tax_inclusive + * - unit_price + * - cart + * - cart_id + * - original_total + * - original_subtotal + * - original_tax_total + * - item_total + * - item_subtotal + * - item_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * title: + * type: string + * title: title + * description: The item's title. + * subtitle: + * type: string + * title: subtitle + * description: The item's subtitle. + * thumbnail: + * type: string + * title: thumbnail + * description: The item's thumbnail. + * quantity: + * oneOf: + * - type: string + * title: quantity + * description: The item's quantity. + * - type: number + * title: quantity + * description: The item's quantity. + * - type: string + * title: quantity + * description: The item's quantity. + * - $ref: "#/components/schemas/IBigNumber" + * product: + * $ref: "#/components/schemas/BaseProduct" + * product_id: + * type: string + * title: product_id + * description: The item's product id. + * product_title: + * type: string + * title: product_title + * description: The item's product title. + * product_description: + * type: string + * title: product_description + * description: The item's product description. + * product_subtitle: + * type: string + * title: product_subtitle + * description: The item's product subtitle. + * product_type: + * type: string + * title: product_type + * description: The item's product type. + * product_collection: + * type: string + * title: product_collection + * description: The item's product collection. + * product_handle: + * type: string + * title: product_handle + * description: The item's product handle. + * variant: + * $ref: "#/components/schemas/BaseProductVariant" + * variant_id: + * type: string + * title: variant_id + * description: The item's variant id. + * variant_sku: + * type: string + * title: variant_sku + * description: The item's variant sku. + * variant_barcode: + * type: string + * title: variant_barcode + * description: The item's variant barcode. + * variant_title: + * type: string + * title: variant_title + * description: The item's variant title. + * variant_option_values: + * type: object + * description: The item's variant option values. + * requires_shipping: + * type: boolean + * title: requires_shipping + * description: The item's requires shipping. + * is_discountable: + * type: boolean + * title: is_discountable + * description: The item's is discountable. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The item's is tax inclusive. + * compare_at_unit_price: + * oneOf: + * - type: string + * title: compare_at_unit_price + * description: The item's compare at unit price. + * - type: number + * title: compare_at_unit_price + * description: The item's compare at unit price. + * - type: string + * title: compare_at_unit_price + * description: The item's compare at unit price. + * - $ref: "#/components/schemas/IBigNumber" + * unit_price: + * oneOf: + * - type: string + * title: unit_price + * description: The item's unit price. + * - type: number + * title: unit_price + * description: The item's unit price. + * - type: string + * title: unit_price + * description: The item's unit price. + * - $ref: "#/components/schemas/IBigNumber" + * tax_lines: + * type: array + * description: The item's tax lines. + * items: + * $ref: "#/components/schemas/BaseLineItemTaxLine" + * adjustments: + * type: array + * description: The item's adjustments. + * items: + * $ref: "#/components/schemas/BaseLineItemAdjustment" + * cart: + * $ref: "#/components/schemas/BaseCart" + * cart_id: + * type: string + * title: cart_id + * description: The item's cart id. + * metadata: + * type: object + * description: The item's metadata. + * created_at: + * type: string + * title: created_at + * description: The item's created at. + * format: date-time + * updated_at: + * type: string + * title: updated_at + * description: The item's updated at. + * format: date-time + * deleted_at: + * type: string + * title: deleted_at + * description: The item's deleted at. + * format: date-time + * original_total: + * oneOf: + * - type: string + * title: original_total + * description: The item's original total. + * - type: number + * title: original_total + * description: The item's original total. + * - type: string + * title: original_total + * description: The item's original total. + * - $ref: "#/components/schemas/IBigNumber" + * original_subtotal: + * oneOf: + * - type: string + * title: original_subtotal + * description: The item's original subtotal. + * - type: number + * title: original_subtotal + * description: The item's original subtotal. + * - type: string + * title: original_subtotal + * description: The item's original subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * original_tax_total: + * oneOf: + * - type: string + * title: original_tax_total + * description: The item's original tax total. + * - type: number + * title: original_tax_total + * description: The item's original tax total. + * - type: string + * title: original_tax_total + * description: The item's original tax total. + * - $ref: "#/components/schemas/IBigNumber" + * item_total: + * oneOf: + * - type: string + * title: item_total + * description: The item's item total. + * - type: number + * title: item_total + * description: The item's item total. + * - type: string + * title: item_total + * description: The item's item total. + * - $ref: "#/components/schemas/IBigNumber" + * item_subtotal: + * oneOf: + * - type: string + * title: item_subtotal + * description: The item's item subtotal. + * - type: number + * title: item_subtotal + * description: The item's item subtotal. + * - type: string + * title: item_subtotal + * description: The item's item subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * item_tax_total: + * oneOf: + * - type: string + * title: item_tax_total + * description: The item's item tax total. + * - type: number + * title: item_tax_total + * description: The item's item tax total. + * - type: string + * title: item_tax_total + * description: The item's item tax total. + * - $ref: "#/components/schemas/IBigNumber" + * total: + * oneOf: + * - type: string + * title: total + * description: The item's total. + * - type: number + * title: total + * description: The item's total. + * - type: string + * title: total + * description: The item's total. + * - $ref: "#/components/schemas/IBigNumber" + * subtotal: + * oneOf: + * - type: string + * title: subtotal + * description: The item's subtotal. + * - type: number + * title: subtotal + * description: The item's subtotal. + * - type: string + * title: subtotal + * description: The item's subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * tax_total: + * oneOf: + * - type: string + * title: tax_total + * description: The item's tax total. + * - type: number + * title: tax_total + * description: The item's tax total. + * - type: string + * title: tax_total + * description: The item's tax total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_total: + * oneOf: + * - type: string + * title: discount_total + * description: The item's discount total. + * - type: number + * title: discount_total + * description: The item's discount total. + * - type: string + * title: discount_total + * description: The item's discount total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_tax_total: + * oneOf: + * - type: string + * title: discount_tax_total + * description: The item's discount tax total. + * - type: number + * title: discount_tax_total + * description: The item's discount tax total. + * - type: string + * title: discount_tax_total + * description: The item's discount tax total. + * - $ref: "#/components/schemas/IBigNumber" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseCartShippingMethod.ts b/www/utils/generated/oas-output/schemas/BaseCartShippingMethod.ts new file mode 100644 index 0000000000..679b289dc4 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseCartShippingMethod.ts @@ -0,0 +1,183 @@ +/** + * @schema BaseCartShippingMethod + * type: object + * description: The shipping method's shipping methods. + * x-schemaName: BaseCartShippingMethod + * required: + * - id + * - cart_id + * - name + * - amount + * - is_tax_inclusive + * - created_at + * - updated_at + * - original_total + * - original_subtotal + * - original_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * properties: + * id: + * type: string + * title: id + * description: The shipping method's ID. + * cart_id: + * type: string + * title: cart_id + * description: The shipping method's cart id. + * name: + * type: string + * title: name + * description: The shipping method's name. + * description: + * type: string + * title: description + * description: The shipping method's description. + * amount: + * oneOf: + * - type: string + * title: amount + * description: The shipping method's amount. + * - type: number + * title: amount + * description: The shipping method's amount. + * - type: string + * title: amount + * description: The shipping method's amount. + * - $ref: "#/components/schemas/IBigNumber" + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The shipping method's is tax inclusive. + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The shipping method's shipping option id. + * data: + * type: object + * description: The shipping method's data. + * metadata: + * type: object + * description: The shipping method's metadata. + * tax_lines: + * type: array + * description: The shipping method's tax lines. + * items: + * $ref: "#/components/schemas/BaseShippingMethodTaxLine" + * adjustments: + * type: array + * description: The shipping method's adjustments. + * items: + * $ref: "#/components/schemas/BaseShippingMethodAdjustment" + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The shipping method's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The shipping method's updated at. + * original_total: + * oneOf: + * - type: string + * title: original_total + * description: The shipping method's original total. + * - type: number + * title: original_total + * description: The shipping method's original total. + * - type: string + * title: original_total + * description: The shipping method's original total. + * - $ref: "#/components/schemas/IBigNumber" + * original_subtotal: + * oneOf: + * - type: string + * title: original_subtotal + * description: The shipping method's original subtotal. + * - type: number + * title: original_subtotal + * description: The shipping method's original subtotal. + * - type: string + * title: original_subtotal + * description: The shipping method's original subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * original_tax_total: + * oneOf: + * - type: string + * title: original_tax_total + * description: The shipping method's original tax total. + * - type: number + * title: original_tax_total + * description: The shipping method's original tax total. + * - type: string + * title: original_tax_total + * description: The shipping method's original tax total. + * - $ref: "#/components/schemas/IBigNumber" + * total: + * oneOf: + * - type: string + * title: total + * description: The shipping method's total. + * - type: number + * title: total + * description: The shipping method's total. + * - type: string + * title: total + * description: The shipping method's total. + * - $ref: "#/components/schemas/IBigNumber" + * subtotal: + * oneOf: + * - type: string + * title: subtotal + * description: The shipping method's subtotal. + * - type: number + * title: subtotal + * description: The shipping method's subtotal. + * - type: string + * title: subtotal + * description: The shipping method's subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * tax_total: + * oneOf: + * - type: string + * title: tax_total + * description: The shipping method's tax total. + * - type: number + * title: tax_total + * description: The shipping method's tax total. + * - type: string + * title: tax_total + * description: The shipping method's tax total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_total: + * oneOf: + * - type: string + * title: discount_total + * description: The shipping method's discount total. + * - type: number + * title: discount_total + * description: The shipping method's discount total. + * - type: string + * title: discount_total + * description: The shipping method's discount total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_tax_total: + * oneOf: + * - type: string + * title: discount_tax_total + * description: The shipping method's discount tax total. + * - type: number + * title: discount_tax_total + * description: The shipping method's discount tax total. + * - type: string + * title: discount_tax_total + * description: The shipping method's discount tax total. + * - $ref: "#/components/schemas/IBigNumber" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseClaim.ts b/www/utils/generated/oas-output/schemas/BaseClaim.ts new file mode 100644 index 0000000000..594d88a512 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseClaim.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseClaim + * type: object + * description: The order change's claim. + * x-schemaName: BaseClaim + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseClaimItem.ts b/www/utils/generated/oas-output/schemas/BaseClaimItem.ts new file mode 100644 index 0000000000..2152a3c648 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseClaimItem.ts @@ -0,0 +1,60 @@ +/** + * @schema BaseClaimItem + * type: object + * description: The claim item's claim items. + * x-schemaName: BaseClaimItem + * required: + * - id + * - claim_id + * - order_id + * - item_id + * - quantity + * - reason + * - raw_quantity + * properties: + * id: + * type: string + * title: id + * description: The claim item's ID. + * claim_id: + * type: string + * title: claim_id + * description: The claim item's claim id. + * order_id: + * type: string + * title: order_id + * description: The claim item's order id. + * item_id: + * type: string + * title: item_id + * description: The claim item's item id. + * quantity: + * type: number + * title: quantity + * description: The claim item's quantity. + * reason: + * type: string + * enum: + * - missing_item + * - wrong_item + * - production_failure + * - other + * raw_quantity: + * type: object + * description: The claim item's raw quantity. + * metadata: + * type: object + * description: The claim item's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The claim item's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The claim item's updated at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseExchangeItem.ts b/www/utils/generated/oas-output/schemas/BaseExchangeItem.ts new file mode 100644 index 0000000000..c52fdb7733 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseExchangeItem.ts @@ -0,0 +1,50 @@ +/** + * @schema BaseExchangeItem + * type: object + * description: The additional item's additional items. + * x-schemaName: BaseExchangeItem + * required: + * - id + * - exchange_id + * - order_id + * - item_id + * - quantity + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The additional item's ID. + * exchange_id: + * type: string + * title: exchange_id + * description: The additional item's exchange id. + * order_id: + * type: string + * title: order_id + * description: The additional item's order id. + * item_id: + * type: string + * title: item_id + * description: The additional item's item id. + * quantity: + * type: number + * title: quantity + * description: The additional item's quantity. + * metadata: + * type: object + * description: The additional item's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The additional item's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The additional item's updated at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseFulfillmentProvider.ts b/www/utils/generated/oas-output/schemas/BaseFulfillmentProvider.ts new file mode 100644 index 0000000000..3c7947dbe0 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseFulfillmentProvider.ts @@ -0,0 +1,20 @@ +/** + * @schema BaseFulfillmentProvider + * type: object + * description: The shipping option's provider. + * x-schemaName: BaseFulfillmentProvider + * required: + * - id + * - is_enabled + * properties: + * id: + * type: string + * title: id + * description: The provider's ID. + * is_enabled: + * type: boolean + * title: is_enabled + * description: The provider's is enabled. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseLineItemAdjustment.ts b/www/utils/generated/oas-output/schemas/BaseLineItemAdjustment.ts new file mode 100644 index 0000000000..cb086343d2 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseLineItemAdjustment.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseLineItemAdjustment + * type: object + * description: The adjustment's adjustments. + * x-schemaName: BaseLineItemAdjustment + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseLineItemTaxLine.ts b/www/utils/generated/oas-output/schemas/BaseLineItemTaxLine.ts new file mode 100644 index 0000000000..98593da5be --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseLineItemTaxLine.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseLineItemTaxLine + * type: object + * description: The tax line's tax lines. + * x-schemaName: BaseLineItemTaxLine + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseOrder.ts b/www/utils/generated/oas-output/schemas/BaseOrder.ts new file mode 100644 index 0000000000..f2070c41b6 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseOrder.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseOrder + * type: object + * description: The order change's order. + * x-schemaName: BaseOrder + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseOrderAddress.ts b/www/utils/generated/oas-output/schemas/BaseOrderAddress.ts new file mode 100644 index 0000000000..43884cde72 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseOrderAddress.ts @@ -0,0 +1,75 @@ +/** + * @schema BaseOrderAddress + * type: object + * description: The order's billing address. + * x-schemaName: BaseOrderAddress + * required: + * - id + * - metadata + * - created_at + * - updated_at + * properties: + * 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/BaseOrderChange.ts b/www/utils/generated/oas-output/schemas/BaseOrderChange.ts new file mode 100644 index 0000000000..44c2751afc --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseOrderChange.ts @@ -0,0 +1,149 @@ +/** + * @schema BaseOrderChange + * type: object + * description: The order preview's order change. + * x-schemaName: BaseOrderChange + * required: + * - id + * - order_id + * - actions + * - status + * - requested_by + * - requested_at + * - confirmed_by + * - confirmed_at + * - declined_by + * - declined_reason + * - metadata + * - declined_at + * - canceled_by + * - canceled_at + * - created_at + * - updated_at + * - version + * - return_id + * - exchange_id + * - claim_id + * - order + * - return_order + * - exchange + * - claim + * properties: + * id: + * type: string + * title: id + * description: The order change's ID. + * order_id: + * type: string + * title: order_id + * description: The order change's order id. + * actions: + * type: array + * description: The order change's actions. + * items: + * $ref: "#/components/schemas/BaseOrderChangeAction" + * status: + * type: string + * title: status + * description: The order change's status. + * requested_by: + * type: string + * title: requested_by + * description: The order change's requested by. + * requested_at: + * oneOf: + * - type: string + * title: requested_at + * description: The order change's requested at. + * - type: string + * title: requested_at + * description: The order change's requested at. + * format: date-time + * confirmed_by: + * type: string + * title: confirmed_by + * description: The order change's confirmed by. + * confirmed_at: + * oneOf: + * - type: string + * title: confirmed_at + * description: The order change's confirmed at. + * - type: string + * title: confirmed_at + * description: The order change's confirmed at. + * format: date-time + * declined_by: + * type: string + * title: declined_by + * description: The order change's declined by. + * declined_reason: + * type: string + * title: declined_reason + * description: The order change's declined reason. + * metadata: + * type: object + * description: The order change's metadata. + * declined_at: + * oneOf: + * - type: string + * title: declined_at + * description: The order change's declined at. + * - type: string + * title: declined_at + * description: The order change's declined at. + * format: date-time + * canceled_by: + * type: string + * title: canceled_by + * description: The order change's canceled by. + * canceled_at: + * oneOf: + * - type: string + * title: canceled_at + * description: The order change's canceled at. + * - type: string + * title: canceled_at + * description: The order change's canceled at. + * format: date-time + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The order change's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The order change's updated at. + * version: + * type: number + * title: version + * description: The order change's version. + * change_type: + * type: string + * enum: + * - return + * - exchange + * - claim + * - edit + * return_id: + * type: string + * title: return_id + * description: The order change's return id. + * exchange_id: + * type: string + * title: exchange_id + * description: The order change's exchange id. + * claim_id: + * type: string + * title: claim_id + * description: The order change's claim id. + * order: + * $ref: "#/components/schemas/BaseOrder" + * return_order: {} + * exchange: {} + * claim: + * $ref: "#/components/schemas/BaseClaim" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseOrderChangeAction.ts b/www/utils/generated/oas-output/schemas/BaseOrderChangeAction.ts new file mode 100644 index 0000000000..af71235e5c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseOrderChangeAction.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseOrderChangeAction + * type: object + * description: The action's actions. + * x-schemaName: BaseOrderChangeAction + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts b/www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts new file mode 100644 index 0000000000..f3dc63528f --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts @@ -0,0 +1,74 @@ +/** + * @schema BaseOrderFulfillment + * type: object + * description: The fulfillment's fulfillments. + * x-schemaName: BaseOrderFulfillment + * required: + * - id + * - location_id + * - packed_at + * - shipped_at + * - delivered_at + * - canceled_at + * - data + * - provider_id + * - shipping_option_id + * - metadata + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The fulfillment's ID. + * location_id: + * type: string + * title: location_id + * description: The fulfillment's location id. + * packed_at: + * type: string + * title: packed_at + * description: The fulfillment's packed at. + * format: date-time + * shipped_at: + * type: string + * title: shipped_at + * description: The fulfillment's shipped at. + * format: date-time + * delivered_at: + * type: string + * title: delivered_at + * description: The fulfillment's delivered at. + * format: date-time + * canceled_at: + * type: string + * title: canceled_at + * description: The fulfillment's canceled at. + * format: date-time + * data: + * type: object + * description: The fulfillment's data. + * provider_id: + * type: string + * title: provider_id + * description: The fulfillment's provider id. + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The fulfillment's shipping option id. + * metadata: + * type: object + * description: The fulfillment's metadata. + * created_at: + * type: string + * title: created_at + * description: The fulfillment's created at. + * format: date-time + * updated_at: + * type: string + * title: updated_at + * description: The fulfillment's updated at. + * format: date-time + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseOrderItemDetail.ts b/www/utils/generated/oas-output/schemas/BaseOrderItemDetail.ts new file mode 100644 index 0000000000..8d577d9ddd --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseOrderItemDetail.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseOrderItemDetail + * type: object + * description: The item's detail. + * x-schemaName: BaseOrderItemDetail + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts b/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts new file mode 100644 index 0000000000..779fce65e6 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts @@ -0,0 +1,216 @@ +/** + * @schema BaseOrderLineItem + * type: object + * description: The item's items. + * x-schemaName: BaseOrderLineItem + * required: + * - id + * - title + * - subtitle + * - thumbnail + * - variant_id + * - product_id + * - product_title + * - product_description + * - product_subtitle + * - product_type + * - product_collection + * - product_handle + * - variant_sku + * - variant_barcode + * - variant_title + * - variant_option_values + * - requires_shipping + * - is_discountable + * - is_tax_inclusive + * - unit_price + * - quantity + * - detail + * - created_at + * - updated_at + * - metadata + * - original_total + * - original_subtotal + * - original_tax_total + * - item_total + * - item_subtotal + * - item_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - refundable_total + * - refundable_total_per_unit + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * title: + * type: string + * title: title + * description: The item's title. + * subtitle: + * type: string + * title: subtitle + * description: The item's subtitle. + * thumbnail: + * type: string + * title: thumbnail + * description: The item's thumbnail. + * variant: + * $ref: "#/components/schemas/BaseProductVariant" + * variant_id: + * type: string + * title: variant_id + * description: The item's variant id. + * product: + * $ref: "#/components/schemas/BaseProduct" + * product_id: + * type: string + * title: product_id + * description: The item's product id. + * product_title: + * type: string + * title: product_title + * description: The item's product title. + * product_description: + * type: string + * title: product_description + * description: The item's product description. + * product_subtitle: + * type: string + * title: product_subtitle + * description: The item's product subtitle. + * product_type: + * type: string + * title: product_type + * description: The item's product type. + * product_collection: + * type: string + * title: product_collection + * description: The item's product collection. + * product_handle: + * type: string + * title: product_handle + * description: The item's product handle. + * variant_sku: + * type: string + * title: variant_sku + * description: The item's variant sku. + * variant_barcode: + * type: string + * title: variant_barcode + * description: The item's variant barcode. + * variant_title: + * type: string + * title: variant_title + * description: The item's variant title. + * variant_option_values: + * type: object + * description: The item's variant option values. + * requires_shipping: + * type: boolean + * title: requires_shipping + * description: The item's requires shipping. + * is_discountable: + * type: boolean + * title: is_discountable + * description: The item's is discountable. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The item's is tax inclusive. + * compare_at_unit_price: + * type: number + * title: compare_at_unit_price + * description: The item's compare at unit price. + * unit_price: + * type: number + * title: unit_price + * description: The item's unit price. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * tax_lines: + * type: array + * description: The item's tax lines. + * items: + * $ref: "#/components/schemas/BaseOrderLineItemTaxLine" + * adjustments: + * type: array + * description: The item's adjustments. + * items: + * $ref: "#/components/schemas/BaseOrderLineItemAdjustment" + * detail: + * $ref: "#/components/schemas/BaseOrderItemDetail" + * created_at: + * type: string + * title: created_at + * description: The item's created at. + * format: date-time + * updated_at: + * type: string + * title: updated_at + * description: The item's updated at. + * format: date-time + * metadata: + * type: object + * description: The item's metadata. + * original_total: + * type: number + * title: original_total + * description: The item's original total. + * original_subtotal: + * type: number + * title: original_subtotal + * description: The item's original subtotal. + * original_tax_total: + * type: number + * title: original_tax_total + * description: The item's original tax total. + * item_total: + * type: number + * title: item_total + * description: The item's item total. + * item_subtotal: + * type: number + * title: item_subtotal + * description: The item's item subtotal. + * item_tax_total: + * type: number + * title: item_tax_total + * description: The item's item tax total. + * total: + * type: number + * title: total + * description: The item's total. + * subtotal: + * type: number + * title: subtotal + * description: The item's subtotal. + * tax_total: + * type: number + * title: tax_total + * description: The item's tax total. + * discount_total: + * type: number + * title: discount_total + * description: The item's discount total. + * discount_tax_total: + * type: number + * title: discount_tax_total + * description: The item's discount tax total. + * refundable_total: + * type: number + * title: refundable_total + * description: The item's refundable total. + * refundable_total_per_unit: + * type: number + * title: refundable_total_per_unit + * description: The item's refundable total per unit. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseOrderLineItemAdjustment.ts b/www/utils/generated/oas-output/schemas/BaseOrderLineItemAdjustment.ts new file mode 100644 index 0000000000..0cd2c7aa8a --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseOrderLineItemAdjustment.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseOrderLineItemAdjustment + * type: object + * description: The adjustment's adjustments. + * x-schemaName: BaseOrderLineItemAdjustment + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseOrderLineItemTaxLine.ts b/www/utils/generated/oas-output/schemas/BaseOrderLineItemTaxLine.ts new file mode 100644 index 0000000000..1fe4ae2ee4 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseOrderLineItemTaxLine.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseOrderLineItemTaxLine + * type: object + * description: The tax line's tax lines. + * x-schemaName: BaseOrderLineItemTaxLine + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseOrderShippingMethod.ts b/www/utils/generated/oas-output/schemas/BaseOrderShippingMethod.ts new file mode 100644 index 0000000000..f34cc3417d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseOrderShippingMethod.ts @@ -0,0 +1,178 @@ +/** + * @schema BaseOrderShippingMethod + * type: object + * description: The shipping method's shipping methods. + * x-schemaName: BaseOrderShippingMethod + * required: + * - id + * - order_id + * - name + * - amount + * - is_tax_inclusive + * - shipping_option_id + * - data + * - metadata + * - original_total + * - original_subtotal + * - original_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The shipping method's ID. + * order_id: + * type: string + * title: order_id + * description: The shipping method's order id. + * name: + * type: string + * title: name + * description: The shipping method's name. + * description: + * type: string + * title: description + * description: The shipping method's description. + * amount: + * type: number + * title: amount + * description: The shipping method's amount. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The shipping method's is tax inclusive. + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The shipping method's shipping option id. + * data: + * type: object + * description: The shipping method's data. + * metadata: + * type: object + * description: The shipping method's metadata. + * tax_lines: + * type: array + * description: The shipping method's tax lines. + * items: + * $ref: "#/components/schemas/BaseOrderShippingMethodTaxLine" + * adjustments: + * type: array + * description: The shipping method's adjustments. + * items: + * $ref: "#/components/schemas/BaseOrderShippingMethodAdjustment" + * original_total: + * oneOf: + * - type: string + * title: original_total + * description: The shipping method's original total. + * - type: number + * title: original_total + * description: The shipping method's original total. + * - type: string + * title: original_total + * description: The shipping method's original total. + * - $ref: "#/components/schemas/IBigNumber" + * original_subtotal: + * oneOf: + * - type: string + * title: original_subtotal + * description: The shipping method's original subtotal. + * - type: number + * title: original_subtotal + * description: The shipping method's original subtotal. + * - type: string + * title: original_subtotal + * description: The shipping method's original subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * original_tax_total: + * oneOf: + * - type: string + * title: original_tax_total + * description: The shipping method's original tax total. + * - type: number + * title: original_tax_total + * description: The shipping method's original tax total. + * - type: string + * title: original_tax_total + * description: The shipping method's original tax total. + * - $ref: "#/components/schemas/IBigNumber" + * total: + * oneOf: + * - type: string + * title: total + * description: The shipping method's total. + * - type: number + * title: total + * description: The shipping method's total. + * - type: string + * title: total + * description: The shipping method's total. + * - $ref: "#/components/schemas/IBigNumber" + * subtotal: + * oneOf: + * - type: string + * title: subtotal + * description: The shipping method's subtotal. + * - type: number + * title: subtotal + * description: The shipping method's subtotal. + * - type: string + * title: subtotal + * description: The shipping method's subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * tax_total: + * oneOf: + * - type: string + * title: tax_total + * description: The shipping method's tax total. + * - type: number + * title: tax_total + * description: The shipping method's tax total. + * - type: string + * title: tax_total + * description: The shipping method's tax total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_total: + * oneOf: + * - type: string + * title: discount_total + * description: The shipping method's discount total. + * - type: number + * title: discount_total + * description: The shipping method's discount total. + * - type: string + * title: discount_total + * description: The shipping method's discount total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_tax_total: + * oneOf: + * - type: string + * title: discount_tax_total + * description: The shipping method's discount tax total. + * - type: number + * title: discount_tax_total + * description: The shipping method's discount tax total. + * - type: string + * title: discount_tax_total + * description: The shipping method's discount tax total. + * - $ref: "#/components/schemas/IBigNumber" + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The shipping method's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The shipping method's updated at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseOrderShippingMethodAdjustment.ts b/www/utils/generated/oas-output/schemas/BaseOrderShippingMethodAdjustment.ts new file mode 100644 index 0000000000..75c2959f5b --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseOrderShippingMethodAdjustment.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseOrderShippingMethodAdjustment + * type: object + * description: The adjustment's adjustments. + * x-schemaName: BaseOrderShippingMethodAdjustment + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseOrderShippingMethodTaxLine.ts b/www/utils/generated/oas-output/schemas/BaseOrderShippingMethodTaxLine.ts new file mode 100644 index 0000000000..2aa44a680c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseOrderShippingMethodTaxLine.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseOrderShippingMethodTaxLine + * type: object + * description: The tax line's tax lines. + * x-schemaName: BaseOrderShippingMethodTaxLine + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseOrderSummary.ts b/www/utils/generated/oas-output/schemas/BaseOrderSummary.ts new file mode 100644 index 0000000000..a05955b6f7 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseOrderSummary.ts @@ -0,0 +1,85 @@ +/** + * @schema BaseOrderSummary + * type: object + * description: The order's summary. + * x-schemaName: BaseOrderSummary + * required: + * - total + * - subtotal + * - total_tax + * - ordered_total + * - fulfilled_total + * - returned_total + * - return_request_total + * - write_off_total + * - projected_total + * - net_total + * - net_subtotal + * - net_total_tax + * - balance + * - paid_total + * - refunded_total + * properties: + * total: + * type: number + * title: total + * description: The summary's total. + * subtotal: + * type: number + * title: subtotal + * description: The summary's subtotal. + * total_tax: + * type: number + * title: total_tax + * description: The summary's total tax. + * ordered_total: + * type: number + * title: ordered_total + * description: The summary's ordered total. + * fulfilled_total: + * type: number + * title: fulfilled_total + * description: The summary's fulfilled total. + * returned_total: + * type: number + * title: returned_total + * description: The summary's returned total. + * return_request_total: + * type: number + * title: return_request_total + * description: The summary's return request total. + * write_off_total: + * type: number + * title: write_off_total + * description: The summary's write off total. + * projected_total: + * type: number + * title: projected_total + * description: The summary's projected total. + * net_total: + * type: number + * title: net_total + * description: The summary's net total. + * net_subtotal: + * type: number + * title: net_subtotal + * description: The summary's net subtotal. + * net_total_tax: + * type: number + * title: net_total_tax + * description: The summary's net total tax. + * balance: + * type: number + * title: balance + * description: The summary's balance. + * paid_total: + * type: number + * title: paid_total + * description: The summary's paid total. + * refunded_total: + * type: number + * title: refunded_total + * description: The summary's refunded total. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseOrderTransaction.ts b/www/utils/generated/oas-output/schemas/BaseOrderTransaction.ts new file mode 100644 index 0000000000..2c224098fd --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseOrderTransaction.ts @@ -0,0 +1,56 @@ +/** + * @schema BaseOrderTransaction + * type: object + * description: The transaction's transactions. + * x-schemaName: BaseOrderTransaction + * required: + * - id + * - order_id + * - amount + * - currency_code + * - reference + * - reference_id + * - metadata + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The transaction's ID. + * order_id: + * type: string + * title: order_id + * description: The transaction's order id. + * amount: + * type: number + * title: amount + * description: The transaction's amount. + * currency_code: + * type: string + * title: currency_code + * description: The transaction's currency code. + * reference: + * type: string + * title: reference + * description: The transaction's reference. + * reference_id: + * type: string + * title: reference_id + * description: The transaction's reference id. + * metadata: + * type: object + * description: The transaction's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The transaction's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The transaction's updated at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BasePayment.ts b/www/utils/generated/oas-output/schemas/BasePayment.ts new file mode 100644 index 0000000000..e938babb68 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BasePayment.ts @@ -0,0 +1,8 @@ +/** + * @schema BasePayment + * type: object + * description: The payment's payments. + * x-schemaName: BasePayment + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BasePaymentCollection.ts b/www/utils/generated/oas-output/schemas/BasePaymentCollection.ts new file mode 100644 index 0000000000..b6bdcf8c73 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BasePaymentCollection.ts @@ -0,0 +1,121 @@ +/** + * @schema BasePaymentCollection + * type: object + * description: The payment collection's payment collections. + * x-schemaName: BasePaymentCollection + * required: + * - id + * - currency_code + * - region_id + * - amount + * - status + * - payment_providers + * properties: + * id: + * type: string + * title: id + * description: The payment collection's ID. + * currency_code: + * type: string + * title: currency_code + * description: The payment collection's currency code. + * region_id: + * type: string + * title: region_id + * description: The payment collection's region id. + * amount: + * oneOf: + * - type: string + * title: amount + * description: The payment collection's amount. + * - type: number + * title: amount + * description: The payment collection's amount. + * - type: string + * title: amount + * description: The payment collection's amount. + * - $ref: "#/components/schemas/IBigNumber" + * authorized_amount: + * oneOf: + * - type: string + * title: authorized_amount + * description: The payment collection's authorized amount. + * - type: number + * title: authorized_amount + * description: The payment collection's authorized amount. + * - type: string + * title: authorized_amount + * description: The payment collection's authorized amount. + * - $ref: "#/components/schemas/IBigNumber" + * captured_amount: + * oneOf: + * - type: string + * title: captured_amount + * description: The payment collection's captured amount. + * - type: number + * title: captured_amount + * description: The payment collection's captured amount. + * - type: string + * title: captured_amount + * description: The payment collection's captured amount. + * - $ref: "#/components/schemas/IBigNumber" + * refunded_amount: + * oneOf: + * - type: string + * title: refunded_amount + * description: The payment collection's refunded amount. + * - type: number + * title: refunded_amount + * description: The payment collection's refunded amount. + * - type: string + * title: refunded_amount + * description: The payment collection's refunded amount. + * - $ref: "#/components/schemas/IBigNumber" + * completed_at: + * oneOf: + * - type: string + * title: completed_at + * description: The payment collection's completed at. + * - type: string + * title: completed_at + * description: The payment collection's completed at. + * format: date-time + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The payment collection's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The payment collection's updated at. + * metadata: + * type: object + * description: The payment collection's metadata. + * status: + * type: string + * enum: + * - canceled + * - not_paid + * - awaiting + * - authorized + * - partially_authorized + * payment_providers: + * type: array + * description: The payment collection's payment providers. + * items: + * $ref: "#/components/schemas/BasePaymentProvider" + * payment_sessions: + * type: array + * description: The payment collection's payment sessions. + * items: + * $ref: "#/components/schemas/BasePaymentSession" + * payments: + * type: array + * description: The payment collection's payments. + * items: + * $ref: "#/components/schemas/BasePayment" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BasePaymentProvider.ts b/www/utils/generated/oas-output/schemas/BasePaymentProvider.ts new file mode 100644 index 0000000000..06e82f3a1a --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BasePaymentProvider.ts @@ -0,0 +1,8 @@ +/** + * @schema BasePaymentProvider + * type: object + * description: The payment provider's payment providers. + * x-schemaName: BasePaymentProvider + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BasePaymentSession.ts b/www/utils/generated/oas-output/schemas/BasePaymentSession.ts new file mode 100644 index 0000000000..9796ae59b1 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BasePaymentSession.ts @@ -0,0 +1,8 @@ +/** + * @schema BasePaymentSession + * type: object + * description: The payment session's payment sessions. + * x-schemaName: BasePaymentSession + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseProduct.ts b/www/utils/generated/oas-output/schemas/BaseProduct.ts index fc499eb4a8..6039481b0c 100644 --- a/www/utils/generated/oas-output/schemas/BaseProduct.ts +++ b/www/utils/generated/oas-output/schemas/BaseProduct.ts @@ -1,7 +1,7 @@ /** * @schema BaseProduct * type: object - * description: The updated's product. + * description: The parent's product. * x-schemaName: BaseProduct * required: * - id diff --git a/www/utils/generated/oas-output/schemas/BasePromotion.ts b/www/utils/generated/oas-output/schemas/BasePromotion.ts new file mode 100644 index 0000000000..09762d74c9 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BasePromotion.ts @@ -0,0 +1,8 @@ +/** + * @schema BasePromotion + * type: object + * description: The application method's promotion. + * x-schemaName: BasePromotion + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BasePromotionRule.ts b/www/utils/generated/oas-output/schemas/BasePromotionRule.ts new file mode 100644 index 0000000000..06ab02450b --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BasePromotionRule.ts @@ -0,0 +1,39 @@ +/** + * @schema BasePromotionRule + * type: object + * description: The rule's rules. + * x-schemaName: BasePromotionRule + * required: + * - id + * - values + * properties: + * id: + * type: string + * title: id + * description: The rule's ID. + * description: + * type: string + * title: description + * description: The rule's description. + * attribute: + * type: string + * title: attribute + * description: The rule's attribute. + * operator: + * type: string + * enum: + * - gt + * - lt + * - eq + * - ne + * - in + * - lte + * - gte + * values: + * type: array + * description: The rule's values. + * items: + * $ref: "#/components/schemas/BasePromotionRuleValue" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BasePromotionRuleValue.ts b/www/utils/generated/oas-output/schemas/BasePromotionRuleValue.ts new file mode 100644 index 0000000000..02086a90a8 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BasePromotionRuleValue.ts @@ -0,0 +1,19 @@ +/** + * @schema BasePromotionRuleValue + * type: object + * description: The value's values. + * x-schemaName: BasePromotionRuleValue + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The value's ID. + * value: + * type: string + * title: value + * description: The value's details. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseRefund.ts b/www/utils/generated/oas-output/schemas/BaseRefund.ts new file mode 100644 index 0000000000..ca0ccfc68b --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseRefund.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseRefund + * type: object + * description: The refund's refunds. + * x-schemaName: BaseRefund + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseRegion.ts b/www/utils/generated/oas-output/schemas/BaseRegion.ts new file mode 100644 index 0000000000..8f3b04a722 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseRegion.ts @@ -0,0 +1,52 @@ +/** + * @schema BaseRegion + * type: object + * description: The cart's region. + * x-schemaName: BaseRegion + * required: + * - id + * - name + * - currency_code + * properties: + * id: + * type: string + * title: id + * description: The region's ID. + * name: + * type: string + * title: name + * description: The region's name. + * currency_code: + * type: string + * title: currency_code + * description: The region's currency code. + * automatic_taxes: + * type: boolean + * title: automatic_taxes + * description: The region's automatic taxes. + * countries: + * type: array + * description: The region's countries. + * items: + * $ref: "#/components/schemas/BaseRegionCountry" + * payment_providers: + * type: array + * description: The region's payment providers. + * items: + * $ref: "#/components/schemas/AdminPaymentProvider" + * metadata: + * type: object + * description: The region's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The region's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The region's updated at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseRegionCountry.ts b/www/utils/generated/oas-output/schemas/BaseRegionCountry.ts new file mode 100644 index 0000000000..4b1ba5d7e8 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseRegionCountry.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseRegionCountry + * type: object + * description: The country's countries. + * x-schemaName: BaseRegionCountry + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseReturnItem.ts b/www/utils/generated/oas-output/schemas/BaseReturnItem.ts new file mode 100644 index 0000000000..9e0b07e3fd --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseReturnItem.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseReturnItem + * type: object + * description: The item's items. + * x-schemaName: BaseReturnItem + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseRuleOperatorOptions.ts b/www/utils/generated/oas-output/schemas/BaseRuleOperatorOptions.ts new file mode 100644 index 0000000000..7ab8c1e0ca --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseRuleOperatorOptions.ts @@ -0,0 +1,25 @@ +/** + * @schema BaseRuleOperatorOptions + * type: object + * description: The operator's operators. + * x-schemaName: BaseRuleOperatorOptions + * required: + * - id + * - value + * - label + * properties: + * id: + * type: string + * title: id + * description: The operator's ID. + * value: + * type: string + * title: value + * description: The operator's value. + * label: + * type: string + * title: label + * description: The operator's label. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseShippingMethodAdjustment.ts b/www/utils/generated/oas-output/schemas/BaseShippingMethodAdjustment.ts new file mode 100644 index 0000000000..5aba850e2c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseShippingMethodAdjustment.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseShippingMethodAdjustment + * type: object + * description: The adjustment's adjustments. + * x-schemaName: BaseShippingMethodAdjustment + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseShippingMethodTaxLine.ts b/www/utils/generated/oas-output/schemas/BaseShippingMethodTaxLine.ts new file mode 100644 index 0000000000..08ad9dc5c4 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseShippingMethodTaxLine.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseShippingMethodTaxLine + * type: object + * description: The tax line's tax lines. + * x-schemaName: BaseShippingMethodTaxLine + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateCampaign.ts b/www/utils/generated/oas-output/schemas/CampaignResponse.ts similarity index 50% rename from www/utils/generated/oas-output/schemas/AdminUpdateCampaign.ts rename to www/utils/generated/oas-output/schemas/CampaignResponse.ts index de6f6d92ca..98b44d3d68 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateCampaign.ts +++ b/www/utils/generated/oas-output/schemas/CampaignResponse.ts @@ -1,58 +1,77 @@ /** - * @schema AdminUpdateCampaign + * @schema CampaignResponse * type: object - * description: SUMMARY - * x-schemaName: AdminUpdateCampaign + * description: The campaign's details. + * x-schemaName: CampaignResponse * required: + * - id + * - name * - description + * - currency + * - campaign_identifier * - starts_at * - ends_at + * - budget * properties: + * id: + * type: string + * title: id + * description: The campaign's ID. * name: * type: string * title: name * description: The campaign's name. - * campaign_identifier: - * type: string - * title: campaign_identifier - * description: The campaign's campaign identifier. * description: * type: string * title: description * description: The campaign's description. - * budget: - * type: object - * description: The campaign's budget. - * required: - * - limit - * properties: - * limit: - * type: number - * title: limit - * description: The budget's limit. + * 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 - * promotions: - * type: array - * description: The campaign's promotions. - * items: - * type: object - * description: The promotion's promotions. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The promotion's ID. + * budget: + * type: object + * description: The campaign's budget. + * required: + * - id + * - type + * - currency_code + * - limit + * - used + * properties: + * id: + * type: string + * title: id + * description: The budget's ID. + * type: + * type: string + * 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. + * used: + * type: number + * title: used + * description: The budget's used. * */ diff --git a/www/utils/generated/oas-output/schemas/CreateCartWorkflowInput.ts b/www/utils/generated/oas-output/schemas/CreateCartWorkflowInput.ts deleted file mode 100644 index 4da68eb2ef..0000000000 --- a/www/utils/generated/oas-output/schemas/CreateCartWorkflowInput.ts +++ /dev/null @@ -1,65 +0,0 @@ -/** - * @schema CreateCartWorkflowInput - * type: object - * description: SUMMARY - * x-schemaName: CreateCartWorkflowInput - * properties: - * region_id: - * type: string - * title: region_id - * description: The cart's region id. - * customer_id: - * type: string - * title: customer_id - * description: The cart's customer id. - * sales_channel_id: - * type: string - * title: sales_channel_id - * description: The cart's sales channel id. - * email: - * type: string - * title: email - * description: The cart's email. - * format: email - * currency_code: - * type: string - * title: currency_code - * description: The cart's currency code. - * shipping_address_id: - * type: string - * title: shipping_address_id - * description: The cart's shipping address id. - * billing_address_id: - * type: string - * title: billing_address_id - * description: The cart's billing address id. - * shipping_address: - * oneOf: - * - type: string - * title: shipping_address - * description: The cart's shipping address. - * - $ref: "#/components/schemas/CreateCartAddress" - * billing_address: - * oneOf: - * - type: string - * title: billing_address - * description: The cart's billing address. - * - $ref: "#/components/schemas/CreateCartAddress" - * metadata: - * type: object - * description: The cart's metadata. - * items: - * type: array - * description: The cart's items. - * items: - * $ref: "#/components/schemas/CreateCartCreateLineItem" - * promo_codes: - * type: array - * description: The cart's promo codes. - * items: - * type: string - * title: promo_codes - * description: The promo code's promo codes. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/IBigNumber.ts b/www/utils/generated/oas-output/schemas/IBigNumber.ts new file mode 100644 index 0000000000..c49fb6b3b2 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/IBigNumber.ts @@ -0,0 +1,8 @@ +/** + * @schema IBigNumber + * type: object + * description: The shipping method's discount tax total. + * x-schemaName: IBigNumber + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/InventoryLevel.ts b/www/utils/generated/oas-output/schemas/InventoryLevel.ts new file mode 100644 index 0000000000..66df29b210 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/InventoryLevel.ts @@ -0,0 +1,48 @@ +/** + * @schema InventoryLevel + * type: object + * description: The inventory level's inventory levels. + * x-schemaName: InventoryLevel + * required: + * - id + * - inventory_item_id + * - location_id + * - stocked_quantity + * - reserved_quantity + * - available_quantity + * - incoming_quantity + * properties: + * id: + * type: string + * title: id + * description: The inventory level's ID. + * inventory_item_id: + * type: string + * title: inventory_item_id + * description: The inventory level's inventory item id. + * location_id: + * type: string + * title: location_id + * description: The inventory level's location id. + * stocked_quantity: + * type: number + * title: stocked_quantity + * description: The inventory level's stocked quantity. + * reserved_quantity: + * type: number + * title: reserved_quantity + * description: The inventory level's reserved quantity. + * available_quantity: + * type: number + * title: available_quantity + * description: The inventory level's available quantity. + * incoming_quantity: + * type: number + * title: incoming_quantity + * description: The inventory level's incoming quantity. + * metadata: + * type: object + * description: The inventory level's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/Order.ts b/www/utils/generated/oas-output/schemas/Order.ts new file mode 100644 index 0000000000..4ed482079e --- /dev/null +++ b/www/utils/generated/oas-output/schemas/Order.ts @@ -0,0 +1,941 @@ +/** + * @schema Order + * type: object + * description: The exchange's order preview. + * x-schemaName: Order + * required: + * - id + * - version + * - status + * - currency_code + * - original_item_total + * - original_item_subtotal + * - original_item_tax_total + * - item_total + * - item_subtotal + * - item_tax_total + * - original_total + * - original_subtotal + * - original_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - gift_card_total + * - gift_card_tax_total + * - shipping_total + * - shipping_subtotal + * - shipping_tax_total + * - original_shipping_total + * - original_shipping_subtotal + * - original_shipping_tax_total + * - raw_original_item_total + * - raw_original_item_subtotal + * - raw_original_item_tax_total + * - raw_item_total + * - raw_item_subtotal + * - raw_item_tax_total + * - raw_original_total + * - raw_original_subtotal + * - raw_original_tax_total + * - raw_total + * - raw_subtotal + * - raw_tax_total + * - raw_discount_total + * - raw_discount_tax_total + * - raw_gift_card_total + * - raw_gift_card_tax_total + * - raw_shipping_total + * - raw_shipping_subtotal + * - raw_shipping_tax_total + * - raw_original_shipping_total + * - raw_original_shipping_subtotal + * - raw_original_shipping_tax_total + * properties: + * id: + * type: string + * title: id + * description: The order preview's ID. + * version: + * type: number + * title: version + * description: The order preview's version. + * order_change: + * $ref: "#/components/schemas/OrderChange" + * status: + * type: string + * enum: + * - canceled + * - requires_action + * - pending + * - completed + * - draft + * - archived + * region_id: + * type: string + * title: region_id + * description: The order preview's region id. + * customer_id: + * type: string + * title: customer_id + * description: The order preview's customer id. + * sales_channel_id: + * type: string + * title: sales_channel_id + * description: The order preview's sales channel id. + * email: + * type: string + * title: email + * description: The order preview's email. + * format: email + * currency_code: + * type: string + * title: currency_code + * description: The order preview's currency code. + * shipping_address: + * $ref: "#/components/schemas/OrderAddress" + * billing_address: + * $ref: "#/components/schemas/OrderAddress" + * items: + * type: array + * description: The order preview's items. + * items: + * $ref: "#/components/schemas/OrderLineItem" + * shipping_methods: + * type: array + * description: The order preview's shipping methods. + * items: + * $ref: "#/components/schemas/OrderShippingMethod" + * transactions: + * type: array + * description: The order preview's transactions. + * items: + * $ref: "#/components/schemas/OrderTransaction" + * summary: + * type: object + * description: The order preview's summary. + * required: + * - total + * - subtotal + * - total_tax + * - ordered_total + * - fulfilled_total + * - returned_total + * - return_request_total + * - write_off_total + * - projected_total + * - net_total + * - net_subtotal + * - net_total_tax + * - balance + * - paid_total + * - refunded_total + * properties: + * total: + * oneOf: + * - type: string + * title: total + * description: The summary's total. + * - type: number + * title: total + * description: The summary's total. + * - type: string + * title: total + * description: The summary's total. + * - type: object + * description: The summary's total. + * x-schemaName: IBigNumber + * subtotal: + * oneOf: + * - type: string + * title: subtotal + * description: The summary's subtotal. + * - type: number + * title: subtotal + * description: The summary's subtotal. + * - type: string + * title: subtotal + * description: The summary's subtotal. + * - type: object + * description: The summary's subtotal. + * x-schemaName: IBigNumber + * total_tax: + * oneOf: + * - type: string + * title: total_tax + * description: The summary's total tax. + * - type: number + * title: total_tax + * description: The summary's total tax. + * - type: string + * title: total_tax + * description: The summary's total tax. + * - type: object + * description: The summary's total tax. + * x-schemaName: IBigNumber + * ordered_total: + * oneOf: + * - type: string + * title: ordered_total + * description: The summary's ordered total. + * - type: number + * title: ordered_total + * description: The summary's ordered total. + * - type: string + * title: ordered_total + * description: The summary's ordered total. + * - type: object + * description: The summary's ordered total. + * x-schemaName: IBigNumber + * fulfilled_total: + * oneOf: + * - type: string + * title: fulfilled_total + * description: The summary's fulfilled total. + * - type: number + * title: fulfilled_total + * description: The summary's fulfilled total. + * - type: string + * title: fulfilled_total + * description: The summary's fulfilled total. + * - type: object + * description: The summary's fulfilled total. + * x-schemaName: IBigNumber + * returned_total: + * oneOf: + * - type: string + * title: returned_total + * description: The summary's returned total. + * - type: number + * title: returned_total + * description: The summary's returned total. + * - type: string + * title: returned_total + * description: The summary's returned total. + * - type: object + * description: The summary's returned total. + * x-schemaName: IBigNumber + * return_request_total: + * oneOf: + * - type: string + * title: return_request_total + * description: The summary's return request total. + * - type: number + * title: return_request_total + * description: The summary's return request total. + * - type: string + * title: return_request_total + * description: The summary's return request total. + * - type: object + * description: The summary's return request total. + * x-schemaName: IBigNumber + * write_off_total: + * oneOf: + * - type: string + * title: write_off_total + * description: The summary's write off total. + * - type: number + * title: write_off_total + * description: The summary's write off total. + * - type: string + * title: write_off_total + * description: The summary's write off total. + * - type: object + * description: The summary's write off total. + * x-schemaName: IBigNumber + * projected_total: + * oneOf: + * - type: string + * title: projected_total + * description: The summary's projected total. + * - type: number + * title: projected_total + * description: The summary's projected total. + * - type: string + * title: projected_total + * description: The summary's projected total. + * - type: object + * description: The summary's projected total. + * x-schemaName: IBigNumber + * net_total: + * oneOf: + * - type: string + * title: net_total + * description: The summary's net total. + * - type: number + * title: net_total + * description: The summary's net total. + * - type: string + * title: net_total + * description: The summary's net total. + * - type: object + * description: The summary's net total. + * x-schemaName: IBigNumber + * net_subtotal: + * oneOf: + * - type: string + * title: net_subtotal + * description: The summary's net subtotal. + * - type: number + * title: net_subtotal + * description: The summary's net subtotal. + * - type: string + * title: net_subtotal + * description: The summary's net subtotal. + * - type: object + * description: The summary's net subtotal. + * x-schemaName: IBigNumber + * net_total_tax: + * oneOf: + * - type: string + * title: net_total_tax + * description: The summary's net total tax. + * - type: number + * title: net_total_tax + * description: The summary's net total tax. + * - type: string + * title: net_total_tax + * description: The summary's net total tax. + * - type: object + * description: The summary's net total tax. + * x-schemaName: IBigNumber + * balance: + * oneOf: + * - type: string + * title: balance + * description: The summary's balance. + * - type: number + * title: balance + * description: The summary's balance. + * - type: string + * title: balance + * description: The summary's balance. + * - type: object + * description: The summary's balance. + * x-schemaName: IBigNumber + * paid_total: + * oneOf: + * - type: string + * title: paid_total + * description: The summary's paid total. + * - type: number + * title: paid_total + * description: The summary's paid total. + * - type: string + * title: paid_total + * description: The summary's paid total. + * - type: object + * description: The summary's paid total. + * x-schemaName: IBigNumber + * refunded_total: + * oneOf: + * - type: string + * title: refunded_total + * description: The summary's refunded total. + * - type: number + * title: refunded_total + * description: The summary's refunded total. + * - type: string + * title: refunded_total + * description: The summary's refunded total. + * - type: object + * description: The summary's refunded total. + * x-schemaName: IBigNumber + * metadata: + * type: object + * description: The order preview's metadata. + * canceled_at: + * oneOf: + * - type: string + * title: canceled_at + * description: The order preview's canceled at. + * - type: string + * title: canceled_at + * description: The order preview's canceled at. + * format: date-time + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The order preview's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The order preview's updated at. + * original_item_total: + * oneOf: + * - type: string + * title: original_item_total + * description: The order preview's original item total. + * - type: number + * title: original_item_total + * description: The order preview's original item total. + * - type: string + * title: original_item_total + * description: The order preview's original item total. + * - $ref: "#/components/schemas/IBigNumber" + * original_item_subtotal: + * oneOf: + * - type: string + * title: original_item_subtotal + * description: The order preview's original item subtotal. + * - type: number + * title: original_item_subtotal + * description: The order preview's original item subtotal. + * - type: string + * title: original_item_subtotal + * description: The order preview's original item subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * original_item_tax_total: + * oneOf: + * - type: string + * title: original_item_tax_total + * description: The order preview's original item tax total. + * - type: number + * title: original_item_tax_total + * description: The order preview's original item tax total. + * - type: string + * title: original_item_tax_total + * description: The order preview's original item tax total. + * - $ref: "#/components/schemas/IBigNumber" + * item_total: + * oneOf: + * - type: string + * title: item_total + * description: The order preview's item total. + * - type: number + * title: item_total + * description: The order preview's item total. + * - type: string + * title: item_total + * description: The order preview's item total. + * - $ref: "#/components/schemas/IBigNumber" + * item_subtotal: + * oneOf: + * - type: string + * title: item_subtotal + * description: The order preview's item subtotal. + * - type: number + * title: item_subtotal + * description: The order preview's item subtotal. + * - type: string + * title: item_subtotal + * description: The order preview's item subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * item_tax_total: + * oneOf: + * - type: string + * title: item_tax_total + * description: The order preview's item tax total. + * - type: number + * title: item_tax_total + * description: The order preview's item tax total. + * - type: string + * title: item_tax_total + * description: The order preview's item tax total. + * - $ref: "#/components/schemas/IBigNumber" + * original_total: + * oneOf: + * - type: string + * title: original_total + * description: The order preview's original total. + * - type: number + * title: original_total + * description: The order preview's original total. + * - type: string + * title: original_total + * description: The order preview's original total. + * - $ref: "#/components/schemas/IBigNumber" + * original_subtotal: + * oneOf: + * - type: string + * title: original_subtotal + * description: The order preview's original subtotal. + * - type: number + * title: original_subtotal + * description: The order preview's original subtotal. + * - type: string + * title: original_subtotal + * description: The order preview's original subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * original_tax_total: + * oneOf: + * - type: string + * title: original_tax_total + * description: The order preview's original tax total. + * - type: number + * title: original_tax_total + * description: The order preview's original tax total. + * - type: string + * title: original_tax_total + * description: The order preview's original tax total. + * - $ref: "#/components/schemas/IBigNumber" + * total: + * oneOf: + * - type: string + * title: total + * description: The order preview's total. + * - type: number + * title: total + * description: The order preview's total. + * - type: string + * title: total + * description: The order preview's total. + * - $ref: "#/components/schemas/IBigNumber" + * subtotal: + * oneOf: + * - type: string + * title: subtotal + * description: The order preview's subtotal. + * - type: number + * title: subtotal + * description: The order preview's subtotal. + * - type: string + * title: subtotal + * description: The order preview's subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * tax_total: + * oneOf: + * - type: string + * title: tax_total + * description: The order preview's tax total. + * - type: number + * title: tax_total + * description: The order preview's tax total. + * - type: string + * title: tax_total + * description: The order preview's tax total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_total: + * oneOf: + * - type: string + * title: discount_total + * description: The order preview's discount total. + * - type: number + * title: discount_total + * description: The order preview's discount total. + * - type: string + * title: discount_total + * description: The order preview's discount total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_tax_total: + * oneOf: + * - type: string + * title: discount_tax_total + * description: The order preview's discount tax total. + * - type: number + * title: discount_tax_total + * description: The order preview's discount tax total. + * - type: string + * title: discount_tax_total + * description: The order preview's discount tax total. + * - $ref: "#/components/schemas/IBigNumber" + * gift_card_total: + * oneOf: + * - type: string + * title: gift_card_total + * description: The order preview's gift card total. + * - type: number + * title: gift_card_total + * description: The order preview's gift card total. + * - type: string + * title: gift_card_total + * description: The order preview's gift card total. + * - $ref: "#/components/schemas/IBigNumber" + * gift_card_tax_total: + * oneOf: + * - type: string + * title: gift_card_tax_total + * description: The order preview's gift card tax total. + * - type: number + * title: gift_card_tax_total + * description: The order preview's gift card tax total. + * - type: string + * title: gift_card_tax_total + * description: The order preview's gift card tax total. + * - $ref: "#/components/schemas/IBigNumber" + * shipping_total: + * oneOf: + * - type: string + * title: shipping_total + * description: The order preview's shipping total. + * - type: number + * title: shipping_total + * description: The order preview's shipping total. + * - type: string + * title: shipping_total + * description: The order preview's shipping total. + * - $ref: "#/components/schemas/IBigNumber" + * shipping_subtotal: + * oneOf: + * - type: string + * title: shipping_subtotal + * description: The order preview's shipping subtotal. + * - type: number + * title: shipping_subtotal + * description: The order preview's shipping subtotal. + * - type: string + * title: shipping_subtotal + * description: The order preview's shipping subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * shipping_tax_total: + * oneOf: + * - type: string + * title: shipping_tax_total + * description: The order preview's shipping tax total. + * - type: number + * title: shipping_tax_total + * description: The order preview's shipping tax total. + * - type: string + * title: shipping_tax_total + * description: The order preview's shipping tax total. + * - $ref: "#/components/schemas/IBigNumber" + * original_shipping_total: + * oneOf: + * - type: string + * title: original_shipping_total + * description: The order preview's original shipping total. + * - type: number + * title: original_shipping_total + * description: The order preview's original shipping total. + * - type: string + * title: original_shipping_total + * description: The order preview's original shipping total. + * - $ref: "#/components/schemas/IBigNumber" + * original_shipping_subtotal: + * oneOf: + * - type: string + * title: original_shipping_subtotal + * description: The order preview's original shipping subtotal. + * - type: number + * title: original_shipping_subtotal + * description: The order preview's original shipping subtotal. + * - type: string + * title: original_shipping_subtotal + * description: The order preview's original shipping subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * original_shipping_tax_total: + * oneOf: + * - type: string + * title: original_shipping_tax_total + * description: The order preview's original shipping tax total. + * - type: number + * title: original_shipping_tax_total + * description: The order preview's original shipping tax total. + * - type: string + * title: original_shipping_tax_total + * description: The order preview's original shipping tax total. + * - $ref: "#/components/schemas/IBigNumber" + * raw_original_item_total: + * type: object + * description: The order preview's raw original item total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original item total's value. + * - type: number + * title: value + * description: The raw original item total's value. + * raw_original_item_subtotal: + * type: object + * description: The order preview's raw original item subtotal. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original item subtotal's value. + * - type: number + * title: value + * description: The raw original item subtotal's value. + * raw_original_item_tax_total: + * type: object + * description: The order preview's raw original item tax total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original item tax total's value. + * - type: number + * title: value + * description: The raw original item tax total's value. + * raw_item_total: + * type: object + * description: The order preview's raw item total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw item total's value. + * - type: number + * title: value + * description: The raw item total's value. + * raw_item_subtotal: + * type: object + * description: The order preview's raw item subtotal. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw item subtotal's value. + * - type: number + * title: value + * description: The raw item subtotal's value. + * raw_item_tax_total: + * type: object + * description: The order preview's raw item tax total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw item tax total's value. + * - type: number + * title: value + * description: The raw item tax total's value. + * raw_original_total: + * type: object + * description: The order preview's raw original total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original total's value. + * - type: number + * title: value + * description: The raw original total's value. + * raw_original_subtotal: + * type: object + * description: The order preview's raw original subtotal. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original subtotal's value. + * - type: number + * title: value + * description: The raw original subtotal's value. + * raw_original_tax_total: + * type: object + * description: The order preview's raw original tax total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original tax total's value. + * - type: number + * title: value + * description: The raw original tax total's value. + * raw_total: + * type: object + * description: The order preview's raw total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw total's value. + * - type: number + * title: value + * description: The raw total's value. + * raw_subtotal: + * type: object + * description: The order preview's raw subtotal. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw subtotal's value. + * - type: number + * title: value + * description: The raw subtotal's value. + * raw_tax_total: + * type: object + * description: The order preview's raw tax total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw tax total's value. + * - type: number + * title: value + * description: The raw tax total's value. + * raw_discount_total: + * type: object + * description: The order preview's raw discount total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw discount total's value. + * - type: number + * title: value + * description: The raw discount total's value. + * raw_discount_tax_total: + * type: object + * description: The order preview's raw discount tax total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw discount tax total's value. + * - type: number + * title: value + * description: The raw discount tax total's value. + * raw_gift_card_total: + * type: object + * description: The order preview's raw gift card total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw gift card total's value. + * - type: number + * title: value + * description: The raw gift card total's value. + * raw_gift_card_tax_total: + * type: object + * description: The order preview's raw gift card tax total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw gift card tax total's value. + * - type: number + * title: value + * description: The raw gift card tax total's value. + * raw_shipping_total: + * type: object + * description: The order preview's raw shipping total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw shipping total's value. + * - type: number + * title: value + * description: The raw shipping total's value. + * raw_shipping_subtotal: + * type: object + * description: The order preview's raw shipping subtotal. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw shipping subtotal's value. + * - type: number + * title: value + * description: The raw shipping subtotal's value. + * raw_shipping_tax_total: + * type: object + * description: The order preview's raw shipping tax total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw shipping tax total's value. + * - type: number + * title: value + * description: The raw shipping tax total's value. + * raw_original_shipping_total: + * type: object + * description: The order preview's raw original shipping total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original shipping total's value. + * - type: number + * title: value + * description: The raw original shipping total's value. + * raw_original_shipping_subtotal: + * type: object + * description: The order preview's raw original shipping subtotal. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original shipping subtotal's value. + * - type: number + * title: value + * description: The raw original shipping subtotal's value. + * raw_original_shipping_tax_total: + * type: object + * description: The order preview's raw original shipping tax total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original shipping tax total's value. + * - type: number + * title: value + * description: The raw original shipping tax total's value. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/OrderAddress.ts b/www/utils/generated/oas-output/schemas/OrderAddress.ts new file mode 100644 index 0000000000..dd14058b9f --- /dev/null +++ b/www/utils/generated/oas-output/schemas/OrderAddress.ts @@ -0,0 +1,74 @@ +/** + * @schema OrderAddress + * type: object + * description: The order preview's billing address. + * x-schemaName: OrderAddress + * required: + * - id + * - created_at + * - updated_at + * properties: + * 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/OrderChange.ts b/www/utils/generated/oas-output/schemas/OrderChange.ts new file mode 100644 index 0000000000..22db9178af --- /dev/null +++ b/www/utils/generated/oas-output/schemas/OrderChange.ts @@ -0,0 +1,151 @@ +/** + * @schema OrderChange + * type: object + * description: The order preview's order change. + * x-schemaName: OrderChange + * required: + * - id + * - version + * - order_id + * - return_id + * - exchange_id + * - claim_id + * - order + * - return_order + * - exchange + * - claim + * - actions + * - status + * - requested_by + * - requested_at + * - confirmed_by + * - confirmed_at + * - declined_by + * - declined_reason + * - metadata + * - declined_at + * - canceled_by + * - canceled_at + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The order change's ID. + * version: + * type: number + * title: version + * description: The order change's version. + * change_type: + * type: string + * enum: + * - return + * - exchange + * - claim + * - edit + * order_id: + * type: string + * title: order_id + * description: The order change's order id. + * return_id: + * type: string + * title: return_id + * description: The order change's return id. + * exchange_id: + * type: string + * title: exchange_id + * description: The order change's exchange id. + * claim_id: + * type: string + * title: claim_id + * description: The order change's claim id. + * order: + * $ref: "#/components/schemas/Order" + * return_order: + * $ref: "#/components/schemas/Return" + * exchange: + * $ref: "#/components/schemas/OrderExchange" + * claim: + * $ref: "#/components/schemas/OrderClaim" + * actions: + * type: array + * description: The order change's actions. + * items: + * $ref: "#/components/schemas/OrderChangeAction" + * status: + * type: string + * title: status + * description: The order change's status. + * requested_by: + * type: string + * title: requested_by + * description: The order change's requested by. + * requested_at: + * oneOf: + * - type: string + * title: requested_at + * description: The order change's requested at. + * - type: string + * title: requested_at + * description: The order change's requested at. + * format: date-time + * confirmed_by: + * type: string + * title: confirmed_by + * description: The order change's confirmed by. + * confirmed_at: + * oneOf: + * - type: string + * title: confirmed_at + * description: The order change's confirmed at. + * - type: string + * title: confirmed_at + * description: The order change's confirmed at. + * format: date-time + * declined_by: + * type: string + * title: declined_by + * description: The order change's declined by. + * declined_reason: + * type: string + * title: declined_reason + * description: The order change's declined reason. + * metadata: + * type: object + * description: The order change's metadata. + * declined_at: + * oneOf: + * - type: string + * title: declined_at + * description: The order change's declined at. + * - type: string + * title: declined_at + * description: The order change's declined at. + * format: date-time + * canceled_by: + * type: string + * title: canceled_by + * description: The order change's canceled by. + * canceled_at: + * oneOf: + * - type: string + * title: canceled_at + * description: The order change's canceled at. + * - type: string + * title: canceled_at + * description: The order change's canceled at. + * format: date-time + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The order change's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The order change's updated at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/OrderChangeAction.ts b/www/utils/generated/oas-output/schemas/OrderChangeAction.ts new file mode 100644 index 0000000000..c6aeda5f06 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/OrderChangeAction.ts @@ -0,0 +1,8 @@ +/** + * @schema OrderChangeAction + * type: object + * description: The action's actions. + * x-schemaName: OrderChangeAction + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/OrderClaim.ts b/www/utils/generated/oas-output/schemas/OrderClaim.ts new file mode 100644 index 0000000000..b9cf396465 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/OrderClaim.ts @@ -0,0 +1,8 @@ +/** + * @schema OrderClaim + * type: object + * description: The order change's claim. + * x-schemaName: OrderClaim + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/OrderExchange.ts b/www/utils/generated/oas-output/schemas/OrderExchange.ts new file mode 100644 index 0000000000..e52a5d2436 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/OrderExchange.ts @@ -0,0 +1,8 @@ +/** + * @schema OrderExchange + * type: object + * description: The order change's exchange. + * x-schemaName: OrderExchange + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/OrderItem.ts b/www/utils/generated/oas-output/schemas/OrderItem.ts new file mode 100644 index 0000000000..879b85ecc3 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/OrderItem.ts @@ -0,0 +1,8 @@ +/** + * @schema OrderItem + * type: object + * description: The item's detail. + * x-schemaName: OrderItem + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/OrderLineItem.ts b/www/utils/generated/oas-output/schemas/OrderLineItem.ts new file mode 100644 index 0000000000..13d7a88890 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/OrderLineItem.ts @@ -0,0 +1,364 @@ +/** + * @schema OrderLineItem + * type: object + * description: The item's items. + * x-schemaName: OrderLineItem + * required: + * - id + * - title + * - requires_shipping + * - is_discountable + * - is_tax_inclusive + * - unit_price + * - raw_unit_price + * - quantity + * - raw_quantity + * - detail + * - created_at + * - updated_at + * - original_total + * - original_subtotal + * - original_tax_total + * - item_total + * - item_subtotal + * - item_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - refundable_total + * - refundable_total_per_unit + * - raw_original_total + * - raw_original_subtotal + * - raw_original_tax_total + * - raw_item_total + * - raw_item_subtotal + * - raw_item_tax_total + * - raw_total + * - raw_subtotal + * - raw_tax_total + * - raw_discount_total + * - raw_discount_tax_total + * - raw_refundable_total + * - raw_refundable_total_per_unit + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * title: + * type: string + * title: title + * description: The item's title. + * subtitle: + * type: string + * title: subtitle + * description: The item's subtitle. + * thumbnail: + * type: string + * title: thumbnail + * description: The item's thumbnail. + * variant_id: + * type: string + * title: variant_id + * description: The item's variant id. + * product_id: + * type: string + * title: product_id + * description: The item's product id. + * product_title: + * type: string + * title: product_title + * description: The item's product title. + * product_description: + * type: string + * title: product_description + * description: The item's product description. + * product_subtitle: + * type: string + * title: product_subtitle + * description: The item's product subtitle. + * product_type: + * type: string + * title: product_type + * description: The item's product type. + * product_collection: + * type: string + * title: product_collection + * description: The item's product collection. + * product_handle: + * type: string + * title: product_handle + * description: The item's product handle. + * variant_sku: + * type: string + * title: variant_sku + * description: The item's variant sku. + * variant_barcode: + * type: string + * title: variant_barcode + * description: The item's variant barcode. + * variant_title: + * type: string + * title: variant_title + * description: The item's variant title. + * variant_option_values: + * type: object + * description: The item's variant option values. + * requires_shipping: + * type: boolean + * title: requires_shipping + * description: The item's requires shipping. + * is_discountable: + * type: boolean + * title: is_discountable + * description: The item's is discountable. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The item's is tax inclusive. + * compare_at_unit_price: + * type: number + * title: compare_at_unit_price + * description: The item's compare at unit price. + * raw_compare_at_unit_price: + * type: object + * description: The item's raw compare at unit price. + * unit_price: + * type: number + * title: unit_price + * description: The item's unit price. + * raw_unit_price: + * type: object + * description: The item's raw unit price. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * raw_quantity: + * type: object + * description: The item's raw quantity. + * tax_lines: + * type: array + * description: The item's tax lines. + * items: + * $ref: "#/components/schemas/OrderLineItemTaxLine" + * adjustments: + * type: array + * description: The item's adjustments. + * items: + * $ref: "#/components/schemas/OrderLineItemAdjustment" + * detail: + * $ref: "#/components/schemas/OrderItem" + * created_at: + * type: string + * title: created_at + * description: The item's created at. + * format: date-time + * updated_at: + * type: string + * title: updated_at + * description: The item's updated at. + * format: date-time + * metadata: + * type: object + * description: The item's metadata. + * original_total: + * oneOf: + * - type: string + * title: original_total + * description: The item's original total. + * - type: number + * title: original_total + * description: The item's original total. + * - type: string + * title: original_total + * description: The item's original total. + * - $ref: "#/components/schemas/IBigNumber" + * original_subtotal: + * oneOf: + * - type: string + * title: original_subtotal + * description: The item's original subtotal. + * - type: number + * title: original_subtotal + * description: The item's original subtotal. + * - type: string + * title: original_subtotal + * description: The item's original subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * original_tax_total: + * oneOf: + * - type: string + * title: original_tax_total + * description: The item's original tax total. + * - type: number + * title: original_tax_total + * description: The item's original tax total. + * - type: string + * title: original_tax_total + * description: The item's original tax total. + * - $ref: "#/components/schemas/IBigNumber" + * item_total: + * oneOf: + * - type: string + * title: item_total + * description: The item's item total. + * - type: number + * title: item_total + * description: The item's item total. + * - type: string + * title: item_total + * description: The item's item total. + * - $ref: "#/components/schemas/IBigNumber" + * item_subtotal: + * oneOf: + * - type: string + * title: item_subtotal + * description: The item's item subtotal. + * - type: number + * title: item_subtotal + * description: The item's item subtotal. + * - type: string + * title: item_subtotal + * description: The item's item subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * item_tax_total: + * oneOf: + * - type: string + * title: item_tax_total + * description: The item's item tax total. + * - type: number + * title: item_tax_total + * description: The item's item tax total. + * - type: string + * title: item_tax_total + * description: The item's item tax total. + * - $ref: "#/components/schemas/IBigNumber" + * total: + * oneOf: + * - type: string + * title: total + * description: The item's total. + * - type: number + * title: total + * description: The item's total. + * - type: string + * title: total + * description: The item's total. + * - $ref: "#/components/schemas/IBigNumber" + * subtotal: + * oneOf: + * - type: string + * title: subtotal + * description: The item's subtotal. + * - type: number + * title: subtotal + * description: The item's subtotal. + * - type: string + * title: subtotal + * description: The item's subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * tax_total: + * oneOf: + * - type: string + * title: tax_total + * description: The item's tax total. + * - type: number + * title: tax_total + * description: The item's tax total. + * - type: string + * title: tax_total + * description: The item's tax total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_total: + * oneOf: + * - type: string + * title: discount_total + * description: The item's discount total. + * - type: number + * title: discount_total + * description: The item's discount total. + * - type: string + * title: discount_total + * description: The item's discount total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_tax_total: + * oneOf: + * - type: string + * title: discount_tax_total + * description: The item's discount tax total. + * - type: number + * title: discount_tax_total + * description: The item's discount tax total. + * - type: string + * title: discount_tax_total + * description: The item's discount tax total. + * - $ref: "#/components/schemas/IBigNumber" + * refundable_total: + * oneOf: + * - type: string + * title: refundable_total + * description: The item's refundable total. + * - type: number + * title: refundable_total + * description: The item's refundable total. + * - type: string + * title: refundable_total + * description: The item's refundable total. + * - $ref: "#/components/schemas/IBigNumber" + * refundable_total_per_unit: + * oneOf: + * - type: string + * title: refundable_total_per_unit + * description: The item's refundable total per unit. + * - type: number + * title: refundable_total_per_unit + * description: The item's refundable total per unit. + * - type: string + * title: refundable_total_per_unit + * description: The item's refundable total per unit. + * - $ref: "#/components/schemas/IBigNumber" + * raw_original_total: + * type: object + * description: The item's raw original total. + * raw_original_subtotal: + * type: object + * description: The item's raw original subtotal. + * raw_original_tax_total: + * type: object + * description: The item's raw original tax total. + * raw_item_total: + * type: object + * description: The item's raw item total. + * raw_item_subtotal: + * type: object + * description: The item's raw item subtotal. + * raw_item_tax_total: + * type: object + * description: The item's raw item tax total. + * raw_total: + * type: object + * description: The item's raw total. + * raw_subtotal: + * type: object + * description: The item's raw subtotal. + * raw_tax_total: + * type: object + * description: The item's raw tax total. + * raw_discount_total: + * type: object + * description: The item's raw discount total. + * raw_discount_tax_total: + * type: object + * description: The item's raw discount tax total. + * raw_refundable_total: + * type: object + * description: The item's raw refundable total. + * raw_refundable_total_per_unit: + * type: object + * description: The item's raw refundable total per unit. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/OrderLineItemAdjustment.ts b/www/utils/generated/oas-output/schemas/OrderLineItemAdjustment.ts new file mode 100644 index 0000000000..bac9721fff --- /dev/null +++ b/www/utils/generated/oas-output/schemas/OrderLineItemAdjustment.ts @@ -0,0 +1,8 @@ +/** + * @schema OrderLineItemAdjustment + * type: object + * description: The adjustment's adjustments. + * x-schemaName: OrderLineItemAdjustment + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/OrderLineItemTaxLine.ts b/www/utils/generated/oas-output/schemas/OrderLineItemTaxLine.ts new file mode 100644 index 0000000000..a465434898 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/OrderLineItemTaxLine.ts @@ -0,0 +1,8 @@ +/** + * @schema OrderLineItemTaxLine + * type: object + * description: The tax line's tax lines. + * x-schemaName: OrderLineItemTaxLine + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/OrderShippingMethod.ts b/www/utils/generated/oas-output/schemas/OrderShippingMethod.ts new file mode 100644 index 0000000000..fbde5bc8a1 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/OrderShippingMethod.ts @@ -0,0 +1,219 @@ +/** + * @schema OrderShippingMethod + * type: object + * description: The shipping method's shipping methods. + * x-schemaName: OrderShippingMethod + * required: + * - id + * - order_id + * - name + * - amount + * - raw_amount + * - is_tax_inclusive + * - created_at + * - updated_at + * - original_total + * - original_subtotal + * - original_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - raw_original_total + * - raw_original_subtotal + * - raw_original_tax_total + * - raw_total + * - raw_subtotal + * - raw_tax_total + * - raw_discount_total + * - raw_discount_tax_total + * properties: + * id: + * type: string + * title: id + * description: The shipping method's ID. + * order_id: + * type: string + * title: order_id + * description: The shipping method's order id. + * name: + * type: string + * title: name + * description: The shipping method's name. + * description: + * type: string + * title: description + * description: The shipping method's description. + * amount: + * oneOf: + * - type: string + * title: amount + * description: The shipping method's amount. + * - type: number + * title: amount + * description: The shipping method's amount. + * - type: string + * title: amount + * description: The shipping method's amount. + * - $ref: "#/components/schemas/IBigNumber" + * raw_amount: + * type: object + * description: The shipping method's raw amount. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The shipping method's is tax inclusive. + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The shipping method's shipping option id. + * data: + * type: object + * description: The shipping method's data. + * metadata: + * type: object + * description: The shipping method's metadata. + * tax_lines: + * type: array + * description: The shipping method's tax lines. + * items: + * $ref: "#/components/schemas/OrderShippingMethodTaxLine" + * adjustments: + * type: array + * description: The shipping method's adjustments. + * items: + * $ref: "#/components/schemas/OrderShippingMethodAdjustment" + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The shipping method's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The shipping method's updated at. + * original_total: + * oneOf: + * - type: string + * title: original_total + * description: The shipping method's original total. + * - type: number + * title: original_total + * description: The shipping method's original total. + * - type: string + * title: original_total + * description: The shipping method's original total. + * - $ref: "#/components/schemas/IBigNumber" + * original_subtotal: + * oneOf: + * - type: string + * title: original_subtotal + * description: The shipping method's original subtotal. + * - type: number + * title: original_subtotal + * description: The shipping method's original subtotal. + * - type: string + * title: original_subtotal + * description: The shipping method's original subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * original_tax_total: + * oneOf: + * - type: string + * title: original_tax_total + * description: The shipping method's original tax total. + * - type: number + * title: original_tax_total + * description: The shipping method's original tax total. + * - type: string + * title: original_tax_total + * description: The shipping method's original tax total. + * - $ref: "#/components/schemas/IBigNumber" + * total: + * oneOf: + * - type: string + * title: total + * description: The shipping method's total. + * - type: number + * title: total + * description: The shipping method's total. + * - type: string + * title: total + * description: The shipping method's total. + * - $ref: "#/components/schemas/IBigNumber" + * subtotal: + * oneOf: + * - type: string + * title: subtotal + * description: The shipping method's subtotal. + * - type: number + * title: subtotal + * description: The shipping method's subtotal. + * - type: string + * title: subtotal + * description: The shipping method's subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * tax_total: + * oneOf: + * - type: string + * title: tax_total + * description: The shipping method's tax total. + * - type: number + * title: tax_total + * description: The shipping method's tax total. + * - type: string + * title: tax_total + * description: The shipping method's tax total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_total: + * oneOf: + * - type: string + * title: discount_total + * description: The shipping method's discount total. + * - type: number + * title: discount_total + * description: The shipping method's discount total. + * - type: string + * title: discount_total + * description: The shipping method's discount total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_tax_total: + * oneOf: + * - type: string + * title: discount_tax_total + * description: The shipping method's discount tax total. + * - type: number + * title: discount_tax_total + * description: The shipping method's discount tax total. + * - type: string + * title: discount_tax_total + * description: The shipping method's discount tax total. + * - $ref: "#/components/schemas/IBigNumber" + * raw_original_total: + * type: object + * description: The shipping method's raw original total. + * raw_original_subtotal: + * type: object + * description: The shipping method's raw original subtotal. + * raw_original_tax_total: + * type: object + * description: The shipping method's raw original tax total. + * raw_total: + * type: object + * description: The shipping method's raw total. + * raw_subtotal: + * type: object + * description: The shipping method's raw subtotal. + * raw_tax_total: + * type: object + * description: The shipping method's raw tax total. + * raw_discount_total: + * type: object + * description: The shipping method's raw discount total. + * raw_discount_tax_total: + * type: object + * description: The shipping method's raw discount tax total. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/OrderShippingMethodAdjustment.ts b/www/utils/generated/oas-output/schemas/OrderShippingMethodAdjustment.ts new file mode 100644 index 0000000000..f19a90e64e --- /dev/null +++ b/www/utils/generated/oas-output/schemas/OrderShippingMethodAdjustment.ts @@ -0,0 +1,8 @@ +/** + * @schema OrderShippingMethodAdjustment + * type: object + * description: The adjustment's adjustments. + * x-schemaName: OrderShippingMethodAdjustment + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/OrderShippingMethodTaxLine.ts b/www/utils/generated/oas-output/schemas/OrderShippingMethodTaxLine.ts new file mode 100644 index 0000000000..f33c1f843c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/OrderShippingMethodTaxLine.ts @@ -0,0 +1,8 @@ +/** + * @schema OrderShippingMethodTaxLine + * type: object + * description: The tax line's tax lines. + * x-schemaName: OrderShippingMethodTaxLine + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/OrderTransaction.ts b/www/utils/generated/oas-output/schemas/OrderTransaction.ts new file mode 100644 index 0000000000..fe45f126d8 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/OrderTransaction.ts @@ -0,0 +1,71 @@ +/** + * @schema OrderTransaction + * type: object + * description: The transaction's transactions. + * x-schemaName: OrderTransaction + * required: + * - id + * - order_id + * - order + * - amount + * - raw_amount + * - currency_code + * - reference + * - reference_id + * - created_at + * - updated_at + * - metadata + * properties: + * id: + * type: string + * title: id + * description: The transaction's ID. + * order_id: + * type: string + * title: order_id + * description: The transaction's order id. + * order: + * $ref: "#/components/schemas/Order" + * amount: + * oneOf: + * - type: string + * title: amount + * description: The transaction's amount. + * - type: number + * title: amount + * description: The transaction's amount. + * - type: string + * title: amount + * description: The transaction's amount. + * - $ref: "#/components/schemas/IBigNumber" + * raw_amount: + * type: object + * description: The transaction's raw amount. + * currency_code: + * type: string + * title: currency_code + * description: The transaction's currency code. + * reference: + * type: string + * title: reference + * description: The transaction's reference. + * reference_id: + * type: string + * title: reference_id + * description: The transaction's reference id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The transaction's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The transaction's updated at. + * metadata: + * type: object + * description: The transaction's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/RefundReasonResponse.ts b/www/utils/generated/oas-output/schemas/RefundReasonResponse.ts new file mode 100644 index 0000000000..09df8f68a7 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/RefundReasonResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema RefundReasonResponse + * type: object + * description: SUMMARY + * x-schemaName: RefundReasonResponse + * required: + * - refund_reason + * properties: + * refund_reason: + * $ref: "#/components/schemas/AdminRefundReason" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/ReservationResponse.ts b/www/utils/generated/oas-output/schemas/ReservationResponse.ts new file mode 100644 index 0000000000..1702fe4ee7 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/ReservationResponse.ts @@ -0,0 +1,71 @@ +/** + * @schema ReservationResponse + * type: object + * description: The reservation's details. + * x-schemaName: ReservationResponse + * required: + * - id + * - line_item_id + * - location_id + * - quantity + * - external_id + * - description + * - inventory_item_id + * - inventory_item + * properties: + * id: + * type: string + * title: id + * description: The reservation's ID. + * 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. + * quantity: + * type: string + * title: quantity + * description: The reservation's quantity. + * external_id: + * type: string + * title: external_id + * description: The reservation's external id. + * description: + * type: string + * title: description + * description: The reservation's description. + * inventory_item_id: + * type: string + * title: inventory_item_id + * description: The reservation's inventory item id. + * inventory_item: + * type: object + * description: The reservation's inventory item. + * metadata: + * type: object + * description: The reservation's metadata. + * created_by: + * type: string + * title: created_by + * description: The reservation's created by. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The reservation's deleted at. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The reservation's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The reservation's updated at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/Return.ts b/www/utils/generated/oas-output/schemas/Return.ts new file mode 100644 index 0000000000..484b0ca25b --- /dev/null +++ b/www/utils/generated/oas-output/schemas/Return.ts @@ -0,0 +1,8 @@ +/** + * @schema Return + * type: object + * description: The order change's return order. + * x-schemaName: Return + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCart.ts b/www/utils/generated/oas-output/schemas/StoreCart.ts new file mode 100644 index 0000000000..205ce9fc88 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCart.ts @@ -0,0 +1,354 @@ +/** + * @schema StoreCart + * type: object + * description: The cart's details. + * x-schemaName: StoreCart + * required: + * - id + * - currency_code + * - original_item_total + * - original_item_subtotal + * - original_item_tax_total + * - item_total + * - item_subtotal + * - item_tax_total + * - original_total + * - original_subtotal + * - original_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - gift_card_total + * - gift_card_tax_total + * - shipping_total + * - shipping_subtotal + * - shipping_tax_total + * - original_shipping_total + * - original_shipping_subtotal + * - original_shipping_tax_total + * properties: + * id: + * type: string + * title: id + * description: The cart's ID. + * region: + * $ref: "#/components/schemas/BaseRegion" + * region_id: + * type: string + * title: region_id + * description: The cart's region id. + * customer_id: + * type: string + * title: customer_id + * description: The cart's customer id. + * sales_channel_id: + * type: string + * title: sales_channel_id + * description: The cart's sales channel id. + * email: + * type: string + * title: email + * description: The cart's email. + * format: email + * currency_code: + * type: string + * title: currency_code + * description: The cart's currency code. + * shipping_address: + * $ref: "#/components/schemas/BaseCartAddress" + * billing_address: + * $ref: "#/components/schemas/BaseCartAddress" + * items: + * type: array + * description: The cart's items. + * items: + * $ref: "#/components/schemas/BaseCartLineItem" + * shipping_methods: + * type: array + * description: The cart's shipping methods. + * items: + * $ref: "#/components/schemas/BaseCartShippingMethod" + * payment_collection: + * $ref: "#/components/schemas/BasePaymentCollection" + * metadata: + * type: object + * description: The cart's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The cart's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The cart's updated at. + * original_item_total: + * oneOf: + * - type: string + * title: original_item_total + * description: The cart's original item total. + * - type: number + * title: original_item_total + * description: The cart's original item total. + * - type: string + * title: original_item_total + * description: The cart'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. + * - type: number + * title: original_item_subtotal + * description: The cart's original item subtotal. + * - type: string + * title: original_item_subtotal + * description: The cart'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. + * - type: number + * title: original_item_tax_total + * description: The cart's original item tax total. + * - type: string + * title: original_item_tax_total + * description: The cart's original item tax total. + * - $ref: "#/components/schemas/IBigNumber" + * item_total: + * oneOf: + * - type: string + * title: item_total + * description: The cart's item total. + * - type: number + * title: item_total + * description: The cart's item total. + * - type: string + * title: item_total + * description: The cart's item total. + * - $ref: "#/components/schemas/IBigNumber" + * item_subtotal: + * oneOf: + * - type: string + * title: item_subtotal + * description: The cart's item subtotal. + * - type: number + * title: item_subtotal + * description: The cart's item subtotal. + * - type: string + * title: item_subtotal + * description: The cart's item subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * item_tax_total: + * oneOf: + * - type: string + * title: item_tax_total + * description: The cart's item tax total. + * - type: number + * title: item_tax_total + * description: The cart's item tax total. + * - type: string + * title: item_tax_total + * description: The cart's item tax total. + * - $ref: "#/components/schemas/IBigNumber" + * original_total: + * oneOf: + * - type: string + * title: original_total + * description: The cart's original total. + * - type: number + * title: original_total + * description: The cart's original total. + * - type: string + * title: original_total + * description: The cart's original total. + * - $ref: "#/components/schemas/IBigNumber" + * original_subtotal: + * oneOf: + * - type: string + * title: original_subtotal + * description: The cart's original subtotal. + * - type: number + * title: original_subtotal + * description: The cart's original subtotal. + * - type: string + * title: original_subtotal + * description: The cart's original subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * original_tax_total: + * oneOf: + * - type: string + * title: original_tax_total + * description: The cart's original tax total. + * - type: number + * title: original_tax_total + * description: The cart's original tax total. + * - type: string + * title: original_tax_total + * description: The cart's original tax total. + * - $ref: "#/components/schemas/IBigNumber" + * total: + * oneOf: + * - type: string + * title: total + * description: The cart's total. + * - type: number + * title: total + * description: The cart's total. + * - type: string + * title: total + * description: The cart's total. + * - $ref: "#/components/schemas/IBigNumber" + * subtotal: + * oneOf: + * - type: string + * title: subtotal + * description: The cart's subtotal. + * - type: number + * title: subtotal + * description: The cart's subtotal. + * - type: string + * title: subtotal + * description: The cart's subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * tax_total: + * oneOf: + * - type: string + * title: tax_total + * description: The cart's tax total. + * - type: number + * title: tax_total + * description: The cart's tax total. + * - type: string + * title: tax_total + * description: The cart's tax total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_total: + * oneOf: + * - type: string + * title: discount_total + * description: The cart's discount total. + * - type: number + * title: discount_total + * description: The cart's discount total. + * - type: string + * title: discount_total + * description: The cart's discount total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_tax_total: + * oneOf: + * - type: string + * title: discount_tax_total + * description: The cart's discount tax total. + * - type: number + * title: discount_tax_total + * description: The cart's discount tax total. + * - type: string + * title: discount_tax_total + * description: The cart'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. + * - type: number + * title: gift_card_total + * description: The cart's gift card total. + * - type: string + * title: gift_card_total + * description: The cart'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. + * - type: number + * title: gift_card_tax_total + * description: The cart's gift card tax total. + * - type: string + * title: gift_card_tax_total + * description: The cart's gift card tax total. + * - $ref: "#/components/schemas/IBigNumber" + * shipping_total: + * oneOf: + * - type: string + * title: shipping_total + * description: The cart's shipping total. + * - type: number + * title: shipping_total + * description: The cart's shipping total. + * - type: string + * title: shipping_total + * description: The cart's shipping total. + * - $ref: "#/components/schemas/IBigNumber" + * shipping_subtotal: + * oneOf: + * - type: string + * title: shipping_subtotal + * description: The cart's shipping subtotal. + * - type: number + * title: shipping_subtotal + * description: The cart's shipping subtotal. + * - type: string + * title: shipping_subtotal + * description: The cart's shipping subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * shipping_tax_total: + * oneOf: + * - type: string + * title: shipping_tax_total + * description: The cart's shipping tax total. + * - type: number + * title: shipping_tax_total + * description: The cart's shipping tax total. + * - type: string + * title: shipping_tax_total + * description: The cart'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. + * - type: number + * title: original_shipping_total + * description: The cart's original shipping total. + * - type: string + * title: original_shipping_total + * description: The cart'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. + * - type: number + * title: original_shipping_subtotal + * description: The cart's original shipping subtotal. + * - type: string + * title: original_shipping_subtotal + * description: The cart'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. + * - type: number + * title: original_shipping_tax_total + * description: The cart's original shipping tax total. + * - type: string + * title: original_shipping_tax_total + * description: The cart's original shipping tax total. + * - $ref: "#/components/schemas/IBigNumber" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCartResponse.ts b/www/utils/generated/oas-output/schemas/StoreCartResponse.ts new file mode 100644 index 0000000000..561d57bbf0 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCartResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema StoreCartResponse + * type: object + * description: SUMMARY + * x-schemaName: StoreCartResponse + * required: + * - cart + * properties: + * cart: + * $ref: "#/components/schemas/StoreCart" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCollection.ts b/www/utils/generated/oas-output/schemas/StoreCollection.ts new file mode 100644 index 0000000000..42e216e62d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCollection.ts @@ -0,0 +1,52 @@ +/** + * @schema StoreCollection + * type: object + * description: The collection's details. + * x-schemaName: StoreCollection + * required: + * - id + * - title + * - handle + * - created_at + * - updated_at + * - deleted_at + * - metadata + * properties: + * id: + * type: string + * title: id + * description: The collection's ID. + * title: + * type: string + * title: title + * description: The collection's title. + * handle: + * type: string + * title: handle + * description: The collection's handle. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The collection's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The collection's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The collection's deleted at. + * products: + * type: array + * description: The collection's products. + * items: + * $ref: "#/components/schemas/AdminProduct" + * metadata: + * type: object + * description: The collection's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCollectionResponse.ts b/www/utils/generated/oas-output/schemas/StoreCollectionResponse.ts new file mode 100644 index 0000000000..69b16445a4 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCollectionResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema StoreCollectionResponse + * type: object + * description: SUMMARY + * x-schemaName: StoreCollectionResponse + * required: + * - collection + * properties: + * collection: + * $ref: "#/components/schemas/StoreCollection" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCurrency.ts b/www/utils/generated/oas-output/schemas/StoreCurrency.ts new file mode 100644 index 0000000000..07d645ea07 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCurrency.ts @@ -0,0 +1,74 @@ +/** + * @schema StoreCurrency + * type: object + * description: The currency's details. + * x-schemaName: StoreCurrency + * 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/StoreCurrencyListResponse.ts b/www/utils/generated/oas-output/schemas/StoreCurrencyListResponse.ts new file mode 100644 index 0000000000..c3280b6d3b --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCurrencyListResponse.ts @@ -0,0 +1,31 @@ +/** + * @schema StoreCurrencyListResponse + * type: object + * description: SUMMARY + * x-schemaName: StoreCurrencyListResponse + * required: + * - limit + * - offset + * - count + * - currencies + * properties: + * limit: + * type: number + * title: limit + * description: The currency's limit. + * offset: + * type: number + * title: offset + * description: The currency's offset. + * count: + * type: number + * title: count + * description: The currency's count. + * currencies: + * type: array + * description: The currency's currencies. + * items: + * $ref: "#/components/schemas/StoreCurrency" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCurrencyResponse.ts b/www/utils/generated/oas-output/schemas/StoreCurrencyResponse.ts new file mode 100644 index 0000000000..9079690069 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCurrencyResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema StoreCurrencyResponse + * type: object + * description: SUMMARY + * x-schemaName: StoreCurrencyResponse + * required: + * - currency + * properties: + * currency: + * $ref: "#/components/schemas/StoreCurrency" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCustomer.ts b/www/utils/generated/oas-output/schemas/StoreCustomer.ts new file mode 100644 index 0000000000..1e56d68407 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCustomer.ts @@ -0,0 +1,78 @@ +/** + * @schema StoreCustomer + * type: object + * description: The customer's details. + * x-schemaName: StoreCustomer + * required: + * - id + * - email + * - default_billing_address_id + * - default_shipping_address_id + * - company_name + * - first_name + * - last_name + * - addresses + * properties: + * id: + * type: string + * title: id + * description: The customer's ID. + * email: + * type: string + * title: email + * description: The customer's email. + * format: email + * default_billing_address_id: + * type: string + * title: default_billing_address_id + * description: The customer's default billing address id. + * default_shipping_address_id: + * type: string + * title: default_shipping_address_id + * description: The customer's default shipping address id. + * company_name: + * type: string + * title: company_name + * description: The customer's company name. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * addresses: + * type: array + * description: The customer's addresses. + * items: + * $ref: "#/components/schemas/BaseCustomerAddress" + * phone: + * type: string + * title: phone + * description: The customer's phone. + * metadata: + * type: object + * description: The customer's metadata. + * created_by: + * type: string + * title: created_by + * description: The customer's created by. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The customer's deleted at. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The customer's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The customer's updated at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCustomerAddress.ts b/www/utils/generated/oas-output/schemas/StoreCustomerAddress.ts new file mode 100644 index 0000000000..32bee63471 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCustomerAddress.ts @@ -0,0 +1,101 @@ +/** + * @schema StoreCustomerAddress + * type: object + * description: The customer's address. + * x-schemaName: StoreCustomerAddress + * 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/StoreCustomerAddressListResponse.ts b/www/utils/generated/oas-output/schemas/StoreCustomerAddressListResponse.ts new file mode 100644 index 0000000000..1d8db15776 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCustomerAddressListResponse.ts @@ -0,0 +1,31 @@ +/** + * @schema StoreCustomerAddressListResponse + * type: object + * description: SUMMARY + * x-schemaName: StoreCustomerAddressListResponse + * required: + * - limit + * - offset + * - count + * - addresses + * properties: + * limit: + * type: number + * title: limit + * description: The customer's limit. + * offset: + * type: number + * title: offset + * description: The customer's offset. + * count: + * type: number + * title: count + * description: The customer's count. + * addresses: + * type: array + * description: The customer's addresses. + * items: + * $ref: "#/components/schemas/StoreCustomerAddress" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCustomerAddressResponse.ts b/www/utils/generated/oas-output/schemas/StoreCustomerAddressResponse.ts new file mode 100644 index 0000000000..d4670f515b --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCustomerAddressResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema StoreCustomerAddressResponse + * type: object + * description: SUMMARY + * x-schemaName: StoreCustomerAddressResponse + * required: + * - address + * properties: + * address: + * $ref: "#/components/schemas/StoreCustomerAddress" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCustomerResponse.ts b/www/utils/generated/oas-output/schemas/StoreCustomerResponse.ts new file mode 100644 index 0000000000..44755eb7d7 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCustomerResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema StoreCustomerResponse + * type: object + * description: SUMMARY + * x-schemaName: StoreCustomerResponse + * required: + * - customer + * properties: + * customer: + * $ref: "#/components/schemas/StoreCustomer" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreOrder.ts b/www/utils/generated/oas-output/schemas/StoreOrder.ts new file mode 100644 index 0000000000..15f5361207 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreOrder.ts @@ -0,0 +1,236 @@ +/** + * @schema StoreOrder + * type: object + * description: The cart's order. + * x-schemaName: StoreOrder + * required: + * - id + * - version + * - region_id + * - customer_id + * - sales_channel_id + * - email + * - currency_code + * - items + * - shipping_methods + * - payment_status + * - fulfillment_status + * - summary + * - metadata + * - created_at + * - updated_at + * - original_item_total + * - original_item_subtotal + * - original_item_tax_total + * - item_total + * - item_subtotal + * - item_tax_total + * - original_total + * - original_subtotal + * - original_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - gift_card_total + * - gift_card_tax_total + * - shipping_total + * - shipping_subtotal + * - shipping_tax_total + * - original_shipping_total + * - original_shipping_subtotal + * - original_shipping_tax_total + * properties: + * id: + * type: string + * title: id + * description: The order's ID. + * version: + * type: number + * title: version + * description: The order's version. + * region_id: + * type: string + * title: region_id + * description: The order's region id. + * customer_id: + * type: string + * title: customer_id + * description: The order's customer id. + * sales_channel_id: + * type: string + * title: sales_channel_id + * description: The order's sales channel id. + * email: + * type: string + * title: email + * description: The order's email. + * format: email + * currency_code: + * type: string + * title: currency_code + * description: The order's currency code. + * display_id: + * type: string + * 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. + * items: + * $ref: "#/components/schemas/BaseOrderLineItem" + * shipping_methods: + * type: array + * description: The order's shipping methods. + * items: + * $ref: "#/components/schemas/BaseOrderShippingMethod" + * payment_collections: + * type: array + * description: The order's payment collections. + * items: + * $ref: "#/components/schemas/BasePaymentCollection" + * payment_status: + * type: string + * enum: + * - canceled + * - not_paid + * - awaiting + * - authorized + * - partially_authorized + * - captured + * - partially_captured + * - partially_refunded + * - refunded + * - requires_action + * fulfillments: + * type: array + * description: The order's fulfillments. + * items: + * $ref: "#/components/schemas/BaseOrderFulfillment" + * fulfillment_status: + * type: string + * enum: + * - canceled + * - not_fulfilled + * - partially_fulfilled + * - fulfilled + * - partially_shipped + * - shipped + * - partially_delivered + * - delivered + * transactions: + * type: array + * description: The order's transactions. + * items: + * $ref: "#/components/schemas/BaseOrderTransaction" + * summary: + * $ref: "#/components/schemas/BaseOrderSummary" + * metadata: + * type: object + * description: The order's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The order's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The order's updated at. + * original_item_total: + * type: number + * title: original_item_total + * description: The order's original item total. + * original_item_subtotal: + * type: number + * title: original_item_subtotal + * description: The order's original item subtotal. + * original_item_tax_total: + * type: number + * title: original_item_tax_total + * description: The order's original item tax total. + * item_total: + * type: number + * title: item_total + * description: The order's item total. + * item_subtotal: + * type: number + * title: item_subtotal + * description: The order's item subtotal. + * item_tax_total: + * type: number + * title: item_tax_total + * description: The order's item tax total. + * original_total: + * type: number + * title: original_total + * description: The order's original total. + * original_subtotal: + * type: number + * title: original_subtotal + * description: The order's original subtotal. + * original_tax_total: + * type: number + * title: original_tax_total + * description: The order's original tax total. + * total: + * type: number + * title: total + * description: The order's total. + * subtotal: + * type: number + * title: subtotal + * description: The order's subtotal. + * tax_total: + * type: number + * title: tax_total + * description: The order's tax total. + * discount_total: + * type: number + * title: discount_total + * description: The order's discount total. + * discount_tax_total: + * type: number + * title: discount_tax_total + * description: The order's discount tax total. + * gift_card_total: + * type: number + * title: gift_card_total + * description: The order's gift card total. + * gift_card_tax_total: + * type: number + * title: gift_card_tax_total + * description: The order's gift card tax total. + * shipping_total: + * type: number + * title: shipping_total + * description: The order's shipping total. + * shipping_subtotal: + * type: number + * title: shipping_subtotal + * description: The order's shipping subtotal. + * shipping_tax_total: + * type: number + * title: shipping_tax_total + * description: The order's shipping tax total. + * original_shipping_total: + * type: number + * title: original_shipping_total + * description: The order's original shipping total. + * original_shipping_subtotal: + * type: number + * title: original_shipping_subtotal + * description: The order's original shipping subtotal. + * original_shipping_tax_total: + * type: number + * title: original_shipping_tax_total + * description: The order's original shipping tax total. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreOrderResponse.ts b/www/utils/generated/oas-output/schemas/StoreOrderResponse.ts new file mode 100644 index 0000000000..039eff0128 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreOrderResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema StoreOrderResponse + * type: object + * description: SUMMARY + * x-schemaName: StoreOrderResponse + * required: + * - order + * properties: + * order: + * $ref: "#/components/schemas/StoreOrder" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StorePaymentCollection.ts b/www/utils/generated/oas-output/schemas/StorePaymentCollection.ts new file mode 100644 index 0000000000..ba304f848c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StorePaymentCollection.ts @@ -0,0 +1,121 @@ +/** + * @schema StorePaymentCollection + * type: object + * description: The payment collection's details. + * x-schemaName: StorePaymentCollection + * required: + * - id + * - currency_code + * - region_id + * - amount + * - status + * - payment_providers + * properties: + * id: + * type: string + * title: id + * description: The payment collection's ID. + * currency_code: + * type: string + * title: currency_code + * description: The payment collection's currency code. + * region_id: + * type: string + * title: region_id + * description: The payment collection's region id. + * amount: + * oneOf: + * - type: string + * title: amount + * description: The payment collection's amount. + * - type: number + * title: amount + * description: The payment collection's amount. + * - type: string + * title: amount + * description: The payment collection's amount. + * - $ref: "#/components/schemas/IBigNumber" + * authorized_amount: + * oneOf: + * - type: string + * title: authorized_amount + * description: The payment collection's authorized amount. + * - type: number + * title: authorized_amount + * description: The payment collection's authorized amount. + * - type: string + * title: authorized_amount + * description: The payment collection's authorized amount. + * - $ref: "#/components/schemas/IBigNumber" + * captured_amount: + * oneOf: + * - type: string + * title: captured_amount + * description: The payment collection's captured amount. + * - type: number + * title: captured_amount + * description: The payment collection's captured amount. + * - type: string + * title: captured_amount + * description: The payment collection's captured amount. + * - $ref: "#/components/schemas/IBigNumber" + * refunded_amount: + * oneOf: + * - type: string + * title: refunded_amount + * description: The payment collection's refunded amount. + * - type: number + * title: refunded_amount + * description: The payment collection's refunded amount. + * - type: string + * title: refunded_amount + * description: The payment collection's refunded amount. + * - $ref: "#/components/schemas/IBigNumber" + * completed_at: + * oneOf: + * - type: string + * title: completed_at + * description: The payment collection's completed at. + * - type: string + * title: completed_at + * description: The payment collection's completed at. + * format: date-time + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The payment collection's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The payment collection's updated at. + * metadata: + * type: object + * description: The payment collection's metadata. + * status: + * type: string + * enum: + * - canceled + * - not_paid + * - awaiting + * - authorized + * - partially_authorized + * payment_providers: + * type: array + * description: The payment collection's payment providers. + * items: + * $ref: "#/components/schemas/BasePaymentProvider" + * payment_sessions: + * type: array + * description: The payment collection's payment sessions. + * items: + * $ref: "#/components/schemas/BasePaymentSession" + * payments: + * type: array + * description: The payment collection's payments. + * items: + * $ref: "#/components/schemas/BasePayment" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StorePaymentCollectionResponse.ts b/www/utils/generated/oas-output/schemas/StorePaymentCollectionResponse.ts new file mode 100644 index 0000000000..70cf7d3692 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StorePaymentCollectionResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema StorePaymentCollectionResponse + * type: object + * description: SUMMARY + * x-schemaName: StorePaymentCollectionResponse + * required: + * - payment_collection + * properties: + * payment_collection: + * $ref: "#/components/schemas/StorePaymentCollection" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StorePaymentProvider.ts b/www/utils/generated/oas-output/schemas/StorePaymentProvider.ts new file mode 100644 index 0000000000..7d658ffe4b --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StorePaymentProvider.ts @@ -0,0 +1,15 @@ +/** + * @schema StorePaymentProvider + * type: object + * description: The payment provider's payment providers. + * x-schemaName: StorePaymentProvider + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The payment provider's ID. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreProduct.ts b/www/utils/generated/oas-output/schemas/StoreProduct.ts index 906120617a..4e649b977a 100644 --- a/www/utils/generated/oas-output/schemas/StoreProduct.ts +++ b/www/utils/generated/oas-output/schemas/StoreProduct.ts @@ -1,7 +1,7 @@ /** * @schema StoreProduct * type: object - * description: The product's products. + * description: The product's details. * x-schemaName: StoreProduct * required: * - title @@ -10,26 +10,26 @@ * - options * - description * - id - * - handle - * - hs_code - * - weight - * - height - * - width - * - origin_country - * - mid_code - * - material - * - thumbnail * - created_at * - updated_at - * - deleted_at * - variants + * - handle * - subtitle * - is_giftcard + * - thumbnail + * - width + * - weight + * - height + * - origin_country + * - hs_code + * - mid_code + * - material * - collection_id * - type_id * - images * - discountable * - external_id + * - deleted_at * properties: * categories: * type: array @@ -69,42 +69,6 @@ * metadata: * type: object * description: The product's metadata. - * handle: - * type: string - * title: handle - * description: The product's handle. - * hs_code: - * type: string - * title: hs_code - * description: The product's hs code. - * weight: - * type: number - * title: weight - * description: The product's weight. - * height: - * type: number - * title: height - * description: The product's height. - * width: - * type: number - * title: width - * description: The product's width. - * origin_country: - * type: string - * title: origin_country - * description: The product's origin country. - * mid_code: - * type: string - * title: mid_code - * description: The product's mid code. - * material: - * type: string - * title: material - * description: The product's material. - * thumbnail: - * type: string - * title: thumbnail - * description: The product's thumbnail. * created_at: * type: string * format: date-time @@ -115,16 +79,15 @@ * format: date-time * title: updated_at * description: The product's updated at. - * deleted_at: - * type: string - * format: date-time - * title: deleted_at - * description: The product's deleted at. * variants: * type: array * description: The product's variants. * items: * $ref: "#/components/schemas/BaseProductVariant" + * handle: + * type: string + * title: handle + * description: The product's handle. * subtitle: * type: string * title: subtitle @@ -133,6 +96,38 @@ * type: boolean * title: is_giftcard * description: The product's is giftcard. + * thumbnail: + * type: string + * title: thumbnail + * description: The product's thumbnail. + * width: + * type: number + * title: width + * description: The product's width. + * weight: + * type: number + * title: weight + * description: The product's weight. + * height: + * type: number + * title: height + * description: The product's height. + * origin_country: + * type: string + * title: origin_country + * description: The product's origin country. + * hs_code: + * type: string + * title: hs_code + * description: The product's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The product's mid code. + * material: + * type: string + * title: material + * description: The product's material. * collection: * $ref: "#/components/schemas/BaseCollection" * collection_id: @@ -161,6 +156,11 @@ * type: string * title: external_id * description: The product's external id. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The product's deleted at. * */ diff --git a/www/utils/generated/oas-output/schemas/StoreProductCategory.ts b/www/utils/generated/oas-output/schemas/StoreProductCategory.ts index 53b35f8271..ba6c8b39cb 100644 --- a/www/utils/generated/oas-output/schemas/StoreProductCategory.ts +++ b/www/utils/generated/oas-output/schemas/StoreProductCategory.ts @@ -1,7 +1,7 @@ /** * @schema StoreProductCategory * type: object - * description: The product category's details. + * description: The category's categories. * x-schemaName: StoreProductCategory * required: * - id @@ -20,63 +20,63 @@ * properties: * products: * type: array - * description: The product category's products. + * description: The category's products. * items: * $ref: "#/components/schemas/StoreProduct" * id: * type: string * title: id - * description: The product category's ID. + * description: The category's ID. * name: * type: string * title: name - * description: The product category's name. + * description: The category's name. * description: * type: string * title: description - * description: The product category's description. + * description: The category's description. * handle: * type: string * title: handle - * description: The product category's handle. + * description: The category's handle. * is_active: * type: boolean * title: is_active - * description: The product category's is active. + * description: The category's is active. * is_internal: * type: boolean * title: is_internal - * description: The product category's is internal. + * description: The category's is internal. * rank: * type: number * title: rank - * description: The product category's rank. + * description: The category's rank. * parent_category_id: * type: string * title: parent_category_id - * description: The product category's parent category id. + * description: The category's parent category id. * parent_category: * $ref: "#/components/schemas/BaseProductCategory" * category_children: * type: array - * description: The product category's category children. + * description: The category's category children. * items: * $ref: "#/components/schemas/BaseProductCategory" * created_at: * type: string * format: date-time * title: created_at - * description: The product category's created at. + * description: The category's created at. * updated_at: * type: string * format: date-time * title: updated_at - * description: The product category's updated at. + * description: The category's updated at. * deleted_at: * type: string * format: date-time * title: deleted_at - * description: The product category's deleted at. + * description: The category's deleted at. * */ diff --git a/www/utils/generated/oas-output/schemas/StoreProductResponse.ts b/www/utils/generated/oas-output/schemas/StoreProductResponse.ts new file mode 100644 index 0000000000..bab32e973d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreProductResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema StoreProductResponse + * type: object + * description: SUMMARY + * x-schemaName: StoreProductResponse + * required: + * - product + * properties: + * product: + * $ref: "#/components/schemas/StoreProduct" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreRegion.ts b/www/utils/generated/oas-output/schemas/StoreRegion.ts new file mode 100644 index 0000000000..d5e18f344d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreRegion.ts @@ -0,0 +1,52 @@ +/** + * @schema StoreRegion + * type: object + * description: The region's details. + * x-schemaName: StoreRegion + * required: + * - id + * - name + * - currency_code + * properties: + * id: + * type: string + * title: id + * description: The region's ID. + * name: + * type: string + * title: name + * description: The region's name. + * currency_code: + * type: string + * title: currency_code + * description: The region's currency code. + * automatic_taxes: + * type: boolean + * title: automatic_taxes + * description: The region's automatic taxes. + * countries: + * type: array + * description: The region's countries. + * items: + * $ref: "#/components/schemas/BaseRegionCountry" + * payment_providers: + * type: array + * description: The region's payment providers. + * items: + * $ref: "#/components/schemas/AdminPaymentProvider" + * metadata: + * type: object + * description: The region's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The region's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The region's updated at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreReturn.ts b/www/utils/generated/oas-output/schemas/StoreReturn.ts new file mode 100644 index 0000000000..e0e54a0b4f --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreReturn.ts @@ -0,0 +1,71 @@ +/** + * @schema StoreReturn + * type: object + * description: The return's details. + * x-schemaName: StoreReturn + * required: + * - id + * - order_id + * - order_version + * - display_id + * - items + * - received_at + * - created_at + * properties: + * id: + * type: string + * title: id + * description: The return's ID. + * order_id: + * type: string + * title: order_id + * description: The return's order id. + * status: + * type: string + * title: status + * description: The return's status. + * exchange_id: + * type: string + * title: exchange_id + * description: The return's exchange id. + * location_id: + * type: string + * title: location_id + * description: The return's location id. + * claim_id: + * type: string + * title: claim_id + * description: The return's claim id. + * order_version: + * type: number + * title: order_version + * description: The return's order version. + * display_id: + * type: number + * title: display_id + * description: The return's display id. + * no_notification: + * type: boolean + * title: no_notification + * description: The return's no notification. + * refund_amount: + * type: number + * title: refund_amount + * description: The return's refund amount. + * items: + * type: array + * description: The return's items. + * items: + * $ref: "#/components/schemas/BaseReturnItem" + * received_at: + * type: string + * title: received_at + * description: The return's received at. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The return's created at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreReturnReason.ts b/www/utils/generated/oas-output/schemas/StoreReturnReason.ts new file mode 100644 index 0000000000..1122f0f829 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreReturnReason.ts @@ -0,0 +1,44 @@ +/** + * @schema StoreReturnReason + * type: object + * description: The return reason's details. + * x-schemaName: StoreReturnReason + * required: + * - id + * - value + * - label + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The return reason's ID. + * value: + * type: string + * title: value + * description: The return reason's value. + * label: + * type: string + * title: label + * description: The return reason's label. + * description: + * type: string + * title: description + * description: The return reason's description. + * metadata: + * type: object + * description: The return reason's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The return reason's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The return reason's updated at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreReturnReasonResponse.ts b/www/utils/generated/oas-output/schemas/StoreReturnReasonResponse.ts new file mode 100644 index 0000000000..d3aeb7cd18 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreReturnReasonResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema StoreReturnReasonResponse + * type: object + * description: SUMMARY + * x-schemaName: StoreReturnReasonResponse + * required: + * - return_reason + * properties: + * return_reason: + * $ref: "#/components/schemas/StoreReturnReason" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreReturnResponse.ts b/www/utils/generated/oas-output/schemas/StoreReturnResponse.ts new file mode 100644 index 0000000000..4aea302938 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreReturnResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema StoreReturnResponse + * type: object + * description: SUMMARY + * x-schemaName: StoreReturnResponse + * required: + * - return + * properties: + * return: + * $ref: "#/components/schemas/StoreReturn" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreShippingOption.ts b/www/utils/generated/oas-output/schemas/StoreShippingOption.ts new file mode 100644 index 0000000000..7837a493c1 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreShippingOption.ts @@ -0,0 +1,70 @@ +/** + * @schema StoreShippingOption + * type: object + * description: The shipping option's shipping options. + * x-schemaName: StoreShippingOption + * required: + * - id + * - name + * - price_type + * - service_zone_id + * - provider_id + * - provider + * - shipping_option_type_id + * - type + * - shipping_profile_id + * - amount + * - is_tax_inclusive + * - data + * - metadata + * properties: + * id: + * type: string + * title: id + * description: The shipping option's ID. + * name: + * type: string + * title: name + * description: The shipping option's name. + * price_type: + * type: string + * enum: + * - flat + * - calculated + * service_zone_id: + * type: string + * title: service_zone_id + * description: The shipping option's service zone id. + * provider_id: + * type: string + * title: provider_id + * description: The shipping option's provider id. + * provider: + * $ref: "#/components/schemas/BaseFulfillmentProvider" + * shipping_option_type_id: + * type: string + * title: shipping_option_type_id + * description: The shipping option's shipping option type id. + * type: + * $ref: "#/components/schemas/StoreShippingOption" + * shipping_profile_id: + * type: string + * title: shipping_profile_id + * description: The shipping option's shipping profile id. + * amount: + * type: number + * title: amount + * description: The shipping option's amount. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The shipping option's is tax inclusive. + * data: + * type: object + * description: The shipping option's data. + * metadata: + * type: object + * description: The shipping option's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreShippingOptionListResponse.ts b/www/utils/generated/oas-output/schemas/StoreShippingOptionListResponse.ts new file mode 100644 index 0000000000..16e10b69f0 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreShippingOptionListResponse.ts @@ -0,0 +1,16 @@ +/** + * @schema StoreShippingOptionListResponse + * type: object + * description: SUMMARY + * x-schemaName: StoreShippingOptionListResponse + * required: + * - shipping_options + * properties: + * shipping_options: + * type: array + * description: The shipping option's shipping options. + * items: + * $ref: "#/components/schemas/StoreShippingOption" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/UpdateCartData.ts b/www/utils/generated/oas-output/schemas/UpdateCartData.ts deleted file mode 100644 index 62a5481a5e..0000000000 --- a/www/utils/generated/oas-output/schemas/UpdateCartData.ts +++ /dev/null @@ -1,49 +0,0 @@ -/** - * @schema UpdateCartData - * type: object - * description: SUMMARY - * x-schemaName: UpdateCartData - * properties: - * region_id: - * type: string - * title: region_id - * description: The cart's region id. - * customer_id: - * type: string - * title: customer_id - * description: The cart's customer id. - * sales_channel_id: - * type: string - * title: sales_channel_id - * description: The cart's sales channel id. - * email: - * type: string - * title: email - * description: The cart's email. - * format: email - * currency_code: - * type: string - * title: currency_code - * description: The cart's currency code. - * shipping_address_id: - * type: string - * title: shipping_address_id - * description: The cart's shipping address id. - * billing_address_id: - * type: string - * title: billing_address_id - * description: The cart's billing address id. - * billing_address: - * oneOf: - * - $ref: "#/components/schemas/CreateAddress" - * - $ref: "#/components/schemas/UpdateAddress" - * shipping_address: - * oneOf: - * - $ref: "#/components/schemas/CreateAddress" - * - $ref: "#/components/schemas/UpdateAddress" - * metadata: - * type: object - * description: The cart's metadata. - * -*/ -